Struct Surface 

pub struct Surface<'a, const COMPONENTS: usize> {
    pub data: &'a [u8],
    pub width: u32,
    pub height: u32,
    pub stride: u32,
}

Describes a 2D image to block-compress.

COMPONENTS is the number of bytes per pixel in the source data. This determines the expected tightly-packed stride (width * COMPONENTS) and is used to validate that data is large enough. The actual channel layout depends on which encoder consumes the surface — see the individual format modules for details.

Available surface type aliases

Alias	COMPONENTS	Layout	Used by
RSurface	1	R8 (1 byte/pixel)	bc4
RgSurface	2	R8 G8 interleaved (2 bytes/pixel)	bc5
RgbaSurface	4	R8 G8 B8 A8 interleaved (4 bytes/pixel)	bc1, bc3, bc7, astc, etc1
Rgba16Surface	8	R16 G16 B16 A16 interleaved (8 bytes/pixel)	bc6h

Fields

data: &'a [u8]

The raw pixel data for the image.

The byte interpretation depends on the encoder that consumes this surface. For most formats, each byte is one u8 channel sample. For bc6h, every two bytes form a little-endian u16 channel sample.

The data does not need to be tightly packed, but if it isn’t, stride must differ from width * COMPONENTS.

Expected to be at least stride * height bytes.

width: u32

The width of the image in texels.

height: u32

The height of the image in texels.

stride: u32

The stride between rows of the image, in bytes.

For tightly-packed data this is width * COMPONENTS.

Implementations

impl<'a, const COMPONENTS: usize> Surface<'a, COMPONENTS>

pub fn new(data: &'a [u8], width: u32, height: u32, stride: u32) -> Self

Creates a new surface, validating that dimensions fit within i32 (required by the underlying C API) and that data is large enough for the given stride and height.

Panics

Panics if width, height, or stride exceed i32::MAX, or if data.len() is less than stride * height.

Trait Implementations

impl<'a, const COMPONENTS: usize> Clone for Surface<'a, COMPONENTS>

fn clone(&self) -> Surface<'a, COMPONENTS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, const COMPONENTS: usize> Debug for Surface<'a, COMPONENTS>

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

Formats the value using the given formatter.

impl<'a, const COMPONENTS: usize> Copy for Surface<'a, COMPONENTS>