Castor3D 0.12.0
Multiplatform 3D engine
Public Member Functions | Public Attributes | List of all members
castor3d::RenderNodesPassDesc Struct Reference

#include <RenderNodesPass.hpp>

Collaboration diagram for castor3d::RenderNodesPassDesc:
Collaboration graph
[legend]

Public Member Functions

 RenderNodesPassDesc (VkExtent3D size, MatrixUbo &matrixUbo, SceneCuller &culler, RenderMode mode, bool oit, bool forceTwoSided)
 
 RenderNodesPassDesc (VkExtent3D size, MatrixUbo &matrixUbo, SceneCuller &culler)
 Constructor for opaque passes. More...
 
 RenderNodesPassDesc (VkExtent3D size, MatrixUbo &matrixUbo, SceneCuller &culler, bool oit)
 Constructor for transparent passes. More...
 
RenderNodesPassDescignored (SceneNode const &value)
 
RenderNodesPassDescsafeBand (bool value)
 
RenderNodesPassDescpassCount (uint32_t value)
 
RenderNodesPassDescresettable (bool value)
 
RenderNodesPassDescimplicitAction (crg::ImageViewId view, crg::RecordContext::ImplicitAction action)
 

Public Attributes

VkExtent3D m_size
 
MatrixUbom_matrixUbo
 
SceneCullerm_culler
 
RenderMode m_mode
 
bool m_oit
 
bool m_forceTwoSided
 
bool m_safeBand {}
 
SceneNode const * m_ignored {}
 
uint32_t m_index { 0u }
 
crg::ru::Config m_ruConfig { 1u, true }
 

Constructor & Destructor Documentation

◆ RenderNodesPassDesc() [1/3]

castor3d::RenderNodesPassDesc::RenderNodesPassDesc ( VkExtent3D  size,
MatrixUbo matrixUbo,
SceneCuller culler,
RenderMode  mode,
bool  oit,
bool  forceTwoSided 
)
inline

◆ RenderNodesPassDesc() [2/3]

castor3d::RenderNodesPassDesc::RenderNodesPassDesc ( VkExtent3D  size,
MatrixUbo matrixUbo,
SceneCuller culler 
)
inline

Constructor for opaque passes.

Parameters
[in]sizeThe render area dimensions.
[in]matrixUboThe scene matrices UBO.
[in]cullerThe scene culler for this pass.

References castor3d::eOpaqueOnly.

◆ RenderNodesPassDesc() [3/3]

castor3d::RenderNodesPassDesc::RenderNodesPassDesc ( VkExtent3D  size,
MatrixUbo matrixUbo,
SceneCuller culler,
bool  oit 
)
inline

Constructor for transparent passes.

Parameters
[in]sizeThe render area dimensions.
[in]matrixUboThe scene matrices UBO.
[in]cullerThe scene culler for this pass.
[in]oitThe order independant status.

References castor3d::eTransparentOnly.

Member Function Documentation

◆ ignored()

RenderNodesPassDesc & castor3d::RenderNodesPassDesc::ignored ( SceneNode const &  value)
inline
Parameters
[in]valueThe scene node to ignore during rendering.

References m_ignored.

◆ implicitAction()

RenderNodesPassDesc & castor3d::RenderNodesPassDesc::implicitAction ( crg::ImageViewId  view,
crg::RecordContext::ImplicitAction  action 
)
inline
Parameters
[in]viewThe image view which the action is applied to.
[in]actionThe action.

References m_ruConfig.

◆ passCount()

RenderNodesPassDesc & castor3d::RenderNodesPassDesc::passCount ( uint32_t  value)
inline
Parameters
[in]valueThe max frame pass variants count.

References m_ruConfig.

◆ resettable()

RenderNodesPassDesc & castor3d::RenderNodesPassDesc::resettable ( bool  value)
inline
Parameters
[in]valueThe frame pass resettable status.

References m_ruConfig.

◆ safeBand()

RenderNodesPassDesc & castor3d::RenderNodesPassDesc::safeBand ( bool  value)
inline
Parameters
[in]valueThe scene node to ignore during rendering.

References m_safeBand.

Member Data Documentation

◆ m_culler

SceneCuller& castor3d::RenderNodesPassDesc::m_culler

◆ m_forceTwoSided

bool castor3d::RenderNodesPassDesc::m_forceTwoSided

◆ m_ignored

SceneNode const* castor3d::RenderNodesPassDesc::m_ignored {}

Referenced by ignored().

◆ m_index

uint32_t castor3d::RenderNodesPassDesc::m_index { 0u }

◆ m_matrixUbo

MatrixUbo& castor3d::RenderNodesPassDesc::m_matrixUbo

◆ m_mode

RenderMode castor3d::RenderNodesPassDesc::m_mode

◆ m_oit

bool castor3d::RenderNodesPassDesc::m_oit

◆ m_ruConfig

crg::ru::Config castor3d::RenderNodesPassDesc::m_ruConfig { 1u, true }

◆ m_safeBand

bool castor3d::RenderNodesPassDesc::m_safeBand {}

Referenced by safeBand().

◆ m_size

VkExtent3D castor3d::RenderNodesPassDesc::m_size

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