Enum MemoryFormat 

#[non_exhaustive]
pub enum MemoryFormat {
    B8g8r8a8Premultiplied,
    A8r8g8b8Premultiplied,
    R8g8b8a8Premultiplied,
    B8g8r8a8,
    A8r8g8b8,
    R8g8b8a8,
    A8b8g8r8,
    R8g8b8,
    B8g8r8,
    R16g16b16,
    R16g16b16a16Premultiplied,
    R16g16b16a16,
    R16g16b16Float,
    R16g16b16a16FloatPremultiplied,
    R16g16b16a16Float,
    R32g32b32Float,
    R32g32b32a32FloatPremultiplied,
    R32g32b32a32Float,
    G8a8Premultiplied,
    G8a8,
    G8,
    G16a16Premultiplied,
    G16a16,
    G16,
    A8,
    A16,
    A16Float,
    A32Float,
    A8b8g8r8Premultiplied,
    B8g8r8x8,
    X8r8g8b8,
    R8g8b8x8,
    X8b8g8r8,
    G8B8r8420,
    G8R8b8420,
    G8B8r8422,
    G8R8b8422,
    G8B8r8444,
    G8R8b8444,
    G10x6B10x6r10x6420,
    G12x4B12x4r12x4420,
    G16B16r16420,
    G8B8R8410,
    G8R8B8410,
    G8B8R8411,
    G8R8B8411,
    G8B8R8420,
    G8R8B8420,
    G8B8R8422,
    G8R8B8422,
    G8B8R8444,
    G8R8B8444,
    G8b8g8r8422,
    G8r8g8b8422,
    R8g8b8g8422,
    B8g8r8g8422,
    X6g10X6b10X6r10420,
    X6g10X6b10X6r10422,
    X6g10X6b10X6r10444,
    X4g12X4b12X4r12420,
    X4g12X4b12X4r12422,
    X4g12X4b12X4r12444,
    G16B16R16420,
    G16B16R16422,
    G16B16R16444,
    Argb2101010Premultiplied,
    Argb2101010,
    Xrgb2101010,
    Abgr2101010Premultiplied,
    Abgr2101010,
    Xbgr2101010,
}

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.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

B8g8r8a8Premultiplied

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

A8r8g8b8Premultiplied

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

R8g8b8a8Premultiplied

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

B8g8r8a8

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

A8r8g8b8

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

R8g8b8a8

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

A8b8g8r8

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

R8g8b8

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

B8g8r8

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

R16g16b16

Available on crate feature v4_6 only.

3 guint16 values; for red, green, blue.

R16g16b16a16Premultiplied

Available on crate feature v4_6 only.

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

R16g16b16a16

Available on crate feature v4_6 only.

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

R16g16b16Float

Available on crate feature v4_6 only.

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

R16g16b16a16FloatPremultiplied

Available on crate feature v4_6 only.

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

R16g16b16a16Float

Available on crate feature v4_6 only.

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

R32g32b32Float

Available on crate feature v4_6 only.

3 float values; for red, green, blue.

R32g32b32a32FloatPremultiplied

Available on crate feature v4_6 only.

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

R32g32b32a32Float

Available on crate feature v4_6 only.

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

G8a8Premultiplied

Available on crate feature v4_12 only.

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

G8a8

Available on crate feature v4_12 only.

2 bytes; for grayscale, alpha.

G8

Available on crate feature v4_12 only.

One byte; for grayscale. The data is opaque.

G16a16Premultiplied

Available on crate feature v4_12 only.

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

G16a16

Available on crate feature v4_12 only.

2 guint16 values; for grayscale, alpha.

G16

Available on crate feature v4_12 only.

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

A8

Available on crate feature v4_12 only.

One byte; for alpha.

A16

Available on crate feature v4_12 only.

One guint16 value; for alpha.

A16Float

Available on crate feature v4_12 only.

One half-float value; for alpha.

A32Float

Available on crate feature v4_12 only.

One float value; for alpha.

A8b8g8r8Premultiplied

Available on crate feature v4_14 only.

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

B8g8r8x8

Available on crate feature v4_14 only.

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

X8r8g8b8

Available on crate feature v4_14 only.

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

R8g8b8x8

Available on crate feature v4_14 only.

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

X8b8g8r8

Available on crate feature v4_14 only.

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

G8B8r8420

Available on crate feature v4_20 only.

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”.

G8R8b8420

Available on crate feature v4_20 only.

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”.

G8B8r8422

Available on crate feature v4_20 only.

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”.

G8R8b8422

Available on crate feature v4_20 only.

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”.

G8B8r8444

Available on crate feature v4_20 only.

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”.

G8R8b8444

Available on crate feature v4_20 only.

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”.

G10x6B10x6r10x6420

Available on crate feature v4_20 only.

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”.

G12x4B12x4r12x4420

Available on crate feature v4_20 only.

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”.

G16B16r16420

Available on crate feature v4_20 only.

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”.

G8B8R8410

Available on crate feature v4_20 only.

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”.

G8R8B8410

Available on crate feature v4_20 only.

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”.

G8B8R8411

Available on crate feature v4_20 only.

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”.

G8R8B8411

Available on crate feature v4_20 only.

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”.

G8B8R8420

Available on crate feature v4_20 only.

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”.

G8R8B8420

Available on crate feature v4_20 only.

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”.

G8B8R8422

Available on crate feature v4_20 only.

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”.

G8R8B8422

Available on crate feature v4_20 only.

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”.

G8B8R8444

Available on crate feature v4_20 only.

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”.

G8R8B8444

Available on crate feature v4_20 only.

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”.

G8b8g8r8422

Available on crate feature v4_20 only.

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”.

G8r8g8b8422

Available on crate feature v4_20 only.

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”.

R8g8b8g8422

Available on crate feature v4_20 only.

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”.

B8g8r8g8422

Available on crate feature v4_20 only.

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”.

X6g10X6b10X6r10420

Available on crate feature v4_20 only.

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”.

X6g10X6b10X6r10422

Available on crate feature v4_20 only.

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”.

X6g10X6b10X6r10444

Available on crate feature v4_20 only.

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”.

X4g12X4b12X4r12420

Available on crate feature v4_20 only.

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”.

X4g12X4b12X4r12422

Available on crate feature v4_20 only.

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”.

X4g12X4b12X4r12444

Available on crate feature v4_20 only.

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”.

G16B16R16420

Available on crate feature v4_20 only.

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”.

G16B16R16422

Available on crate feature v4_20 only.

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”.

G16B16R16444

Available on crate feature v4_20 only.

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”.

Argb2101010Premultiplied

Available on crate feature v4_24 only.

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.

Argb2101010

Available on crate feature v4_24 only.

4 bytes per pixel

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

Xrgb2101010

Available on crate feature v4_24 only.

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.

Abgr2101010Premultiplied

Abgr2101010

Available on crate feature v4_24 only.

4 bytes per pixel

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

Xbgr2101010

Available on crate feature v4_24 only.

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.

Trait Implementations

impl Clone for MemoryFormat

fn clone(&self) -> MemoryFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryFormat

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

Formats the value using the given formatter.

impl From<MemoryFormat> for Value

fn from(v: MemoryFormat) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for MemoryFormat

type Checker = GenericValueTypeChecker<MemoryFormat>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for MemoryFormat

type ParamSpec = ParamSpecEnum

type SetValue = MemoryFormat

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

type BuilderFn = fn(&str, MemoryFormat) -> ParamSpecEnumBuilder<'_, MemoryFormat>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MemoryFormat

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

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 MemoryFormat

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

This method returns an Ordering between self and other.

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 PartialEq for MemoryFormat

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

Tests for self and other values to be equal, and is used by ==.

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 PartialOrd for MemoryFormat

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

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

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 MemoryFormat

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for MemoryFormat

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for MemoryFormat

type Type = MemoryFormat

Type to get the Type from.

impl Copy for MemoryFormat

impl Eq for MemoryFormat

impl StructuralPartialEq for MemoryFormat