gdk4/auto/

cicp_params.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, CicpRange, ColorState};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// The [`CicpParams`][crate::CicpParams] 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.
    ///
    /// [`CicpParams`][crate::CicpParams] can be used as a builder object to construct a color
    /// state from Cicp data with [`build_color_state()`][Self::build_color_state()].
    /// The function will return an error if the given parameters are not
    /// supported.
    ///
    /// You can obtain a [`CicpParams`][crate::CicpParams] object from a color state with
    /// [`ColorState::create_cicp_params()`][crate::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
    #[doc(alias = "GdkCicpParams")]
    pub struct CicpParams(Object<ffi::GdkCicpParams, ffi::GdkCicpParamsClass>);

    match fn {
        type_ => || ffi::gdk_cicp_params_get_type(),
    }
}

impl CicpParams {
    /// Creates a new [`CicpParams`][crate::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`][crate::CicpParams]
    #[doc(alias = "gdk_cicp_params_new")]
    pub fn new() -> CicpParams {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gdk_cicp_params_new()) }
    }

    /// Creates a new [`ColorState`][crate::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`][crate::ColorState]
    #[doc(alias = "gdk_cicp_params_build_color_state")]
    pub fn build_color_state(&self) -> Result<Option<ColorState>, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::gdk_cicp_params_build_color_state(self.to_glib_none().0, &mut error);
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Returns the value of the color-primaries property
    /// of @self.
    ///
    /// # Returns
    ///
    /// the color-primaries value
    #[doc(alias = "gdk_cicp_params_get_color_primaries")]
    #[doc(alias = "get_color_primaries")]
    #[doc(alias = "color-primaries")]
    pub fn color_primaries(&self) -> u32 {
        unsafe { ffi::gdk_cicp_params_get_color_primaries(self.to_glib_none().0) }
    }

    /// Gets the matrix-coefficients property of @self.
    ///
    /// # Returns
    ///
    /// the matrix-coefficients value
    #[doc(alias = "gdk_cicp_params_get_matrix_coefficients")]
    #[doc(alias = "get_matrix_coefficients")]
    #[doc(alias = "matrix-coefficients")]
    pub fn matrix_coefficients(&self) -> u32 {
        unsafe { ffi::gdk_cicp_params_get_matrix_coefficients(self.to_glib_none().0) }
    }

    /// Gets the range property of @self.
    ///
    /// # Returns
    ///
    /// the range value
    #[doc(alias = "gdk_cicp_params_get_range")]
    #[doc(alias = "get_range")]
    pub fn range(&self) -> CicpRange {
        unsafe { from_glib(ffi::gdk_cicp_params_get_range(self.to_glib_none().0)) }
    }

    /// Gets the transfer-function property of @self.
    ///
    /// # Returns
    ///
    /// the transfer-function value
    #[doc(alias = "gdk_cicp_params_get_transfer_function")]
    #[doc(alias = "get_transfer_function")]
    #[doc(alias = "transfer-function")]
    pub fn transfer_function(&self) -> u32 {
        unsafe { ffi::gdk_cicp_params_get_transfer_function(self.to_glib_none().0) }
    }

    /// Sets the color-primaries property of @self.
    /// ## `color_primaries`
    /// the new color primaries value
    #[doc(alias = "gdk_cicp_params_set_color_primaries")]
    #[doc(alias = "color-primaries")]
    pub fn set_color_primaries(&self, color_primaries: u32) {
        unsafe {
            ffi::gdk_cicp_params_set_color_primaries(self.to_glib_none().0, color_primaries);
        }
    }

    /// @self a [`CicpParams`][crate::CicpParams]
    /// Sets the matrix-coefficients property of @self.
    /// ## `matrix_coefficients`
    /// the new matrix-coefficients value
    #[doc(alias = "gdk_cicp_params_set_matrix_coefficients")]
    #[doc(alias = "matrix-coefficients")]
    pub fn set_matrix_coefficients(&self, matrix_coefficients: u32) {
        unsafe {
            ffi::gdk_cicp_params_set_matrix_coefficients(
                self.to_glib_none().0,
                matrix_coefficients,
            );
        }
    }

    /// Sets the range property of @self
    /// ## `range`
    /// the range value
    #[doc(alias = "gdk_cicp_params_set_range")]
    #[doc(alias = "range")]
    pub fn set_range(&self, range: CicpRange) {
        unsafe {
            ffi::gdk_cicp_params_set_range(self.to_glib_none().0, range.into_glib());
        }
    }

    /// Sets the transfer-function property of @self.
    /// ## `transfer_function`
    /// the new transfer-function value
    #[doc(alias = "gdk_cicp_params_set_transfer_function")]
    #[doc(alias = "transfer-function")]
    pub fn set_transfer_function(&self, transfer_function: u32) {
        unsafe {
            ffi::gdk_cicp_params_set_transfer_function(self.to_glib_none().0, transfer_function);
        }
    }

    #[cfg(feature = "v4_16")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_16")))]
    #[doc(alias = "color-primaries")]
    pub fn connect_color_primaries_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_color_primaries_trampoline<F: Fn(&CicpParams) + 'static>(
            this: *mut ffi::GdkCicpParams,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::color-primaries\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_color_primaries_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_16")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_16")))]
    #[doc(alias = "matrix-coefficients")]
    pub fn connect_matrix_coefficients_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_matrix_coefficients_trampoline<F: Fn(&CicpParams) + 'static>(
            this: *mut ffi::GdkCicpParams,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::matrix-coefficients\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_matrix_coefficients_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_16")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_16")))]
    #[doc(alias = "range")]
    pub fn connect_range_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_range_trampoline<F: Fn(&CicpParams) + 'static>(
            this: *mut ffi::GdkCicpParams,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::range\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_range_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_16")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_16")))]
    #[doc(alias = "transfer-function")]
    pub fn connect_transfer_function_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_transfer_function_trampoline<F: Fn(&CicpParams) + 'static>(
            this: *mut ffi::GdkCicpParams,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::transfer-function\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_transfer_function_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

#[cfg(feature = "v4_16")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_16")))]
impl Default for CicpParams {
    fn default() -> Self {
        Self::new()
    }
}