Struct bevy_internal::render::render_resource::ImageSubresourceRange

#[repr(C)]
pub struct ImageSubresourceRange {
    pub aspect: TextureAspect,
    pub base_mip_level: u32,
    pub mip_level_count: Option<u32>,
    pub base_array_layer: u32,
    pub array_layer_count: Option<u32>,
}

Subresource range within an image

Fields

aspect: TextureAspect

Aspect of the texture. Color textures must be TextureAspect::All.

base_mip_level: u32

Base mip level.

mip_level_count: Option<u32>

Mip level count. If Some(count), base_mip_level + count must be less or equal to underlying texture mip count. If None, considered to include the rest of the mipmap levels, but at least 1 in total.

base_array_layer: u32

Base array layer.

array_layer_count: Option<u32>

Layer count. If Some(count), base_array_layer + count must be less or equal to the underlying array count. If None, considered to include the rest of the array layers, but at least 1 in total.

Implementations

impl ImageSubresourceRange

pub fn is_full_resource( &self, format: TextureFormat, mip_levels: u32, array_layers: u32 ) -> bool

Returns if the given range represents a full resource, with a texture of the given layer count and mip count.

let range_none = wgpu::ImageSubresourceRange {
    aspect: wgpu::TextureAspect::All,
    base_mip_level: 0,
    mip_level_count: None,
    base_array_layer: 0,
    array_layer_count: None,
};
assert_eq!(range_none.is_full_resource(wgpu::TextureFormat::Stencil8, 5, 10), true);

let range_some = wgpu::ImageSubresourceRange {
    aspect: wgpu::TextureAspect::All,
    base_mip_level: 0,
    mip_level_count: Some(5),
    base_array_layer: 0,
    array_layer_count: Some(10),
};
assert_eq!(range_some.is_full_resource(wgpu::TextureFormat::Stencil8, 5, 10), true);

let range_mixed = wgpu::ImageSubresourceRange {
    aspect: wgpu::TextureAspect::StencilOnly,
    base_mip_level: 0,
    // Only partial resource
    mip_level_count: Some(3),
    base_array_layer: 0,
    array_layer_count: None,
};
assert_eq!(range_mixed.is_full_resource(wgpu::TextureFormat::Stencil8, 5, 10), false);

pub fn mip_range(&self, mip_level_count: u32) -> Range<u32>

Returns the mip level range of a subresource range describes for a specific texture.

pub fn layer_range(&self, array_layer_count: u32) -> Range<u32>

Returns the layer range of a subresource range describes for a specific texture.

Trait Implementations

impl Clone for ImageSubresourceRange

fn clone(&self) -> ImageSubresourceRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageSubresourceRange

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

Formats the value using the given formatter.

impl Default for ImageSubresourceRange

fn default() -> ImageSubresourceRange

Returns the “default value” for a type.

impl PartialEq for ImageSubresourceRange

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ImageSubresourceRange

impl Eq for ImageSubresourceRange

impl StructuralEq for ImageSubresourceRange

impl StructuralPartialEq for ImageSubresourceRange