graphene/auto/

vec2.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! {
    /// A structure capable of holding a vector with two dimensions, x and y.
    ///
    /// The contents of the [`Vec2`][crate::Vec2] structure are private and should
    /// never be accessed directly.
    pub struct Vec2(BoxedInline<ffi::graphene_vec2_t>);

    match fn {
        copy => |ptr| glib::gobject_ffi::g_boxed_copy(ffi::graphene_vec2_get_type(), ptr as *mut _) as *mut ffi::graphene_vec2_t,
        free => |ptr| glib::gobject_ffi::g_boxed_free(ffi::graphene_vec2_get_type(), ptr as *mut _),
        type_ => || ffi::graphene_vec2_get_type(),
    }
}

impl Vec2 {
    /// Adds each component of the two passed vectors and places
    /// each result into the components of `res`.
    /// ## `b`
    /// a [`Vec2`][crate::Vec2]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the result
    #[doc(alias = "graphene_vec2_add")]
    #[must_use]
    pub fn add(&self, b: &Vec2) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_add(
                self.to_glib_none().0,
                b.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Divides each component of the first operand `self` by the corresponding
    /// component of the second operand `b`, and places the results into the
    /// vector `res`.
    /// ## `b`
    /// a [`Vec2`][crate::Vec2]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the result
    #[doc(alias = "graphene_vec2_divide")]
    #[must_use]
    pub fn divide(&self, b: &Vec2) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_divide(
                self.to_glib_none().0,
                b.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Computes the dot product of the two given vectors.
    /// ## `b`
    /// a [`Vec2`][crate::Vec2]
    ///
    /// # Returns
    ///
    /// the dot product of the vectors
    #[doc(alias = "graphene_vec2_dot")]
    pub fn dot(&self, b: &Vec2) -> f32 {
        unsafe { ffi::graphene_vec2_dot(self.to_glib_none().0, b.to_glib_none().0) }
    }

    #[doc(alias = "graphene_vec2_equal")]
    fn equal(&self, v2: &Vec2) -> bool {
        unsafe { ffi::graphene_vec2_equal(self.to_glib_none().0, v2.to_glib_none().0) }
    }

    /// Retrieves the X component of the [`Vec2`][crate::Vec2].
    ///
    /// # Returns
    ///
    /// the value of the X component
    #[doc(alias = "graphene_vec2_get_x")]
    #[doc(alias = "get_x")]
    pub fn x(&self) -> f32 {
        unsafe { ffi::graphene_vec2_get_x(self.to_glib_none().0) }
    }

    /// Retrieves the Y component of the [`Vec2`][crate::Vec2].
    ///
    /// # Returns
    ///
    /// the value of the Y component
    #[doc(alias = "graphene_vec2_get_y")]
    #[doc(alias = "get_y")]
    pub fn y(&self) -> f32 {
        unsafe { ffi::graphene_vec2_get_y(self.to_glib_none().0) }
    }

    /// Linearly interpolates `self` and `v2` using the given `factor`.
    /// ## `v2`
    /// a [`Vec2`][crate::Vec2]
    /// ## `factor`
    /// the interpolation factor
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// the interpolated vector
    #[doc(alias = "graphene_vec2_interpolate")]
    #[must_use]
    pub fn interpolate(&self, v2: &Vec2, factor: f64) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_interpolate(
                self.to_glib_none().0,
                v2.to_glib_none().0,
                factor,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Computes the length of the given vector.
    ///
    /// # Returns
    ///
    /// the length of the vector
    #[doc(alias = "graphene_vec2_length")]
    pub fn length(&self) -> f32 {
        unsafe { ffi::graphene_vec2_length(self.to_glib_none().0) }
    }

    /// Compares the two given vectors and places the maximum
    /// values of each component into `res`.
    /// ## `b`
    /// a [`Vec2`][crate::Vec2]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// the resulting vector
    #[doc(alias = "graphene_vec2_max")]
    #[must_use]
    pub fn max(&self, b: &Vec2) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_max(
                self.to_glib_none().0,
                b.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Compares the two given vectors and places the minimum
    /// values of each component into `res`.
    /// ## `b`
    /// a [`Vec2`][crate::Vec2]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// the resulting vector
    #[doc(alias = "graphene_vec2_min")]
    #[must_use]
    pub fn min(&self, b: &Vec2) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_min(
                self.to_glib_none().0,
                b.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Multiplies each component of the two passed vectors and places
    /// each result into the components of `res`.
    /// ## `b`
    /// a [`Vec2`][crate::Vec2]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the result
    #[doc(alias = "graphene_vec2_multiply")]
    #[must_use]
    pub fn multiply(&self, b: &Vec2) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_multiply(
                self.to_glib_none().0,
                b.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Compares the two given [`Vec2`][crate::Vec2] vectors and checks
    /// whether their values are within the given `epsilon`.
    /// ## `v2`
    /// a [`Vec2`][crate::Vec2]
    /// ## `epsilon`
    /// the threshold between the two vectors
    ///
    /// # Returns
    ///
    /// `true` if the two vectors are near each other
    #[doc(alias = "graphene_vec2_near")]
    pub fn near(&self, v2: &Vec2, epsilon: f32) -> bool {
        unsafe { ffi::graphene_vec2_near(self.to_glib_none().0, v2.to_glib_none().0, epsilon) }
    }

    /// Negates the given [`Vec2`][crate::Vec2].
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the result vector
    #[doc(alias = "graphene_vec2_negate")]
    #[must_use]
    pub fn negate(&self) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_negate(self.to_glib_none().0, res.to_glib_none_mut().0);
            res
        }
    }

    /// Computes the normalized vector for the given vector `self`.
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the
    ///  normalized vector
    #[doc(alias = "graphene_vec2_normalize")]
    #[must_use]
    pub fn normalize(&self) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_normalize(self.to_glib_none().0, res.to_glib_none_mut().0);
            res
        }
    }

    /// Multiplies all components of the given vector with the given scalar `factor`.
    /// ## `factor`
    /// the scalar factor
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the result vector
    #[doc(alias = "graphene_vec2_scale")]
    #[must_use]
    pub fn scale(&self, factor: f32) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_scale(self.to_glib_none().0, factor, res.to_glib_none_mut().0);
            res
        }
    }

    /// Subtracts from each component of the first operand `self` the
    /// corresponding component of the second operand `b` and places
    /// each result into the components of `res`.
    /// ## `b`
    /// a [`Vec2`][crate::Vec2]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the result
    #[doc(alias = "graphene_vec2_subtract")]
    #[must_use]
    pub fn subtract(&self, b: &Vec2) -> Vec2 {
        unsafe {
            let mut res = Vec2::uninitialized();
            ffi::graphene_vec2_subtract(
                self.to_glib_none().0,
                b.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Retrieves a constant vector with (1, 1) components.
    ///
    /// # Returns
    ///
    /// the one vector
    #[doc(alias = "graphene_vec2_one")]
    pub fn one() -> Vec2 {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::graphene_vec2_one()) }
    }

    /// Retrieves a constant vector with (1, 0) components.
    ///
    /// # Returns
    ///
    /// the X axis vector
    #[doc(alias = "graphene_vec2_x_axis")]
    pub fn x_axis() -> Vec2 {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::graphene_vec2_x_axis()) }
    }

    /// Retrieves a constant vector with (0, 1) components.
    ///
    /// # Returns
    ///
    /// the Y axis vector
    #[doc(alias = "graphene_vec2_y_axis")]
    pub fn y_axis() -> Vec2 {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::graphene_vec2_y_axis()) }
    }

    /// Retrieves a constant vector with (0, 0) components.
    ///
    /// # Returns
    ///
    /// the zero vector
    #[doc(alias = "graphene_vec2_zero")]
    pub fn zero() -> Vec2 {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::graphene_vec2_zero()) }
    }
}

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

impl Eq for Vec2 {}