Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GI.Cogl.Structs.Color
Contents
- Exported types
- Methods
- copy
- equal
- free
- getAlpha
- getAlphaByte
- getAlphaFloat
- getBlue
- getBlueByte
- getBlueFloat
- getGreen
- getGreenByte
- getGreenFloat
- getRed
- getRedByte
- getRedFloat
- initFrom4f
- initFrom4fv
- initFrom4ub
- initFromHsl
- new
- premultiply
- setAlpha
- setAlphaByte
- setAlphaFloat
- setBlue
- setBlueByte
- setBlueFloat
- setFrom4f
- setFrom4ub
- setGreen
- setGreenByte
- setGreenFloat
- setRed
- setRedByte
- setRedFloat
- toHsl
- unpremultiply
Description
A structure for holding a color definition. The contents of the CoglColor structure are private and should never by accessed directly.
Since: 1.0
Synopsis
- newtype Color = Color (ManagedPtr Color)
- newZeroColor :: MonadIO m => m Color
- colorCopy :: (HasCallStack, MonadIO m) => Color -> m Color
- colorEqual :: (HasCallStack, MonadIO m) => Ptr () -> Ptr () -> m Int32
- colorFree :: (HasCallStack, MonadIO m) => Color -> m ()
- colorGetAlpha :: (HasCallStack, MonadIO m) => Color -> m Float
- colorGetAlphaByte :: (HasCallStack, MonadIO m) => Color -> m Word8
- colorGetAlphaFloat :: (HasCallStack, MonadIO m) => Color -> m Float
- colorGetBlue :: (HasCallStack, MonadIO m) => Color -> m Float
- colorGetBlueByte :: (HasCallStack, MonadIO m) => Color -> m Word8
- colorGetBlueFloat :: (HasCallStack, MonadIO m) => Color -> m Float
- colorGetGreen :: (HasCallStack, MonadIO m) => Color -> m Float
- colorGetGreenByte :: (HasCallStack, MonadIO m) => Color -> m Word8
- colorGetGreenFloat :: (HasCallStack, MonadIO m) => Color -> m Float
- colorGetRed :: (HasCallStack, MonadIO m) => Color -> m Float
- colorGetRedByte :: (HasCallStack, MonadIO m) => Color -> m Word8
- colorGetRedFloat :: (HasCallStack, MonadIO m) => Color -> m Float
- colorInitFrom4f :: (HasCallStack, MonadIO m) => Color -> Float -> Float -> Float -> Float -> m ()
- colorInitFrom4fv :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorInitFrom4ub :: (HasCallStack, MonadIO m) => Color -> Word8 -> Word8 -> Word8 -> Word8 -> m ()
- colorInitFromHsl :: (HasCallStack, MonadIO m) => Float -> Float -> Float -> m Color
- colorNew :: (HasCallStack, MonadIO m) => m Color
- colorPremultiply :: (HasCallStack, MonadIO m) => Color -> m ()
- colorSetAlpha :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorSetAlphaByte :: (HasCallStack, MonadIO m) => Color -> Word8 -> m ()
- colorSetAlphaFloat :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorSetBlue :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorSetBlueByte :: (HasCallStack, MonadIO m) => Color -> Word8 -> m ()
- colorSetBlueFloat :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorSetFrom4f :: (HasCallStack, MonadIO m) => Color -> Float -> Float -> Float -> Float -> m ()
- colorSetFrom4ub :: (HasCallStack, MonadIO m) => Color -> Word8 -> Word8 -> Word8 -> Word8 -> m ()
- colorSetGreen :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorSetGreenByte :: (HasCallStack, MonadIO m) => Color -> Word8 -> m ()
- colorSetGreenFloat :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorSetRed :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorSetRedByte :: (HasCallStack, MonadIO m) => Color -> Word8 -> m ()
- colorSetRedFloat :: (HasCallStack, MonadIO m) => Color -> Float -> m ()
- colorToHsl :: (HasCallStack, MonadIO m) => Color -> m (Float, Float, Float)
- colorUnpremultiply :: (HasCallStack, MonadIO m) => Color -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Color Source # | |
GBoxed Color Source # | |
Defined in GI.Cogl.Structs.Color | |
ManagedPtrNewtype Color Source # | |
Defined in GI.Cogl.Structs.Color Methods toManagedPtr :: Color -> ManagedPtr Color | |
TypedObject Color Source # | |
Defined in GI.Cogl.Structs.Color | |
HasParentTypes Color Source # | |
Defined in GI.Cogl.Structs.Color | |
tag ~ 'AttrSet => Constructible Color tag Source # | |
IsGValue (Maybe Color) Source # | Convert |
Defined in GI.Cogl.Structs.Color Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Color -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Color) | |
type ParentTypes Color Source # | |
Defined in GI.Cogl.Structs.Color |
Methods
Click to display all available methods, including inherited ones
Methods
copy, free, initFrom4f, initFrom4fv, initFrom4ub, premultiply, toHsl, unpremultiply.
Getters
getAlpha, getAlphaByte, getAlphaFloat, getBlue, getBlueByte, getBlueFloat, getGreen, getGreenByte, getGreenFloat, getRed, getRedByte, getRedFloat.
Setters
setAlpha, setAlphaByte, setAlphaFloat, setBlue, setBlueByte, setBlueFloat, setFrom4f, setFrom4ub, setGreen, setGreenByte, setGreenFloat, setRed, setRedByte, setRedFloat.
copy
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Color | Returns: a newly-allocated |
Creates a copy of color
Since: 1.0
equal
free
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m () |
getAlpha
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Float | Returns: the alpha channel of the passed color |
Retrieves the alpha channel of color
as a fixed point
value between 0 and 1.0.
Since: 1.0
getAlphaByte
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Word8 | Returns: the alpha channel of the passed color |
Retrieves the alpha channel of color
as a byte value
between 0 and 255
Since: 1.0
getAlphaFloat
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Float | Returns: the alpha channel of the passed color |
Retrieves the alpha channel of color
as a floating point
value between 0.0 and 1.0
Since: 1.0
getBlue
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Float | Returns: the blue channel of the passed color |
Retrieves the blue channel of color
as a fixed point
value between 0 and 1.0.
Since: 1.0
getBlueByte
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Word8 | Returns: the blue channel of the passed color |
Retrieves the blue channel of color
as a byte value
between 0 and 255
Since: 1.0
getBlueFloat
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Float | Returns: the blue channel of the passed color |
Retrieves the blue channel of color
as a floating point
value between 0.0 and 1.0
Since: 1.0
getGreen
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Float | Returns: the green channel of the passed color |
Retrieves the green channel of color
as a fixed point
value between 0 and 1.0.
Since: 1.0
getGreenByte
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Word8 | Returns: the green channel of the passed color |
Retrieves the green channel of color
as a byte value
between 0 and 255
Since: 1.0
getGreenFloat
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Float | Returns: the green channel of the passed color |
Retrieves the green channel of color
as a floating point
value between 0.0 and 1.0
Since: 1.0
getRed
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Float | Returns: the red channel of the passed color |
Retrieves the red channel of color
as a fixed point
value between 0 and 1.0.
Since: 1.0
getRedByte
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Word8 | Returns: the red channel of the passed color |
Retrieves the red channel of color
as a byte value
between 0 and 255
Since: 1.0
getRedFloat
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m Float | Returns: the red channel of the passed color |
Retrieves the red channel of color
as a floating point
value between 0.0 and 1.0
Since: 1.0
initFrom4f
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> Float |
|
-> Float |
|
-> Float |
|
-> m () |
Sets the values of the passed channels into a Color
Since: 1.4
initFrom4fv
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the values of the passed channels into a Color
Since: 1.4
initFrom4ub
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Word8 |
|
-> Word8 |
|
-> Word8 |
|
-> Word8 |
|
-> m () |
Sets the values of the passed channels into a Color
.
Since: 1.4
initFromHsl
Arguments
:: (HasCallStack, MonadIO m) | |
=> Float |
|
-> Float |
|
-> Float |
|
-> m Color |
Converts a color expressed in HLS (hue, luminance and saturation)
values into a Color
.
Since: 1.16
new
Arguments
:: (HasCallStack, MonadIO m) | |
=> m Color | Returns: a newly-allocated |
Creates a new (empty) color
Since: 1.0
premultiply
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m () |
Converts a non-premultiplied color to a pre-multiplied color. For example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied and (0.5, 0, 0, 0.5) when premultiplied.
Since: 1.0
setAlpha
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the alpha channel of color
to alpha
.
Since: 1.4
setAlphaByte
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Word8 |
|
-> m () |
Sets the alpha channel of color
to alpha
.
Since: 1.4
setAlphaFloat
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the alpha channel of color
to alpha
.
Since: 1.4
setBlue
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the blue channel of color
to blue
.
Since: 1.4
setBlueByte
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Word8 |
|
-> m () |
Sets the blue channel of color
to blue
.
Since: 1.4
setBlueFloat
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the blue channel of color
to blue
.
Since: 1.4
setFrom4f
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> Float |
|
-> Float |
|
-> Float |
|
-> m () |
Deprecated: (Since version 1.4)Use cogl_color_init_from_4f instead.
Sets the values of the passed channels into a Color
Since: 1.0
setFrom4ub
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Word8 |
|
-> Word8 |
|
-> Word8 |
|
-> Word8 |
|
-> m () |
Deprecated: (Since version 1.4)Use cogl_color_init_from_4ub instead.
Sets the values of the passed channels into a Color
.
Since: 1.0
setGreen
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the green channel of color
to green
.
Since: 1.4
setGreenByte
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Word8 |
|
-> m () |
Sets the green channel of color
to green
.
Since: 1.4
setGreenFloat
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the green channel of color
to green
.
Since: 1.4
setRed
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the red channel of color
to red
.
Since: 1.4
setRedByte
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Word8 |
|
-> m () |
Sets the red channel of color
to red
.
Since: 1.4
setRedFloat
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> Float |
|
-> m () |
Sets the red channel of color
to red
.
Since: 1.4
toHsl
Converts color
to the HLS format.
The hue
value is in the 0 .. 360 range. The luminance
and
saturation
values are in the 0 .. 1 range.
Since: 1.16
unpremultiply
Arguments
:: (HasCallStack, MonadIO m) | |
=> Color |
|
-> m () |
Converts a pre-multiplied color to a non-premultiplied color. For example, semi-transparent red is (0.5, 0, 0, 0.5) when premultiplied and (1.0, 0, 0, 0.5) when non-premultiplied.
Since: 1.4