Struct ImageInfo 

pub struct ImageInfo {

    pub alloc_dedicated: bool,
    pub array_layer_count: u32,
    pub depth: u32,
    pub flags: ImageCreateFlags,
    pub format: Format,
    pub height: u32,
    pub host_readable: bool,
    pub host_writable: bool,
    pub mip_level_count: u32,
    pub sample_count: SampleCount,
    pub sharing_mode: SharingMode,
    pub tiling: ImageTiling,
    pub image_type: ImageType,
    pub usage: ImageUsageFlags,
    pub width: u32,
}

Information used to create an Image instance.

See VkImageCreateInfo.

Fields

alloc_dedicated: bool

Specifies a dedicated memory allocation managed by the Vulkan driver and not by the internal memory allocation pool transient resources share.

The driver may optimize access to dedicated images.

array_layer_count: u32

The number of layers in the image.

depth: u32

Image extent of the Z axis, when describing a three dimensional image.

flags: ImageCreateFlags

A bitmask describing additional parameters of the image.

See VkImageCreateFlagBits.

format: Format

The format and type of the texel blocks that will be contained in the image.

height: u32

Image extent of the Y axis, when describing a two or three dimensional image.

host_readable: bool

Specifies an image whose memory is host-visible and may be mapped for reads.

Memory optimal for CPU readback of data may be used.

host_writable: bool

Specifies an image whose memory is host-visible and may be mapped for writes.

Memory optimal for uploading data to the GPU may be used.

mip_level_count: u32

The number of levels of detail available for minified sampling of the image.

sample_count: SampleCount

Specifies the number of [samples per texel].

See VkImageCreateInfo.

sharing_mode: SharingMode

Controls whether the image is accessible from a single queue family (EXCLUSIVE) or from multiple queue families concurrently (CONCURRENT).

EXCLUSIVE (the default) restricts the image to a single queue family. This may enable driver optimizations but requires ownership transfers to use the image on a different queue family.

Set to CONCURRENT when the image will be accessed from multiple queue families (e.g. graphics and compute on separate queues).

See VkSharingMode in the Vulkan specification.

tiling: ImageTiling

Specifies the tiling arrangement of the texel blocks in memory.

The default value is vk::ImageTiling::OPTIMAL.

image_type: ImageType

The basic dimensionality of the image.

Layers in array textures do not count as a dimension for the purposes of the image type.

usage: ImageUsageFlags

A bitmask describing the intended usage of the image.

See VkImageUsageFlagBits.

width: u32

Image extent of the X axis.

Implementations

impl ImageInfo

pub const fn cube( size: u32, format: Format, usage: ImageUsageFlags, ) -> ImageInfo

Specifies a cube image.

pub const fn image_1d( size: u32, format: Format, usage: ImageUsageFlags, ) -> ImageInfo

Specifies a one-dimensional image.

pub const fn image_2d( width: u32, height: u32, format: Format, usage: ImageUsageFlags, ) -> ImageInfo

Specifies a two-dimensional image.

pub const fn image_2d_array( width: u32, height: u32, array_layer_count: u32, format: Format, usage: ImageUsageFlags, ) -> ImageInfo

Specifies a two-dimensional image array.

pub const fn image_3d( width: u32, height: u32, depth: u32, format: Format, usage: ImageUsageFlags, ) -> ImageInfo

Specifies a three-dimensional image.

pub fn builder() -> ImageInfoBuilder

Creates a default ImageInfoBuilder.

pub fn into_image_view(self) -> ImageViewInfo

Provides an ImageViewInfo for this format, type, aspect, array elements, and mip levels.

pub fn is_array(self) -> bool

Returns true if this image is an array.

pub fn is_cube(self) -> bool

Returns true if this image is a cube or cube array.

pub fn is_cube_array(self) -> bool

Returns true if this image is a cube array.

pub fn is_host_visible(self) -> bool

Returns true if this information specifies host-visible memory.

pub fn into_builder(self) -> ImageInfoBuilder

Converts an ImageInfo into an ImageInfoBuilder.

Trait Implementations

impl Clone for ImageInfo

fn clone(&self) -> ImageInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ImageInfo

impl Debug for ImageInfo

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

Formats the value using the given formatter.

impl Eq for ImageInfo

impl From<ImageInfo> for ImageCreateInfo<'_>

fn from(value: ImageInfo) -> Self

Converts to this type from the input type.

impl From<ImageInfo> for ImageSubresourceRange

fn from(info: ImageInfo) -> Self

Converts to this type from the input type.

impl From<ImageInfo> for ImageViewInfo

fn from(info: ImageInfo) -> Self

Converts to this type from the input type.

impl From<ImageInfoBuilder> for ImageInfo

fn from(info: ImageInfoBuilder) -> Self

Converts to this type from the input type.

impl Hash for ImageInfo

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 ImageInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Pool<ImageInfo, Image> for FifoPool

fn resource(&mut self, info: ImageInfo) -> Result<Lease<Image>, DriverError>

Request a resource.

impl Pool<ImageInfo, Image> for HashPool

fn resource(&mut self, info: ImageInfo) -> Result<Lease<Image>, DriverError>

Request a resource.

impl Pool<ImageInfo, Image> for LazyPool

fn resource(&mut self, info: ImageInfo) -> Result<Lease<Image>, DriverError>

Request a resource.

impl StructuralPartialEq for ImageInfo