Struct bevy_render::render_resource::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:
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) |
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
impl Clone for ImageDataLayout
source§fn clone(&self) -> ImageDataLayout
fn clone(&self) -> ImageDataLayout
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ImageDataLayout
impl Debug for ImageDataLayout
source§impl Default for ImageDataLayout
impl Default for ImageDataLayout
source§fn default() -> ImageDataLayout
fn default() -> ImageDataLayout
impl Copy for ImageDataLayout
Auto Trait Implementations§
impl Freeze for ImageDataLayout
impl RefUnwindSafe for ImageDataLayout
impl Send for ImageDataLayout
impl Sync for ImageDataLayout
impl Unpin for ImageDataLayout
impl UnwindSafe for ImageDataLayout
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.