Skip to main content

TexelArrayLayout

Struct TexelArrayLayout 

Source
pub struct TexelArrayLayout {
    pub texel_format: TextureFormat,
    pub lanes_per_texel: u32,
    pub element_size: u64,
    pub elements_per_row: u32,
    pub width: u32,
    pub height: u32,
}
Expand description

A texel array’s shape and texel format.

Derived from an element size and a capacity; see the module docs for how the row width follows from the two.

Fields§

§texel_format: TextureFormat

The format the texture is created with.

§lanes_per_texel: u32

f32 lanes per texel: 1 for R32Float, 4 for Rgba32Float.

§element_size: u64

Bytes per element.

§elements_per_row: u32

How many elements one row holds.

§width: u32

The texture’s width in texels.

§height: u32

The texture’s height in texels.

Implementations§

Source§

impl TexelArrayLayout

Source

pub fn new(element_size: u64, capacity: u64, max_dimension: u32) -> Self

Lay out capacity elements of element_size bytes in a texture no larger than max_dimension on either axis.

max_dimension is the device’s [wgpu::Limits::max_texture_dimension_2d].

§Panics

If element_size is not a whole number of f32 lanes, or if capacity elements of that size cannot be stored in a texture within max_dimension.

Source

pub fn row_bytes(&self) -> u64

Bytes one row spans, padding included.

Always a whole number of [wgpu::COPY_BYTES_PER_ROW_ALIGNMENT] bytes.

Source

pub fn capacity(&self) -> u64

How many elements fit without growing the texture.

Source

pub fn texture_size(&self) -> Extent3d

The texture size to create.

Source

fn rows_for(&self, element_count: u64) -> u32

How many rows element_count elements occupy.

Source

pub fn pack(&self, elements: &[u8], out: &mut Vec<u8>)

Write elements into out as the row-padded image the texture holds.

elements is the packed element bytes — the same bytes a storage buffer would have been uploaded, and the same ones Self::element_size describes one of. out is reused across calls, so a steady frame reallocates nothing. Only the rows the elements reach are written; the rest of the texture is left as it was, which is sound because the shader addresses nothing past the element count the caller uploaded.

§Panics

If elements is not a whole number of elements, or holds more than Self::capacity of them.

Source

pub fn binding(binding: u32, visibility: ShaderStages) -> BindGroupLayoutEntry

The bind-group layout entry that binds one of these as a texture.

Trait Implementations§

Source§

impl Clone for TexelArrayLayout

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TexelArrayLayout

Source§

impl Debug for TexelArrayLayout

Source§

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

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

impl Eq for TexelArrayLayout

Source§

impl PartialEq for TexelArrayLayout

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TexelArrayLayout

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

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

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

impl<T> Upcast<T> for T

§

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

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more