gsk4/auto/

component_transfer.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;
use glib::translate::*;

glib::wrapper! {
    /// 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.
    #[derive(Debug, PartialOrd, Ord, Hash)]
    pub struct ComponentTransfer(Boxed<ffi::GskComponentTransfer>);

    match fn {
        copy => |ptr| ffi::gsk_component_transfer_copy(ptr),
        free => |ptr| ffi::gsk_component_transfer_free(ptr),
        type_ => || ffi::gsk_component_transfer_get_type(),
    }
}

impl 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
    ///
    /// <figure>
    ///   <picture>
    ///     <source srcset="discrete-dark.png" media="(prefers-color-scheme: dark)">
    ///       <img alt="Component transfer: discrete" src="discrete-light.png">
    ///   </picture>
    /// </figure>
    /// ## `values`
    /// Values
    ///
    /// # Returns
    ///
    /// a new [`ComponentTransfer`][crate::ComponentTransfer]
    #[doc(alias = "gsk_component_transfer_new_discrete")]
    pub fn new_discrete(values: &[f32]) -> ComponentTransfer {
        assert_initialized_main_thread!();
        let n = values.len() as _;
        unsafe {
            from_glib_full(ffi::gsk_component_transfer_new_discrete(
                n,
                values.to_glib_none().0,
            ))
        }
    }

    /// Creates a new component transfer that applies
    /// a gamma transform.
    ///
    /// The new value is computed as
    ///
    ///     C' = amp * pow (C, exp) + ofs
    ///
    /// <figure>
    ///   <picture>
    ///     <source srcset="gamma-dark.png" media="(prefers-color-scheme: dark)">
    ///       <img alt="Component transfer: gamma" src="gamma-light.png">
    ///   </picture>
    /// </figure>
    /// ## `amp`
    /// Amplitude
    /// ## `exp`
    /// Exponent
    /// ## `ofs`
    /// Offset
    ///
    /// # Returns
    ///
    /// a new [`ComponentTransfer`][crate::ComponentTransfer]
    #[doc(alias = "gsk_component_transfer_new_gamma")]
    pub fn new_gamma(amp: f32, exp: f32, ofs: f32) -> ComponentTransfer {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gsk_component_transfer_new_gamma(amp, exp, ofs)) }
    }

    /// Creates a new component transfer that doesn't
    /// change the component value.
    ///
    /// <figure>
    ///   <picture>
    ///     <source srcset="identity-dark.png" media="(prefers-color-scheme: dark)">
    ///       <img alt="Component transfer: identity" src="identity-light.png">
    ///   </picture>
    /// </figure>
    ///
    /// # Returns
    ///
    /// a new [`ComponentTransfer`][crate::ComponentTransfer]
    #[doc(alias = "gsk_component_transfer_new_identity")]
    pub fn new_identity() -> ComponentTransfer {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gsk_component_transfer_new_identity()) }
    }

    /// 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) + 0.5) / n
    ///
    /// <figure>
    ///   <picture>
    ///     <source srcset="levels-dark.png" media="(prefers-color-scheme: dark)">
    ///       <img alt="Component transfer: levels" src="levels-light.png">
    ///   </picture>
    /// </figure>
    /// ## `n`
    /// Number of levels
    ///
    /// # Returns
    ///
    /// a new [`ComponentTransfer`][crate::ComponentTransfer]
    #[doc(alias = "gsk_component_transfer_new_levels")]
    pub fn new_levels(n: f32) -> ComponentTransfer {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gsk_component_transfer_new_levels(n)) }
    }

    /// Creates a new component transfer that applies
    /// a linear transform.
    ///
    /// The new value is computed as
    ///
    ///     C' = C * m + b
    ///
    /// <figure>
    ///   <picture>
    ///     <source srcset="linear-dark.png" media="(prefers-color-scheme: dark)">
    ///       <img alt="Component transfer: linear" src="linear-light.png">
    ///   </picture>
    /// </figure>
    /// ## `m`
    /// Slope
    /// ## `b`
    /// Offset
    ///
    /// # Returns
    ///
    /// a new [`ComponentTransfer`][crate::ComponentTransfer]
    #[doc(alias = "gsk_component_transfer_new_linear")]
    pub fn new_linear(m: f32, b: f32) -> ComponentTransfer {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gsk_component_transfer_new_linear(m, b)) }
    }

    /// Creates a new component transfer that applies
    /// a piecewise linear function.
    ///
    /// The new value is computed as
    ///
    ///     C' = values[k] + (C - k / (n - 1)) * n * (values[k + 1] - values[k])
    ///
    /// where k is the smallest value such that
    ///
    ///     k / (n - 1) <= C < (k + 1) / (n - 1)
    ///
    /// <figure>
    ///   <picture>
    ///     <source srcset="table-dark.png" media="(prefers-color-scheme: dark)">
    ///       <img alt="Component transfer: table" src="table-light.png">
    ///   </picture>
    /// </figure>
    /// ## `values`
    /// Values
    ///
    /// # Returns
    ///
    /// a new [`ComponentTransfer`][crate::ComponentTransfer]
    #[doc(alias = "gsk_component_transfer_new_table")]
    pub fn new_table(values: &[f32]) -> ComponentTransfer {
        assert_initialized_main_thread!();
        let n = values.len() as _;
        unsafe {
            from_glib_full(ffi::gsk_component_transfer_new_table(
                n,
                values.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "gsk_component_transfer_equal")]
    fn equal(&self, other: &ComponentTransfer) -> bool {
        assert_initialized_main_thread!();
        unsafe {
            from_glib(ffi::gsk_component_transfer_equal(
                ToGlibPtr::<*const ffi::GskComponentTransfer>::to_glib_none(self).0
                    as glib::ffi::gconstpointer,
                ToGlibPtr::<*const ffi::GskComponentTransfer>::to_glib_none(other).0
                    as glib::ffi::gconstpointer,
            ))
        }
    }
}

impl PartialEq for ComponentTransfer {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.equal(other)
    }
}

impl Eq for ComponentTransfer {}