Struct screen_13::driver::image::Image

pub struct Image {
    pub info: ImageInfo,
    pub name: Option<String>,
    /* private fields */
}

Smart pointer handle to an image object.

Also contains information about the object.

Deref behavior

Image automatically dereferences to vk::Image (via the Deref trait), so you can call vk::Image’s methods on a value of type Image. To avoid name clashes with vk::Image’s methods, the methods of Image itself are associated functions, called using fully qualified syntax:

let prev = Image::access(&my_image, AccessType::AnyShaderWrite);

Fields

info: ImageInfo

Information used to create this object.

name: Option<String>

A name for debugging purposes.

Implementations

impl Image

pub fn create( device: &Arc<Device>, info: impl Into<ImageInfo> ) -> Result<Self, DriverError>

Creates a new image on the given device.

Examples

Basic usage:

let info = ImageInfo::image_2d(32, 32, vk::Format::R8G8B8A8_UNORM, vk::ImageUsageFlags::SAMPLED);
let image = Image::create(&device, info)?;

assert_ne!(*image, vk::Image::null());
assert_eq!(image.info.width, 32);
assert_eq!(image.info.height, 32);

pub fn access(this: &Self, next_access: AccessType) -> AccessType

Keeps track of some next_access which affects this object.

Returns the previous access for which a pipeline barrier should be used to prevent data corruption.

Note

Used to maintain object state when passing a Screen 13-created vk::Image handle to external code such as Ash or Erupt bindings.

Examples

Basic usage:

// Initially we want to "Read Other"
let next = AccessType::AnyShaderReadOther;
let prev = Image::access(&my_image, next);
assert_eq!(prev, AccessType::Nothing);

// External code may now "Read Other"; no barrier required

// Subsequently we want to "Write"
let next = AccessType::FragmentShaderWrite;
let prev = Image::access(&my_image, next);
assert_eq!(prev, AccessType::AnyShaderReadOther);

// A barrier on "Read Other" before "Write" is required!

pub fn from_raw( device: &Arc<Device>, image: Image, info: impl Into<ImageInfo> ) -> Self

Consumes a Vulkan image created by some other library.

The image is not destroyed automatically on drop, unlike images created through the Image::create function.

Trait Implementations

impl<T> Alias<ImageInfo, Image> for AliasPool<T>

where T: Pool<ImageInfo, Image>,

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

Aliases a resource.

impl Bind<&mut RenderGraph, ImageNode> for Image

fn bind(self, graph: &mut RenderGraph) -> ImageNode

Binds the resource to a graph-like object.

impl Debug for Image

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

Formats the value using the given formatter.

impl Deref for Image

type Target = Image

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for Image

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Pool<ImageInfo, Image> for AliasPool<T>

where T: Pool<ImageInfo, Image>,

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

Lease a resource.

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.