castor3d::ColourBackground Class Reference

#include <Colour.hpp>

Inheritance diagram for castor3d::ColourBackground:

Collaboration diagram for castor3d::ColourBackground:

Public Member Functions
C3D_API	ColourBackground (Engine &engine, Scene &scene, castor::String const &name=castor::String{})
	Constructor. More...
C3D_API void	accept (BackgroundVisitor &visitor) override
	Visitor acceptance function. More...
TextureLayout const &	getTexture () const
TextureLayout &	getTexture ()
ashes::Image const &	getImage () const
ashes::ImageView const &	getView () const
castor::HdrRgbColour const &	getColour () const
Public Member Functions inherited from castor3d::SceneBackground
C3D_API	SceneBackground (Engine &engine, Scene &scene, castor::String const &name, BackgroundType type)
	Constructor. More...
virtual C3D_API	~SceneBackground ()
	Destructor. More...
C3D_API bool	initialise (RenderDevice const &device)
	Initialisation function. More...
C3D_API void	cleanup (RenderDevice const &device)
	Cleanup function. More...
C3D_API void	update (CpuUpdater &updater) const
	Updates the background, CPU side. More...
C3D_API void	update (GpuUpdater &updater) const
	Updates the background, GPU side. More...
C3D_API void	notifyChanged ()
	Notifies a change to apply on GPU for the background. More...
virtual C3D_API void	accept (BackgroundVisitor &visitor)=0
	Visitor acceptance function. More...
Scene const &	getScene () const
Scene &	getScene ()
BackgroundType	getType () const
Texture const &	getTextureId () const
TextureLayout const &	getTexture () const
TextureLayout &	getTexture ()
ashes::Image const &	getImage () const
ashes::ImageView const &	getView () const
bool	isHdr () const
bool	isSRGB () const
bool	hasIbl () const
bool	isInitialised () const
IblTextures const &	getIbl () const
Sampler const &	getSampler () const

Additional Inherited Members
Public Types inherited from castor3d::SceneBackground
enum	DescriptorIdx : uint32_t {   MtxUboIdx = 0u , MdlMtxUboIdx = 1u , HdrCfgUboIdx = 2u , SceneUboIdx = 3u ,   SkyBoxImgIdx = 4u }
Public Attributes inherited from castor3d::SceneBackground
OnBackgroundChanged	onChanged
Protected Attributes inherited from castor3d::SceneBackground
Scene &	m_scene
BackgroundType	m_type
std::atomic_bool	m_initialised { false }
bool	m_hdr { true }
bool	m_srgb { false }
Texture	m_textureId
TextureLayoutSPtr	m_texture
SamplerResPtr	m_sampler
std::unique_ptr< IblTextures >	m_ibl

Constructor & Destructor Documentation

ColourBackground()

C3D_API castor3d::ColourBackground::ColourBackground	(	Engine &	engine,
		Scene &	scene,
		castor::String const &	name = castor::String{}
	)

Constructor.

Parameters

[in]	engine	The engine.
[in]	scene	The scene.
	name	The background name.

Member Function Documentation

accept()

C3D_API void castor3d::ColourBackground::accept ( BackgroundVisitor &  visitor )

overridevirtual

Visitor acceptance function.

Parameters

visitor

The visitor.

Implements castor3d::SceneBackground.

getColour()

castor::HdrRgbColour const & castor3d::ColourBackground::getColour ( ) const

inline

getImage()

ashes::Image const & castor3d::ColourBackground::getImage ( ) const

inline

References castor3d::SceneBackground::m_texture.

getTexture() [1/2]

TextureLayout & castor3d::ColourBackground::getTexture ( )

inline

References castor3d::SceneBackground::m_texture.

getTexture() [2/2]

TextureLayout const & castor3d::ColourBackground::getTexture ( ) const

inline

name Getters.

References castor3d::SceneBackground::m_texture.

getView()

ashes::ImageView const & castor3d::ColourBackground::getView ( ) const

inline

References castor3d::SceneBackground::m_texture.

---

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

• Scene/Background/Colour.hpp