castor3d::DoubleBufferedResourceT< ResourceT, PointerT > Class Template Reference

#include <FontTexture.hpp>

Inheritance diagram for castor3d::DoubleBufferedResourceT< ResourceT, PointerT >:

Collaboration diagram for castor3d::DoubleBufferedResourceT< ResourceT, PointerT >:

Classes
struct	Resource

Public Types
using	ResourcePtrT = PointerT< ResourceT >
using	OnChangedFunction = castor::Function< void( DoubleBufferedResourceT const & ) >
using	OnChanged = castor::SignalT< OnChangedFunction >

Public Member Functions
void	update (bool clean)
	Updates the resource.
Resource const &	getResource () const
Resource const &	getFront () const
Resource const &	getBack () const
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const noexcept
void	setOwner (Engine &owner) noexcept

Public Attributes
OnChanged	onResourceChanged

Protected Member Functions
	DoubleBufferedResourceT (Engine &parent, ResourcePtrT back, ResourcePtrT front)
virtual C3D_API	~DoubleBufferedResourceT () noexcept=default
void	doInitialise (RenderDevice const &device, QueueData const &queueData)
	Initialises the texture.
void	doCleanup ()
	Flushes the teture.
void	doRefresh (bool clean, bool front)
	Orders events to refresh the resource.
Resource &	doGetFront ()
Resource &	doGetBack ()
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner) noexcept
	Constructor.

Protected Attributes
Resource	m_back
Resource	m_front

Member Typedef Documentation

OnChanged

template<typename ResourceT , template< typename ResT > typename PointerT>

using castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::OnChanged = castor::SignalT< OnChangedFunction >

OnChangedFunction

template<typename ResourceT , template< typename ResT > typename PointerT>

using castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::OnChangedFunction = castor::Function< void( DoubleBufferedResourceT const & ) >

ResourcePtrT

template<typename ResourceT , template< typename ResT > typename PointerT>

using castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::ResourcePtrT = PointerT< ResourceT >

Constructor & Destructor Documentation

DoubleBufferedResourceT()

template<typename ResourceT , template< typename ResT > typename PointerT>

castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::DoubleBufferedResourceT ( Engine & parent, ResourcePtrT back, ResourcePtrT front )

inlineprotected

~DoubleBufferedResourceT()

template<typename ResourceT , template< typename ResT > typename PointerT>

virtual C3D_API castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::~DoubleBufferedResourceT ( )

protectedvirtualdefaultnoexcept

Member Function Documentation

doCleanup()

template<typename ResourceT , template< typename ResT > typename PointerT>

void castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doCleanup ( )

inlineprotected

Flushes the teture.

References castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_back, and castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_front.

doGetBack()

template<typename ResourceT , template< typename ResT > typename PointerT>

Resource & castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doGetBack ( )

inlineprotected

References castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_back.

doGetFront()

template<typename ResourceT , template< typename ResT > typename PointerT>

Resource & castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doGetFront ( )

inlineprotected

References castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_front.

doInitialise()

template<typename ResourceT , template< typename ResT > typename PointerT>

void castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doInitialise ( RenderDevice const & device, QueueData const & queueData )

inlineprotected

Initialises the texture.

Parameters

[in]	device	The GPU device.
[in]	queueData	The queue receiving the GPU commands.

References castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_back, and castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_front.

doRefresh()

template<typename ResourceT , template< typename ResT > typename PointerT>

void castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doRefresh ( bool clean, bool front )

inlineprotected

Orders events to refresh the resource.

References castor3d::getEngine(), castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_back, castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_front, castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::onResourceChanged, castor3d::postPreRenderGpuEvent(), and castor3d::postQueueRenderCpuEvent().

Referenced by castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::update().

Here is the call graph for this function:

Here is the caller graph for this function:

getBack()

template<typename ResourceT , template< typename ResT > typename PointerT>

Resource const & castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::getBack ( ) const

inline

References castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_back.

getFront()

template<typename ResourceT , template< typename ResT > typename PointerT>

Resource const & castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::getFront ( ) const

inline

References castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_front.

getResource()

template<typename ResourceT , template< typename ResT > typename PointerT>

Resource const & castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::getResource ( ) const

inline

References castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_front.

Referenced by castor3d::FontTexture::getTexture().

Here is the caller graph for this function:

update()

template<typename ResourceT , template< typename ResT > typename PointerT>

void castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::update ( bool clean )

inline

Updates the resource.

References castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doRefresh().

Here is the call graph for this function:

Member Data Documentation

m_back

template<typename ResourceT , template< typename ResT > typename PointerT>

Resource castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_back

protected

Referenced by castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doCleanup(), castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doGetBack(), castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doInitialise(), castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doRefresh(), and castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::getBack().

m_front

template<typename ResourceT , template< typename ResT > typename PointerT>

Resource castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::m_front

protected

Referenced by castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doCleanup(), castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doGetFront(), castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doInitialise(), castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doRefresh(), castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::getFront(), and castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::getResource().

onResourceChanged

template<typename ResourceT , template< typename ResT > typename PointerT>

OnChanged castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::onResourceChanged

The signal used to notify clients that this resource has changed.

Referenced by castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::doRefresh().

---

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

• Castor3D/Overlay/FontTexture.hpp