Struct vulkano::command_buffer::RenderPassBeginInfo

pub struct RenderPassBeginInfo {
    pub render_pass: Arc<RenderPass>,
    pub framebuffer: Arc<Framebuffer>,
    pub render_area_offset: [u32; 2],
    pub render_area_extent: [u32; 2],
    pub clear_values: Vec<Option<ClearValue>>,
    pub _ne: NonExhaustive,
}

Parameters to begin a new render pass.

Fields

render_pass: Arc<RenderPass>

The render pass to begin.

If this is not the render pass that framebuffer was created with, it must be compatible with that render pass.

The default value is the render pass of framebuffer.

framebuffer: Arc<Framebuffer>

The framebuffer to use for rendering.

There is no default value.

render_area_offset: [u32; 2]

The offset from the top left corner of the framebuffer that will be rendered to.

The default value is [0, 0].

render_area_extent: [u32; 2]

The size of the area that will be rendered to.

render_area_offset + render_area_extent must not be greater than [framebuffer.extent()].

The default value is [framebuffer.extent()].

clear_values: Vec<Option<ClearValue>>

Provides, for each attachment in render_pass that has a load operation of LoadOp::Clear, the clear values that should be used for the attachments in the framebuffer. There must be exactly [framebuffer.attachments().len()] elements provided, and each one must match the attachment format.

To skip over an attachment whose load operation is something else, provide None.

The default value is empty, which must be overridden if the framebuffer has attachments.

_ne: NonExhaustive

Implementations

impl RenderPassBeginInfo

pub fn framebuffer(framebuffer: Arc<Framebuffer>) -> Self

Trait Implementations

impl Clone for RenderPassBeginInfo

fn clone(&self) -> RenderPassBeginInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RenderPassBeginInfo

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

Formats the value using the given formatter.