Struct vulkano::framebuffer::RenderPass

pub struct RenderPass<D> { /* fields omitted */ }

Defines the layout of multiple subpasses.

The RenderPass struct should always implement the RenderPassAbstract trait. Therefore you can turn any Arc<RenderPass<D>> into a Arc<RenderPassAbstract + Send + Sync> if you need to.

Methods

impl<D> RenderPass<D> where
    D: RenderPassDesc, 

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

Builds a new render pass.

Panic

• Can panic if it detects some violations in the restrictions. Only unexpensive checks are performed. debug_assert! is used, so some restrictions are only checked in debug mode.

impl RenderPass<EmptySinglePassRenderPassDesc>

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

Builds a render pass with one subpass and no attachment.

This method is useful for quick tests.

impl<D> RenderPass<D>

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 performances will be optimal. Performances are always optimal for render areas that cover the whole framebuffer.

pub fn desc(&self) -> &D

Returns the description of the render pass.

Note: You must not somehow modify the description. This shouldn't be possible anyway if RenderPassDesc was implemented correctly.

Trait Implementations

impl<D> RenderPassDesc for RenderPass<D> where
    D: RenderPassDesc, 

fn num_attachments(&self) -> usize

Returns the number of attachments of the render pass.

fn attachment_desc(&self, num: usize) -> Option<LayoutAttachmentDescription>

Returns the description of an attachment.

fn num_subpasses(&self) -> usize

Returns the number of subpasses of the render pass.

fn subpass_desc(&self, num: usize) -> Option<LayoutPassDescription>

Returns the description of a subpass.

fn num_dependencies(&self) -> usize

Returns the number of dependencies of the render pass.

fn dependency_desc(&self, num: usize) -> Option<LayoutPassDependencyDescription>

Returns the description of a dependency.

Important traits for RenderPassDescAttachments<'a, R>

impl<'a, R: ?Sized + 'a> Iterator for RenderPassDescAttachments<'a, R> where
    R: RenderPassDesc,  type Item = LayoutAttachmentDescription;

fn attachment_descs(&self) -> RenderPassDescAttachments<Self> where
    Self: Sized, 

Returns an iterator to the list of attachments.

Important traits for RenderPassDescSubpasses<'a, R>

impl<'a, R: ?Sized + 'a> Iterator for RenderPassDescSubpasses<'a, R> where
    R: RenderPassDesc,  type Item = LayoutPassDescription;

fn subpass_descs(&self) -> RenderPassDescSubpasses<Self> where
    Self: Sized, 

Returns an iterator to the list of subpasses.

Important traits for RenderPassDescDependencies<'a, R>

impl<'a, R: ?Sized + 'a> Iterator for RenderPassDescDependencies<'a, R> where
    R: RenderPassDesc,  type Item = LayoutPassDependencyDescription;

fn dependency_descs(&self) -> RenderPassDescDependencies<Self> where
    Self: Sized, 

Returns an iterator to the list of dependencies.

fn is_compatible_with<T: ?Sized>(&self, other: &T) -> bool where
    Self: Sized,
    T: RenderPassDesc, 

Returns true if this render pass is compatible with another render pass.

fn build_render_pass(
    self,
    device: Arc<Device>
) -> Result<RenderPass<Self>, RenderPassCreationError> where
    Self: Sized, 

Builds a render pass from this description.

fn num_color_attachments(&self, subpass: u32) -> Option<u32>

Returns the number of color attachments of a subpass. Returns None if out of range.

fn num_samples(&self, subpass: u32) -> Option<u32>

Returns the number of samples of the attachments of a subpass. Returns None if out of range or if the subpass has no attachment. TODO: return an enum instead?

fn has_depth_stencil_attachment(&self, subpass: u32) -> Option<(bool, bool)>

Returns a tuple whose first element is true if there's a depth attachment, and whose second element is true if there's a stencil attachment. Returns None if out of range.

fn has_depth(&self, subpass: u32) -> Option<bool>

Returns true if a subpass has a depth attachment or a depth-stencil attachment.

fn has_writable_depth(&self, subpass: u32) -> Option<bool>

Returns true if a subpass has a depth attachment or a depth-stencil attachment whose layout is not DepthStencilReadOnlyOptimal.

fn has_stencil(&self, subpass: u32) -> Option<bool>

Returns true if a subpass has a stencil attachment or a depth-stencil attachment.

fn has_writable_stencil(&self, subpass: u32) -> Option<bool>

Returns true if a subpass has a stencil attachment or a depth-stencil attachment whose layout is not DepthStencilReadOnlyOptimal.

impl<C, D> RenderPassDescClearValues<C> for RenderPass<D> where
    D: RenderPassDescClearValues<C>, 

fn convert_clear_values(&self, vals: C) -> Box<Iterator<Item = ClearValue>>

Decodes a C 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.

impl<D> RenderPassAbstract for RenderPass<D> where
    D: RenderPassDesc, 

fn inner(&self) -> RenderPassSys

Returns an opaque object representing the render pass' internals.

impl<D> DeviceOwned for RenderPass<D>

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl<D> Debug for RenderPass<D> where
    D: Debug, 

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<D> Drop for RenderPass<D>

fn drop(&mut self)

Executes the destructor for this type.