Coherent UI  2.5.3
A modern user interface library for games
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Coherent::UI::ResourceData Class Referenceabstract

Abstract interface providing data for storing resources. More...

#include <Coherent/UI/FileHandler.h>

Public Member Functions

virtual const void * GetBuffer ()=0
 Get the buffer with the resource data. More...
 
virtual unsigned long GetSize ()=0
 Get the size of the data. More...
 
virtual void SignalSuccess ()=0
 Report that writing to resource was successful. More...
 
virtual void SignalFailure ()=0
 Report that resource writing has failed. More...
 

Detailed Description

Abstract interface providing data for storing resources.

Member Function Documentation

virtual const void* Coherent::UI::ResourceData::GetBuffer ( )
pure virtual

Get the buffer with the resource data.

Returns
pointer to the beginning of the data. May return nullptr when acquiring the buffer has failed
Note
GetBuffer may be called in any thread.
virtual unsigned long Coherent::UI::ResourceData::GetSize ( )
pure virtual

Get the size of the data.

Returns
the size of the data
Note
GetSize may be called in any thread.
virtual void Coherent::UI::ResourceData::SignalFailure ( )
pure virtual

Report that resource writing has failed.

Warning
This should be executed in the thread that all Coherent UI methods are executed.
After this method is called, any calls to any method of the instance are undefined behavior.
virtual void Coherent::UI::ResourceData::SignalSuccess ( )
pure virtual

Report that writing to resource was successful.

Warning
This should be executed in the thread that all Coherent UI methods are executed.
After this method is called, any calls to any method of the instance are undefined behavior.