Struct gdk4::RGBA

#[repr(transparent)]
pub struct RGBA { /* private fields */ }

A RGBA is used to represent a color, in a way that is compatible with cairo’s notion of color.

RGBA is a convenient way to pass colors around. It’s based on cairo’s way to deal with colors and mirrors its behavior. All values are in the range from 0.0 to 1.0 inclusive. So the color (0.0, 0.0, 0.0, 0.0) represents transparent black and (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will be clamped to this range when drawing.

Implementations

impl RGBA

pub fn as_ptr(&self) -> *mut GdkRGBA

pub unsafe fn from_glib_ptr_borrow<'a>(ptr: *const GdkRGBA) -> &'a Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut<'a>(ptr: *mut GdkRGBA) -> &'a mut Self

Borrows the underlying C value mutably.

impl RGBA

pub fn is_clear(&self) -> bool

Checks if an @self value is transparent.

That is, drawing with the value would not produce any change.

Returns

true if the @self is clear

pub fn is_opaque(&self) -> bool

Checks if an @self value is opaque.

That is, drawing with the value will not retain any results from previous contents.

Returns

true if the @self is opaque

pub fn to_str(&self) -> GString

Returns a textual specification of @self 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 a floating point value in the range 0 to 1.

These string forms are string forms that are supported by the CSS3 colors module, and can be parsed by parse().

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.

Returns

A newly allocated text string

impl RGBA

pub const fn new(red: f32, green: f32, blue: f32, alpha: f32) -> Self

pub const fn with_red(self, red: f32) -> Self

Creates an owned RGBA like self but with the given red value.

Example

let rgba = RGBA::new(1.0, 1.0, 1.0, 1.0);
assert_eq!(rgba.with_red(0.5), RGBA::new(0.5, 1.0, 1.0, 1.0));

pub const fn with_green(self, green: f32) -> Self

Creates an owned RGBA like self but with the given green value.

Example

let rgba = RGBA::new(1.0, 1.0, 1.0, 1.0);
assert_eq!(rgba.with_green(0.5), RGBA::new(1.0, 0.5, 1.0, 1.0));

pub const fn with_blue(self, blue: f32) -> Self

Creates an owned RGBA like self but with the given blue value.

Example

let rgba = RGBA::new(1.0, 1.0, 1.0, 1.0);
assert_eq!(rgba.with_blue(0.5), RGBA::new(1.0, 1.0, 0.5, 1.0));

pub const fn with_alpha(self, alpha: f32) -> Self

Creates an owned RGBA like self but with the given alpha value.

Example

let rgba = RGBA::new(1.0, 1.0, 1.0, 1.0);
assert_eq!(rgba.with_alpha(0.5), RGBA::new(1.0, 1.0, 1.0, 0.5));

pub fn builder() -> RGBABuilder

Creates a new builder-pattern struct instance to construct RGBA objects.

This method returns an instance of RGBABuilder which can be used to create RGBA objects.

pub fn red(&self) -> f32

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

pub fn green(&self) -> f32

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

pub fn blue(&self) -> f32

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

pub fn alpha(&self) -> f32

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

pub fn parse(s: impl IntoGStr) -> Result<RGBA, BoolError>

Parses a textual representation of a color.

The string can be either one of:

• A standard name (Taken from the CSS specification).
• A hexadecimal value in the form “#rgb”, “#rrggbb”, “#rrrgggbbb” or ”#rrrrggggbbbb”
• A hexadecimal value in the form “#rgba”, “#rrggbbaa”, or ”#rrrrggggbbbbaaaa”
• 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)”
• A HSL color in the form “hsl(hue, saturation, lightness)”
• A HSLA color in the form “hsla(hue, saturation, lightness, alpha)”

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 percentage values in the range 0% to 100%, and a is a floating point value in the range 0 to 1.

spec

the string specifying the color

Returns

true if the parsing succeeded

pub const BLACK: RGBA = _

pub const BLUE: RGBA = _

pub const GREEN: RGBA = _

pub const RED: RGBA = _

pub const WHITE: RGBA = _

pub const TRANSPARENT: RGBA = _

Trait Implementations

impl Clone for RGBA

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RGBA

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

Formats the value using the given formatter.

impl Display for RGBA

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

Formats the value using the given formatter.

impl FromStr for RGBA

type Err = BoolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl HasParamSpec for RGBA

type ParamSpec = ParamSpecBoxed

type SetValue = RGBA

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, RGBA>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for RGBA

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<RGBA> for RGBA

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StaticType for RGBA

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for RGBA

impl Eq for RGBA