suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc correction

Browse Source 
Closes PR 12171
This commit is contained in:
Matthew Flatt 2011-11-27 11:14:58 -07:00
parent a707b0c5f5
commit 49802b7ba1
3 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
collects/scribblings/draw/bitmap-class.scrbl
View File

@ -23,7 +23,7 @@ A bitmap is convertible to @racket['png-bytes] through the
'xbm 'xbm/alpha 'xpm 'xpm/alpha
'bmp 'bmp/alpha)
'unknown]
[bg-color (or/c (is-a?/c color%) false/c) #f]
[bg-color (or/c (is-a?/c color%) #f) #f]
[complain-on-failure? any/c #f])
([bits bytes?]
[width exact-positive-integer?]
@ -90,7 +90,7 @@ Gets the height of the bitmap in pixels.
}
@defmethod[(get-loaded-mask)
(or/c (is-a?/c bitmap%) false/c)]{
(or/c (is-a?/c bitmap%) #f)]{
Returns a mask bitmap that is stored with this bitmap.
@ -155,7 +155,7 @@ Returns @racket[#f] if the bitmap is monochrome, @racket[#t] otherwise.
'xbm 'xbm/alpha 'xpm 'xpm/alpha
'bmp 'bmp/alpha)
'unknown]
[bg-color (or/c (is-a?/c color%) false/c) #f]
[bg-color (or/c (is-a?/c color%) #f) #f]
[complain-on-failure? any/c #f])
boolean?]{

10
collects/scribblings/draw/bitmap-dc-class.scrbl
View File

@ -17,7 +17,7 @@ Drawing to a @racket[bitmap-dc%] with a color bitmap is guaranteed to
can be used for offscreen staging of canvas content.
@defconstructor[([bitmap (or/c (is-a?/c bitmap%) false/c)])]{
@defconstructor[([bitmap (or/c (is-a?/c bitmap%) #f)])]{
Creates a new memory DC. If @racket[bitmap] is not @racket[#f], it is
installed into the DC so that drawing commands on the DC draw to
@ -36,7 +36,9 @@ Creates a new memory DC. If @racket[bitmap] is not @racket[#f], it is
[src-y real?]
[src-width (and/c real? (not/c negative?))]
[src-height (and/c real? (not/c negative?))]
[mask (or/c (is-a?/c bitmap%) false/c)])
[style (one-of/c 'solid 'opaque 'xor) 'solid]
[color (is-a?/c color%) (send the-color-database find-color "black")]
[mask (or/c (is-a?/c bitmap%) #f) #f])
boolean?]{
The same as @method[dc<%> draw-bitmap-section], except that
@ -91,7 +93,7 @@ If @racket[pre-multiplied?] is true, @racket[just-alpha?] is false,
}
@defmethod[(get-bitmap)
(or/c (is-a?/c bitmap%) false/c)]{
(or/c (is-a?/c bitmap%) #f)]{
Gets the bitmap currently installed in the DC, or @racket[#f] if no
bitmap is installed. See @method[bitmap-dc% set-bitmap] for more
@ -153,7 +155,7 @@ If @racket[pre-multiplied?] is true, @racket[just-alpha?] is false,
}
@defmethod[(set-bitmap [bitmap (or/c (is-a?/c bitmap%) false/c)])
@defmethod[(set-bitmap [bitmap (or/c (is-a?/c bitmap%) #f)])
void?]{
Installs a bitmap into the DC, so that drawing operations on the bitmap

12
collects/scribblings/draw/dc-intf.scrbl
View File

@ -85,7 +85,7 @@ If both the pen and brush are non-transparent, the wedge is filled
[dest-y real?]
[style (one-of/c 'solid 'opaque 'xor) 'solid]
[color (is-a?/c color%) (send the-color-database find-color "black")]
[mask (or/c (is-a?/c bitmap%) false/c) #f])
[mask (or/c (is-a?/c bitmap%) #f) #f])
boolean?]{
Displays the @racket[source] bitmap. The @racket[dest-x] and @racket[dest-y] arguments
@ -157,7 +157,7 @@ See also @method[dc<%> draw-bitmap-section].
[src-height (and/c real? (not/c negative?))]
[style (one-of/c 'solid 'opaque 'xor) 'solid]
[color (is-a?/c color%) (send the-color-database find-color "black")]
[mask (or/c (is-a?/c bitmap%) false/c) #f])
[mask (or/c (is-a?/c bitmap%) #f) #f])
boolean?]{
Displays part of a bitmap.
@ -532,7 +532,7 @@ Unlike most methods, this method can be called for a
}
@defmethod[(get-clipping-region)
(or/c (is-a?/c region%) false/c)]{
(or/c (is-a?/c region%) #f)]{
Gets the current clipping region, returning @racket[#f] if the drawing
context is not clipped (i.e., the clipping region is the entire
@ -563,7 +563,7 @@ Gets the current font. See also @method[dc<%> set-font].
}
@defmethod[(get-gl-context)
(or/c (is-a?/c gl-context<%>) false/c)]{
(or/c (is-a?/c gl-context<%>) #f)]{
Returns a @racket[gl-context<%>] object for this drawing context
if it supports OpenGL, @racket[#f] otherwise.
@ -673,7 +673,7 @@ set-text-background].
}
@defmethod[(get-text-extent [string string?]
[font (or/c (is-a?/c font%) false/c) #f]
[font (or/c (is-a?/c font%) #f) #f]
[combine? any/c #f]
[offset exact-nonnegative-integer? 0])
(values (and/c real? (not/c negative?))
@ -887,7 +887,7 @@ get-clipping-region].
}
@defmethod[(set-clipping-region [rgn (or/c (is-a?/c region%) false/c)])
@defmethod[(set-clipping-region [rgn (or/c (is-a?/c region%) #f)])
void?]{
Sets the clipping region for the drawing area, turning off all