Struct wgpu::Extent3d[][src]

#[repr(C)]
pub struct Extent3d { pub width: u32, pub height: u32, pub depth_or_array_layers: u32, }

Extent of a texture related operation.

Fields

width: u32
height: u32
depth_or_array_layers: u32

Implementations

impl Extent3d[src]

pub fn physical_size(&self, format: TextureFormat) -> Extent3d[src]

Calculates the physical size is backing an texture of the given format and extent. This includes padding to the block width and height of the format.

This is the texture extent that you must upload at when uploading to mipmaps of compressed textures.

let format = wgpu::TextureFormat::Bc1RgbaUnormSrgb; // 4x4 blocks
assert_eq!(
    wgpu::Extent3d { width: 7, height: 7, depth_or_array_layers: 1 }.physical_size(format),
    wgpu::Extent3d { width: 8, height: 8, depth_or_array_layers: 1 }
);
// Doesn't change, already aligned
assert_eq!(
    wgpu::Extent3d { width: 8, height: 8, depth_or_array_layers: 1 }.physical_size(format),
    wgpu::Extent3d { width: 8, height: 8, depth_or_array_layers: 1 }
);
let format = wgpu::TextureFormat::Astc8x5RgbaUnorm; // 8x5 blocks
assert_eq!(
    wgpu::Extent3d { width: 7, height: 7, depth_or_array_layers: 1 }.physical_size(format),
    wgpu::Extent3d { width: 8, height: 10, depth_or_array_layers: 1 }
);

pub fn max_mips(&self) -> u8[src]

Calculates the maximum possible count of mipmaps.

Treats the depth as part of the mipmaps. If calculating for a 2DArray texture, which does not mipmap depth, set depth to 1.

assert_eq!(wgpu::Extent3d { width: 1, height: 1, depth_or_array_layers: 1 }.max_mips(), 1);
assert_eq!(wgpu::Extent3d { width: 60, height: 60, depth_or_array_layers: 1 }.max_mips(), 6);
assert_eq!(wgpu::Extent3d { width: 240, height: 1, depth_or_array_layers: 1 }.max_mips(), 8);

pub fn at_mip_level(&self, level: u8) -> Option<Extent3d>[src]

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 extent = wgpu::Extent3d { width: 100, height: 60, depth_or_array_layers: 1 };

assert_eq!(extent.at_mip_level(0), Some(wgpu::Extent3d { width: 100, height: 60, depth_or_array_layers: 1 }));
assert_eq!(extent.at_mip_level(1), Some(wgpu::Extent3d { width: 50, height: 30, depth_or_array_layers: 1 }));
assert_eq!(extent.at_mip_level(2), Some(wgpu::Extent3d { width: 25, height: 15, depth_or_array_layers: 1 }));
assert_eq!(extent.at_mip_level(3), Some(wgpu::Extent3d { width: 12, height: 7, depth_or_array_layers: 1 }));
assert_eq!(extent.at_mip_level(4), Some(wgpu::Extent3d { width: 6, height: 3, depth_or_array_layers: 1 }));
assert_eq!(extent.at_mip_level(5), Some(wgpu::Extent3d { width: 3, height: 1, depth_or_array_layers: 1 }));
assert_eq!(extent.at_mip_level(6), Some(wgpu::Extent3d { width: 1, height: 1, depth_or_array_layers: 1 }));
assert_eq!(extent.at_mip_level(7), None);

Trait Implementations

impl Clone for Extent3d[src]

impl Copy for Extent3d[src]

impl Debug for Extent3d[src]

impl Default for Extent3d[src]

impl<'de> Deserialize<'de> for Extent3d[src]

impl Eq for Extent3d[src]

impl Hash for Extent3d[src]

impl PartialEq<Extent3d> for Extent3d[src]

impl Serialize for Extent3d[src]

impl StructuralEq for Extent3d[src]

impl StructuralPartialEq for Extent3d[src]

Auto Trait Implementations

impl RefUnwindSafe for Extent3d

impl Send for Extent3d

impl Sync for Extent3d

impl Unpin for Extent3d

impl UnwindSafe for Extent3d

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> CallHasher for T where
    T: Hash
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> Downcast<T> for T[src]

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

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Upcast<T> for T[src]