Struct CicpParams

pub struct CicpParams { /* private fields */ }

Available on crate feature v4_16 only.

The CicpParams struct contains the parameters that define a colorstate according to the ITU-T H.273 specification.

See the documentation of individual properties for supported values.

The ‘unspecified’ value (2) is not treated in any special way, and must be replaced by a different value before creating a color state.

CicpParams can be used as a builder object to construct a color state from Cicp data with build_color_state(). The function will return an error if the given parameters are not supported.

You can obtain a CicpParams object from a color state with ColorState::create_cicp_params(). This can be used to create a variant of a color state, by changing just one of the cicp parameters, or just to obtain information about the color state.

Properties

color-primaries

The color primaries to use.

Supported values:

• 1: BT.709 / sRGB
• 2: unspecified
• 5: PAL
• 6,7: BT.601 / NTSC
• 9: BT.2020
• 12: Display P3

Readable | Writeable

matrix-coefficients

The matrix coefficients (for YUV to RGB conversion).

Supported values:

• 0: RGB
• 2: unspecified

Readable | Writeable

range

Whether the data is using the full range of values.

The range of the data.

Readable | Writeable

transfer-function

The transfer function to use.

Supported values:

• 1,6,14,15: BT.709, BT.601, BT.2020
• 2: unspecified
• 4: gamma 2.2
• 5: gamma 2.8
• 8: linear
• 13: sRGB
• 16: BT.2100 PQ
• 18: BT.2100 HLG

Readable | Writeable

GLib type: GObject with reference counted clone semantics.

Implementations

impl CicpParams

pub fn new() -> CicpParams

Creates a new CicpParams object.

The initial values of the properties are the values for “undefined” and need to be set before a color state object can be built.

Returns

a new CicpParams

pub fn build_color_state(&self) -> Result<Option<ColorState>, Error>

Creates a new ColorState object for the cicp parameters in @self.

Note that this may fail if the cicp parameters in @self are not supported by GTK. In that case, NULL is returned, and @error is set with an error message that can be presented to the user.

Returns

A newly allocated ColorState

pub fn color_primaries(&self) -> u32

Returns the value of the color-primaries property of @self.

Returns

the color-primaries value

pub fn matrix_coefficients(&self) -> u32

Gets the matrix-coefficients property of @self.

Returns

the matrix-coefficients value

pub fn range(&self) -> CicpRange

Gets the range property of @self.

Returns

the range value

pub fn transfer_function(&self) -> u32

Gets the transfer-function property of @self.

Returns

the transfer-function value

pub fn set_color_primaries(&self, color_primaries: u32)

Sets the color-primaries property of @self.

color_primaries

the new color primaries value

pub fn set_matrix_coefficients(&self, matrix_coefficients: u32)

@self a CicpParams Sets the matrix-coefficients property of @self.

matrix_coefficients

the new matrix-coefficients value

pub fn set_range(&self, range: CicpRange)

Sets the range property of @self

range

the range value

pub fn set_transfer_function(&self, transfer_function: u32)

Sets the transfer-function property of @self.

transfer_function

the new transfer-function value

pub fn connect_color_primaries_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_matrix_coefficients_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_range_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_transfer_function_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for CicpParams

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl Debug for CicpParams

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

Formats the value using the given formatter.

impl Default for CicpParams

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for CicpParams

type ParamSpec = ParamSpecObject

type SetValue = CicpParams

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

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, CicpParams>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for CicpParams

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

where H: Hasher,

Hashes the memory address of this object.

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 CicpParams

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 ParentClassIs for CicpParams

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for CicpParams

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for CicpParams

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 CicpParams

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for CicpParams