Struct ColorState

pub struct ColorState { /* private fields */ }

Available on crate feature v4_16 only.

A ColorState object provides the information to interpret colors and pixels in a variety of ways.

They are also known as color spaces.

Crucially, GTK knows how to convert colors from one color state to another.

ColorState objects are immutable and therefore threadsafe.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl ColorState

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

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GdkColorState) -> &Self

Borrows the underlying C value.

impl ColorState

pub fn create_cicp_params(&self) -> Option<CicpParams>

Create a CicpParams representing the colorstate.

It is not guaranteed that every ColorState can be represented with Cicp parameters. If that is the case, this function returns NULL.

Returns

A new CicpParams

pub fn oklab() -> ColorState

Available on crate feature v4_18 only.

Returns the color state object representing the oklab color space.

This is a perceptually uniform color state.

Returns

the color state object for oklab

pub fn oklch() -> ColorState

Available on crate feature v4_18 only.

Returns the color state object representing the oklch color space.

This is the polar variant of oklab, in which the hue is encoded as a polar coordinate.

Returns

the color state object for oklch

pub fn rec2100_linear() -> ColorState

Returns the color state object representing the linear rec2100 color space.

This color state uses the primaries defined by BT.2020-2 and BT.2100-0 and a linear transfer function.

It is equivalent to the Cicp tuple 9/8/0/1.

See e.g. the CSS HDR Module for details about this colorstate.

Returns

the color state object for linearized rec2100

pub fn rec2100_pq() -> ColorState

Returns the color state object representing the rec2100-pq color space.

This color state uses the primaries defined by BT.2020-2 and BT.2100-0 and the transfer function defined by SMPTE ST 2084 and BT.2100-2.

It is equivalent to the Cicp tuple 9/16/0/1.

See e.g. the CSS HDR Module for details about this colorstate.

Returns

the color state object for rec2100-pq

pub fn srgb() -> ColorState

Returns the color state object representing the sRGB color space.

This color state uses the primaries defined by BT.709-6 and the transfer function defined by IEC 61966-2-1.

It is equivalent to the Cicp tuple 1/13/0/1.

See e.g. the CSS Color Module for details about this colorstate.

Returns

the color state object for sRGB

pub fn srgb_linear() -> ColorState

Returns the color state object representing the linearized sRGB color space.

This color state uses the primaries defined by BT.709-6 and a linear transfer function.

It is equivalent to the Cicp tuple 1/8/0/1.

See e.g. the CSS Color Module for details about this colorstate.

Returns

the color state object for linearized sRGB

Trait Implementations

impl Clone for ColorState

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for ColorState

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

Formats the value using the given formatter.

impl From<ColorState> for Value

fn from(s: ColorState) -> Self

Converts to this type from the input type.

impl HasParamSpec for ColorState

type ParamSpec = ParamSpecBoxed

type SetValue = ColorState

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ColorState

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

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 Ord for ColorState

fn cmp(&self, other: &ColorState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ColorState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ColorState

fn partial_cmp(&self, other: &ColorState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ColorState

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ColorState