Struct SurfaceMetadata 

pub struct SurfaceMetadata {
    pub backend: BackendKind,
    pub residency: SurfaceResidency,
    pub dimensions: (u32, u32),
    pub pixel_format: PixelFormat,
    pub pitch_bytes: usize,
    pub byte_offset: usize,
}

Backend-neutral metadata for a decoded accelerator surface.

Fields

backend: BackendKind

Backend that owns or produced the surface.

residency: SurfaceResidency

Memory residency of the surface bytes.

dimensions: (u32, u32)

Surface dimensions in pixels.

pixel_format: PixelFormat

Pixel format stored by the surface.

pitch_bytes: usize

Number of bytes between consecutive rows.

byte_offset: usize

Byte offset into the backend allocation.

Implementations

impl SurfaceMetadata

pub const fn new( backend: BackendKind, residency: SurfaceResidency, dimensions: (u32, u32), pixel_format: PixelFormat, pitch_bytes: usize, ) -> Self

Construct tight or explicitly pitched surface metadata with no byte offset.

pub const fn with_byte_offset(self, byte_offset: usize) -> Self

Return metadata adjusted to start at byte_offset inside an allocation.

pub const fn byte_len(self) -> usize

Number of bytes represented by the surface.

Trait Implementations

impl Clone for SurfaceMetadata

fn clone(&self) -> SurfaceMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SurfaceMetadata

impl Debug for SurfaceMetadata

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

Formats the value using the given formatter.

impl Eq for SurfaceMetadata

impl Hash for SurfaceMetadata

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

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SurfaceMetadata