#[repr(C)]pub struct TextureDescriptor<L, V> {
pub label: L,
pub size: Extent3d,
pub mip_level_count: u32,
pub sample_count: u32,
pub dimension: TextureDimension,
pub format: TextureFormat,
pub usage: TextureUsages,
pub view_formats: V,
pub texture_binding_view_dimension: Option<TextureViewDimension>,
}Expand description
Describes a Texture.
Corresponds to WebGPU GPUTextureDescriptor.
Fields§
§label: LDebug label of the texture. This will show up in graphics debuggers for easy identification.
size: Extent3dSize of the texture. All components must be greater than zero. For a regular 1D/2D texture, the unused sizes will be 1. For 2DArray textures, Z is the number of 2D textures in that array.
mip_level_count: u32Mip count of texture. For a texture with no extra mips, this must be 1.
sample_count: u32Sample count of texture. If this is not 1, texture must have BindingType::Texture::multisampled set to true.
dimension: TextureDimensionDimensions of the texture.
format: TextureFormatFormat of the texture.
usage: TextureUsagesAllowed usages of the texture. If used in other ways, the operation will panic.
view_formats: VSpecifies what view formats will be allowed when calling Texture::create_view on this texture.
View formats of the same format as the texture are always allowed.
Note: currently, only the srgb-ness is allowed to change. (ex: Rgba8Unorm texture + Rgba8UnormSrgb view)
texture_binding_view_dimension: Option<TextureViewDimension>For devices without ARBITRARY_BINDING_VIEW_DIMENSIONS:
views of this texture used as bindings must have this as their dimension. Pass it
explicitly, or pass None to have it inferred from the texture’s dimension and layer count.
Otherwise it is ignored.
Implementations§
Source§impl<L, V> TextureDescriptor<L, V>
impl<L, V> TextureDescriptor<L, V>
Sourcepub fn map_label<'a, K>(
&'a self,
fun: impl FnOnce(&'a L) -> K,
) -> TextureDescriptor<K, V>where
V: Clone,
pub fn map_label<'a, K>(
&'a self,
fun: impl FnOnce(&'a L) -> K,
) -> TextureDescriptor<K, V>where
V: Clone,
Takes a closure and maps the label of the texture descriptor into another.
Sourcepub fn map_label_and_view_formats<'a, K, M>(
&'a self,
l_fun: impl FnOnce(&'a L) -> K,
v_fun: impl FnOnce(&'a V) -> M,
) -> TextureDescriptor<K, M>
pub fn map_label_and_view_formats<'a, K, M>( &'a self, l_fun: impl FnOnce(&'a L) -> K, v_fun: impl FnOnce(&'a V) -> M, ) -> TextureDescriptor<K, M>
Maps the label and view formats of the texture descriptor into another.
Sourcepub fn mip_level_size(&self, level: u32) -> Option<Extent3d>
pub fn mip_level_size(&self, level: u32) -> Option<Extent3d>
Calculates the extent at a given mip level.
If the given mip level is larger than possible, returns None.
Treats the depth as part of the mipmaps. If calculating for a 2DArray texture, which does not mipmap depth, set depth to 1.
let desc = TextureDescriptor {
label: (),
size: wgpu::Extent3d { width: 100, height: 60, depth_or_array_layers: 1 },
mip_level_count: 7,
sample_count: 1,
dimension: wgpu::TextureDimension::D3,
format: wgpu::TextureFormat::Rgba8Sint,
usage: wgpu::TextureUsages::empty(),
view_formats: &[],
texture_binding_view_dimension: None,
};
assert_eq!(desc.mip_level_size(0), Some(wgpu::Extent3d { width: 100, height: 60, depth_or_array_layers: 1 }));
assert_eq!(desc.mip_level_size(1), Some(wgpu::Extent3d { width: 50, height: 30, depth_or_array_layers: 1 }));
assert_eq!(desc.mip_level_size(2), Some(wgpu::Extent3d { width: 25, height: 15, depth_or_array_layers: 1 }));
assert_eq!(desc.mip_level_size(3), Some(wgpu::Extent3d { width: 12, height: 7, depth_or_array_layers: 1 }));
assert_eq!(desc.mip_level_size(4), Some(wgpu::Extent3d { width: 6, height: 3, depth_or_array_layers: 1 }));
assert_eq!(desc.mip_level_size(5), Some(wgpu::Extent3d { width: 3, height: 1, depth_or_array_layers: 1 }));
assert_eq!(desc.mip_level_size(6), Some(wgpu::Extent3d { width: 1, height: 1, depth_or_array_layers: 1 }));
assert_eq!(desc.mip_level_size(7), None);Sourcepub fn array_layer_count(&self) -> u32
pub fn array_layer_count(&self) -> u32
Returns the number of array layers.
https://gpuweb.github.io/gpuweb/#abstract-opdef-array-layer-count
Sourcepub fn theoretical_memory_footprint(&self) -> u64
pub fn theoretical_memory_footprint(&self) -> u64
Returns the theoretical memory footprint of a texture.
Actual memory usage may greatly exceed this value due to alignment and padding.
Sourcepub fn default_view_dimension(&self) -> TextureViewDimension
pub fn default_view_dimension(&self) -> TextureViewDimension
Infer the view dimension from a given descriptor.
This is used when ARBITRARY_BINDING_VIEW_DIMENSIONS is not set. See https://gpuweb.github.io/gpuweb/#dom-gpudevice-createtexture
Trait Implementations§
Source§impl<L: Clone, V: Clone> Clone for TextureDescriptor<L, V>
impl<L: Clone, V: Clone> Clone for TextureDescriptor<L, V>
Source§fn clone(&self) -> TextureDescriptor<L, V>
fn clone(&self) -> TextureDescriptor<L, V>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<'de, L, V> Deserialize<'de> for TextureDescriptor<L, V>where
L: Deserialize<'de>,
V: Deserialize<'de>,
impl<'de, L, V> Deserialize<'de> for TextureDescriptor<L, V>where
L: Deserialize<'de>,
V: Deserialize<'de>,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<L: PartialEq, V: PartialEq> PartialEq for TextureDescriptor<L, V>
impl<L: PartialEq, V: PartialEq> PartialEq for TextureDescriptor<L, V>
Source§fn eq(&self, other: &TextureDescriptor<L, V>) -> bool
fn eq(&self, other: &TextureDescriptor<L, V>) -> bool
self and other values to be equal, and is used by ==.Source§impl<L, V> Serialize for TextureDescriptor<L, V>
impl<L, V> Serialize for TextureDescriptor<L, V>
impl<L: Eq, V: Eq> Eq for TextureDescriptor<L, V>
impl<L, V> StructuralPartialEq for TextureDescriptor<L, V>
Auto Trait Implementations§
impl<L, V> Freeze for TextureDescriptor<L, V>
impl<L, V> RefUnwindSafe for TextureDescriptor<L, V>where
L: RefUnwindSafe,
V: RefUnwindSafe,
impl<L, V> Send for TextureDescriptor<L, V>
impl<L, V> Sync for TextureDescriptor<L, V>
impl<L, V> Unpin for TextureDescriptor<L, V>
impl<L, V> UnsafeUnpin for TextureDescriptor<L, V>where
L: UnsafeUnpin,
V: UnsafeUnpin,
impl<L, V> UnwindSafe for TextureDescriptor<L, V>where
L: UnwindSafe,
V: UnwindSafe,
Blanket Implementations§
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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