Struct nannou::vk::FramebufferObject

pub struct FramebufferObject { /* fields omitted */ }

The FramebufferObject or Fbo type for easy management of a framebuffer.

Creating and maintaining a framebuffer and ensuring it is up to date with the given renderpass and images can be a tedious task that requires a lot of boilerplate code. This type simplifies the process with a single update method that creates or recreates the framebuffer if any of the following conditions are met:

• The update method is called for the first time.
• The given render pass is different to that which was used to create the existing framebuffer.
• The dimensions of the framebuffer don't match the dimensions of the images.

Methods

impl FramebufferObject

pub fn inner(&self) -> &Option<Arc<dyn FramebufferAbstract + Send + Sync>>

Access the inner framebuffer trait object.

pub fn update<R, F, A>(
    &mut self,
    render_pass: R,
    dimensions: [u32; 3],
    builder: F
) -> Result<(), FramebufferCreationError> where
    R: 'static + RenderPassAbstract + Send + Sync,
    F: FnOnce(FramebufferBuilder<R, ()>) -> FramebufferBuilderResult<R, A>,
    A: 'static + AttachmentsList + Send + Sync, 

Ensure the framebuffer is up to date with the given dimensions and render pass.

pub fn expect_inner(&self) -> Arc<dyn FramebufferAbstract + Send + Sync>

Expects that there is a inner framebuffer object instantiated and returns it.

**panic!**s if the update method has not yet been called.

This method is shorthand for fbo.as_ref().expect("inner framebuffer was None").clone().

pub fn render_passes_match<R>(&self, render_pass: R) -> bool where
    R: RenderPassAbstract, 

Whether or not the given renderpass matches the framebuffer's render pass.

pub fn dimensions_match(&self, dimensions: [u32; 3]) -> bool

Whether or not the given dimensions match the current dimensions.

Trait Implementations

impl Default for FramebufferObject

fn default() -> FramebufferObject

Returns the "default value" for a type.

impl Deref for FramebufferObject

type Target = Option<Arc<dyn FramebufferAbstract + Send + Sync>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.