Struct vulkano::image::attachment::AttachmentImage

pub struct AttachmentImage<F = Format, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> { /* fields omitted */ }

ImageAccess whose purpose is to be used as a framebuffer attachment.

The image is always two-dimensional and has only one mipmap, but it can have any kind of format. Trying to use a format that the backend doesn't support for rendering will result in an error being returned when creating the image. Once you have an AttachmentImage, you are guaranteed that you will be able to draw on it.

The template parameter of AttachmentImage is a type that describes the format of the image.

Regular vs transient

Calling AttachmentImage::new will create a regular image, while calling AttachmentImage::transient will create a transient image. Transient image are only relevant for images that serve as attachments, so AttachmentImage is the only type of image in vulkano that provides a shortcut for this.

A transient image is a special kind of image whose content is undefined outside of render passes. Once you finish drawing, reading from it will returned undefined data (which can be either valid or garbage, depending on the implementation).

This gives a hint to the Vulkan implementation that it is possible for the image's content to live exclusively in some cache memory, and that no real memory has to be allocated for it.

In other words, if you are going to read from the image after drawing to it, use a regular image. If you don't need to read from it (for example if it's some kind of intermediary color, or a depth buffer that is only used once) then use a transient image as it may improve performance.

Methods

impl<F> AttachmentImage<F>

pub fn new(
    device: Arc<Device>,
    dimensions: [u32; 2],
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Creates a new image with the given dimensions and format.

Returns an error if the dimensions are too large or if the backend doesn't support this format as a framebuffer attachment.

pub fn input_attachment(
    device: Arc<Device>,
    dimensions: [u32; 2],
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as new, but creates an image that can be used as an input attachment.

Note: This function is just a convenient shortcut for with_usage.

pub fn multisampled(
    device: Arc<Device>,
    dimensions: [u32; 2],
    samples: u32,
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as new, but creates a multisampled image.

Note: You can also use this function and pass 1 for the number of samples if you want a regular image.

pub fn multisampled_input_attachment(
    device: Arc<Device>,
    dimensions: [u32; 2],
    samples: u32,
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as multisampled, but creates an image that can be used as an input attachment.

Note: This function is just a convenient shortcut for multisampled_with_usage.

pub fn with_usage(
    device: Arc<Device>,
    dimensions: [u32; 2],
    format: F,
    usage: ImageUsage
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as new, but lets you specify additional usages.

The color_attachment or depth_stencil_attachment usages are automatically added based on the format of the usage. Therefore the usage parameter allows you specify usages in addition to these two.

pub fn multisampled_with_usage(
    device: Arc<Device>,
    dimensions: [u32; 2],
    samples: u32,
    format: F,
    usage: ImageUsage
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as with_usage, but creates a multisampled image.

Note: You can also use this function and pass 1 for the number of samples if you want a regular image.

Note: This function is just a convenient shortcut for multisampled_with_usage.

pub fn sampled(
    device: Arc<Device>,
    dimensions: [u32; 2],
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as new, except that the image can later be sampled.

Note: This function is just a convenient shortcut for with_usage.

pub fn sampled_input_attachment(
    device: Arc<Device>,
    dimensions: [u32; 2],
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as sampled, except that the image can be used as an input attachment.

Note: This function is just a convenient shortcut for with_usage.

pub fn sampled_multisampled(
    device: Arc<Device>,
    dimensions: [u32; 2],
    samples: u32,
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as sampled, but creates a multisampled image.

Note: You can also use this function and pass 1 for the number of samples if you want a regular image.

Note: This function is just a convenient shortcut for multisampled_with_usage.

pub fn sampled_multisampled_input_attachment(
    device: Arc<Device>,
    dimensions: [u32; 2],
    samples: u32,
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as sampled_multisampled, but creates an image that can be used as an input attachment.

Note: This function is just a convenient shortcut for multisampled_with_usage.

pub fn transient(
    device: Arc<Device>,
    dimensions: [u32; 2],
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as new, except that the image will be transient.

A transient image is special because its content is undefined outside of a render pass. This means that the implementation has the possibility to not allocate any memory for it.

Note: This function is just a convenient shortcut for with_usage.

pub fn transient_input_attachment(
    device: Arc<Device>,
    dimensions: [u32; 2],
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as transient, except that the image can be used as an input attachment.

Note: This function is just a convenient shortcut for with_usage.

pub fn transient_multisampled(
    device: Arc<Device>,
    dimensions: [u32; 2],
    samples: u32,
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as transient, but creates a multisampled image.

Note: You can also use this function and pass 1 for the number of samples if you want a regular image.

Note: This function is just a convenient shortcut for multisampled_with_usage.

pub fn transient_multisampled_input_attachment(
    device: Arc<Device>,
    dimensions: [u32; 2],
    samples: u32,
    format: F
) -> Result<Arc<AttachmentImage<F>>, ImageCreationError> where
    F: FormatDesc, 

Same as transient_multisampled, but creates an image that can be used as an input attachment.

Note: This function is just a convenient shortcut for multisampled_with_usage.

impl<F, A> AttachmentImage<F, A>

pub fn dimensions(&self) -> [u32; 2]

Returns the dimensions of the image.

Trait Implementations

impl<F, A> ImageAccess for AttachmentImage<F, A> where
    F: 'static + Send + Sync, 

fn inner(&self) -> ImageInner

Returns the inner unsafe image object used by this image.

fn initial_layout_requirement(&self) -> ImageLayout

Returns the layout that the image has when it is first used in a primary command buffer.

fn final_layout_requirement(&self) -> ImageLayout

Returns the layout that the image must be returned to before the end of the command buffer.

fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool

Returns true if an access to self potentially overlaps the same memory as an access to other.

fn conflicts_image(&self, other: &dyn ImageAccess) -> bool

Returns true if an access to self potentially overlaps the same memory as an access to other.

fn conflict_key(&self) -> u64

Returns a key that uniquely identifies the memory content of the image. Two ranges that potentially overlap in memory must return the same key.

fn try_gpu_lock(
    &self,
    _: bool,
    expected_layout: ImageLayout
) -> Result<(), AccessError>

Locks the resource for usage on the GPU. Returns an error if the lock can't be acquired.

unsafe fn increase_gpu_lock(&self)

Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one.

unsafe fn unlock(&self, new_layout: Option<ImageLayout>)

Unlocks the resource previously acquired with try_gpu_lock or increase_gpu_lock.

unsafe fn layout_initialized(&self)

When images are created their memory layout is initially Undefined or Preinitialized. This method allows the image memory barrier creation process to signal when an image has been transitioned out of its initial Undefined or Preinitialized state. This allows vulkano to avoid creating unnecessary image memory barriers between future uses of the image.

fn is_layout_initialized(&self) -> bool

fn format(&self) -> Format

Returns the format of this image.

fn has_color(&self) -> bool

Returns true if the image is a color image.

fn has_depth(&self) -> bool

Returns true if the image has a depth component. In other words, if it is a depth or a depth-stencil format.

fn has_stencil(&self) -> bool

Returns true if the image has a stencil component. In other words, if it is a stencil or a depth-stencil format.

fn mipmap_levels(&self) -> u32

Returns the number of mipmap levels of this image.

fn samples(&self) -> u32

Returns the number of samples of this image.

fn dimensions(&self) -> ImageDimensions

Returns the dimensions of the image.

fn supports_blit_source(&self) -> bool

Returns true if the image can be used as a source for blits.

fn supports_blit_destination(&self) -> bool

Returns true if the image can be used as a destination for blits.

unsafe fn preinitialized_layout(&self) -> bool

unsafe fn forced_undefined_initial_layout(
    self,
    preinitialized: bool
) -> ImageAccessFromUndefinedLayout<Self> where
    Self: Sized, 

Wraps around this ImageAccess and returns an identical ImageAccess but whose initial layout requirement is either Undefined or Preinitialized.

impl<F, A> ImageViewAccess for AttachmentImage<F, A> where
    F: 'static + Send + Sync, 

fn parent(&self) -> &dyn ImageAccess

fn dimensions(&self) -> Dimensions

Returns the dimensions of the image view.

fn inner(&self) -> &UnsafeImageView

Returns the inner unsafe image view object used by this image view.

fn descriptor_set_storage_image_layout(&self) -> ImageLayout

Returns the image layout to use in a descriptor with the given subresource.

fn descriptor_set_combined_image_sampler_layout(&self) -> ImageLayout

Returns the image layout to use in a descriptor with the given subresource.

fn descriptor_set_sampled_image_layout(&self) -> ImageLayout

Returns the image layout to use in a descriptor with the given subresource.

fn descriptor_set_input_attachment_layout(&self) -> ImageLayout

Returns the image layout to use in a descriptor with the given subresource.

fn identity_swizzle(&self) -> bool

Returns true if the view doesn't use components swizzling.

fn format(&self) -> Format

Returns the format of this view. This can be different from the parent's format.

fn samples(&self) -> u32

fn can_be_sampled(&self, _sampler: &Sampler) -> bool

Returns true if the given sampler can be used with this image view.

impl<F: Debug, A: Debug> Debug for AttachmentImage<F, A>

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

Formats the value using the given formatter.