castor3d::BackgroundPassBase Class Reference

#include <BackgroundPassBase.hpp>

Collaboration diagram for castor3d::BackgroundPassBase:

Public Member Functions
C3D_API	BackgroundPassBase (crg::FramePass const &pass, RenderDevice const &device, SceneBackground &background, bool forceVisible)
	Constructor.
virtual C3D_API	~BackgroundPassBase () noexcept=default
C3D_API void	update (CpuUpdater &updater)
	Updates the render pass, CPU wise.
C3D_API void	update (GpuUpdater &updater)
	Updates the render pass, GPU wise.

Protected Member Functions
C3D_API bool	doIsEnabled () const

Protected Attributes
RenderDevice const &	m_device
SceneBackground const *	m_background
Viewport	m_viewport
OnBackgroundChangedConnection	m_onBackgroundChanged

Constructor & Destructor Documentation

BackgroundPassBase()

C3D_API castor3d::BackgroundPassBase::BackgroundPassBase	(	crg::FramePass const &	pass,
		RenderDevice const &	device,
		SceneBackground &	background,
		bool	forceVisible )

Constructor.

Parameters

[in]	pass	The parent frame pass.
[in]	device	The GPU device.
[in]	background	The scene background.
[in]	forceVisible	true to force display of background.

~BackgroundPassBase()

virtual C3D_API castor3d::BackgroundPassBase::~BackgroundPassBase ( )

virtualdefaultnoexcept

Member Function Documentation

doIsEnabled()

C3D_API bool castor3d::BackgroundPassBase::doIsEnabled ( ) const

protected

update() [1/2]

C3D_API void castor3d::BackgroundPassBase::update

(

CpuUpdater &

updater

)

Updates the render pass, CPU wise.

Parameters

[in,out]

updater

The update data.

update() [2/2]

C3D_API void castor3d::BackgroundPassBase::update

(

GpuUpdater &

updater

)

Updates the render pass, GPU wise.

Parameters

[in,out]

updater

The update data.

Member Data Documentation

m_background

SceneBackground const* castor3d::BackgroundPassBase::m_background

protected

m_device

RenderDevice const& castor3d::BackgroundPassBase::m_device

protected

m_onBackgroundChanged

OnBackgroundChangedConnection castor3d::BackgroundPassBase::m_onBackgroundChanged

protected

m_viewport

Viewport castor3d::BackgroundPassBase::m_viewport

protected

---

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

• Castor3D/Render/Passes/BackgroundPassBase.hpp