castor3d::RenderQueue Class Reference

#include <RenderQueue.hpp>

Inheritance diagram for castor3d::RenderQueue:

Collaboration diagram for castor3d::RenderQueue:

Public Member Functions
C3D_API	RenderQueue (RenderNodesPass &renderPass, RenderMode mode, SceneNode const *ignored)
	Constructor. More...
C3D_API	~RenderQueue ()
C3D_API void	initialise ()
	Initialises the queue. More...
C3D_API void	cleanup ()
	Cleans the queue up. More...
C3D_API void	update (ShadowMapLightTypeArray &shadowMaps)
	Updates the render nodes. More...
C3D_API void	update (ShadowMapLightTypeArray &shadowMaps, VkViewport const &viewport, VkRect2D const &scissor)
	Updates the render nodes. More...
C3D_API void	update (ShadowMapLightTypeArray &shadowMaps, VkRect2D const &scissor)
	Updates the render nodes. More...
C3D_API void	setIgnoredNode (SceneNode const &node)
	Sets the node to be ignored in rendering. remarks All objects attached to this node will be ignored. More...
C3D_API bool	hasNodes () const
C3D_API RenderMode	getMode () const
C3D_API ashes::CommandBuffer const &	initCommandBuffer ()
bool	hasCommandBuffer () const
ashes::CommandBuffer const &	getCommandBuffer () const
QueueRenderNodes &	getRenderNodes () const
SceneCuller const &	getCuller () const
SceneNode const *	getIgnoredNode () const

Constructor & Destructor Documentation

RenderQueue()

C3D_API castor3d::RenderQueue::RenderQueue	(	RenderNodesPass &	renderPass,
		RenderMode	mode,
		SceneNode const *	ignored
	)

Constructor.

Parameters

[in]	renderPass	The parent render pass.
[in]	mode	The render mode for this render queue.
[in]	ignored	The geometries attached to this node will be ignored in the render.

~RenderQueue()

C3D_API castor3d::RenderQueue::~RenderQueue

(

)

Member Function Documentation

cleanup()

C3D_API void castor3d::RenderQueue::cleanup

(

)

Cleans the queue up.

getCommandBuffer()

ashes::CommandBuffer const & castor3d::RenderQueue::getCommandBuffer ( ) const

inline

References hasCommandBuffer().

Here is the call graph for this function:

getCuller()

SceneCuller const & castor3d::RenderQueue::getCuller ( ) const

inline

getIgnoredNode()

SceneNode const * castor3d::RenderQueue::getIgnoredNode ( ) const

inline

getMode()

C3D_API RenderMode castor3d::RenderQueue::getMode

(

)

const

getRenderNodes()

QueueRenderNodes & castor3d::RenderQueue::getRenderNodes ( ) const

inline

hasCommandBuffer()

bool castor3d::RenderQueue::hasCommandBuffer ( ) const

inline

Referenced by getCommandBuffer().

Here is the caller graph for this function:

hasNodes()

C3D_API bool castor3d::RenderQueue::hasNodes

(

)

const

name Getters.

initCommandBuffer()

C3D_API ashes::CommandBuffer const & castor3d::RenderQueue::initCommandBuffer

(

)

initialise()

C3D_API void castor3d::RenderQueue::initialise

(

)

Initialises the queue.

setIgnoredNode()

C3D_API void castor3d::RenderQueue::setIgnoredNode

(

SceneNode const &

node

)

Sets the node to be ignored in rendering. remarks All objects attached to this node will be ignored.

update() [1/3]

C3D_API void castor3d::RenderQueue::update

(

ShadowMapLightTypeArray &

shadowMaps

)

Updates the render nodes.

Parameters

[in,out]

shadowMaps

Receives the shadow maps used in the render pass.

update() [2/3]

C3D_API void castor3d::RenderQueue::update	(	ShadowMapLightTypeArray &	shadowMaps,
		VkRect2D const &	scissor
	)

Updates the render nodes.

Parameters

[in,out]	shadowMaps	Receives the shadow maps used in the render pass.
[in]	scissor	The scissors restraining the render pass.

update() [3/3]

C3D_API void castor3d::RenderQueue::update	(	ShadowMapLightTypeArray &	shadowMaps,
		VkViewport const &	viewport,
		VkRect2D const &	scissor
	)

Updates the render nodes.

Parameters

[in,out]	shadowMaps	Receives the shadow maps used in the render pass.
[in]	viewport	The viewport restraining the render pass.
[in]	scissor	The scissors restraining the render pass.

---

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

• Render/RenderQueue.hpp