GI.Poppler.Structs.Color

A Color describes a RGB color. Color components are values between 0 and 65535

Exported types

newtype Color

Memory-managed wrapper type.

Constructors

Color (ManagedPtr Color)

Instances

BoxedObject Color

Defined in GI.Poppler.Structs.Color

Methods

boxedType :: Color -> IO GType

tag ~ AttrSet => Constructible Color tag

Defined in GI.Poppler.Structs.Color

Methods

new :: MonadIO m => (ManagedPtr Color -> Color) -> [AttrOp Color tag] -> m Color

newZeroColor :: MonadIO m => m Color

Construct a Color struct initialized to zero.

noColor :: Maybe Color

A convenience alias for Nothing :: Maybe Color.

Methods

copy

colorCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color to copy

-> m Color

Returns: a new allocated copy of color

Creates a copy of color

free

colorFree

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color

-> m ()

Frees the given Color

new

colorNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Color

Returns: a new Color, use colorFree to free it

Creates a new Color

Properties

blue

the blue component of color

getColorBlue :: MonadIO m => Color -> m Word16

Get the value of the “blue” field. When overloading is enabled, this is equivalent to

get color #blue

setColorBlue :: MonadIO m => Color -> Word16 -> m ()

Set the value of the “blue” field. When overloading is enabled, this is equivalent to

set color [ #blue := value ]

green

the green component of color

getColorGreen :: MonadIO m => Color -> m Word16

Get the value of the “green” field. When overloading is enabled, this is equivalent to

get color #green

setColorGreen :: MonadIO m => Color -> Word16 -> m ()

Set the value of the “green” field. When overloading is enabled, this is equivalent to

set color [ #green := value ]

red

the red component of color

getColorRed :: MonadIO m => Color -> m Word16

Get the value of the “red” field. When overloading is enabled, this is equivalent to

get color #red

setColorRed :: MonadIO m => Color -> Word16 -> m ()

Set the value of the “red” field. When overloading is enabled, this is equivalent to

set color [ #red := value ]