gtkmm: Gdk::CicpParams Class Reference

Gdk::CicpParams contains the parameters that define a colorstate according to the ITU-T H.273 specification. More...

#include <gdkmm/cicpparams.h>

Inheritance diagram for Gdk::CicpParams:

Public Types
enum class	Range { Range::NARROW , Range::FULL }
	The values of this enumeration describe whether image data uses the full range of 8-bit values. More...

Public Member Functions
	CicpParams (CicpParams && src) noexcept

CicpParams &	operator= (CicpParams && src) noexcept

	~CicpParams () noexcept override

GdkCicpParams *	gobj ()
	Provides access to the underlying C GObject.

const GdkCicpParams *	gobj () const
	Provides access to the underlying C GObject.

GdkCicpParams *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

guint	get_color_primaries () const
	Returns the value of the color-primaries property of self.

void	set_color_primaries (guint color_primaries)
	Sets the color-primaries property of self.

guint	get_transfer_function () const
	Gets the transfer-function property of self.

void	set_transfer_function (guint transfer_function)
	Sets the transfer-function property of self.

guint	get_matrix_coefficients () const
	Gets the matrix-coefficients property of self.

void	set_matrix_coefficients (guint matrix_coefficients)
	Sets the matrix-coefficients property of self.

Range	get_range () const
	Gets the range property of self.

void	set_range (Range range)
	Sets the range property of self.

Glib::RefPtr< ColorState >	build_color_state () const
	Creates a new `Gdk::ColorState` object for the cicp parameters in self.

Glib::PropertyProxy< guint >	property_color_primaries ()
	The color primaries to use.

Glib::PropertyProxy_ReadOnly< guint >	property_color_primaries () const
	The color primaries to use.

Glib::PropertyProxy< guint >	property_transfer_function ()
	The transfer function to use.

Glib::PropertyProxy_ReadOnly< guint >	property_transfer_function () const
	The transfer function to use.

Glib::PropertyProxy< guint >	property_matrix_coefficients ()
	The matrix coefficients (for YUV to RGB conversion).

Glib::PropertyProxy_ReadOnly< guint >	property_matrix_coefficients () const
	The matrix coefficients (for YUV to RGB conversion).

Glib::PropertyProxy< Range >	property_range ()
	Whether the data is using the full range of values.

Glib::PropertyProxy_ReadOnly< Range >	property_range () const
	Whether the data is using the full range of values.

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< CicpParams >	create ()
	Creates a new `Gdk::CicpParams` object.

Protected Member Functions
	CicpParams ()

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gdk::CicpParams >	wrap (GdkCicpParams * object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

Gdk::CicpParams 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.

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

You can obtain a Gdk::CicpParams object from a color state with Gdk::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.

Since gtkmm 4.16:

Constructor & Destructor Documentation

◆ CicpParams() [1/2]

Gdk::CicpParams::CicpParams ( CicpParams && src )

noexcept

◆ ~CicpParams()

Gdk::CicpParams::~CicpParams ( )

overridenoexcept

◆ CicpParams() [2/2]

Gdk::CicpParams::CicpParams ( )

protected

Member Function Documentation

◆ build_color_state()

Glib::RefPtr< ColorState > Gdk::CicpParams::build_color_state ( ) const

Creates a new Gdk::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, nullptr is returned, and error is set with an error message that can be presented to the user.

Since gtkmm 4.16:

Returns: A newly allocated Gdk::ColorState.

Exceptions

Gio::Error

◆ create()

static Glib::RefPtr< CicpParams > Gdk::CicpParams::create ( )

static

Creates a new Gdk::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.

Since gtkmm 4.16:

Returns: A new Gdk::CicpParams.

◆ get_color_primaries()

guint Gdk::CicpParams::get_color_primaries ( ) const

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

Since gtkmm 4.16:

Returns: The color-primaries value.

◆ get_matrix_coefficients()

guint Gdk::CicpParams::get_matrix_coefficients ( ) const

Gets the matrix-coefficients property of self.

Since gtkmm 4.16:

Returns: The matrix-coefficients value.

◆ get_range()

Range Gdk::CicpParams::get_range ( ) const

Gets the range property of self.

Since gtkmm 4.16:

Returns: The range value.

◆ get_transfer_function()

guint Gdk::CicpParams::get_transfer_function ( ) const

Gets the transfer-function property of self.

Since gtkmm 4.16:

Returns: The transfer-function value.

◆ get_type()

static GType Gdk::CicpParams::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GdkCicpParams * Gdk::CicpParams::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GdkCicpParams * Gdk::CicpParams::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GdkCicpParams * Gdk::CicpParams::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

CicpParams & Gdk::CicpParams::operator= ( CicpParams && src )

noexcept

◆ property_color_primaries() [1/2]

Glib::PropertyProxy< guint > Gdk::CicpParams::property_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

Since gtkmm 4.16:

Default value: 2

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_color_primaries() [2/2]

Glib::PropertyProxy_ReadOnly< guint > Gdk::CicpParams::property_color_primaries ( ) const

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

Since gtkmm 4.16:

Default value: 2

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_matrix_coefficients() [1/2]

Glib::PropertyProxy< guint > Gdk::CicpParams::property_matrix_coefficients ( )

The matrix coefficients (for YUV to RGB conversion).

Supported values:

0: RGB
2: unspecified

Since gtkmm 4.16:

Default value: 2

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_matrix_coefficients() [2/2]

Glib::PropertyProxy_ReadOnly< guint > Gdk::CicpParams::property_matrix_coefficients ( ) const

The matrix coefficients (for YUV to RGB conversion).

Supported values:

0: RGB
2: unspecified

Since gtkmm 4.16:

Default value: 2

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_range() [1/2]

Glib::PropertyProxy< Range > Gdk::CicpParams::property_range ( )

Whether the data is using the full range of values.

The range of the data.

Since gtkmm 4.16:

Default value: Gdk::CicpParams::Range::NARROW

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_range() [2/2]

Glib::PropertyProxy_ReadOnly< Range > Gdk::CicpParams::property_range ( ) const

Whether the data is using the full range of values.

The range of the data.

Since gtkmm 4.16:

Default value: Gdk::CicpParams::Range::NARROW

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_transfer_function() [1/2]

Glib::PropertyProxy< guint > Gdk::CicpParams::property_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

Since gtkmm 4.16:

Default value: 2

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_transfer_function() [2/2]

Glib::PropertyProxy_ReadOnly< guint > Gdk::CicpParams::property_transfer_function ( ) const

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

Since gtkmm 4.16:

Default value: 2

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ set_color_primaries()

void Gdk::CicpParams::set_color_primaries ( guint color_primaries )

Sets the color-primaries property of self.

Since gtkmm 4.16:

Parameters

color_primaries The new color primaries value.

◆ set_matrix_coefficients()

void Gdk::CicpParams::set_matrix_coefficients ( guint matrix_coefficients )

Sets the matrix-coefficients property of self.

Since gtkmm 4.16:

Parameters

matrix_coefficients The new matrix-coefficients value.

◆ set_range()

void Gdk::CicpParams::set_range ( Range range )

Sets the range property of self.

Since gtkmm 4.16:

Parameters

range The range value.

◆ set_transfer_function()

void Gdk::CicpParams::set_transfer_function ( guint transfer_function )

Sets the transfer-function property of self.

Since gtkmm 4.16:

Parameters

transfer_function The new transfer-function value.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gdk::CicpParams > wrap	(	GdkCicpParams *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ CicpParams() [1/2]

◆ ~CicpParams()

◆ CicpParams() [2/2]

Member Function Documentation

◆ build_color_state()

◆ create()

◆ get_color_primaries()

◆ get_matrix_coefficients()

◆ get_range()

◆ get_transfer_function()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ operator=()

◆ property_color_primaries() [1/2]

◆ property_color_primaries() [2/2]

◆ property_matrix_coefficients() [1/2]

◆ property_matrix_coefficients() [2/2]

◆ property_range() [1/2]

◆ property_range() [2/2]

◆ property_transfer_function() [1/2]

◆ property_transfer_function() [2/2]

◆ set_color_primaries()

◆ set_matrix_coefficients()

◆ set_range()

◆ set_transfer_function()

Friends And Related Symbol Documentation

◆ wrap()