Enumeration (GI Enum)

Gdk-4.0GdkMemoryFormat

Describes formats that image data can have in memory.

It describes formats by listing the contents of the memory passed to it. So GDK_MEMORY_A8R8G8B8 will be 1 byte (8 bits) of alpha, followed by a byte each of red, green and blue. It is not endian-dependent, so CAIRO_FORMAT_ARGB32 is represented by different GdkMemoryFormats on architectures with different endiannesses.

A note on naming

The format names are roughly modelled after VkFormat. A name follows GDK_MEMORY_<CHANNELS>_<DATA_TYPE>_<SUBSAMPLING> <PREMULTIPLIED> where CHANNELS describe how the RGBA channels are layed out in memory, with an X denoting padding. DATA_TYPE is unsigned normalized integer if not present, or otherwise FLOAT. The optional SUBSAMPLING defines the subsampling method used. The optional ENDIAN term describes the endianness if it is not host-endian. Finally, an optional PREMULTIPLIED term indicates that the color channels are premultiplied with the alpha value, if it is omitted, the data is not premultiplied or there is no alpha channel.

The CHANNELS are given as a list of planes seperated by underscores where each plane is split into multiple elements describing one or more bytes of memory. Each element is given as the list of channels folowed by the amount of bits taken up.

So the fictional format RGB565_A8_PREMULTIPLIED would describe a format with 2 planes where the first plane is an unsigned 16 bit integer containing the RGB channels with 5, 6, and 5 bits respectively while the 2nd plane contains the alpha channel as an unisnged 8bit integer.

Index

Enumeration Members

A16: number

One guint16 value; for alpha.

A16_FLOAT: number

One half-float value; for alpha.

A32_FLOAT: number

One float value; for alpha.

A8: number

One byte; for alpha.

A8B8G8R8: number

4 bytes; for alpha, blue, green, red.

A8B8G8R8_PREMULTIPLIED: number

4 bytes; for alpha, blue, green, red, The color values are premultiplied with the alpha value.

A8R8G8B8: number

4 bytes; for alpha, red, green, blue.

A8R8G8B8_PREMULTIPLIED: number

4 bytes; for alpha, red, green, blue. The color values are premultiplied with the alpha value.

ABGR2101010: number

4 bytes per pixel

Bits 31..30 contain the alpha channel, 29..20 blue, 19..10 green and 9..0 red.

ABGR2101010_PREMULTIPLIED: number
ARGB2101010: number

4 bytes per pixel

Bits 31..30 contain the alpha channel, 29..20 red, 19..10 green and 9..0 blue.

ARGB2101010_PREMULTIPLIED: number

4 bytes per pixel

Bits 31..30 contain the alpha channel, 29..20 red, 19..10 green and 9..0 blue.

The color values are premultiplied with the alpha value.

B8G8R8: number

3 bytes; for blue, green, red. The data is opaque.

B8G8R8A8: number

4 bytes; for blue, green, red, alpha.

B8G8R8A8_PREMULTIPLIED: number

4 bytes; for blue, green, red, alpha. The color values are premultiplied with the alpha value.

B8G8R8G8_422: number

Packed format with subsampled channels.

Each channel is a 8 bit integer. The red and blue/chroma channels are subsampled and interleaved with the green/luma channel.

Each block contains 2 pixels, so the width must be a multiple of 2.

Commonly known by the fourcc "UYVY".

B8G8R8X8: number

4 bytes; for blue, green, red, unused.

G10X6_B10X6R10X6_420: number

Multiplane format with 2 planes.

Each channel is a 16 bit integer, but only the highest 10 bits are used.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cr followed by Cb. This format is not subsampled.

Commonly known by the fourcc "P010".

G12X4_B12X4R12X4_420: number

Multiplane format with 2 planes.

Each channel is a 16 bit integer, but only the highest 10 bits are used.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cr followed by Cb. This format is not subsampled.

Commonly known by the fourcc "P012".

G16: number

One guint16 value; for grayscale. The data is opaque.

G16_B16_R16_420: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in both the X and Y direction. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in both the X and Y direction. It is mapped into the 1st channel.

Commonly known by the fourcc "S016".

G16_B16_R16_422: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in the X direction. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in the X direction. It is mapped into the 1st channel.

Commonly known by the fourcc "S216".

G16_B16_R16_444: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. It is mapped into the 1st channel.

Commonly known by the fourcc "S416".

G16_B16R16_420: number

Multiplane format with 2 planes.

Each channel is a 16 bit integer.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cr followed by Cb. This format is not subsampled.

Commonly known by the fourcc "P016".

G16A16: number

2 guint16 values; for grayscale, alpha.

G16A16_PREMULTIPLIED: number

2 guint16 values; for grayscale, alpha. The color values are premultiplied with the alpha value.

G8: number

One byte; for grayscale. The data is opaque.

G8_B8_R8_410: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in both the X and Y direction with 4:1 ratio. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in both the X and Y direction with 4:1 ratio. It is mapped into the 1st channel.

Commonly known by the fourcc "YUV410".

G8_B8_R8_411: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in the X direction with 4:1 ratio. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in the X direction with 4:1 ratio. It is mapped into the 1st channel.

Commonly known by the fourcc "YUV411".

G8_B8_R8_420: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in both the X and Y direction. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in both the X and Y direction. It is mapped into the 1st channel.

Commonly known by the fourcc "YUV420".

G8_B8_R8_422: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in the X direction. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in the X direction. It is mapped into the 1st channel.

Commonly known by the fourcc "YUV422".

G8_B8_R8_444: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. It is mapped into the 1st channel.

Commonly known by the fourcc "YUV444".

G8_B8R8_420: number

Multiplane format with 2 planes.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cb followed by Cr. Subsampled in both the X and Y direction.

Commonly known by the fourcc "NV12".

G8_B8R8_422: number

Multiplane format with 2 planes.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cb followed by Cr. Subsampled in the X direction.

Commonly known by the fourcc "NV16".

G8_B8R8_444: number

Multiplane format with 2 planes.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cb followed by Cr. This format is not subsampled.

Commonly known by the fourcc "NV24".

G8_R8_B8_410: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the second chroma chanel. Subsampled in both the X and Y direction with 4:1 ratio. It is mapped into the 1st channel.

The third plane usually contains the first chroma channel. Subsampled in both the X and Y direction with 4:1 ratio. It is mapped into the 3rd channel.

Commonly known by the fourcc "YVU410".

G8_R8_B8_411: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the second chroma chanel. Subsampled in the X direction with 4:1 ratio. It is mapped into the 1st channel.

The third plane usually contains the first chroma channel. Subsampled in the X direction with 4:1 ratio. It is mapped into the 3rd channel.

Commonly known by the fourcc "YVU411".

G8_R8_B8_420: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the second chroma chanel. Subsampled in both the X and Y direction. It is mapped into the 1st channel.

The third plane usually contains the first chroma channel. Subsampled in both the X and Y direction. It is mapped into the 3rd channel.

Commonly known by the fourcc "YVU420".

G8_R8_B8_422: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the second chroma chanel. Subsampled in the X direction. It is mapped into the 1st channel.

The third plane usually contains the first chroma channel. Subsampled in the X direction. It is mapped into the 3rd channel.

Commonly known by the fourcc "YVU422".

G8_R8_B8_444: number

Multiplane format with 3 planes.

Each channel is a 8 bit integer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the second chroma chanel. Subsampled in the X direction. It is mapped into the 1st channel.

The third plane usually contains the first chroma channel. Subsampled in the X direction. It is mapped into the 3rd channel.

Commonly known by the fourcc "YVU444".

G8_R8B8_420: number

Multiplane format with 2 planes.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cr followed by Cb. Subsampled in both the X and Y direction.

Commonly known by the fourcc "NV21".

G8_R8B8_422: number

Multiplane format with 2 planes.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cr followed by Cb. Subsampled in the X direction.

Commonly known by the fourcc "NV61".

G8_R8B8_444: number

Multiplane format with 2 planes.

The first plane contains the first channel, usually containing luma values. The second plane with interleaved chroma values, Cr followed by Cb. This format is not subsampled.

Commonly known by the fourcc "NV42".

G8A8: number

2 bytes; for grayscale, alpha.

G8A8_PREMULTIPLIED: number

2 bytes; for grayscale, alpha. The color values are premultiplied with the alpha value.

G8B8G8R8_422: number

Packed format with subsampled channels.

Each channel is a 8 bit integer. The red and blue/chroma channels are subsampled and interleaved with the green/luma channel.

Each block contains 2 pixels, so the width must be a multiple of 2.

Commonly known by the fourcc "YUYV".

G8R8G8B8_422: number

Packed format with subsampled channels.

Each channel is a 8 bit integer. The red and blue/chroma channels are subsampled and interleaved with the green/luma channel.

Each block contains 2 pixels, so the width must be a multiple of 2.

Commonly known by the fourcc "YVYU".

N_FORMATS: number

The number of formats. This value will change as more formats get added, so do not rely on its concrete integer.

R16G16B16: number

3 guint16 values; for red, green, blue.

R16G16B16_FLOAT: number

3 half-float values; for red, green, blue. The data is opaque.

R16G16B16A16: number

4 guint16 values; for red, green, blue, alpha.

R16G16B16A16_FLOAT: number

4 half-float values; for red, green, blue and alpha.

R16G16B16A16_FLOAT_PREMULTIPLIED: number

4 half-float values; for red, green, blue and alpha. The color values are premultiplied with the alpha value.

R16G16B16A16_PREMULTIPLIED: number

4 guint16 values; for red, green, blue, alpha. The color values are premultiplied with the alpha value.

R32G32B32_FLOAT: number

3 float values; for red, green, blue.

R32G32B32A32_FLOAT: number

4 float values; for red, green, blue and alpha.

R32G32B32A32_FLOAT_PREMULTIPLIED: number

4 float values; for red, green, blue and alpha. The color values are premultiplied with the alpha value.

R8G8B8: number

3 bytes; for red, green, blue. The data is opaque.

R8G8B8A8: number

4 bytes; for red, green, blue, alpha.

R8G8B8A8_PREMULTIPLIED: number

4 bytes; for red, green, blue, alpha The color values are premultiplied with the alpha value.

R8G8B8G8_422: number

Packed format with subsampled channels.

Each channel is a 8 bit integer. The red and blue/chroma channels are subsampled and interleaved with the green/luma channel.

Each block contains 2 pixels, so the width must be a multiple of 2.

Commonly known by the fourcc "VYUY".

R8G8B8X8: number

4 bytes; for red, green, blue, unused.

X4G12_X4B12_X4R12_420: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

Only the 12 lower bits are used. The remaining ones must be set to 0 by the producer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in both the X and Y direction. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in both the X and Y direction. It is mapped into the 1st channel.

Commonly known by the fourcc "S012".

X4G12_X4B12_X4R12_422: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

Only the 12 lower bits are used. The remaining ones must be set to 0 by the producer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in the X direction. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in the X direction. It is mapped into the 1st channel.

Commonly known by the fourcc "S212".

X4G12_X4B12_X4R12_444: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

Only the 12 lower bits are used. The remaining ones must be set to 0 by the producer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. It is mapped into the 1st channel.

Commonly known by the fourcc "S412".

X6G10_X6B10_X6R10_420: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

Only the 10 lower bits are used. The remaining ones must be set to 0 by the producer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in both the X and Y direction. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in both the X and Y direction. It is mapped into the 1st channel.

Commonly known by the fourcc "S010".

X6G10_X6B10_X6R10_422: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

Only the 10 lower bits are used. The remaining ones must be set to 0 by the producer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. Subsampled in the X direction. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. Subsampled in the X direction. It is mapped into the 1st channel.

Commonly known by the fourcc "S210".

X6G10_X6B10_X6R10_444: number

Multiplane format with 3 planes.

Each channel is a 16 bit integer.

Only the 10 lower bits are used. The remaining ones must be set to 0 by the producer.

The first plane usually contains the luma channel. It is mapped into the 2nd channel.

The second plane usually contains the first chroma chanel. It is mapped into the 3rd channel.

The third plane usually contains the second chroma channel. It is mapped into the 1st channel.

Commonly known by the fourcc "S410".

X8B8G8R8: number

4 bytes; for unused, blue, green, red.

X8R8G8B8: number

4 bytes; for unused, red, green, blue.

XBGR2101010: number

4 bytes per pixel

Bits 31..30 are padding, bits 29..20 contain blue, 19..10 green and 9..0 red.

The format is opaque.

XRGB2101010: number

4 bytes per pixel

Bits 31..30 are padding, bits 29..20 contain red, 19..10 green and 9..0 blue.

The format is opaque.

Variables

$gtype