Cogs::Core::RenderResource Struct Reference

Inheritance diagram for Cogs::Core::RenderResource:

Public Types
typedef uint32_t	Id

Public Member Functions
	RenderResource (const RenderResource &)=delete
RenderResource &	operator= (const RenderResource &)=delete
void	setActive ()
void	setDelayed ()
void	setFailed ()
void	setReleased ()
void	setOwned ()
void	setPersistent ()
void	setOverride ()
bool	isActive () const
	Get if the render resource is active and can be used for rendering.
bool	isDelayed () const
	Get if the render resource is in a delayed state.
bool	isSet (RenderResourceFlags flag) const
bool	isPersistent () const
bool	isOverride () const
bool	hasFailed () const
bool	isReleased () const
bool	isOwned () const
void	setName (std::string_view str)
const std::string &	getName () const
RenderResourceType	getType () const
RenderResourceFlags	getFlags () const
void	incrementGeneration ()
uint16_t	getGeneration ()
Id	getIdentity () const

Protected Attributes
std::string	name
RenderResourceType	type = RenderResourceType::Unknown
RenderResourceFlags	flags = RenderResourceFlags::None
uint16_t	generation = 0
Id	identity = 0

Friends
class	RenderResources

Detailed Description

Definition at line 46 of file RenderResource.h.

Member Typedef Documentation

Id

typedef uint32_t Cogs::Core::RenderResource::Id

Definition at line 48 of file RenderResource.h.

Constructor & Destructor Documentation

RenderResource()

Cogs::Core::RenderResource::RenderResource

(

)

Definition at line 10 of file RenderResource.cpp.

Member Function Documentation

getFlags()

RenderResourceFlags Cogs::Core::RenderResource::getFlags ( ) const

inline

Definition at line 90 of file RenderResource.h.

getGeneration()

uint16_t Cogs::Core::RenderResource::getGeneration ( )

inline

Definition at line 93 of file RenderResource.h.

getIdentity()

Id Cogs::Core::RenderResource::getIdentity ( ) const

inline

Definition at line 97 of file RenderResource.h.

getName()

const std::string & Cogs::Core::RenderResource::getName ( ) const

inline

Definition at line 87 of file RenderResource.h.

getType()

RenderResourceType Cogs::Core::RenderResource::getType ( ) const

inline

Definition at line 89 of file RenderResource.h.

hasFailed()

bool Cogs::Core::RenderResource::hasFailed ( ) const

inline

Definition at line 82 of file RenderResource.h.

incrementGeneration()

void Cogs::Core::RenderResource::incrementGeneration ( )

inline

Definition at line 92 of file RenderResource.h.

isActive()

bool Cogs::Core::RenderResource::isActive ( ) const

inline

Get if the render resource is active and can be used for rendering.

If the resource is not active, trying to render will most likely produce an assertion, or at best strange rendering artifacts.

Definition at line 69 of file RenderResource.h.

isDelayed()

bool Cogs::Core::RenderResource::isDelayed ( ) const

inline

Get if the render resource is in a delayed state.

The resource contents may be loaded and ready for transfer to the GPU, but are not ready for use during rendering.

Definition at line 77 of file RenderResource.h.

Referenced by Cogs::Core::RenderMaterialInstance::checkReady().

isOverride()

bool Cogs::Core::RenderResource::isOverride ( ) const

inline

Definition at line 81 of file RenderResource.h.

isOwned()

bool Cogs::Core::RenderResource::isOwned ( ) const

inline

Definition at line 84 of file RenderResource.h.

isPersistent()

bool Cogs::Core::RenderResource::isPersistent ( ) const

inline

Definition at line 80 of file RenderResource.h.

isReleased()

bool Cogs::Core::RenderResource::isReleased ( ) const

inline

Definition at line 83 of file RenderResource.h.

isSet()

bool Cogs::Core::RenderResource::isSet ( RenderResourceFlags  flag ) const

inline

Definition at line 79 of file RenderResource.h.

setActive()

void Cogs::Core::RenderResource::setActive ( )

inline

Definition at line 55 of file RenderResource.h.

setDelayed()

void Cogs::Core::RenderResource::setDelayed ( )

inline

Definition at line 56 of file RenderResource.h.

setFailed()

void Cogs::Core::RenderResource::setFailed ( )

inline

Definition at line 57 of file RenderResource.h.

setName()

void Cogs::Core::RenderResource::setName ( std::string_view  str )

inline

Definition at line 86 of file RenderResource.h.

setOverride()

void Cogs::Core::RenderResource::setOverride ( )

inline

Definition at line 61 of file RenderResource.h.

setOwned()

void Cogs::Core::RenderResource::setOwned ( )

inline

Definition at line 59 of file RenderResource.h.

setPersistent()

void Cogs::Core::RenderResource::setPersistent ( )

inline

Definition at line 60 of file RenderResource.h.

setReleased()

void Cogs::Core::RenderResource::setReleased ( )

inline

Definition at line 58 of file RenderResource.h.

Friends And Related Function Documentation

RenderResources

friend class RenderResources

friend

Definition at line 108 of file RenderResource.h.

Member Data Documentation

flags

RenderResourceFlags Cogs::Core::RenderResource::flags = RenderResourceFlags::None

protected

Definition at line 103 of file RenderResource.h.

generation

uint16_t Cogs::Core::RenderResource::generation = 0

protected

Definition at line 105 of file RenderResource.h.

identity

Id Cogs::Core::RenderResource::identity = 0

protected

Definition at line 106 of file RenderResource.h.

name

std::string Cogs::Core::RenderResource::name

protected

Definition at line 100 of file RenderResource.h.

type

RenderResourceType Cogs::Core::RenderResource::type = RenderResourceType::Unknown

protected

Definition at line 102 of file RenderResource.h.

---

The documentation for this struct was generated from the following files:

• Source/Renderer/RenderResource.h
• Source/Renderer/RenderResource.cpp