GdkPixdata.Pixdata

Fields

Name	Type	Access	Description
height	int	r/w	Height of the image in pixels
length	int	r/w	less than 1 to disable length checks, otherwise GDK_PIXDATA_HEADER_LENGTH plus the length of pixel_data
magic	int	r/w	magic number. A valid GdkPixdata structure must have GDK_PIXBUF_MAGIC_NUMBER here
pixdata_type	int	r/w	information about colorspace, sample width and encoding, in a GdkPixdataType
pixel_data	bytes	r/w	width x height pixels, encoded according to pixdata_type and rowstride
rowstride	int	r/w	Distance in bytes between rows
width	int	r/w	Width of the image in pixels

Methods

	deserialize (stream)
	serialize ()
	to_csource (name, dump_type)

Details

class GdkPixdata.Pixdata

A pixel buffer suitable for serialization and streaming.

Using GdkPixdata, images can be compiled into an application, making it unnecessary to refer to external image files at runtime.

GdkPixbuf includes a utility named gdk-pixbuf-csource, which can be used to convert image files into GdkPixdata structures suitable for inclusion in C sources. To convert the GdkPixdata structures back into a GdkPixbuf, use gdk_pixbuf_from_pixdata().

Deprecated since version 2.32: GdkPixdata should not be used any more. GResource should be used to save the original compressed images inside the program’s binary

deserialize(stream)

Parameters:

stream (bytes) – stream of bytes containing a serialized GdkPixdata.Pixdata structure.

Raises:

GLib.Error

Returns:

Upon successful deserialization TRUE is returned, FALSE otherwise.

Return type:

bool

Deserializes (reconstruct) a GdkPixdata.Pixdata structure from a byte stream.

The byte stream consists of a straightforward writeout of the GdkPixdata fields in network byte order, plus the pixel_data bytes the structure points to.

The pixdata contents are reconstructed byte by byte and are checked for validity.

This function may fail with GDK_PIXBUF_ERROR_CORRUPT_IMAGE or GDK_PIXBUF_ERROR_UNKNOWN_TYPE.

Deprecated since version 2.32: Use GResource instead.

serialize()

Returns:

A newly-allocated string containing the serialized GdkPixdata.Pixdata structure.

Return type:

bytes

Serializes a GdkPixdata.Pixdata structure into a byte stream. The byte stream consists of a straightforward writeout of the GdkPixdata.Pixdata fields in network byte order, plus the pixel_data bytes the structure points to.

Deprecated since version 2.32: Use Gio.Resource instead.

to_csource(name, dump_type)

Parameters:

• name (str) – used for naming generated data structures or macros

• dump_type (GdkPixdata.PixdataDumpType) – the kind of C source to be generated

Returns:

a newly-allocated string buffer containing the C source form of pixdata.

Return type:

GLib.String

Generates C source code suitable for compiling images directly into programs.

GdkPixbuf.Pixbuf ships with a program called gdk-pixbuf-csource, which offers a command line interface to this function.

Deprecated since version 2.32: Use Gio.Resource instead.