Struct cogl::Color

pub struct Color(_);

Implementations

impl Color

pub fn new() -> Color

Creates a new (empty) color

Returns

a newly-allocated Color. Use Color::free to free the allocated resources

pub fn get_alpha(&self) -> f32

Retrieves the alpha channel of self as a fixed point value between 0 and 1.0.

Returns

the alpha channel of the passed color

pub fn get_alpha_byte(&self) -> u8

Retrieves the alpha channel of self as a byte value between 0 and 255

Returns

the alpha channel of the passed color

pub fn get_alpha_float(&self) -> f32

Retrieves the alpha channel of self as a floating point value between 0.0 and 1.0

Returns

the alpha channel of the passed color

pub fn get_blue(&self) -> f32

Retrieves the blue channel of self as a fixed point value between 0 and 1.0.

Returns

the blue channel of the passed color

pub fn get_blue_byte(&self) -> u8

Retrieves the blue channel of self as a byte value between 0 and 255

Returns

the blue channel of the passed color

pub fn get_blue_float(&self) -> f32

Retrieves the blue channel of self as a floating point value between 0.0 and 1.0

Returns

the blue channel of the passed color

pub fn get_green(&self) -> f32

Retrieves the green channel of self as a fixed point value between 0 and 1.0.

Returns

the green channel of the passed color

pub fn get_green_byte(&self) -> u8

Retrieves the green channel of self as a byte value between 0 and 255

Returns

the green channel of the passed color

pub fn get_green_float(&self) -> f32

Retrieves the green channel of self as a floating point value between 0.0 and 1.0

Returns

the green channel of the passed color

pub fn get_red(&self) -> f32

Retrieves the red channel of self as a fixed point value between 0 and 1.0.

Returns

the red channel of the passed color

pub fn get_red_byte(&self) -> u8

Retrieves the red channel of self as a byte value between 0 and 255

Returns

the red channel of the passed color

pub fn get_red_float(&self) -> f32

Retrieves the red channel of self as a floating point value between 0.0 and 1.0

Returns

the red channel of the passed color

pub fn init_from_4f(&mut self, red: f32, green: f32, blue: f32, alpha: f32)

Sets the values of the passed channels into a Color

red

value of the red channel, between 0 and 1.0

green

value of the green channel, between 0 and 1.0

blue

value of the blue channel, between 0 and 1.0

alpha

value of the alpha channel, between 0 and 1.0

pub fn init_from_4ub(&mut self, red: u8, green: u8, blue: u8, alpha: u8)

Sets the values of the passed channels into a Color.

red

value of the red channel, between 0 and 255

green

value of the green channel, between 0 and 255

blue

value of the blue channel, between 0 and 255

alpha

value of the alpha channel, between 0 and 255

pub fn premultiply(&mut self)

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.

pub fn set_alpha(&mut self, alpha: f32)

Sets the alpha channel of self to alpha.

alpha

a float value between 0.0f and 1.0f

pub fn set_alpha_byte(&mut self, alpha: u8)

Sets the alpha channel of self to alpha.

alpha

a byte value between 0 and 255

pub fn set_alpha_float(&mut self, alpha: f32)

Sets the alpha channel of self to alpha.

alpha

a float value between 0.0f and 1.0f

pub fn set_blue(&mut self, blue: f32)

Sets the blue channel of self to blue.

blue

a float value between 0.0f and 1.0f

pub fn set_blue_byte(&mut self, blue: u8)

Sets the blue channel of self to blue.

blue

a byte value between 0 and 255

pub fn set_blue_float(&mut self, blue: f32)

Sets the blue channel of self to blue.

blue

a float value between 0.0f and 1.0f

pub fn set_green(&mut self, green: f32)

Sets the green channel of self to green.

green

a float value between 0.0f and 1.0f

pub fn set_green_byte(&mut self, green: u8)

Sets the green channel of self to green.

green

a byte value between 0 and 255

pub fn set_green_float(&mut self, green: f32)

Sets the green channel of self to green.

green

a float value between 0.0f and 1.0f

pub fn set_red(&mut self, red: f32)

Sets the red channel of self to red.

red

a float value between 0.0f and 1.0f

pub fn set_red_byte(&mut self, red: u8)

Sets the red channel of self to red.

red

a byte value between 0 and 255

pub fn set_red_float(&mut self, red: f32)

Sets the red channel of self to red.

red

a float value between 0.0f and 1.0f

pub fn to_hsl(&self) -> (f32, f32, f32)

Converts self to the HLS format.

The hue value is in the 0 .. 360 range. The luminance and saturation values are in the 0 .. 1 range.

hue

return location for the hue value or None

saturation

return location for the saturation value or None

luminance

return location for the luminance value or None

pub fn unpremultiply(&mut self)

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.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Color

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Color

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Color

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl StaticType for Color

fn static_type() -> Type

Returns the type identifier of Self.