gdk4/auto/

memory_texture_builder.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, ColorState, MemoryFormat, Texture};
use glib::translate::*;

glib::wrapper! {
    /// Constructs [`Texture`][crate::Texture] objects from system memory provided
    /// via [`glib::Bytes`][crate::glib::Bytes].
    ///
    /// The operation is quite simple: Create a texture builder, set all the necessary
    /// properties - keep in mind that the properties [`bytes`][struct@crate::MemoryTextureBuilder#bytes],
    /// [`stride`][struct@crate::MemoryTextureBuilder#stride], [`width`][struct@crate::MemoryTextureBuilder#width],
    /// and [`height`][struct@crate::MemoryTextureBuilder#height] are mandatory - and then call
    /// [`build()`][Self::build()] to create the new texture.
    ///
    /// [`MemoryTextureBuilder`][crate::MemoryTextureBuilder] can be used for quick one-shot construction of
    /// textures as well as kept around and reused to construct multiple textures.
    ///
    /// ## Properties
    ///
    ///
    /// #### `bytes`
    ///  The bytes holding the data.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `color-state`
    ///  The colorstate describing the data.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `format`
    ///  The format of the data.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `height`
    ///  The height of the texture.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `stride`
    ///  The rowstride of the texture.
    ///
    /// The rowstride is the number of bytes between the first pixel
    /// in a row of image data, and the first pixel in the next row.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `update-region`
    ///  The update region for [`update-texture`][struct@crate::MemoryTextureBuilder#update-texture].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `update-texture`
    ///  The texture [`update-region`][struct@crate::MemoryTextureBuilder#update-region] is an update for.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `width`
    ///  The width of the texture.
    ///
    /// Readable | Writeable
    #[doc(alias = "GdkMemoryTextureBuilder")]
    pub struct MemoryTextureBuilder(Object<ffi::GdkMemoryTextureBuilder, ffi::GdkMemoryTextureBuilderClass>);

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

impl MemoryTextureBuilder {
    /// Creates a new texture builder.
    ///
    /// # Returns
    ///
    /// the new `GdkTextureBuilder`
    #[doc(alias = "gdk_memory_texture_builder_new")]
    pub fn new() -> MemoryTextureBuilder {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gdk_memory_texture_builder_new()) }
    }

    /// Builds a new [`Texture`][crate::Texture] with the values set up in the builder.
    ///
    /// Note that it is a programming error to call this function if any mandatory
    /// property has not been set.
    ///
    /// It is possible to call this function multiple times to create multiple textures,
    /// possibly with changing properties in between.
    ///
    /// # Returns
    ///
    /// a newly built [`Texture`][crate::Texture]
    #[doc(alias = "gdk_memory_texture_builder_build")]
    pub fn build(&self) -> Texture {
        unsafe { from_glib_full(ffi::gdk_memory_texture_builder_build(self.to_glib_none().0)) }
    }

    /// Gets the bytes previously set via gdk_memory_texture_builder_set_bytes()
    /// or [`None`] if none was set.
    ///
    /// # Returns
    ///
    /// The bytes
    #[doc(alias = "gdk_memory_texture_builder_get_bytes")]
    #[doc(alias = "get_bytes")]
    pub fn bytes(&self) -> Option<glib::Bytes> {
        unsafe {
            from_glib_none(ffi::gdk_memory_texture_builder_get_bytes(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the colorstate previously set via gdk_memory_texture_builder_set_color_state().
    ///
    /// # Returns
    ///
    /// The colorstate
    #[doc(alias = "gdk_memory_texture_builder_get_color_state")]
    #[doc(alias = "get_color_state")]
    #[doc(alias = "color-state")]
    pub fn color_state(&self) -> ColorState {
        unsafe {
            from_glib_none(ffi::gdk_memory_texture_builder_get_color_state(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the format previously set via gdk_memory_texture_builder_set_format().
    ///
    /// # Returns
    ///
    /// The format
    #[doc(alias = "gdk_memory_texture_builder_get_format")]
    #[doc(alias = "get_format")]
    pub fn format(&self) -> MemoryFormat {
        unsafe {
            from_glib(ffi::gdk_memory_texture_builder_get_format(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the height previously set via gdk_memory_texture_builder_set_height()
    /// or 0 if the height wasn't set.
    ///
    /// # Returns
    ///
    /// The height
    #[doc(alias = "gdk_memory_texture_builder_get_height")]
    #[doc(alias = "get_height")]
    pub fn height(&self) -> i32 {
        unsafe { ffi::gdk_memory_texture_builder_get_height(self.to_glib_none().0) }
    }

    /// Gets the offset previously set via gdk_memory_texture_builder_set_offset().
    /// ## `plane`
    /// a plane
    ///
    /// # Returns
    ///
    /// The offset associated to a @plane
    #[cfg(feature = "v4_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_20")))]
    #[doc(alias = "gdk_memory_texture_builder_get_offset")]
    #[doc(alias = "get_offset")]
    pub fn offset(&self, plane: u32) -> usize {
        unsafe { ffi::gdk_memory_texture_builder_get_offset(self.to_glib_none().0, plane) }
    }

    /// Gets the stride previously set via gdk_memory_texture_builder_set_stride().
    ///
    /// # Returns
    ///
    /// the stride
    #[doc(alias = "gdk_memory_texture_builder_get_stride")]
    #[doc(alias = "get_stride")]
    pub fn stride(&self) -> usize {
        unsafe { ffi::gdk_memory_texture_builder_get_stride(self.to_glib_none().0) }
    }

    /// Gets the stride previously set via gdk_memory_texture_builder_set_stride_for_plane().
    /// ## `plane`
    /// a plane
    ///
    /// # Returns
    ///
    /// The stride associated to a @plane
    #[cfg(feature = "v4_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_20")))]
    #[doc(alias = "gdk_memory_texture_builder_get_stride_for_plane")]
    #[doc(alias = "get_stride_for_plane")]
    pub fn stride_for_plane(&self, plane: u32) -> usize {
        unsafe {
            ffi::gdk_memory_texture_builder_get_stride_for_plane(self.to_glib_none().0, plane)
        }
    }

    /// Gets the region previously set via gdk_memory_texture_builder_set_update_region()
    /// or [`None`] if none was set.
    ///
    /// # Returns
    ///
    /// The update region
    #[doc(alias = "gdk_memory_texture_builder_get_update_region")]
    #[doc(alias = "get_update_region")]
    #[doc(alias = "update-region")]
    pub fn update_region(&self) -> Option<cairo::Region> {
        unsafe {
            from_glib_none(ffi::gdk_memory_texture_builder_get_update_region(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the texture previously set via gdk_memory_texture_builder_set_update_texture()
    /// or [`None`] if none was set.
    ///
    /// # Returns
    ///
    /// The update texture
    #[doc(alias = "gdk_memory_texture_builder_get_update_texture")]
    #[doc(alias = "get_update_texture")]
    #[doc(alias = "update-texture")]
    pub fn update_texture(&self) -> Option<Texture> {
        unsafe {
            from_glib_none(ffi::gdk_memory_texture_builder_get_update_texture(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the width previously set via gdk_memory_texture_builder_set_width()
    /// or 0 if the width wasn't set.
    ///
    /// # Returns
    ///
    /// The width
    #[doc(alias = "gdk_memory_texture_builder_get_width")]
    #[doc(alias = "get_width")]
    pub fn width(&self) -> i32 {
        unsafe { ffi::gdk_memory_texture_builder_get_width(self.to_glib_none().0) }
    }
}

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

unsafe impl Send for MemoryTextureBuilder {}
unsafe impl Sync for MemoryTextureBuilder {}