kanzi::RenderPassArchetype Class Reference

The Render Pass Archetype contains a set of Kanzi Graphics render pass objects that are all compatible. More...

#include <kanzi/core.ui/graphics/render_pass_archetype.hpp>

Classes
struct	AttachmentState
	Per-attachment information. More...

Public Member Functions
uint64_t	getIdentifier () const
	Gets the unique identifier that represents this archetype.
gfx::RenderPassHandleGuard	getPrototype ()
	Gets the render pass that represents the prototype for this archetype.
gfx::RenderPassHandleGuard	getVariant (span< AttachmentState > colorAttachmentStates, AttachmentState depthAttachmentState, AttachmentState stencilAttachmentState)
	Gets a compatible render pass with the specified load operations and MSAA resolve.
	RenderPassArchetype (const gfx::AttachmentDescriptionSet &fbads)
	Constructor.

Detailed Description

The Render Pass Archetype contains a set of Kanzi Graphics render pass objects that are all compatible.

Use the prototype render pass to construct render pipelines that are compatible with all render passes managed by this archetype.

Since

Kanzi 4.0.0

Constructor & Destructor Documentation

RenderPassArchetype()

kanzi::RenderPassArchetype::RenderPassArchetype

(

const gfx::AttachmentDescriptionSet &

fbads

)

Constructor.

Parameters

fbads

The set of framebuffer attachment descriptions.

Member Function Documentation

getPrototype()

gfx::RenderPassHandleGuard kanzi::RenderPassArchetype::getPrototype

(

)

Gets the render pass that represents the prototype for this archetype.

You can use this render pass with Kanzi Graphics to create render pipelines that are compatible with all render passes associated with this archetype.

Returns

The Kanzi Graphics render pass.

getIdentifier()

uint64_t kanzi::RenderPassArchetype::getIdentifier ( ) const

inline

Gets the unique identifier that represents this archetype.

getVariant()

gfx::RenderPassHandleGuard kanzi::RenderPassArchetype::getVariant	(	span< AttachmentState >	colorAttachmentStates,
		AttachmentState	depthAttachmentState,
		AttachmentState	stencilAttachmentState )

Gets a compatible render pass with the specified load operations and MSAA resolve.

Parameters

colorAttachmentStates	Span of color attachment states for each color attachment. If fewer operations are specified than needed, the last operation will be used for all remaining attachments. If extra operations are specified, they will be silently ignored.
depthAttachmentState	The attachment state for the depth attachment.
stencilAttachmentState	The attachment state for the stencil attachment.

Returns

A Kanzi Graphics render pass that is compatible with the archetype with the load operations as specified.

---

The documentation for this class was generated from the following file:

• kanzi/core.ui/graphics/render_pass_archetype.hpp