Struct ComponentTransfer 

pub struct ComponentTransfer { /* private fields */ }

Available on crate feature v4_20 only.

Specifies a transfer function for a color component to be applied while rendering.

The available functions include linear, piecewise-linear, gamma and step functions.

Note that the transfer function is applied to un-premultiplied values, and all results are clamped to the [0, 1] range.

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl ComponentTransfer

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut( ptr: &mut *mut GskComponentTransfer, ) -> &mut Self

Borrows the underlying C value mutably.

impl ComponentTransfer

pub fn new_discrete(values: &[f32]) -> ComponentTransfer

Creates a new component transfer that applies a step function.

The new value is computed as

C' = values[k]

where k is the smallest value such that

k / n <= C < (k + 1) / n

values

Values

Returns

a new ComponentTransfer

pub fn new_gamma(amp: f32, exp: f32, ofs: f32) -> ComponentTransfer

Creates a new component transfer that applies a gamma transform.

The new value is computed as

C' = amp * pow (C, exp) + ofs

amp

Amplitude

exp

Exponent

ofs

Offset

Returns

a new ComponentTransfer

pub fn new_identity() -> ComponentTransfer

Creates a new component transfer that doesn’t change the component value.

Returns

a new ComponentTransfer

pub fn new_levels(n: f32) -> ComponentTransfer

Creates a new component transfer that limits the values of the component to n levels.

The new value is computed as

C' = floor (C * n) / n

n

Number of levels

Returns

a new ComponentTransfer

pub fn new_linear(m: f32, b: f32) -> ComponentTransfer

Creates a new component transfer that applies a linear transform.

The new value is computed as

C' = C * m + b

m

Slope

b

Offset

Returns

a new ComponentTransfer

pub fn new_table(values: &[f32]) -> ComponentTransfer

Creates a new component transfer that applies a piecewise linear function.

The new value is computed as

C' = values[k] + (C - k / n) * n * (values[k + 1] - values[k])

where k is the smallest value such that

k / n <= C < (k + 1) / n

values

Values

Returns

a new ComponentTransfer

Trait Implementations

impl Clone for ComponentTransfer

fn clone(&self) -> Self

Copies the boxed type with the type-specific copy function.

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

Performs copy-assignment from source.

impl Debug for ComponentTransfer

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

Formats the value using the given formatter.

impl From<ComponentTransfer> for Value

fn from(o: ComponentTransfer) -> Self

Converts to this type from the input type.

impl HasParamSpec for ComponentTransfer

type ParamSpec = ParamSpecBoxed

type SetValue = ComponentTransfer

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ComponentTransfer

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 ComponentTransfer

fn cmp(&self, other: &ComponentTransfer) -> 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 ComponentTransfer

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 ComponentTransfer

fn partial_cmp(&self, other: &ComponentTransfer) -> 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 ComponentTransfer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ComponentTransfer