Struct Texture

pub struct Texture { /* private fields */ }

Texture is the basic element used to refer to pixel data.

It is primarily meant for pixel data that will not change over multiple frames, and will be used for a long time.

There are various ways to create Texture objects from a gdk_pixbuf::Pixbuf, or from bytes stored in memory, a file, or a Gio::Resource.

The ownership of the pixel data is transferred to the Texture instance; you can only make a copy of it, via TextureExtManual::download().

Texture is an immutable object: That means you cannot change anything about it other than increasing the reference count via GObject::Object::ref(), and consequently, it is a threadsafe object.

GDK provides a number of threadsafe texture loading functions: from_resource(), from_bytes(), from_file(), from_filename(), for_pixbuf(). Note that these are meant for loading icons and resources that are shipped with the toolkit or application. It is recommended that you use a dedicated image loading framework such as glycin, if you need to load untrusted image data.

This is an Abstract Base Class, you cannot instantiate it.

Properties

color-state

The color state of the texture.

Readable | Writeable | Construct Only

height

The height of the texture, in pixels.

Readable | Writeable | Construct Only

width

The width of the texture, in pixels.

Readable | Writeable | Construct Only

Implements

TextureExt, PaintableExt, gio::prelude::IconExt, gio::prelude::LoadableIconExt, TextureExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl Texture

pub const NONE: Option<&'static Texture> = None

pub fn for_pixbuf(pixbuf: &Pixbuf) -> Texture

Creates a new texture object representing the gdk_pixbuf::Pixbuf.

This function is threadsafe, so that you can e.g. use GTask and Gio::Task::run_in_thread() to avoid blocking the main thread while loading a big image.

pixbuf

a gdk_pixbuf::Pixbuf

Returns

a new Texture

pub fn from_bytes(bytes: &Bytes) -> Result<Texture, Error>

Available on crate feature v4_6 only.

Creates a new texture by loading an image from memory,

The file format is detected automatically. The supported formats are PNG, JPEG and TIFF, though more formats might be available.

If None is returned, then @error will be set.

This function is threadsafe, so that you can e.g. use GTask and Gio::Task::run_in_thread() to avoid blocking the main thread while loading a big image.

bytes

a GBytes containing the data to load

Returns

A newly-created Texture

pub fn from_file(file: &impl IsA<File>) -> Result<Texture, Error>

Creates a new texture by loading an image from a file.

The file format is detected automatically. The supported formats are PNG, JPEG and TIFF, though more formats might be available.

If None is returned, then @error will be set.

This function is threadsafe, so that you can e.g. use GTask and Gio::Task::run_in_thread() to avoid blocking the main thread while loading a big image.

file

GFile to load

Returns

A newly-created Texture

pub fn from_filename(path: impl AsRef<Path>) -> Result<Texture, Error>

Available on crate feature v4_6 only.

Creates a new texture by loading an image from a file.

The file format is detected automatically. The supported formats are PNG, JPEG and TIFF, though more formats might be available.

If None is returned, then @error will be set.

This function is threadsafe, so that you can e.g. use GTask and Gio::Task::run_in_thread() to avoid blocking the main thread while loading a big image.

path

the filename to load

Returns

A newly-created Texture

pub fn from_resource(resource_path: &str) -> Texture

Creates a new texture by loading an image from a resource.

The file format is detected automatically. The supported formats are PNG and JPEG, though more formats might be available.

It is a fatal error if @resource_path does not specify a valid image resource and the program will abort if that happens. If you are unsure about the validity of a resource, use from_file() to load it.

This function is threadsafe, so that you can e.g. use GTask and Gio::Task::run_in_thread() to avoid blocking the main thread while loading a big image.

resource_path

the path of the resource file

Returns

A newly-created Texture

Trait Implementations

impl Clone for Texture

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 Texture

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

Formats the value using the given formatter.

impl HasParamSpec for Texture

type ParamSpec = ParamSpecObject

type SetValue = Texture

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Texture

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 Texture

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 Texture

type Parent = Object

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

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 Texture

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 Texture

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Texture

impl IsA<Icon> for Texture

impl IsA<LoadableIcon> for Texture

impl IsA<Paintable> for Texture

impl IsA<Texture> for DmabufTexture

Available on crate feature v4_14 only.

impl IsA<Texture> for GLTexture

impl IsA<Texture> for MemoryTexture

impl Send for Texture

impl Sync for Texture