Struct gdk4::GLTextureBuilder

#[repr(transparent)]
pub struct GLTextureBuilder { /* private fields */ }

Available on crate feature v4_12 only.

GLTextureBuilder is a buider used to construct Texture objects from GL textures.

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

GLTextureBuilder can be used for quick one-shot construction of textures as well as kept around and reused to construct multiple textures.

Properties

context

The context owning the texture.

Readable | Writeable

format

The format when downloading the texture.

Readable | Writeable

has-mipmap

If the texture has a mipmap.

Readable | Writeable

height

The height of the texture.

Readable | Writeable

id

The texture ID to use.

Readable | Writeable

sync

An optional GLSync object.

If this is set, GTK will wait on it before using the texture.

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

Implementations

impl GLTextureBuilder

pub fn new() -> GLTextureBuilder

Creates a new texture builder.

Returns

the new GdkTextureBuilder

pub fn context(&self) -> Option<GLContext>

Gets the context previously set via gdk_gl_texture_builder_set_context() or None if none was set.

Returns

The context

pub fn format(&self) -> MemoryFormat

Gets the format previously set via gdk_gl_texture_builder_set_format().

Returns

The format

pub fn has_mipmap(&self) -> bool

Gets whether the texture has a mipmap.

Returns

Whether the texture has a mipmap

pub fn height(&self) -> i32

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

Returns

The height

pub fn id(&self) -> u32

Gets the texture id previously set via gdk_gl_texture_builder_set_id() or 0 if the id wasn’t set.

Returns

The id

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

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

Returns

The region

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

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

Returns

The texture

pub fn width(&self) -> i32

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

Returns

The width

impl GLTextureBuilder

pub unsafe fn build(self) -> Texture

Builds a new Texture with the values set up in the builder.

The destroy function gets called when the returned texture gets released; either when the texture is finalized or by an explicit call to GLTexture::release(). It should release all GL resources associated with the texture, such as the id and the sync.

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 unsafe fn build_with_release_func<F: FnOnce() + 'static>( self, release_func: F ) -> Texture

pub fn set_context(self, context: Option<&impl IsA<GLContext>>) -> Self

Sets the context to be used for the texture. This is the context that owns the texture.

The context must be set before calling build().

context

The context the texture beongs to or None to unset

pub fn set_format(self, format: MemoryFormat) -> Self

Sets the format of the texture. The default is GDK_MEMORY_R8G8B8A8_PREMULTIPLIED.

The format is the preferred format the texture data should be downloaded to. The format must be supported by the GL version of context.

GDK’s texture download code assumes that the format corresponds to the storage parameters of the GL texture in an obvious way. For example, a format of GDK_MEMORY_R16G16B16A16_PREMULTIPLIED is expected to be stored as GL_RGBA16 texture, and GDK_MEMORY_G8A8 is expected to be stored as GL_RG8 texture.

Setting the right format is particularly useful when using high bit depth textures to preserve the bit depth, to set the correct value for unpremultiplied textures and to make sure opaque textures are treated as such.

Non-RGBA textures need to have swizzling parameters set up properly to be usable in GSK’s shaders.

format

The texture’s format

pub fn set_has_mipmap(self, has_mipmap: bool) -> Self

Sets whether the texture has a mipmap. This allows the renderer and other users of the generated texture to use a higher quality downscaling.

Typically, the glGenerateMipmap function is used to generate a mimap.

has_mipmap

Whether the texture has a mipmap

pub fn set_height(self, height: i32) -> Self

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_id(self, id: u32) -> Self

Sets the texture id of the texture. The texture id must remain unmodified until the texture was finalized. See build() for a longer discussion.

The id must be set before calling build().

id

The texture id to be used for creating the texture

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

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>>) -> Self

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) -> Self

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 sync(&self) -> Option<GLsync>

Gets the GLsync previously set via gdk_gl_texture_builder_set_sync().

Returns

the GLSync

pub fn set_sync(self, sync: Option<GLsync>) -> Self

Sets the GLSync object to use for the texture.

GTK will wait on this object before using the created Texture.

The destroy function that is passed to build() is responsible for freeing the sync object when it is no longer needed. The texture builder does not destroy it and it is the callers responsibility to make sure it doesn’t leak.

sync

the GLSync object

Trait Implementations

impl Clone for GLTextureBuilder

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GLTextureBuilder

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

Formats the value using the given formatter.

impl Default for GLTextureBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Display for GLTextureBuilder

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

Formats the value using the given formatter.

impl HasParamSpec for GLTextureBuilder

type ParamSpec = ParamSpecObject

type SetValue = GLTextureBuilder

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GLTextureBuilder

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

Feeds this value into the given Hasher.

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 GLTextureBuilder

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for GLTextureBuilder

type Parent = Object

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for GLTextureBuilder

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GLTextureBuilder

impl Send for GLTextureBuilder

impl Sync for GLTextureBuilder