Struct vulkano::image::ImageCreateFlags

pub struct ImageCreateFlags {
    pub sparse_binding: bool,
    pub sparse_residency: bool,
    pub sparse_aliased: bool,
    pub mutable_format: bool,
    pub cube_compatible: bool,
    pub array_2d_compatible: bool,
    pub block_texel_view_compatible: bool,
}

Flags that can be set when creating a new image.

Fields

sparse_binding: bool

The image will be backed by sparsely bound memory.

Requires the sparse_binding feature to be enabled.

sparse_residency: bool

The image is allowed to be only partially resident in memory, not all parts of the image must be backed by memory.

Requires the sparse_binding flag, and depending on the image dimensions, either the sparse_residency_image2_d or the sparse_residency_image3_d feature to be enabled. For a multisampled image, this also requires the appropriate sparse residency feature for the number of samples to be enabled.

sparse_aliased: bool

The image can be backed by memory that is shared (aliased) with other images.

Requires the sparse_binding flag and the sparse_residency_aliased feature to be enabled.

mutable_format: bool

For non-multi-planar formats, an image view wrapping this image can have a different format.

For multi-planar formats, an image view wrapping this image can be created from a single plane of the image.

cube_compatible: bool

For 2D images, allows creation of an image view of type Cube or CubeArray.

array_2d_compatible: bool

For 3D images, allows creation of an image view of type Dim2d or Dim2dArray.

block_texel_view_compatible: bool

For images with a compressed format, allows creation of an image view with an uncompressed format, where each texel in the view will correspond to a compressed texel block in the image.

Requires mutable_format.

Implementations

impl ImageCreateFlags

pub fn none() -> Self

Trait Implementations

impl Clone for ImageCreateFlags

fn clone(&self) -> ImageCreateFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageCreateFlags

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

Formats the value using the given formatter.

impl Default for ImageCreateFlags

fn default() -> ImageCreateFlags

Returns the “default value” for a type.

impl From<ImageCreateFlags> for ImageCreateFlags

fn from(flags: ImageCreateFlags) -> Self

Performs the conversion.

impl PartialEq<ImageCreateFlags> for ImageCreateFlags

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

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

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

This method tests for !=.

impl Copy for ImageCreateFlags

impl Eq for ImageCreateFlags

impl StructuralEq for ImageCreateFlags

impl StructuralPartialEq for ImageCreateFlags