Struct screen_13::driver::image::ImageInfo

pub struct ImageInfo {
    pub array_elements: u32,
    pub depth: u32,
    pub flags: ImageCreateFlags,
    pub fmt: Format,
    pub height: u32,
    pub linear_tiling: bool,
    pub mip_level_count: u32,
    pub sample_count: SampleCount,
    pub ty: ImageType,
    pub usage: ImageUsageFlags,
    pub width: u32,
}

Information used to create an Image instance.

Fields

array_elements: 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 of describing additional parameters of the image.

fmt: 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.

linear_tiling: bool

Specifies the tiling arrangement of the texel blocks in memory.

The default value of false indicates a VK_IMAGE_TILING_OPTIMAL image.

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.

ty: 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 of describing the intended usage of the image.

width: u32

Image extent of the X axis.

Implementations

impl ImageInfo

pub const fn new_1d( fmt: Format, len: u32, usage: ImageUsageFlags ) -> ImageInfoBuilder

Specifies a one-dimensional image.

pub const fn new_2d( fmt: Format, width: u32, height: u32, usage: ImageUsageFlags ) -> ImageInfoBuilder

Specifies a two-dimensional image.

pub const fn new_2d_array( fmt: Format, width: u32, height: u32, array_elements: u32, usage: ImageUsageFlags ) -> ImageInfoBuilder

Specifies a two-dimensional image array.

pub const fn new_3d( fmt: Format, width: u32, height: u32, depth: u32, usage: ImageUsageFlags ) -> ImageInfoBuilder

Specifies a three-dimensional image.

pub fn new_cube( fmt: Format, width: u32, usage: ImageUsageFlags ) -> ImageInfoBuilder

Specifies a cube image.

pub fn default_view_info(self) -> ImageViewInfo

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

Trait Implementations

impl Clone for ImageInfo

fn clone(&self) -> ImageInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageInfo

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

Formats the value using the given formatter.

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

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 Pool<ImageInfo, Image> for FifoPool

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

Lease a resource.

impl Pool<ImageInfo, Image> for HashPool

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

Lease a resource.

impl Pool<ImageInfo, Image> for LazyPool

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

Lease a resource.

impl Copy for ImageInfo

impl Eq for ImageInfo

impl StructuralPartialEq for ImageInfo