Struct ccthw::graphics::vulkan_api::ColorPass

pub struct ColorPass { /* private fields */ }

A utility for managing a render pass and framebuffers which target a given set of images.

The color pass is single-sampled and does not have a depth/stencil buffer.

Implementations

impl ColorPass

pub unsafe fn new( render_device: Arc<RenderDevice>, swapchain: &Swapchain ) -> Result<Self, GraphicsError>

Create a render pass with a single coloro attachment which can target all of the provided images.

Params

• render_device - the render device used to create Vulkan resources
• images - the images that can be targeted by this render pass
• format - the image format for all provided images
• extent - the extent for all provided images

Safety

Unsafe because:

• the framebuffers are only valid while the swapchain exists
• if the swapchain is rebuilt, the framebuffers should be destroyed and rebuilt too
• the targeted images MUST outlive the ColorPass.

pub fn extent(&self) -> Extent2D

The current extent.

pub fn format(&self) -> Format

The current format.

pub fn render_pass(&self) -> &RenderPass

The current render pass.

pub unsafe fn begin_render_pass_inline( &self, frame: &Frame, clear_color: [f32; 4] )

Begin a render pass for the given image index.

Safety

Unsafe because:

• image_index is not checked, it is expected to be between 0 and the number of images given when the CololPass was created.
• the ColorPass must not be destroyed until the command buffer finishes executing or is discarded.

Trait Implementations

impl Debug for ColorPass

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

Formats the value using the given formatter.