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,
}

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

Its naming is modelled after VkFormat for details).

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.

Trait Implementations

impl Clone for MemoryFormat

fn clone(&self) -> MemoryFormat

Returns a copy 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