gdk4/

memory_texture_builder.rs

// Take a look at the license at the top of the repository in the LICENSE file.

use crate::{ffi, ColorState, MemoryFormat, MemoryTextureBuilder, Texture};
use glib::{prelude::*, translate::*};

impl MemoryTextureBuilder {
    /// Sets the data to be shown but the texture.
    ///
    /// The bytes must be set before calling [`build()`][Self::build()].
    /// ## `bytes`
    /// The bytes the texture shows or [`None`] to unset
    #[doc(alias = "gdk_memory_texture_builder_set_bytes")]
    #[doc(alias = "bytes")]
    pub fn set_bytes(self, bytes: Option<&glib::Bytes>) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_bytes(
                self.to_glib_none().0,
                bytes.to_glib_none().0,
            );
        }

        self
    }

    /// Sets the colorstate describing the data.
    ///
    /// By default, the sRGB colorstate is used. If you don't know
    /// what colorstates are, this is probably the right thing.
    /// ## `color_state`
    /// The colorstate describing the data
    #[doc(alias = "gdk_memory_texture_builder_set_color_state")]
    #[doc(alias = "color-state")]
    pub fn set_color_state(self, color_state: &ColorState) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_color_state(
                self.to_glib_none().0,
                color_state.to_glib_none().0,
            );
        }

        self
    }

    /// Sets the format of the bytes.
    ///
    /// The default is `GDK_MEMORY_R8G8B8A8_PREMULTIPLIED`.
    /// ## `format`
    /// The texture's format
    #[doc(alias = "gdk_memory_texture_builder_set_format")]
    #[doc(alias = "format")]
    pub fn set_format(self, format: MemoryFormat) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_format(self.to_glib_none().0, format.into_glib());
        }

        self
    }

    /// Sets the height of the texture.
    ///
    /// The height must be set before calling [`build()`][Self::build()]
    /// and conform to size requirements of the provided format.
    /// ## `height`
    /// The texture's height or 0 to unset
    #[doc(alias = "gdk_memory_texture_builder_set_height")]
    #[doc(alias = "height")]
    pub fn set_height(self, height: i32) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_height(self.to_glib_none().0, height);
        }

        self
    }

    /// Sets the offset of the texture for @plane.
    /// ## `plane`
    /// a plane
    /// ## `offset`
    /// the texture's offset for @plane
    #[cfg(feature = "v4_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_20")))]
    #[doc(alias = "gdk_memory_texture_builder_set_offset")]
    pub fn set_offset(self, plane: u32, offset: usize) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_offset(self.to_glib_none().0, plane, offset);
        }

        self
    }

    /// Sets the rowstride of the bytes used.
    ///
    /// The rowstride must be set before calling [`build()`][Self::build()].
    /// ## `stride`
    /// the stride or 0 to unset
    #[doc(alias = "gdk_memory_texture_builder_set_stride")]
    #[doc(alias = "stride")]
    pub fn set_stride(self, stride: usize) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_stride(self.to_glib_none().0, stride);
        }

        self
    }

    /// Sets the stride of the texture for @plane.
    /// ## `plane`
    /// a plane
    /// ## `stride`
    /// the texture's stride for @plane
    #[cfg(feature = "v4_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_20")))]
    #[doc(alias = "gdk_memory_texture_builder_set_stride_for_plane")]
    pub fn set_stride_for_plane(self, plane: u32, stride: usize) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_stride_for_plane(
                self.to_glib_none().0,
                plane,
                stride,
            );
        }

        self
    }

    /// Sets the region to be updated by this texture.
    ///
    /// Together with [`update-texture`][struct@crate::MemoryTextureBuilder#update-texture],
    /// this describes an update of a previous texture.
    ///
    /// When rendering animations of large textures, it is possible that
    /// consecutive textures are only updating contents in parts of the texture.
    /// It is then possible to describe this update via these two properties,
    /// so that GTK can avoid rerendering parts that did not change.
    ///
    /// An example would be a screen recording where only the mouse pointer moves.
    /// ## `region`
    /// the region to update
    #[doc(alias = "gdk_memory_texture_builder_set_update_region")]
    #[doc(alias = "update-region")]
    pub fn set_update_region(self, region: Option<&cairo::Region>) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_update_region(
                self.to_glib_none().0,
                mut_override(region.to_glib_none().0),
            );
        }

        self
    }

    /// Sets the texture to be updated by this texture.
    ///
    /// See [`set_update_region()`][Self::set_update_region()] for an explanation.
    /// ## `texture`
    /// the texture to update
    #[doc(alias = "gdk_memory_texture_builder_set_update_texture")]
    #[doc(alias = "update-texture")]
    pub fn set_update_texture(self, texture: Option<&impl IsA<Texture>>) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_update_texture(
                self.to_glib_none().0,
                texture.map(|p| p.as_ref()).to_glib_none().0,
            );
        }

        self
    }

    /// Sets the width of the texture.
    ///
    /// The width must be set before calling [`build()`][Self::build()]
    /// and conform to size requirements of the provided format.
    /// ## `width`
    /// The texture's width or 0 to unset
    #[doc(alias = "gdk_memory_texture_builder_set_width")]
    #[doc(alias = "width")]
    pub fn set_width(self, width: i32) -> Self {
        unsafe {
            ffi::gdk_memory_texture_builder_set_width(self.to_glib_none().0, width);
        }

        self
    }
}