Struct vulkano::render_pass::RenderPass

source · [−]

pub struct RenderPass { /* private fields */ }

Expand description

An object representing the discrete steps in which rendering is done.

A render pass in Vulkan is made up of three parts:

A list of attachments, which are image views that are inputs, outputs or intermediate stages in the rendering process.
One or more subpasses, which are the steps in which the rendering process, takes place, and the attachments that are used for each step.
Dependencies, which describe how the input and output data of each subpass is to be passed from one subpass to the next.

use vulkano::render_pass::{RenderPass, RenderPassCreateInfo, SubpassDescription};

let render_pass = RenderPass::new(
    device.clone(),
    RenderPassCreateInfo {
        subpasses: vec![SubpassDescription::default()],
        ..Default::default()
    },
).unwrap();

This example creates a render pass with no attachment and one single subpass that doesn’t draw on anything. While it’s sometimes useful, most of the time it’s not what you want.

The easiest way to create a “real” render pass is to use the single_pass_renderpass! macro.

use vulkano::format::Format;

let render_pass = single_pass_renderpass!(device.clone(),
    attachments: {
        // `foo` is a custom name we give to the first and only attachment.
        foo: {
            load: Clear,
            store: Store,
            format: Format::R8G8B8A8_UNORM,
            samples: 1,
        }
    },
    pass: {
        color: [foo],       // Repeat the attachment name here.
        depth_stencil: {}
    }
).unwrap();

See the documentation of the macro for more details. TODO: put link here

Implementations

source

impl RenderPass

source

pub fn new(
device: Arc<Device>,
create_info: RenderPassCreateInfo
) -> Result<Arc<RenderPass>, RenderPassCreationError>

Creates a new RenderPass.

Panics

Panics if create_info.subpasses is empty.
Panics if any element of create_info.attachments has a format of None.

source

pub fn empty_single_pass(
device: Arc<Device>
) -> Result<Arc<RenderPass>, RenderPassCreationError>

Builds a render pass with one subpass and no attachment.

This method is useful for quick tests.

source

pub fn attachments(&self) -> &[AttachmentDescription ]

Returns the attachments of the render pass.

source

pub fn subpasses(&self) -> &[SubpassDescription ]

Returns the subpasses of the render pass.

source

pub fn dependencies(&self) -> &[SubpassDependency ]

Returns the dependencies of the render pass.

source

pub fn correlated_view_masks(&self) -> &[u32 ]

Returns the correlated view masks of the render pass.

source

pub fn views_used(&self) -> u32

If the render pass has multiview enabled, returns the number of views used by the render pass. Returns 0 if multiview is not enabled.

source

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

Returns the granularity of this render pass.

If the render area of a render pass in a command buffer is a multiple of this granularity, then the performance will be optimal. Performances are always optimal for render areas that cover the whole framebuffer.

source

pub fn first_subpass(self: Arc<Self>) -> Subpass

Returns the first subpass of the render pass.

source

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

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

source

pub fn is_compatible_with_shader(
    &self,
    subpass: u32,
    shader_interface: &ShaderInterface
) -> bool

Returns true if the subpass of this description is compatible with the shader’s fragment output definition.

source

pub fn convert_clear_values(
 &self,
 values: I
) -> impl Iterator<Item = ClearValue> where
 I: IntoIterator<Item = ClearValue>,

Decodes I into a list of clear values where each element corresponds to an attachment. The size of the returned iterator must be the same as the number of attachments.

When the user enters a render pass, they need to pass a list of clear values to apply to the attachments of the framebuffer. This method is then responsible for checking the correctness of these values and turning them into a list that can be processed by vulkano.

The format of the clear value must match the format of the attachment. Attachments that are not loaded with LoadOp::Clear must have an entry equal to ClearValue::None.