Enum vulkano::image::ImageDimensions

pub enum ImageDimensions {
    Dim1d {
        width: u32,
        array_layers: u32,
    },
    Dim2d {
        width: u32,
        height: u32,
        array_layers: u32,
    },
    Dim3d {
        width: u32,
        height: u32,
        depth: u32,
    },
}

The dimensions of an image.

Variants

Dim1d

Fields of Dim1d

width: u32array_layers: u32

Dim2d

Fields of Dim2d

width: u32height: u32array_layers: u32

Dim3d

Fields of Dim3d

width: u32height: u32depth: u32

Implementations

impl ImageDimensions

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn width_height(&self) -> [u32; 2]

pub fn depth(&self) -> u32

pub fn width_height_depth(&self) -> [u32; 3]

pub fn array_layers(&self) -> u32

pub fn num_texels(&self) -> u32

Returns the total number of texels for an image of these dimensions.

pub fn max_mipmaps(&self) -> u32

Returns the maximum number of mipmaps for these image dimensions.

The returned value is always at least superior or equal to 1.

Example

use vulkano::image::ImageDimensions;

let dims = ImageDimensions::Dim2d {
    width: 32,
    height: 50,
    array_layers: 1,
};

assert_eq!(dims.max_mipmaps(), 6);

pub fn mipmap_dimensions(&self, level: u32) -> Option<ImageDimensions>

Returns the dimensions of the levelth mipmap level. If level is 0, then the dimensions are left unchanged.

Returns None if level is superior or equal to max_mipmaps().

Example

use vulkano::image::ImageDimensions;

let dims = ImageDimensions::Dim2d {
    width: 963,
    height: 256,
    array_layers: 1,
};

assert_eq!(dims.mipmap_dimensions(0), Some(dims));
assert_eq!(dims.mipmap_dimensions(1), Some(ImageDimensions::Dim2d {
    width: 481,
    height: 128,
    array_layers: 1,
}));
assert_eq!(dims.mipmap_dimensions(6), Some(ImageDimensions::Dim2d {
    width: 15,
    height: 4,
    array_layers: 1,
}));
assert_eq!(dims.mipmap_dimensions(9), Some(ImageDimensions::Dim2d {
    width: 1,
    height: 1,
    array_layers: 1,
}));
assert_eq!(dims.mipmap_dimensions(11), None);

Panic

In debug mode, Panics if width, height or depth is equal to 0. In release, returns an unspecified value.

Trait Implementations

impl Clone for ImageDimensions

fn clone(&self) -> ImageDimensions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageDimensions

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

Formats the value using the given formatter.

impl PartialEq<ImageDimensions> for ImageDimensions

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

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

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

This method tests for !=.

impl Copy for ImageDimensions

impl Eq for ImageDimensions

impl StructuralEq for ImageDimensions

impl StructuralPartialEq for ImageDimensions