Struct vulkano::render_pass::AttachmentDescription

pub struct AttachmentDescription {
    pub format: Option<Format>,
    pub samples: SampleCount,
    pub load_op: LoadOp,
    pub store_op: StoreOp,
    pub stencil_load_op: LoadOp,
    pub stencil_store_op: StoreOp,
    pub initial_layout: ImageLayout,
    pub final_layout: ImageLayout,
    pub _ne: NonExhaustive,
}

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

Fields

format: Option<Format>

The format of the image that is going to be bound.

The default value is None, which must be overridden.

samples: SampleCount

The number of samples of the image that is going to be bound.

The default value is SampleCount::Sample1.

load_op: LoadOp

What the implementation should do with the attachment at the start of the subpass that first uses it.

The default value is LoadOp::DontCare.

store_op: StoreOp

What the implementation should do with the attachment at the end of the subpass that last uses it.

The default value is StoreOp::DontCare.

stencil_load_op: LoadOp

The equivalent of load_op for the stencil component of the attachment, if any. Irrelevant if there is no stencil component.

The default value is LoadOp::DontCare.

stencil_store_op: StoreOp

The equivalent of store_op for the stencil component of the attachment, if any. Irrelevant if there is no stencil component.

The default value is StoreOp::DontCare.

initial_layout: ImageLayout

The layout that the image must in at the start of the render pass.

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

The default value is ImageLayout::Undefined, which must be overridden.

final_layout: ImageLayout

The layout that the image will be transitioned to at the end of the render pass.

The default value is ImageLayout::Undefined, which must be overridden.

_ne: NonExhaustive

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.

impl Default for AttachmentDescription

fn default() -> Self

Returns the “default value” for a type.

impl Copy for AttachmentDescription