Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gdk.Structs.RGBA

Contents

Exported types
Methods
Properties
- alpha
- blue
- green
- red

Description

A RGBA is used to represent a (possibly translucent) color, in a way that is compatible with cairos notion of color.

Synopsis

Exported types

newtype RGBA Source #

Constructors

RGBA (ManagedPtr RGBA)

Instances

BoxedObject RGBA Source #
Methods boxedType :: RGBA -> IO GType #
(~) AttrOpTag tag AttrSet => Constructible RGBA tag Source #
Methods new :: MonadIO m => (ManagedPtr RGBA -> RGBA) -> [AttrOp RGBA tag] -> m RGBA #
((~) * info (ResolveRGBAMethod t RGBA), MethodInfo * info RGBA p) => IsLabel t (RGBA -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> RGBA -> p #
((~) * info (ResolveRGBAMethod t RGBA), MethodInfo * info RGBA p) => IsLabelProxy t (RGBA -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> RGBA -> p #
HasAttributeList * RGBA Source #

((~) * signature (m Text), MonadIO m) => MethodInfo * RGBAToStringMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAToStringMethodInfo RGBA -> signature -> s #
((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * RGBAParseMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAParseMethodInfo RGBA -> signature -> s #
((~) * signature (m Word32), MonadIO m) => MethodInfo * RGBAHashMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAHashMethodInfo RGBA -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * RGBAFreeMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAFreeMethodInfo RGBA -> signature -> s #
((~) * signature (RGBA -> m Bool), MonadIO m) => MethodInfo * RGBAEqualMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAEqualMethodInfo RGBA -> signature -> s #
((~) * signature (m RGBA), MonadIO m) => MethodInfo * RGBACopyMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBACopyMethodInfo RGBA -> signature -> s #
type AttributeList RGBA Source #
type AttributeList RGBA

newZeroRGBA :: MonadIO m => m RGBA Source #

Construct a RGBA struct initialized to zero.

noRGBA :: Maybe RGBA Source #

Methods

copy

data RGBACopyMethodInfo Source #

Instances

((~) * signature (m RGBA), MonadIO m) => MethodInfo * RGBACopyMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBACopyMethodInfo RGBA -> signature -> s #

rGBACopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RGBA	`rgba`: a `RGBA`
-> m RGBA	Returns: A newly allocated `RGBA`, with the same contents as `rgba`

Makes a copy of a RGBA.

The result must be freed through rGBAFree.

Since: 3.0

equal

data RGBAEqualMethodInfo Source #

Instances

((~) * signature (RGBA -> m Bool), MonadIO m) => MethodInfo * RGBAEqualMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAEqualMethodInfo RGBA -> signature -> s #

rGBAEqual Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RGBA	`p1`: a `RGBA` pointer
-> RGBA	`p2`: another `RGBA` pointer
-> m Bool	Returns: `True` if the two colors compare equal

Compares two RGBA colors.

Since: 3.0

free

data RGBAFreeMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * RGBAFreeMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAFreeMethodInfo RGBA -> signature -> s #

rGBAFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RGBA	`rgba`: a `RGBA`
-> m ()

Frees a RGBA created with rGBACopy

Since: 3.0

hash

data RGBAHashMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * RGBAHashMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAHashMethodInfo RGBA -> signature -> s #

rGBAHash Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RGBA	`p`: a `RGBA` pointer
-> m Word32	Returns: The hash value for `p`

A hash function suitable for using for a hash table that stores GdkRGBAs.

Since: 3.0

parse

data RGBAParseMethodInfo Source #

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * RGBAParseMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAParseMethodInfo RGBA -> signature -> s #

rGBAParse Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RGBA	`rgba`: the `RGBA` to fill in
-> Text	`spec`: the string specifying the color
-> m Bool	Returns: `True` if the parsing succeeded

Parses a textual representation of a color, filling in the red, green, blue and alpha fields of the rgba RGBA.

The string can be either one of:

A standard name (Taken from the X11 rgb.txt file).
A hexadecimal value in the form “rrggbb”, “rrrrggggbbbb”
A RGB color in the form “rgb(r,g,b)” (In this case the color will have full opacity)
A RGBA color in the form “rgba(r,g,b,a)”

Where “r”, “g”, “b” and “a” are respectively the red, green, blue and alpha color values. In the last two cases, r g and b are either integers in the range 0 to 255 or precentage values in the range 0% to 100%, and a is a floating point value in the range 0 to 1.

Since: 3.0

toString

data RGBAToStringMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * RGBAToStringMethodInfo RGBA signature Source #
Methods overloadedMethod :: MethodProxy RGBAToStringMethodInfo RGBA -> signature -> s #

rGBAToString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RGBA	`rgba`: a `RGBA`
-> m Text	Returns: A newly allocated text string

Returns a textual specification of rgba in the form rgb (r, g, b) or rgba (r, g, b, a), where “r”, “g”, “b” and “a” represent the red, green, blue and alpha values respectively. r, g, and b are represented as integers in the range 0 to 255, and a is represented as floating point value in the range 0 to 1.

These string forms are string forms those supported by the CSS3 colors module, and can be parsed by rGBAParse.

Note that this string representation may lose some precision, since r, g and b are represented as 8-bit integers. If this is a concern, you should use a different representation.

Since: 3.0