Struct vulkano::framebuffer::AttachmentDescription

pub struct AttachmentDescription {
    pub format: Format,
    pub samples: u32,
    pub load: LoadOp,
    pub store: StoreOp,
    pub stencil_load: LoadOp,
    pub stencil_store: StoreOp,
    pub initial_layout: ImageLayout,
    pub final_layout: ImageLayout,
}

Describes an attachment that will be used in a render pass.

Fields

format: Format

Format of the image that is going to be bound.

samples: u32

Number of samples of the image that is going to be bound.

load: LoadOp

What the implementation should do with that attachment at the start of the render pass.

store: StoreOp

What the implementation should do with that attachment at the end of the render pass.

stencil_load: LoadOp

Equivalent of load for the stencil component of the attachment, if any. Irrelevant if there is no stencil component.

stencil_store: StoreOp

Equivalent of store for the stencil component of the attachment, if any. Irrelevant if there is no stencil component.

initial_layout: ImageLayout

Layout that the image is going to be in at the start of the renderpass.

The vulkano library will automatically switch to the correct layout if necessary, but it is more efficient to set this to the correct value.

final_layout: ImageLayout

Layout that the image will be transitioned to at the end of the renderpass.

Methods

impl AttachmentDescription

pub fn is_compatible_with(&self, other: &AttachmentDescription) -> bool

Returns true if this attachment is compatible with another attachment, as defined in the Render Pass Compatibility section of the Vulkan specs.

Trait Implementations

impl Clone for AttachmentDescription

fn clone(&self) -> AttachmentDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AttachmentDescription

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

Formats the value using the given formatter.