#include <Image.hpp>

Inheritance diagram for castor3d::ImageBackground:

[legend]

Collaboration diagram for castor3d::ImageBackground:

[legend]

Public Member Functions
C3D_API	ImageBackground (Engine &engine, Scene &scene, castor::String const &name=castor::String{})
	Constructor. More...

C3D_API bool	loadImage (castor::Path const &folder, castor::Path const &relative)

C3D_API void	accept (BackgroundVisitor &visitor) override
	Visitor acceptance function. More...

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

◆ ImageBackground()

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

explicit

Constructor.

Parameters

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

overridevirtual

Visitor acceptance function.

Parameters

visitor The visitor.

C3D_API bool castor3d::ImageBackground::loadImage	(	castor::Path const &	folder,
		castor::Path const &	relative
	)

Parameters

[in]	folder	The image folder.
[in]	relative	The image file path, relative to `folder`.

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