castor3d::EnvironmentMapPass Class Reference

#include <EnvironmentMapPass.hpp>

Inheritance diagram for castor3d::EnvironmentMapPass:

Collaboration diagram for castor3d::EnvironmentMapPass:

Public Member Functions
C3D_API	EnvironmentMapPass (RenderDevice const &device, EnvironmentMap &environmentMap, SceneNodeUPtr faceNode, uint32_t index, CubeMapFace face, SceneBackground &background)
	Constructor.
C3D_API	~EnvironmentMapPass () noexcept
C3D_API void	update (CpuUpdater &updater)
	Updates the render pass, CPU wise.
C3D_API void	update (GpuUpdater &updater)
	Updates the render pass, GPU wise.
C3D_API void	record ()
	Records the pass commands.
C3D_API crg::SemaphoreWaitArray	render (crg::SemaphoreWaitArray const &toWait, ashes::Queue const &queue)
	Renders the environment map.
C3D_API void	attachTo (SceneNode &node)
	Attaches this pass to given node.
crg::FramePass const &	getLastPass () const noexcept
Public Member Functions inherited from castor::OwnedBy< EnvironmentMap >
EnvironmentMap *	getOwner () const
Public Member Functions inherited from castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructor.
T const &	getName () const noexcept
	Retrieves the name.
void	rename (T name) noexcept

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< EnvironmentMap >
	OwnedBy (EnvironmentMap &owner)
	Constructor.
Protected Attributes inherited from castor::NamedBaseT< T >
T	m_name

Constructor & Destructor Documentation

EnvironmentMapPass()

C3D_API castor3d::EnvironmentMapPass::EnvironmentMapPass	(	RenderDevice const &	device,
		EnvironmentMap &	environmentMap,
		SceneNodeUPtr	faceNode,
		uint32_t	index,
		CubeMapFace	face,
		SceneBackground &	background )

Constructor.

Parameters

[in]	device	The GPU device.
[in]	environmentMap	The parent reflection map.
[in]	faceNode	The node from which the camera is created.
[in]	index	The cube index this pass renders to.
[in]	face	The cube face this pass renders to.
[in]	background	The scene background.

~EnvironmentMapPass()

C3D_API castor3d::EnvironmentMapPass::~EnvironmentMapPass ( )

noexcept

Member Function Documentation

attachTo()

C3D_API void castor3d::EnvironmentMapPass::attachTo

(

SceneNode &

node

)

Attaches this pass to given node.

Remarks

Set the ignored node for the internal render passes.

Parameters

[in]

node

The node.

getLastPass()

crg::FramePass const & castor3d::EnvironmentMapPass::getLastPass ( ) const

inlinenoexcept

name Getters.

record()

C3D_API void castor3d::EnvironmentMapPass::record

(

)

Records the pass commands.

render()

C3D_API crg::SemaphoreWaitArray castor3d::EnvironmentMapPass::render	(	crg::SemaphoreWaitArray const &	toWait,
		ashes::Queue const &	queue )

Renders the environment map.

Parameters

[in]	toWait	The semaphores to wait.
[in]	queue	The queue receiving the render commands.

Returns

The semaphores signaled by this render.

update() [1/2]

C3D_API void castor3d::EnvironmentMapPass::update

(

CpuUpdater &

updater

)

Updates the render pass, CPU wise.

Parameters

[in,out]

updater

The update data.

update() [2/2]

C3D_API void castor3d::EnvironmentMapPass::update

(

GpuUpdater &

updater

)

Updates the render pass, GPU wise.

Parameters

[in,out]

updater

The update data.

---

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

• Castor3D/Render/EnvironmentMap/EnvironmentMapPass.hpp