CheckoutLock

Used by Viewports to signal they are rendering and we should not be performing an Update. More...

Collaboration diagram for CheckoutLock:

Public Member Functions
	CheckoutLock (CheckoutLock &&checkout)
	Move constructor.
	CheckoutLock (const CheckoutLock &checkout)=delete
	Non-copyable.
	CheckoutLock (GraphicsUpdater *updater, bool wait_until_ready, UUID id=Constant< UUID >::Invalid)
	Constructs a checkout lock for a renderer.
	~CheckoutLock ()
	Destructor.
bool	isCheckedOut ()
	Checks whether this lock holds a valid checkout.

Protected Attributes
UUID	m_id
	The checked-out camera UUID.
RLock	m_lock
	The read lock held during checkout.
GraphicsUpdater *	m_updater
	The owning updater.

Detailed Description

Used by Viewports to signal they are rendering and we should not be performing an Update.

---

Definition at line 160 of file GraphicsUpdater.h.

Constructor & Destructor Documentation

CheckoutLock() [1/2]

CheckoutLock::CheckoutLock ( GraphicsUpdater * updater, bool wait_until_ready, UUID id = Constant<UUID>::Invalid )

inline

Constructs a checkout lock for a renderer.

Parameters

[in]	updater	The graphics updater.
[in]	wait_until_ready	Whether to block until available.
[in]	id	The camera UUID to check out.

Definition at line 167 of file GraphicsUpdater.h.

References IsValid(), m_id, m_lock, and m_updater.

Referenced by CheckoutLock(), and CheckoutLock().

CheckoutLock() [2/2]

CheckoutLock::CheckoutLock ( CheckoutLock && checkout )

inline

Move constructor.

Parameters

[in]

checkout

The lock to move from.

Definition at line 175 of file GraphicsUpdater.h.

References CheckoutLock(), m_id, m_lock, and m_updater.

~CheckoutLock()

CheckoutLock::~CheckoutLock ( )

inline

Destructor.

Checks in the renderer if checked out.

Definition at line 183 of file GraphicsUpdater.h.

References IsValid(), m_id, and m_updater.

Member Function Documentation

isCheckedOut()

bool CheckoutLock::isCheckedOut ( )

inline

Checks whether this lock holds a valid checkout.

Returns

True if a renderer is checked out.

Definition at line 190 of file GraphicsUpdater.h.

References IsValid(), and m_id.

---

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

• NDEVRGraphics/Headers/GraphicsUpdater.h