castor3d::SceneCuller Class Reference

#include <SceneCuller.hpp>

Inheritance diagram for castor3d::SceneCuller:

Collaboration diagram for castor3d::SceneCuller:

Classes
struct	RenderPassBuffers

Public Types
template<typename NodeT >
using	NodeArrayT = std::vector< NodeT const * >
template<typename NodeT >
using	SidedNodeArrayT = std::vector< std::pair< NodeT const *, bool > >
template<typename NodeT >
using	SidedNodeBufferMapT = std::map< ashes::BufferBase const *, SidedNodeArrayT< NodeT > >
template<typename NodeT >
using	SidedNodePipelineMapT = std::map< uint64_t, SidedNodeBufferMapT< NodeT > >
template<typename NodeT >
using	SidedObjectNodeMapT = std::map< NodeObjectT< NodeT > const *, SidedNodeArrayT< NodeT > >
template<typename NodeT >
using	SidedObjectNodePassMapT = std::map< Pass const *, SidedObjectNodeMapT< NodeT > >
template<typename NodeT >
using	SidedObjectNodeBufferMapT = std::map< ashes::BufferBase const *, SidedObjectNodePassMapT< NodeT > >
template<typename NodeT >
using	SidedObjectNodePipelineMapT = std::map< uint64_t, SidedObjectNodeBufferMapT< NodeT > >
using	IndexedDrawCommandsBuffer = ashes::BufferPtr< VkDrawIndexedIndirectCommand >
using	DrawCommandsBuffer = ashes::BufferPtr< VkDrawIndirectCommand >
using	PipelineNodesBuffer = ashes::BufferPtr< PipelineNodes >
using	PipelineBufferArray = std::vector< PipelineBuffer >

Public Member Functions
C3D_API	SceneCuller (Scene &scene, Camera *camera)
virtual C3D_API	~SceneCuller ()=default
C3D_API void	registerRenderPass (RenderNodesPass const &renderPass)
C3D_API void	unregisterRenderPass (RenderNodesPass const &renderPass)
C3D_API void	compute ()
C3D_API uint32_t	getPipelineNodesIndex (RenderNodesPass const &renderPass, Submesh const &submesh, Pass const &pass, ashes::BufferBase const &buffer, bool isFrontCulled) const
C3D_API uint32_t	getPipelineNodesIndex (RenderNodesPass const &renderPass, BillboardBase const &billboard, Pass const &pass, ashes::BufferBase const &buffer, bool isFrontCulled) const
float	getMinCastersZ ()
Scene &	getScene () const
bool	hasCamera () const
Camera const &	getCamera () const
Camera &	getCamera ()
bool	areAllChanged () const
bool	areCulledChanged () const
bool	hasCulledNodes (RenderNodesPass const &renderPass) const
ashes::Buffer< VkDrawIndexedIndirectCommand > const &	getSubmeshIdxCommands (RenderNodesPass const &renderPass) const
ashes::Buffer< VkDrawIndirectCommand > const &	getSubmeshNIdxCommands (RenderNodesPass const &renderPass) const
ashes::Buffer< VkDrawIndirectCommand > const &	getBillboardCommands (RenderNodesPass const &renderPass) const
ashes::Buffer< PipelineNodes > const &	getNodesIds (RenderNodesPass const &renderPass) const
SidedNodePipelineMapT< SubmeshRenderNode > const &	getSubmeshNodes (RenderNodesPass const &renderPass) const
SidedObjectNodePipelineMapT< SubmeshRenderNode > const &	getInstancedSubmeshNodes (RenderNodesPass const &renderPass) const
SidedNodePipelineMapT< BillboardRenderNode > const &	getBillboardNodes (RenderNodesPass const &renderPass) const

Public Attributes
SceneCullerSignal	onCompute

Protected Attributes
Camera *	m_camera
uint32_t	m_index
bool	m_allChanged { true }
bool	m_culledChanged { true }
bool	m_sceneDirty { true }
bool	m_cameraDirty { true }
float	m_minCullersZ { 0.0f }
NodeArrayT< SubmeshRenderNode >	m_culledSubmeshes
NodeArrayT< BillboardRenderNode >	m_culledBillboards
std::map< RenderNodesPass const *, RenderPassBuffers >	m_renderPasses
OnSceneChangedConnection	m_sceneChanged
OnCameraChangedConnection	m_cameraChanged

Member Typedef Documentation

DrawCommandsBuffer

using castor3d::SceneCuller::DrawCommandsBuffer = ashes::BufferPtr< VkDrawIndirectCommand >

IndexedDrawCommandsBuffer

using castor3d::SceneCuller::IndexedDrawCommandsBuffer = ashes::BufferPtr< VkDrawIndexedIndirectCommand >

NodeArrayT

template<typename NodeT >

using castor3d::SceneCuller::NodeArrayT = std::vector< NodeT const * >

PipelineBufferArray

using castor3d::SceneCuller::PipelineBufferArray = std::vector< PipelineBuffer >

PipelineNodesBuffer

using castor3d::SceneCuller::PipelineNodesBuffer = ashes::BufferPtr< PipelineNodes >

SidedNodeArrayT

template<typename NodeT >

using castor3d::SceneCuller::SidedNodeArrayT = std::vector< std::pair< NodeT const *, bool > >

SidedNodeBufferMapT

template<typename NodeT >

using castor3d::SceneCuller::SidedNodeBufferMapT = std::map< ashes::BufferBase const *, SidedNodeArrayT< NodeT > >

SidedNodePipelineMapT

template<typename NodeT >

using castor3d::SceneCuller::SidedNodePipelineMapT = std::map< uint64_t, SidedNodeBufferMapT< NodeT > >

SidedObjectNodeBufferMapT

template<typename NodeT >

using castor3d::SceneCuller::SidedObjectNodeBufferMapT = std::map< ashes::BufferBase const *, SidedObjectNodePassMapT< NodeT > >

SidedObjectNodeMapT

template<typename NodeT >

using castor3d::SceneCuller::SidedObjectNodeMapT = std::map< NodeObjectT< NodeT > const *, SidedNodeArrayT< NodeT > >

SidedObjectNodePassMapT

template<typename NodeT >

using castor3d::SceneCuller::SidedObjectNodePassMapT = std::map< Pass const *, SidedObjectNodeMapT< NodeT > >

SidedObjectNodePipelineMapT

template<typename NodeT >

using castor3d::SceneCuller::SidedObjectNodePipelineMapT = std::map< uint64_t, SidedObjectNodeBufferMapT< NodeT > >

Constructor & Destructor Documentation

SceneCuller()

C3D_API castor3d::SceneCuller::SceneCuller	(	Scene &	scene,
		Camera *	camera
	)

~SceneCuller()

virtual C3D_API castor3d::SceneCuller::~SceneCuller ( )

virtualdefault

Member Function Documentation

areAllChanged()

bool castor3d::SceneCuller::areAllChanged ( ) const

inline

References m_allChanged.

areCulledChanged()

bool castor3d::SceneCuller::areCulledChanged ( ) const

inline

References m_culledChanged.

compute()

C3D_API void castor3d::SceneCuller::compute

(

)

getBillboardCommands()

ashes::Buffer< VkDrawIndirectCommand > const & castor3d::SceneCuller::getBillboardCommands ( RenderNodesPass const &  renderPass ) const

inline

References m_renderPasses.

getBillboardNodes()

SidedNodePipelineMapT< BillboardRenderNode > const & castor3d::SceneCuller::getBillboardNodes ( RenderNodesPass const &  renderPass ) const

inline

References m_renderPasses.

getCamera() [1/2]

Camera & castor3d::SceneCuller::getCamera ( )

inline

References hasCamera(), and m_camera.

Here is the call graph for this function:

getCamera() [2/2]

Camera const & castor3d::SceneCuller::getCamera ( ) const

inline

References hasCamera(), and m_camera.

Here is the call graph for this function:

getInstancedSubmeshNodes()

SidedObjectNodePipelineMapT< SubmeshRenderNode > const & castor3d::SceneCuller::getInstancedSubmeshNodes ( RenderNodesPass const &  renderPass ) const

inline

References m_renderPasses.

getMinCastersZ()

float castor3d::SceneCuller::getMinCastersZ ( )

inline

References m_minCullersZ.

getNodesIds()

ashes::Buffer< PipelineNodes > const & castor3d::SceneCuller::getNodesIds ( RenderNodesPass const &  renderPass ) const

inline

References m_renderPasses.

getPipelineNodesIndex() [1/2]

C3D_API uint32_t castor3d::SceneCuller::getPipelineNodesIndex	(	RenderNodesPass const &	renderPass,
		BillboardBase const &	billboard,
		Pass const &	pass,
		ashes::BufferBase const &	buffer,
		bool	isFrontCulled
	)		const

getPipelineNodesIndex() [2/2]

C3D_API uint32_t castor3d::SceneCuller::getPipelineNodesIndex	(	RenderNodesPass const &	renderPass,
		Submesh const &	submesh,
		Pass const &	pass,
		ashes::BufferBase const &	buffer,
		bool	isFrontCulled
	)		const

getScene()

Scene & castor3d::SceneCuller::getScene ( ) const

inline

getSubmeshIdxCommands()

ashes::Buffer< VkDrawIndexedIndirectCommand > const & castor3d::SceneCuller::getSubmeshIdxCommands ( RenderNodesPass const &  renderPass ) const

inline

References m_renderPasses.

getSubmeshNIdxCommands()

ashes::Buffer< VkDrawIndirectCommand > const & castor3d::SceneCuller::getSubmeshNIdxCommands ( RenderNodesPass const &  renderPass ) const

inline

References m_renderPasses.

getSubmeshNodes()

SidedNodePipelineMapT< SubmeshRenderNode > const & castor3d::SceneCuller::getSubmeshNodes ( RenderNodesPass const &  renderPass ) const

inline

References m_renderPasses.

hasCamera()

bool castor3d::SceneCuller::hasCamera ( ) const

inline

References m_camera.

Referenced by getCamera().

Here is the caller graph for this function:

hasCulledNodes()

bool castor3d::SceneCuller::hasCulledNodes ( RenderNodesPass const &  renderPass ) const

inline

References m_renderPasses.

registerRenderPass()

C3D_API void castor3d::SceneCuller::registerRenderPass

(

RenderNodesPass const &

renderPass

)

unregisterRenderPass()

C3D_API void castor3d::SceneCuller::unregisterRenderPass

(

RenderNodesPass const &

renderPass

)

Member Data Documentation

m_allChanged

bool castor3d::SceneCuller::m_allChanged { true }

protected

Referenced by areAllChanged().

m_camera

Camera* castor3d::SceneCuller::m_camera

protected

Referenced by getCamera(), and hasCamera().

m_cameraChanged

OnCameraChangedConnection castor3d::SceneCuller::m_cameraChanged

protected

m_cameraDirty

bool castor3d::SceneCuller::m_cameraDirty { true }

protected

m_culledBillboards

NodeArrayT< BillboardRenderNode > castor3d::SceneCuller::m_culledBillboards

protected

m_culledChanged

bool castor3d::SceneCuller::m_culledChanged { true }

protected

Referenced by areCulledChanged().

m_culledSubmeshes

NodeArrayT< SubmeshRenderNode > castor3d::SceneCuller::m_culledSubmeshes

protected

m_index

uint32_t castor3d::SceneCuller::m_index

protected

m_minCullersZ

float castor3d::SceneCuller::m_minCullersZ { 0.0f }

protected

Referenced by getMinCastersZ().

m_renderPasses

std::map< RenderNodesPass const *, RenderPassBuffers > castor3d::SceneCuller::m_renderPasses

protected

Referenced by getBillboardCommands(), getBillboardNodes(), getInstancedSubmeshNodes(), getNodesIds(), getSubmeshIdxCommands(), getSubmeshNIdxCommands(), getSubmeshNodes(), and hasCulledNodes().

m_sceneChanged

OnSceneChangedConnection castor3d::SceneCuller::m_sceneChanged

protected

m_sceneDirty

bool castor3d::SceneCuller::m_sceneDirty { true }

protected

onCompute

SceneCullerSignal castor3d::SceneCuller::onCompute

mutable

---

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

• Render/Culling/SceneCuller.hpp