Struct vulkano::render_pass::AttachmentDescription

pub struct AttachmentDescription {
    pub flags: AttachmentDescriptionFlags,
    pub format: Format,
    pub samples: SampleCount,
    pub load_op: AttachmentLoadOp,
    pub store_op: AttachmentStoreOp,
    pub initial_layout: ImageLayout,
    pub final_layout: ImageLayout,
    pub stencil_load_op: Option<AttachmentLoadOp>,
    pub stencil_store_op: Option<AttachmentStoreOp>,
    pub stencil_initial_layout: Option<ImageLayout>,
    pub stencil_final_layout: Option<ImageLayout>,
    pub _ne: NonExhaustive,
}

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

Fields

flags: AttachmentDescriptionFlags

Additional properties of the attachment.

The default value is empty.

format: Format

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

The default value is Format::UNDEFINED.

samples: SampleCount

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

The default value is SampleCount::Sample1.

load_op: AttachmentLoadOp

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

The default value is AttachmentLoadOp::DontCare.

store_op: AttachmentStoreOp

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

The default value is AttachmentStoreOp::DontCare.

initial_layout: ImageLayout

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

The default value is ImageLayout::Undefined.

final_layout: ImageLayout

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

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

stencil_load_op: Option<AttachmentLoadOp>

The load_op for the stencil aspect of the attachment, if different.

The default value is None.

stencil_store_op: Option<AttachmentStoreOp>

The store_op for the stencil aspect of the attachment, if different.

The default value is None.

stencil_initial_layout: Option<ImageLayout>

The initial_layout for the stencil aspect of the attachment, if different.

stencil_initial_layout and stencil_final_layout must be either both None, or both Some.

If this is Some, then the separate_depth_stencil_layouts feature must be enabled on the device.

The default value is None.

stencil_final_layout: Option<ImageLayout>

The final_layout for the stencil aspect of the attachment, if different.

stencil_initial_layout and stencil_final_layout must be either both None, or both Some.

If this is Some, then the separate_depth_stencil_layouts feature must be enabled on the device.

The default value is None.

_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