{"size": 2244, "ext": "scrbl", "max_stars_repo_path": "gui-doc/scribblings/gui/mult-color-intf.scrbl", "max_stars_repo_name": "jjsimpso/gui", "max_stars_repo_stars_event_min_datetime": "2015-03-17T22:11:52.000Z", "max_stars_repo_stars_event_max_datetime": "2022-03-12T15:09:34.000Z", "max_issues_repo_path": "gui-doc/scribblings/gui/mult-color-intf.scrbl", "max_issues_repo_name": "jjsimpso/gui", "max_issues_repo_issues_event_min_datetime": "2015-01-09T15:53:25.000Z", "max_issues_repo_issues_event_max_datetime": "2022-03-31T16:21:29.000Z", "max_forks_repo_path": "gui-doc/scribblings/gui/mult-color-intf.scrbl", "max_forks_repo_name": "jjsimpso/gui", "max_forks_repo_forks_event_min_datetime": "2015-01-08T13:03:07.000Z", "max_forks_repo_forks_event_max_datetime": "2022-03-26T21:49:09.000Z"}
{"max_stars_count": 65, "max_issues_count": 231, "max_forks_count": 89, "avg_line_length": 23.1340206186, "max_line_length": 88, "alphanum_fraction": 0.6421568627}
#lang scribble/doc
@(require "common.rkt")

@definterface/title[mult-color<%> ()]{

A @racket[mult-color<%>] object is used to scale the RGB values of a
 @racket[color%] object. A @racket[mult-color<%>] object exist only
 within a @racket[style-delta%] object.

See also @method[style-delta% get-foreground-mult] and
 @method[style-delta% get-background-mult].



@defmethod[(get [r (box/c real?)]
                [g (box/c real?)]
                [b (box/c real?)]
                [a (or/c (box/c real?) #f) #f])
           void?]{

Gets all of the scaling values.

@boxisfill[@racket[r] @elem{the scaling value for the red component of the color}]
@boxisfill[@racket[g] @elem{the scaling value for the green component of the color}]
@boxisfill[@racket[b] @elem{the scaling value for the blue component of the color}]
@boxisfillnull[@racket[a] @elem{the scaling value for the alpha component of the color}]

@history[#:changed "1.63" @elem{Added the @racket[a] optional argument.}]}

@defmethod[(get-a)
           real?]{

Gets the multiplicative scaling value for the alpha component of the color.

@history[#:added "1.63"]}


@defmethod[(get-b)
           real?]{

Gets the multiplicative scaling value for the blue component of the color.

}

@defmethod[(get-g)
           real?]{

Gets the multiplicative scaling value for the green component of the color.

}

@defmethod[(get-r)
           real?]{

Gets the multiplicative scaling value for the red component of the color.

}

@defmethod[(set [r real?]
                [g real?]
                [b real?]
                [a real? 1.0])
           void?]{

Sets all of the scaling values.

@history[#:changed "1.63" @elem{Added the @racket[a] optional argument.}]}

@defmethod[(set-a [v real?])
           void?]{

Sets the multiplicative scaling value for the alpha component of the color.

@history[#:added "1.63"]}

@defmethod[(set-b [v real?])
           void?]{

Sets the multiplicative scaling value for the blue component of the color.

}

@defmethod[(set-g [v real?])
           void?]{

Sets the multiplicative scaling value for the green component of the
color.

}

@defmethod[(set-r [v real?])
           void?]{

Sets the additive value for the red component of the color.

}}
