Struct vulkano::image::ImageFormatInfo

pub struct ImageFormatInfo {
    pub flags: ImageCreateFlags,
    pub format: Format,
    pub view_formats: Vec<Format>,
    pub image_type: ImageType,
    pub tiling: ImageTiling,
    pub usage: ImageUsage,
    pub stencil_usage: Option<ImageUsage>,
    pub drm_format_modifier_info: Option<ImageDrmFormatModifierInfo>,
    pub external_memory_handle_type: Option<ExternalMemoryHandleType>,
    pub image_view_type: Option<ImageViewType>,
    pub _ne: NonExhaustive,
}

The image configuration to query in PhysicalDevice::image_format_properties.

Fields

flags: ImageCreateFlags

The flags that the image will have.

The default value is ImageCreateFlags::empty().

format: Format

The format that the image will have.

The default value is Format::UNDEFINED.

view_formats: Vec<Format>

The image view formats that will be allowed for the image.

If this is not empty, then the physical device API version must be at least 1.2, or the khr_image_format_list extension must be supported by the physical device.

The default value is empty.

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: Option<ImageUsage>

The stencil_usage that the image will have, if different from the regular usage.

If this is Some, 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 None.

drm_format_modifier_info: Option<ImageDrmFormatModifierInfo>

The Linux DRM format modifier information to query.

If this is Some, then the ext_image_drm_format_modifier extension must be supported by the physical device.

The default value is None.

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.

_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.

impl Hash for ImageFormatInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ImageFormatInfo

fn eq(&self, other: &ImageFormatInfo) -> 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 Eq for ImageFormatInfo

impl StructuralEq for ImageFormatInfo

impl StructuralPartialEq for ImageFormatInfo