Struct wgpu::ImageDataLayout

source ·
#[repr(C)]
pub struct ImageDataLayout { pub offset: u64, pub bytes_per_row: Option<u32>, pub rows_per_image: Option<u32>, }
Expand description

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:

ResolutionFormatBytes per blockPixels per blockBytes per rowRows per image
256x256RGBA841 * 1 * 1256 * 4 = Some(1024)None
32x16x8RGBA841 * 1 * 132 * 4 = 128 padded to 256 = Some(256)None
256x256BC3164 * 4 * 116 * (256 / 4) = 1024 = Some(1024)None
64x64x8BC3164 * 4 * 116 * (64 / 4) = 256 = Some(256)64 / 4 = 16 = Some(16)

Corresponds to WebGPU GPUImageDataLayout.

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<u32>

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<u32>

“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§

source§

impl Clone for ImageDataLayout

source§

fn clone(&self) -> ImageDataLayout

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ImageDataLayout

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ImageDataLayout

source§

fn default() -> ImageDataLayout

Returns the “default value” for a type. Read more
source§

impl Copy for ImageDataLayout

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSync for T
where T: Sync,