API Documentation
Resource.h
1 // Resource.h
3 //
5 
6 namespace nkGraphics
7 {
11  class Resource
12  {
13  public :
14 
18  virtual ~Resource () ;
19 
20  // Getters
24  bool isReadyForRendering () const ;
28  bool isUnloaded () const ;
48  System* getSystem () const ;
52  bool getHidden () const ;
56  bool getGpuUploadCanBeDeferred () const ;
57 
58  // Setters
64  virtual void setPath (nkMemory::StringView value) ;
77  void setHidden (bool value) ;
92  void setGpuUploadCanBeDeferred (bool value) ;
93 
94  // Loading
107  virtual bool load () = 0 ;
111  virtual void unload () = 0 ;
112  } ;
113 }
nkGraphics::Resource::isUnloaded
bool isUnloaded() const
nkGraphics::Resource::getPath
nkMemory::StringView getPath() const
nkGraphics::Resource::~Resource
virtual ~Resource()
nkGraphics::Resource::getLoadState
RESOURCE_LOAD_STATE getLoadState() const
nkGraphics::RESOURCE_TYPE
RESOURCE_TYPE
The type of resources available in the component.
Definition: ResourceType.h:12
nkGraphics::Resource::getName
nkMemory::StringView getName() const
nkGraphics::Resource::isReadyForRendering
bool isReadyForRendering() const
nkGraphics::Resource::getSystem
System * getSystem() const
nkGraphics::Resource::setGpuUploadCanBeDeferred
void setGpuUploadCanBeDeferred(bool value)
nkGraphics::Resource::getGpuUploadCanBeDeferred
bool getGpuUploadCanBeDeferred() const
nkGraphics::RESOURCE_LOAD_STATE
RESOURCE_LOAD_STATE
The resource load states possible.
Definition: ResourceLoadState.h:12
nkGraphics::Resource::load
virtual bool load()=0
nkGraphics::Resource::getHidden
bool getHidden() const
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::Resource::getTypeName
RESOURCE_TYPE getTypeName() const
nkGraphics::Resource
Base class for a resource in the component.
Definition: Resource.h:12
nkGraphics::Resource::setName
void setName(nkMemory::StringView value)
nkGraphics::Resource::setPath
virtual void setPath(nkMemory::StringView value)
nkGraphics::Resource::unload
virtual void unload()=0
nkGraphics::Resource::setHidden
void setHidden(bool value)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7