Struct wgpu::ImageDataLayout

#[repr(C)]
pub struct ImageDataLayout {
    pub offset: u64,
    pub bytes_per_row: Option<NonZeroU32>,
    pub rows_per_image: Option<NonZeroU32>,
}

Layout of a texture in a buffer’s memory.

The bytes per row and rows per image can be hard to figure out so here are some examples:

Resolution	Format	Bytes per block	Pixels per block	Bytes per row	Rows per image
256x256	RGBA8	4	1 * 1 * 1	256 * 4 = Some(1024)	None
32x16x8	RGBA8	4	1 * 1 * 1	32 * 4 = 128 padded to 256 = Some(256)	None
256x256	BC3	16	4 * 4 * 1	16 * (256 / 4) = 1024 = Some(1024)	None
64x64x8	BC3	16	4 * 4 * 1	16 * (64 / 4) = 256 = Some(256)	64 / 4 = 16 = Some(16)

Fields

offset: u64

Offset into the buffer that is the start of the texture. Must be a multiple of texture block size. For non-compressed textures, this is 1.

bytes_per_row: Option<NonZeroU32>

Bytes per “row” in an image.

A row is one row of pixels or of compressed blocks in the x direction.

This value is required if there are multiple rows (i.e. height or depth is more than one pixel or pixel block for compressed textures)

Must be a multiple of 256 for [CommandEncoder::copy_buffer_to_texture] and [CommandEncoder::copy_texture_to_buffer]. You must manually pad the image such that this is a multiple of 256. It will not affect the image data.

[Queue::write_texture] does not have this requirement.

Must be a multiple of the texture block size. For non-compressed textures, this is 1.

rows_per_image: Option<NonZeroU32>

“Rows” that make up a single “image”.

A row is one row of pixels or of compressed blocks in the x direction.

An image is one layer in the z direction of a 3D image or 2DArray texture.

The amount of rows per image may be larger than the actual amount of rows of data.

Required if there are multiple images (i.e. the depth is more than one).

Trait Implementations

impl Clone for ImageDataLayout

pub fn clone(&self) -> ImageDataLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageDataLayout

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

Formats the value using the given formatter.

impl Default for ImageDataLayout

pub fn default() -> ImageDataLayout

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImageDataLayout

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<ImageDataLayout, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ImageDataLayout

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Copy for ImageDataLayout