VisuTwin Canvas
C++ 3D Engine — Metal Backend
Loading...
Searching...
No Matches
visutwin::canvas::RenderPass Class Reference

#include <platform/graphics/renderPass.h>

Inheritance diagram for visutwin::canvas::RenderPass:
[legend]

Public Member Functions

void addAfterPass (const std::shared_ptr< RenderPass > &renderPass)
void addBeforePass (const std::shared_ptr< RenderPass > &renderPass)
virtual void after ()
const std::vector< std::shared_ptr< RenderPass > > & afterPasses () const
void allocateAttachments ()
virtual void before ()
const std::vector< std::shared_ptr< RenderPass > > & beforePasses () const
void clearAfterPasses ()
void clearBeforePasses ()
const std::vector< std::shared_ptr< ColorAttachmentOps > > & colorArrayOps () const
std::shared_ptr< ColorAttachmentOps > colorOps () const
std::shared_ptr< DepthStencilAttachmentOps > depthStencilOps () const
bool enabled () const
virtual void execute ()
virtual void frameUpdate () const
virtual void init (const std::shared_ptr< RenderTarget > &renderTarget=nullptr, const std::shared_ptr< RenderPassOptions > &options=nullptr)
void log (std::shared_ptr< GraphicsDevice > device, int index=0) const
virtual void onDisable ()
virtual void onEnable ()
virtual void postInit ()
void render ()
 RenderPass (const std::shared_ptr< GraphicsDevice > &device)
std::shared_ptr< RenderTarget > renderTarget () const
bool requiresCubemaps () const
float scaleX () const
float scaleY () const
void setClearColor (const Color *color=nullptr)
void setClearDepth (const float *depthValue=nullptr)
void setClearStencil (const int *stencilValue=nullptr)
void setEnabled (bool value)
void setOptions (const std::shared_ptr< RenderPassOptions > &value)
void setRequiresCubemaps (bool value)
void setSkipEnd (const bool value)
void setSkipStart (const bool value)

Protected Member Functions

std::shared_ptr< GraphicsDevice > device () const

Protected Attributes

std::string _name
bool _requiresCubemaps = true

Detailed Description

Definition at line 63 of file renderPass.h.

Constructor & Destructor Documentation

◆ RenderPass()

visutwin::canvas::RenderPass::RenderPass ( const std::shared_ptr< GraphicsDevice > & device)
inline

Definition at line 66 of file renderPass.h.

References device().

Referenced by visutwin::canvas::RenderPassBloom::RenderPassBloom(), visutwin::canvas::RenderPassCameraFrame::RenderPassCameraFrame(), visutwin::canvas::RenderPassColorGrab::RenderPassColorGrab(), visutwin::canvas::RenderPassCookieRenderer::RenderPassCookieRenderer(), visutwin::canvas::RenderPassDepthGrab::RenderPassDepthGrab(), visutwin::canvas::RenderPassDof::RenderPassDof(), visutwin::canvas::RenderPassForward::RenderPassForward(), visutwin::canvas::RenderPassPostprocessing::RenderPassPostprocessing(), visutwin::canvas::RenderPassPrepass::RenderPassPrepass(), visutwin::canvas::RenderPassShaderQuad::RenderPassShaderQuad(), visutwin::canvas::RenderPassShadowDirectional::RenderPassShadowDirectional(), visutwin::canvas::RenderPassShadowLocalClustered::RenderPassShadowLocalClustered(), visutwin::canvas::RenderPassShadowLocalNonClustered::RenderPassShadowLocalNonClustered(), and visutwin::canvas::RenderPassUpdateClustered::RenderPassUpdateClustered().

Member Function Documentation

◆ addAfterPass()

void visutwin::canvas::RenderPass::addAfterPass ( const std::shared_ptr< RenderPass > & renderPass)

Definition at line 244 of file renderPass.cpp.

Referenced by visutwin::canvas::RenderPassSsao::RenderPassSsao().

◆ addBeforePass()

void visutwin::canvas::RenderPass::addBeforePass ( const std::shared_ptr< RenderPass > & renderPass)

Definition at line 237 of file renderPass.cpp.

Referenced by visutwin::canvas::RenderPassDof::RenderPassDof(), visutwin::canvas::RenderPassPostprocessing::RenderPassPostprocessing(), and visutwin::canvas::RenderPassCameraFrame::updateSourceActions().

◆ after()

virtual void visutwin::canvas::RenderPass::after ( )
inlinevirtual

Reimplemented in visutwin::canvas::RenderPassForward, visutwin::canvas::RenderPassPrepass, visutwin::canvas::RenderPassShadowDirectional, and visutwin::canvas::RenderPassSsao.

Definition at line 74 of file renderPass.h.

Referenced by visutwin::canvas::RenderPassPrepass::after(), and render().

◆ afterPasses()

const std::vector< std::shared_ptr< RenderPass > > & visutwin::canvas::RenderPass::afterPasses ( ) const
inline

Definition at line 85 of file renderPass.h.

◆ allocateAttachments()

void visutwin::canvas::RenderPass::allocateAttachments ( )

Definition at line 103 of file renderPass.cpp.

References colorOps(), and visutwin::canvas::isIntegerPixelFormat().

Referenced by init().

◆ before()

virtual void visutwin::canvas::RenderPass::before ( )
inlinevirtual

Reimplemented in visutwin::canvas::RenderPassDepthGrab, visutwin::canvas::RenderPassForward, and visutwin::canvas::RenderPassTAA.

Definition at line 73 of file renderPass.h.

Referenced by render().

◆ beforePasses()

const std::vector< std::shared_ptr< RenderPass > > & visutwin::canvas::RenderPass::beforePasses ( ) const
inline

Definition at line 83 of file renderPass.h.

◆ clearAfterPasses()

void visutwin::canvas::RenderPass::clearAfterPasses ( )

Definition at line 256 of file renderPass.cpp.

◆ clearBeforePasses()

void visutwin::canvas::RenderPass::clearBeforePasses ( )

Definition at line 251 of file renderPass.cpp.

Referenced by visutwin::canvas::RenderPassCameraFrame::reset(), and visutwin::canvas::RenderPassCameraFrame::updateSourceActions().

◆ colorArrayOps()

const std::vector< std::shared_ptr< ColorAttachmentOps > > & visutwin::canvas::RenderPass::colorArrayOps ( ) const
inline

Definition at line 100 of file renderPass.h.

Referenced by visutwin::canvas::MetalGraphicsDevice::endRenderPass(), and visutwin::canvas::MetalGraphicsDevice::startRenderPass().

◆ colorOps()

std::shared_ptr< ColorAttachmentOps > visutwin::canvas::RenderPass::colorOps ( ) const

Definition at line 229 of file renderPass.cpp.

Referenced by allocateAttachments(), setClearColor(), visutwin::canvas::ShadowRenderer::setupRenderPass(), and visutwin::canvas::MetalGraphicsDevice::startRenderPass().

◆ depthStencilOps()

std::shared_ptr< DepthStencilAttachmentOps > visutwin::canvas::RenderPass::depthStencilOps ( ) const
inline

Definition at line 102 of file renderPass.h.

Referenced by visutwin::canvas::ShadowRenderer::setupRenderPass(), and visutwin::canvas::MetalGraphicsDevice::startRenderPass().

◆ device()

std::shared_ptr< GraphicsDevice > visutwin::canvas::RenderPass::device ( ) const
inlineprotected

Definition at line 124 of file renderPass.h.

Referenced by visutwin::canvas::RenderPassForward::after(), visutwin::canvas::RenderPassPrepass::after(), visutwin::canvas::RenderPassDepthGrab::before(), visutwin::canvas::RenderPassForward::before(), visutwin::canvas::RenderPassCameraFrame::destroy(), visutwin::canvas::RenderPassCoC::execute(), visutwin::canvas::RenderPassCompose::execute(), visutwin::canvas::RenderPassDepthAwareBlur::execute(), visutwin::canvas::RenderPassDofBlur::execute(), visutwin::canvas::RenderPassShaderQuad::execute(), visutwin::canvas::RenderPassSsao::execute(), visutwin::canvas::RenderPassTAA::execute(), visutwin::canvas::RenderPassCameraFrame::frameUpdate(), log(), RenderPass(), visutwin::canvas::RenderPassBloom::RenderPassBloom(), visutwin::canvas::RenderPassCameraFrame::RenderPassCameraFrame(), visutwin::canvas::RenderPassCoC::RenderPassCoC(), visutwin::canvas::RenderPassColorGrab::RenderPassColorGrab(), visutwin::canvas::RenderPassCompose::RenderPassCompose(), visutwin::canvas::RenderPassCookieRenderer::RenderPassCookieRenderer(), visutwin::canvas::RenderPassDepthAwareBlur::RenderPassDepthAwareBlur(), visutwin::canvas::RenderPassDepthGrab::RenderPassDepthGrab(), visutwin::canvas::RenderPassDof::RenderPassDof(), visutwin::canvas::RenderPassDofBlur::RenderPassDofBlur(), visutwin::canvas::RenderPassDownsample::RenderPassDownsample(), visutwin::canvas::RenderPassDownsample::RenderPassDownsample(), visutwin::canvas::RenderPassForward::RenderPassForward(), visutwin::canvas::RenderPassPostprocessing::RenderPassPostprocessing(), visutwin::canvas::RenderPassPrepass::RenderPassPrepass(), visutwin::canvas::RenderPassShaderQuad::RenderPassShaderQuad(), visutwin::canvas::RenderPassShadowDirectional::RenderPassShadowDirectional(), visutwin::canvas::RenderPassShadowLocalClustered::RenderPassShadowLocalClustered(), visutwin::canvas::RenderPassShadowLocalNonClustered::RenderPassShadowLocalNonClustered(), visutwin::canvas::RenderPassSsao::RenderPassSsao(), visutwin::canvas::RenderPassTAA::RenderPassTAA(), visutwin::canvas::RenderPassUpdateClustered::RenderPassUpdateClustered(), and visutwin::canvas::RenderPassUpsample::RenderPassUpsample().

◆ enabled()

bool visutwin::canvas::RenderPass::enabled ( ) const
inline

Definition at line 95 of file renderPass.h.

◆ execute()

virtual void visutwin::canvas::RenderPass::execute ( )
inlinevirtual

Reimplemented in visutwin::canvas::RenderPassCoC, visutwin::canvas::RenderPassCompose, visutwin::canvas::RenderPassDepthAwareBlur, visutwin::canvas::RenderPassDepthGrab, visutwin::canvas::RenderPassDofBlur, visutwin::canvas::RenderPassDownsample, visutwin::canvas::RenderPassForward, visutwin::canvas::RenderPassPostprocessing, visutwin::canvas::RenderPassPrepass, visutwin::canvas::RenderPassShaderQuad, visutwin::canvas::RenderPassShadowDirectional, visutwin::canvas::RenderPassShadowLocalNonClustered, visutwin::canvas::RenderPassSsao, visutwin::canvas::RenderPassTAA, and visutwin::canvas::RenderPassUpsample.

Definition at line 75 of file renderPass.h.

Referenced by render().

◆ frameUpdate()

void visutwin::canvas::RenderPass::frameUpdate ( ) const
virtual

Reimplemented in visutwin::canvas::RenderPassBloom, visutwin::canvas::RenderPassCameraFrame, visutwin::canvas::RenderPassDof, and visutwin::canvas::RenderPassTAA.

Definition at line 13 of file renderPass.cpp.

References scaleX(), and scaleY().

Referenced by visutwin::canvas::RenderPassBloom::frameUpdate(), visutwin::canvas::RenderPassCameraFrame::frameUpdate(), visutwin::canvas::RenderPassDof::frameUpdate(), and visutwin::canvas::RenderPassTAA::frameUpdate().

◆ init()

void visutwin::canvas::RenderPass::init ( const std::shared_ptr< RenderTarget > & renderTarget = nullptr,
const std::shared_ptr< RenderPassOptions > & options = nullptr )
virtual

Definition at line 68 of file renderPass.cpp.

References allocateAttachments(), postInit(), renderTarget(), and setOptions().

Referenced by visutwin::canvas::RenderPassPostprocessing::RenderPassPostprocessing(), visutwin::canvas::RenderPassSsao::RenderPassSsao(), visutwin::canvas::ShadowRenderer::setupRenderPass(), and visutwin::canvas::RenderPassTAA::update().

◆ log()

void visutwin::canvas::RenderPass::log ( std::shared_ptr< GraphicsDevice > device,
int index = 0 ) const

Definition at line 181 of file renderPass.cpp.

References device().

Referenced by render().

◆ onDisable()

virtual void visutwin::canvas::RenderPass::onDisable ( )
inlinevirtual

Reimplemented in visutwin::canvas::RenderPassBloom.

Definition at line 111 of file renderPass.h.

Referenced by setEnabled().

◆ onEnable()

virtual void visutwin::canvas::RenderPass::onEnable ( )
inlinevirtual

Definition at line 110 of file renderPass.h.

Referenced by setEnabled().

◆ postInit()

virtual void visutwin::canvas::RenderPass::postInit ( )
inlinevirtual

Definition at line 117 of file renderPass.h.

Referenced by init().

◆ render()

void visutwin::canvas::RenderPass::render ( )

Definition at line 25 of file renderPass.cpp.

References after(), before(), execute(), and log().

◆ renderTarget()

std::shared_ptr< RenderTarget > visutwin::canvas::RenderPass::renderTarget ( ) const
inline

Definition at line 98 of file renderPass.h.

Referenced by visutwin::canvas::RenderPassDepthAwareBlur::execute(), visutwin::canvas::RenderPassDofBlur::execute(), visutwin::canvas::RenderPassSsao::execute(), init(), and visutwin::canvas::MetalGraphicsDevice::startRenderPass().

◆ requiresCubemaps()

bool visutwin::canvas::RenderPass::requiresCubemaps ( ) const
inline

Definition at line 107 of file renderPass.h.

References _requiresCubemaps.

◆ scaleX()

float visutwin::canvas::RenderPass::scaleX ( ) const
inline

Definition at line 79 of file renderPass.h.

Referenced by frameUpdate().

◆ scaleY()

float visutwin::canvas::RenderPass::scaleY ( ) const
inline

Definition at line 81 of file renderPass.h.

Referenced by frameUpdate().

◆ setClearColor()

void visutwin::canvas::RenderPass::setClearColor ( const Color * color = nullptr)

Definition at line 140 of file renderPass.cpp.

References colorOps().

Referenced by visutwin::canvas::RenderPassSsao::RenderPassSsao().

◆ setClearDepth()

void visutwin::canvas::RenderPass::setClearDepth ( const float * depthValue = nullptr)

Definition at line 157 of file renderPass.cpp.

◆ setClearStencil()

void visutwin::canvas::RenderPass::setClearStencil ( const int * stencilValue = nullptr)

Definition at line 169 of file renderPass.cpp.

◆ setEnabled()

void visutwin::canvas::RenderPass::setEnabled ( bool value)

Definition at line 57 of file renderPass.cpp.

References onDisable(), and onEnable().

Referenced by visutwin::canvas::RenderPassShadowLocalClustered::update().

◆ setOptions()

void visutwin::canvas::RenderPass::setOptions ( const std::shared_ptr< RenderPassOptions > & value)

Definition at line 86 of file renderPass.cpp.

Referenced by visutwin::canvas::RenderPassTAA::before(), init(), visutwin::canvas::RenderPassPrepass::RenderPassPrepass(), and visutwin::canvas::RenderPassSsao::setScale().

◆ setRequiresCubemaps()

void visutwin::canvas::RenderPass::setRequiresCubemaps ( bool value)
inline

Definition at line 108 of file renderPass.h.

References _requiresCubemaps.

Referenced by visutwin::canvas::ShadowRenderer::setupRenderPass().

◆ setSkipEnd()

void visutwin::canvas::RenderPass::setSkipEnd ( const bool value)
inline

Definition at line 105 of file renderPass.h.

◆ setSkipStart()

void visutwin::canvas::RenderPass::setSkipStart ( const bool value)
inline

Definition at line 104 of file renderPass.h.

Member Data Documentation

◆ _name

std::string visutwin::canvas::RenderPass::_name
protected

Definition at line 128 of file renderPass.h.

Referenced by visutwin::canvas::RenderPassShadowDirectional::RenderPassShadowDirectional().

◆ _requiresCubemaps

bool visutwin::canvas::RenderPass::_requiresCubemaps = true
protected

Definition at line 126 of file renderPass.h.

Referenced by visutwin::canvas::RenderPassShadowDirectional::RenderPassShadowDirectional(), visutwin::canvas::RenderPassShadowLocalNonClustered::RenderPassShadowLocalNonClustered(), requiresCubemaps(), and setRequiresCubemaps().

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