Gdk.Texture¶

Subclasses:: Gdk.GLTexture, Gdk.MemoryTexture

Methods¶

Inherited:: GObject.Object (37), Gdk.Paintable (10), Gio.Icon (6), Gio.LoadableIcon (3)
Structs:: GObject.ObjectClass (5)

class	`new_for_pixbuf` (pixbuf)
class	`new_from_bytes` (bytes)
class	`new_from_file` (file)
class	`new_from_filename` (path)
class	`new_from_resource` (resource_path)
	`download` (data, stride)
	`get_format` ()
	`get_height` ()
	`get_width` ()
	`save_to_png` (filename)
	`save_to_png_bytes` ()
	`save_to_tiff` (filename)
	`save_to_tiff_bytes` ()

Virtual Methods¶

Inherited:: GObject.Object (7), Gdk.Paintable (6), Gio.Icon (4), Gio.LoadableIcon (3)

Properties¶

Name	Type	Flags	Short Description
`height`	`int`	r/w/co/en
`width`	`int`	r/w/co/en

Signals¶

Inherited:: GObject.Object (1), Gdk.Paintable (2)

Fields¶

Inherited:: GObject.Object (1), Gdk.Paintable (2)

Class Details¶

class Gdk.Texture(**kwargs)¶

Bases:: GObject.Object, Gdk.Paintable, Gio.Icon, Gio.LoadableIcon
Abstract:: Yes
Structure:: Gdk.TextureClass

GdkTexture 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 GdkTexture objects from a [class`GdkPixbuf`.Pixbuf], or from bytes stored in memory, a file, or a [struct`Gio`.Resource].

The ownership of the pixel data is transferred to the GdkTexture instance; you can only make a copy of it, via [method`Gdk`.Texture.download].

GdkTexture is an immutable object: That means you cannot change anything about it other than increasing the reference count via [method`GObject`.Object.ref], and consequently, it is a thread-safe object.

classmethod new_for_pixbuf(pixbuf)[source]¶

Parameters:: pixbuf (GdkPixbuf.Pixbuf) – a GdkPixbuf
Returns:: a new GdkTexture
Return type:: Gdk.Texture

Creates a new texture object representing the GdkPixbuf.

This function is threadsafe, so that you can e.g. use Gio.Task and [method`Gio`.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

classmethod new_from_bytes(bytes)[source]¶

Parameters:: bytes (GLib.Bytes) – a GBytes containing the data to load
Raises:: GLib.Error
Returns:: A newly-created GdkTexture
Return type:: Gdk.Texture

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 Gio.Task and [method`Gio`.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

New in version 4.6.

classmethod new_from_file(file)[source]¶

Parameters:: file (Gio.File) – GFile to load
Raises:: GLib.Error
Returns:: A newly-created GdkTexture
Return type:: Gdk.Texture

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 Gio.Task and [method`Gio`.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

classmethod new_from_filename(path)[source]¶

Parameters:: path (str) – the filename to load
Raises:: GLib.Error
Returns:: A newly-created GdkTexture
Return type:: Gdk.Texture

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 Gio.Task and [method`Gio`.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

New in version 4.6.

classmethod new_from_resource(resource_path)[source]¶

Parameters:: resource_path (str) – the path of the resource file
Returns:: A newly-created GdkTexture
Return type:: Gdk.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 [ctor`Gdk`.Texture.new_from_file] to load it.

This function is threadsafe, so that you can e.g. use Gio.Task and [method`Gio`.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

download(data, stride)[source]¶

Parameters:

data (bytes) – pointer to enough memory to be filled with the downloaded data of self
stride (int) – rowstride in bytes

Downloads the self into local memory.

This may be an expensive operation, as the actual texture data may reside on a GPU or on a remote display server.

The data format of the downloaded data is equivalent to cairo.Format.ARGB32, so every downloaded pixel requires 4 bytes of memory.

Downloading a texture into a Cairo image surface: ``c surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32,

gdk_texture_get_width (texture), gdk_texture_get_height (texture));

gdk_texture_download (texture,: cairo_image_surface_get_data (surface), cairo_image_surface_get_stride (surface));

cairo_surface_mark_dirty (surface); ``

For more flexible download capabilites, see [struct`Gdk`.TextureDownloader].

get_format()[source]¶

Returns:: the preferred format for the texture’s data
Return type:: Gdk.MemoryFormat

Gets the memory format most closely associated with the data of the texture.

Note that it may not be an exact match for texture data stored on the GPU or with compression.

The format can give an indication about the bit depth and opacity of the texture and is useful to determine the best format for downloading the texture.

New in version 4.10.

get_height()[source]¶

Returns:: the height of the GdkTexture
Return type:: int

Returns the height of the self, in pixels.

get_width()[source]¶

Returns:: the width of the GdkTexture
Return type:: int

Returns the width of self, in pixels.

save_to_png(filename)[source]¶

Parameters:: filename (str) – the filename to store to
Returns:: True if saving succeeded, False on failure.
Return type:: bool

Store the given self to the filename as a PNG file.

This is a utility function intended for debugging and testing. If you want more control over formats, proper error handling or want to store to a [iface`Gio`.File] or other location, you might want to use [method`Gdk`.Texture.save_to_png_bytes] or look into the gdk-pixbuf library.

save_to_png_bytes()[source]¶

Returns:: a newly allocated GBytes containing PNG data
Return type:: GLib.Bytes

Store the given self in memory as a PNG file.

Use [ctor`Gdk`.Texture.new_from_bytes] to read it back.

If you want to serialize a texture, this is a convenient and portable way to do that.

If you need more control over the generated image, such as attaching metadata, you should look into an image handling library such as the gdk-pixbuf library.

If you are dealing with high dynamic range float data, you might also want to consider [method`Gdk`.Texture.save_to_tiff_bytes] instead.

New in version 4.6.

save_to_tiff(filename)[source]¶

Parameters:: filename (str) – the filename to store to
Returns:: True if saving succeeded, False on failure.
Return type:: bool

Store the given self to the filename as a TIFF file.

GTK will attempt to store data without loss.

New in version 4.6.

save_to_tiff_bytes()[source]¶

Returns:: a newly allocated GBytes containing TIFF data
Return type:: GLib.Bytes

Store the given self in memory as a TIFF file.

Use [ctor`Gdk`.Texture.new_from_bytes] to read it back.

This function is intended to store a representation of the texture’s data that is as accurate as possible. This is particularly relevant when working with high dynamic range images and floating-point texture data.

If that is not your concern and you are interested in a smaller size and a more portable format, you might want to use [method`Gdk`.Texture.save_to_png_bytes].

New in version 4.6.

Property Details¶

Gdk.Texture.props.height¶

Name:: height
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

The height of the texture, in pixels.

Gdk.Texture.props.width¶

Name:: width
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

The width of the texture, in pixels.