:right-sidebar: True

CicpParams
===================================================================

.. currentmodule:: gi.repository.Gdk


.. versionadded:: 4.16




.. class:: CicpParams(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





The ``GdkCicpParams`` struct contains the parameters that define
a colorstate according to the ITU-T H.273
`specification <https://www.itu.int/rec/T-REC-H.273/en>`__\.

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.

``GdkCicpParams`` can be used as a builder object to construct a color
state from Cicp data with :obj:`~gi.repository.Gdk.CicpParams.build_color_state`\.
The function will return an error if the given parameters are not
supported.

You can obtain a ``GdkCicpParams`` object from a color state with
:obj:`~gi.repository.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.


Constructors
------------

.. rst-class:: interim-class

.. class:: CicpParams
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gdk.CicpParams

      Creates a new ``GdkCicpParams`` 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.


      .. versionadded:: 4.16












Methods
-------

.. rst-class:: interim-class

.. class:: CicpParams
   :no-index:


   .. method:: build_color_state() -> ~gi.repository.Gdk.ColorState | None

      Creates a new ``GdkColorState`` 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.


      .. versionadded:: 4.16








   .. method:: get_color_primaries() -> int

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


      .. versionadded:: 4.16








   .. method:: get_matrix_coefficients() -> int

      Gets the matrix-coefficients property of ``self``\.


      .. versionadded:: 4.16








   .. method:: get_range() -> ~gi.repository.Gdk.CicpRange

      Gets the range property of ``self``\.


      .. versionadded:: 4.16








   .. method:: get_transfer_function() -> int

      Gets the transfer-function property of ``self``\.


      .. versionadded:: 4.16








   .. method:: set_color_primaries(color_primaries: int) -> None

      Sets the color-primaries property of ``self``\.


      .. versionadded:: 4.16





      :param color_primaries: the new color primaries value




   .. method:: set_matrix_coefficients(matrix_coefficients: int) -> None

      ``self`` a ``GdkCicpParams``
      Sets the matrix-coefficients property of ``self``\.


      .. versionadded:: 4.16





      :param matrix_coefficients: the new matrix-coefficients value




   .. method:: set_range(range: ~gi.repository.Gdk.CicpRange) -> None

      Sets the range property of ``self``


      .. versionadded:: 4.16





      :param range: the range value




   .. method:: set_transfer_function(transfer_function: int) -> None

      Sets the transfer-function property of ``self``\.


      .. versionadded:: 4.16





      :param transfer_function: the new transfer-function value








Properties
----------

.. rst-class:: interim-class

.. class:: CicpParams
   :no-index:
   

   .. attribute:: props.color_primaries
      :type: int

      The type of the None singleton.



      .. versionadded:: 4.16





   .. attribute:: props.matrix_coefficients
      :type: int

      The type of the None singleton.



      .. versionadded:: 4.16





   .. attribute:: props.range
      :type: ~gi.repository.Gdk.CicpRange

      The type of the None singleton.



      .. versionadded:: 4.16





   .. attribute:: props.transfer_function
      :type: int

      The type of the None singleton.



      .. versionadded:: 4.16