Struct vulkano::image::ImageFormatInfo

pub struct ImageFormatInfo {
    pub format: Option<Format>,
    pub image_type: ImageType,
    pub tiling: ImageTiling,
    pub usage: ImageUsage,
    pub stencil_usage: ImageUsage,
    pub external_memory_handle_type: Option<ExternalMemoryHandleType>,
    pub image_view_type: Option<ImageViewType>,
    pub mutable_format: bool,
    pub cube_compatible: bool,
    pub array_2d_compatible: bool,
    pub block_texel_view_compatible: bool,
    pub _ne: NonExhaustive,
}

The image configuration to query in PhysicalDevice::image_format_properties.

Fields

format: Option<Format>

The format that the image will have.

The default value is None, which must be overridden.

image_type: ImageType

The dimension type that the image will have.

The default value is ImageType::Dim2d.

tiling: ImageTiling

The tiling that the image will have.

The default value is ImageTiling::Optimal.

usage: ImageUsage

The usage that the image will have.

The default value is ImageUsage::empty(), which must be overridden.

stencil_usage: ImageUsage

The stencil_usage that the image will have.

If stencil_usage is empty or if format does not have both a depth and a stencil aspect, then it is automatically set to equal usage.

If after this, stencil_usage does not equal usage, then the physical device API version must be at least 1.2, or the ext_separate_stencil_usage extension must be supported by the physical device.

The default value is ImageUsage::empty().

external_memory_handle_type: Option<ExternalMemoryHandleType>

An external memory handle type that will be imported to or exported from the image.

This is needed to retrieve the external_memory_properties value, and the physical device API version must be at least 1.1 or the khr_external_memory_capabilities extension must be enabled on the instance.

The default value is None.

image_view_type: Option<ImageViewType>

The image view type that will be created from the image.

This is needed to retrieve the filter_cubic and filter_cubic_minmax values, and the ext_filter_cubic extension must be supported on the physical device.

The default value is None.

mutable_format: bool

The mutable_format that the image will have.

The default value is false.

cube_compatible: bool

The cube_compatible that the image will have.

The default value is false.

array_2d_compatible: bool

The array_2d_compatible that the image will have.

The default value is false.

block_texel_view_compatible: bool

The block_texel_view_compatible that the image will have.

The default value is false.

_ne: NonExhaustive

Trait Implementations

impl Clone for ImageFormatInfo

fn clone(&self) -> ImageFormatInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageFormatInfo

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

Formats the value using the given formatter.

impl Default for ImageFormatInfo

fn default() -> Self

Returns the “default value” for a type.