Castor3D 0.12.0
Multiplatform 3D engine
Public Member Functions | Static Public Attributes | List of all members
castor3d::ShadowMapPassDirectional Class Reference

#include <ShadowMapPassDirectional.hpp>

Inheritance diagram for castor3d::ShadowMapPassDirectional:
Inheritance graph
[legend]
Collaboration diagram for castor3d::ShadowMapPassDirectional:
Collaboration graph
[legend]

Public Member Functions

C3D_API ShadowMapPassDirectional (crg::FramePass const &pass, crg::GraphContext &context, crg::RunnableGraph &graph, RenderDevice const &device, MatrixUbo &matrixUbo, SceneCuller &culler, ShadowMap const &shadowMap, uint32_t cascadeCount)
 Constructor. More...
 
C3D_API ~ShadowMapPassDirectional () override
 Destructor. More...
 
C3D_API void update (CpuUpdater &updater) override
 Updates the render pass, CPU wise. More...
 
C3D_API void update (GpuUpdater &updater) override
 Updates the render pass, CPU wise. More...
 
- Public Member Functions inherited from castor3d::ShadowMapPass
C3D_API ShadowMapPass (crg::FramePass const &pass, crg::GraphContext &context, crg::RunnableGraph &graph, RenderDevice const &device, castor::String const &typeName, castor::String name, MatrixUbo &matrixUbo, SceneCuller &culler, ShadowMap const &shadowMap)
 Constructor. More...
 
bool isUpToDate () const
 
TextureFlags getTexturesMask () const override
 
ShaderFlags getShaderFlags () const override
 
void setUpToDate ()
 
- Public Member Functions inherited from castor3d::RenderNodesPass
C3D_API ~RenderNodesPass () override
 Destructor. More...
 
virtual C3D_API void update (CpuUpdater &updater)
 Updates the render pass, CPU wise. More...
 
virtual C3D_API void update (GpuUpdater &updater)
 Updates the render pass, GPU wise. More...
 
C3D_API ShaderPtr getVertexShaderSource (PipelineFlags const &flags) const
 Retrieves the vertex shader source matching the given flags. More...
 
C3D_API ShaderPtr getHullShaderSource (PipelineFlags const &flags) const
 Retrieves the hull shader source matching the given flags. More...
 
C3D_API ShaderPtr getDomainShaderSource (PipelineFlags const &flags) const
 Retrieves the domain shader source matching the given flags. More...
 
C3D_API ShaderPtr getGeometryShaderSource (PipelineFlags const &flags) const
 Retrieves the geometry shader source matching the given flags. More...
 
C3D_API ShaderPtr getPixelShaderSource (PipelineFlags const &flags) const
 Retrieves the pixel shader source matching the given flags. More...
 
C3D_API PassFlags adjustFlags (PassFlags flags) const
 Adjusts given flags to match the render pass requirements. More...
 
C3D_API ProgramFlags adjustFlags (ProgramFlags flags) const
 Adjusts given flags to match the render pass requirements. More...
 
C3D_API SceneFlags adjustFlags (SceneFlags flags) const
 Adjusts given flags to match the render pass requirements. More...
 
C3D_API PipelineFlags createPipelineFlags (BlendMode colourBlendMode, BlendMode alphaBlendMode, PassFlags passFlags, RenderPassTypeID renderPassTypeID, PassTypeID passTypeID, uint32_t heightTextureIndex, VkCompareOp alphaFunc, VkCompareOp blendAlphaFunc, TextureFlagsArray const &textures, ProgramFlags const &programFlags, SceneFlags const &sceneFlags, VkPrimitiveTopology topology, bool isFrontCulled)
 Creates the pipeline flags for given configuration. More...
 
C3D_API PipelineFlags createPipelineFlags (Pass const &pass, TextureFlagsArray const &textures, ProgramFlags const &programFlags, SceneFlags const &sceneFlags, VkPrimitiveTopology topology, bool isFrontCulled)
 Creates the pipeline flags for given configuration. More...
 
C3D_API RenderPipelineprepareBackPipeline (PipelineFlags pipelineFlags, ashes::PipelineVertexInputStateCreateInfoCRefArray const &vertexLayouts)
 Prepares the pipeline matching the given flags, for back face culling nodes. More...
 
C3D_API RenderPipelineprepareFrontPipeline (PipelineFlags pipelineFlags, ashes::PipelineVertexInputStateCreateInfoCRefArray const &vertexLayouts)
 Prepares the pipeline matching the given flags, for front face culling nodes. More...
 
C3D_API void initialiseAdditionalDescriptor (RenderPipeline &pipeline, ShadowMapLightTypeArray const &shadowMaps)
 Initialises the additional descriptor set of a billboard node. More...
 
C3D_API FilteredTextureFlags filterTexturesFlags (TextureFlagsArray const &textures) const
 Filters the given textures flags using this pass needed textures. More...
 
C3D_API void setIgnoredNode (SceneNode const &node)
 Sets the node ignored node. More...
 
C3D_API bool isValidPass (Pass const &pass) const
 
C3D_API bool isValidRenderable (RenderedObject const &object) const
 
C3D_API bool hasNodes () const
 
C3D_API bool isPassEnabled () const
 
C3D_API ScenegetScene () const
 
C3D_API SceneNode const * getIgnoredNode () const
 
bool isOrderIndependent () const
 
SceneCuller const & getCuller () const
 
SceneCullergetCuller ()
 
SceneUbogetSceneUbo ()
 
SceneUbo const & getSceneUbo () const
 
MatrixUbogetMatrixUbo () const
 
uint32_t getPipelinesCount () const
 
bool isDirty () const
 
bool forceTwoSided () const
 
RenderMode getRenderMode () const
 
castor::String const & getTypeName () const
 
RenderPassTypeID getTypeID () const
 

Static Public Attributes

static C3D_API uint32_t const TileSize
 
static C3D_API uint32_t const TileCountX
 
static C3D_API uint32_t const TileCountY
 
static C3D_API castor::String const Type
 

Additional Inherited Members

- Static Public Member Functions inherited from castor3d::RenderNodesPass
static C3D_API ashes::PipelineColorBlendStateCreateInfo createBlendState (BlendMode colourBlendMode, BlendMode alphaBlendMode, uint32_t attachesCount)
 Creates a blend state matching given blend modes. More...
 
- Protected Member Functions inherited from castor3d::ShadowMapPass
void doUpdateNodes (QueueRenderNodes &nodes)
 Updates the given nodes. More...
 
- Protected Member Functions inherited from castor3d::RenderNodesPass
C3D_API RenderNodesPass (crg::FramePass const &pass, crg::GraphContext &context, crg::RunnableGraph &graph, RenderDevice const &device, castor::String const &typeName, castor::String const &category, castor::String const &name, RenderNodesPassDesc const &desc)
 Constructor. More...
 
C3D_API void doUpdate (SubmeshRenderNodesPtrByPipelineMap &nodes)
 Updates instantiated submeshes. More...
 
C3D_API void doUpdate (SubmeshRenderNodesPtrByPipelineMap &nodes, RenderInfo &info)
 Updates instantiated submeshes. More...
 
C3D_API void doUpdate (SubmeshRenderNodePtrByPipelineMap &nodes)
 Updates non instantiated submeshes. More...
 
C3D_API void doUpdate (SubmeshRenderNodePtrByPipelineMap &nodes, RenderInfo &info)
 Updates non instantiated submeshes. More...
 
C3D_API void doUpdate (BillboardRenderNodePtrByPipelineMap &nodes)
 Updates billboards. More...
 
C3D_API void doUpdate (BillboardRenderNodePtrByPipelineMap &nodes, RenderInfo &info)
 Updates billboards. More...
 
virtual C3D_API void doUpdate (RenderQueueArray &queues)
 Updates the specific data. More...
 
virtual C3D_API void doUpdateUbos (CpuUpdater &updater)
 Updates the render pass, CPU wise. More...
 
virtual C3D_API void doFillAdditionalBindings (ashes::VkDescriptorSetLayoutBindingArray &bindings) const =0
 Fills the render pass specific descriptor layout bindings. More...
 
virtual C3D_API bool doAreValidPassFlags (PassFlags const &passFlags) const
 
virtual C3D_API bool doIsValidPass (Pass const &pass) const
 
virtual C3D_API bool doIsValidRenderable (RenderedObject const &object) const
 
virtual C3D_API PassFlags doAdjustPassFlags (PassFlags flags) const
 
virtual C3D_API ProgramFlags doAdjustProgramFlags (ProgramFlags flags) const
 
virtual C3D_API SceneFlags doAdjustSceneFlags (SceneFlags flags) const
 
C3D_API ShaderProgramSPtr doGetProgram (PipelineFlags const &flags, VkCullModeFlags cullMode=VK_CULL_MODE_NONE)
 
- Protected Attributes inherited from castor3d::ShadowMapPass
ShadowMap const & m_shadowMap
 
bool m_initialised { false }
 
bool m_outOfDate { true }
 
ShadowMapUbo m_shadowMapUbo
 
- Protected Attributes inherited from castor3d::RenderNodesPass
RenderDevice const & m_device
 
RenderSystemm_renderSystem
 
MatrixUbom_matrixUbo
 
SceneCullerm_culler
 
castor::String m_typeName
 
RenderPassTypeID m_typeID {}
 
RenderQueueUPtr m_renderQueue
 
castor::String m_category
 
castor::Size m_size
 
RenderMode m_mode { RenderMode::eBoth }
 
bool m_oit { false }
 
bool m_forceTwoSided { false }
 
bool m_safeBand { false }
 
bool m_isDirty { true }
 
SceneUbo m_sceneUbo
 
uint32_t m_index { 0u }
 
std::array< PassDescriptors, size_t(RenderNodeType::eCount) > m_additionalDescriptors
 

Constructor & Destructor Documentation

◆ ShadowMapPassDirectional()

C3D_API castor3d::ShadowMapPassDirectional::ShadowMapPassDirectional ( crg::FramePass const &  pass,
crg::GraphContext &  context,
crg::RunnableGraph &  graph,
RenderDevice const &  device,
MatrixUbo matrixUbo,
SceneCuller culler,
ShadowMap const &  shadowMap,
uint32_t  cascadeCount 
)

Constructor.

Parameters
[in]passThe parent frame pass.
[in]contextThe rendering context.
[in]graphThe runnable graph.
[in]deviceThe GPU device.
[in]matrixUboThe scene matrices UBO.
[in]cullerThe culler for this pass.
[in]shadowMapThe parent shadow map.
[in]cascadeCountThe cascades count, used to instantiate objects.

◆ ~ShadowMapPassDirectional()

C3D_API castor3d::ShadowMapPassDirectional::~ShadowMapPassDirectional ( )
override

Destructor.

Member Function Documentation

◆ update() [1/2]

C3D_API void castor3d::ShadowMapPassDirectional::update ( CpuUpdater updater)
overridevirtual

Updates the render pass, CPU wise.

Parameters
[in,out]updaterThe update data.

Reimplemented from castor3d::RenderNodesPass.

◆ update() [2/2]

C3D_API void castor3d::ShadowMapPassDirectional::update ( GpuUpdater updater)
overridevirtual

Updates the render pass, CPU wise.

Parameters
[in,out]updaterThe update data.

Reimplemented from castor3d::RenderNodesPass.

Member Data Documentation

◆ TileCountX

C3D_API uint32_t const castor3d::ShadowMapPassDirectional::TileCountX
static

◆ TileCountY

C3D_API uint32_t const castor3d::ShadowMapPassDirectional::TileCountY
static

◆ TileSize

C3D_API uint32_t const castor3d::ShadowMapPassDirectional::TileSize
static

◆ Type

C3D_API castor::String const castor3d::ShadowMapPassDirectional::Type
static

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