Struct MemoryTextureBuilder

pub struct MemoryTextureBuilder { /* private fields */ }

Available on crate feature v4_16 only.

MemoryTextureBuilder is a builder used to construct Texture objects from system memory provided via glib::Bytes.

The operation is quite simple: Create a texture builder, set all the necessary properties - keep in mind that the properties bytes, stride, width, and height are mandatory - and then call build() to create the new texture.

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.

Readable | Writeable

update-texture

The texture update-region is an update for.

Readable | Writeable

width

The width of the texture.

Readable | Writeable

GLib type: GObject with reference counted clone semantics.

Implementations

impl MemoryTextureBuilder

pub fn new() -> MemoryTextureBuilder

Creates a new texture builder.

Returns

the new GdkTextureBuilder

pub fn build(&self) -> Texture

Builds a new 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

pub fn bytes(&self) -> Option<Bytes>

Gets the bytes previously set via gdk_memory_texture_builder_set_bytes() or None if none was set.

Returns

The bytes

pub fn color_state(&self) -> ColorState

Gets the colorstate previously set via gdk_memory_texture_builder_set_color_state().

Returns

The colorstate

pub fn format(&self) -> MemoryFormat

Gets the format previously set via gdk_memory_texture_builder_set_format().

Returns

The format

pub fn height(&self) -> i32

Gets the height previously set via gdk_memory_texture_builder_set_height() or 0 if the height wasn’t set.

Returns

The height

pub fn stride(&self) -> usize

Gets the stride previously set via gdk_memory_texture_builder_set_stride().

Returns

the stride

pub fn update_region(&self) -> Option<Region>

Gets the region previously set via gdk_memory_texture_builder_set_update_region() or None if none was set.

Returns

The update region

pub fn update_texture(&self) -> Option<Texture>

Gets the texture previously set via gdk_memory_texture_builder_set_update_texture() or None if none was set.

Returns

The update texture

pub fn width(&self) -> i32

Gets the width previously set via gdk_memory_texture_builder_set_width() or 0 if the width wasn’t set.

Returns

The width

pub fn set_bytes(&self, bytes: Option<&Bytes>)

Sets the data to be shown but the texture.

The bytes must be set before calling build().

bytes

The bytes the texture shows or None to unset

pub fn set_color_state(&self, color_state: Option<&ColorState>)

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

pub fn set_format(&self, format: MemoryFormat)

Sets the format of the bytes.

The default is GDK_MEMORY_R8G8B8A8_PREMULTIPLIED.

format

The texture’s format

pub fn set_height(&self, height: i32)

Sets the height of the texture.

The height must be set before calling build().

height

The texture’s height or 0 to unset

pub fn set_stride(&self, stride: usize)

Sets the rowstride of the bytes used.

The rowstride must be set before calling build().

stride

the stride or 0 to unset

pub fn set_update_region(&self, region: Option<&Region>)

Sets the region to be updated by this texture.

Together with 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

pub fn set_update_texture(&self, texture: Option<&impl IsA<Texture>>)

Sets the texture to be updated by this texture.

See set_update_region() for an explanation.

texture

the texture to update

pub fn set_width(&self, width: i32)

Sets the width of the texture.

The width must be set before calling build().

width

The texture’s width or 0 to unset

pub fn connect_bytes_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_color_state_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_format_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_height_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_stride_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_update_region_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_update_texture_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_width_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for MemoryTextureBuilder

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MemoryTextureBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MemoryTextureBuilder

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for MemoryTextureBuilder

type ParamSpec = ParamSpecObject

type SetValue = MemoryTextureBuilder

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, MemoryTextureBuilder>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MemoryTextureBuilder

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MemoryTextureBuilder

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for MemoryTextureBuilder

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for MemoryTextureBuilder

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for MemoryTextureBuilder

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for MemoryTextureBuilder

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MemoryTextureBuilder

impl Send for MemoryTextureBuilder

impl Sync for MemoryTextureBuilder