xiiRenderingSetup Class Reference

#include <RenderTargetSetup.h>

Public Member Functions
XII_FORCE_INLINE xiiRenderingSetup &	AddColorAttachment (const xiiAttachmentSettings &attachmentSettings)
	Adds a color attachment based on the provided settings.
XII_FORCE_INLINE xiiRenderingSetup &	SetDepthStencilAttachment (const xiiDepthStencilSettings &depthStencilSettings)
	Sets (or replaces) the depth-stencil attachment.
XII_FORCE_INLINE xiiRenderingSetup &	AddSubPass (const xiiGALSubPassDescription &subPass)
	Adds a sub pass description directly.
XII_FORCE_INLINE xiiRenderingSetup &	AddSubPassDependency (const xiiGALSubPassDependencyDescription &dependency)
	Adds a sub pass dependency.
void	Build ()
	Finalizes the setup. This gathers all attachments into the render pass and framebuffer creation descriptors. Optionally, if no sub passes were added, a default sub pass is generated with color attachments as render targets and the depth-stencil attachment as the depth attachment.
void	Reset ()
	This is the same as creating a new instance.
XII_ALWAYS_INLINE const xiiGALRenderPassCreationDescription &	GetRenderPassDescription () const
	Retrieves the render pass description.
XII_ALWAYS_INLINE const xiiGALFramebufferCreationDescription &	GetFramebufferDescription () const
	Retrieves the framebuffer description.
XII_ALWAYS_INLINE xiiArrayPtr< const xiiGALOptimizedClearValue >	GetClearValues () const
	Retrieves the render pass clear values.

Friends
class	xiiRenderContext

Detailed Description

xiiRenderingSetup encapsulates creating both the render pass and the framebuffer. It offers a unified interface with a fluent API:

xiiRenderingSetup setup;
setup.AddColorAttachment(myColorSettings)
  .SetDepthStencilAttachment(myDepthSettings)
  .AddSubPass(myCustomSubPass)
  .AddSubPassDependency(mySubPassDependency)
  .Build();

It automatically deduces the framebuffer size from the first attachment that is added.

See also

xiiGALRenderPassCreationDescription, xiiGALFramebufferCreationDescription, xiiRenderContext::BeginRendering

Member Function Documentation

GetFramebufferDescription()

XII_ALWAYS_INLINE const xiiGALFramebufferCreationDescription & xiiRenderingSetup::GetFramebufferDescription ( ) const

inlinenodiscard

Retrieves the framebuffer description.

Note

The render pass pointer is null, and is meant to be filled externally.

---

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

• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/RenderContext/RenderTargetSetup.h
• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/RenderContext/Implementation/RenderTargetSetup.cpp