Resource Class Reference

Public Member Functions
template<typename Array , typename Element >
Array	asArray (size_t offset=0, size_t max_size=0xFFFFFFFF)
	Array conversion. More...
FloatArray	asFloatArray (size_t offset=0, size_t max_size=0xFFFFFFFF)
bool	exists () const
void *	getData ()
	Get pointer to data. More...
const char *	getName () const
	Get resource name. More...
size_t	getSize () const
	Get buffer size in bytes. More...
bool	hasData () const
	Check if data is available. More...
bool	isMutable () const
size_t	read (void *dest, size_t len, size_t offset=0)
	Read data from resource into memory. More...
	Resource ()
	~Resource ()

Static Public Member Functions
static void	destroy (Resource *resource)
	Clean up used memory resources. More...
static Resource *	load (const char *name)
	Open resource and load data. More...
static Resource *	open (const char *name)
	Get resource from storage. More...

Protected Member Functions
	Resource (const char *name, size_t size, void *data)

Protected Attributes
bool	allocated
uint8_t *	data
const char *	name
size_t	size

Detailed Description

Definition at line 8 of file Resource.h.

Constructor & Destructor Documentation

Resource() [1/2]

Resource::Resource ( )

inline

Definition at line 93 of file Resource.h.

Referenced by open().

~Resource()

Resource::~Resource ( )

inline

Definition at line 94 of file Resource.h.

Resource() [2/2]

Resource::Resource ( const char *  name, size_t  size, void *  data  )

inlineprotected

Definition at line 96 of file Resource.h.

Member Function Documentation

asArray()

template<typename Array , typename Element >

template FloatArray Resource::asArray< FloatArray, float >	(	size_t	offset = 0,
		size_t	max_size = 0xFFFFFFFF
	)

Array conversion.

Parameters

offset	offset in bytes
max_size	maximum size, actual size can be smaller depending on object size

Definition at line 9 of file Resource.cpp.

References data, and size.

asFloatArray()

FloatArray Resource::asFloatArray ( size_t  offset = 0, size_t  max_size = 0xFFFFFFFF  )

inline

Definition at line 55 of file Resource.h.

destroy()

void Resource::destroy ( Resource *  resource )

static

Clean up used memory resources.

Definition at line 18 of file Resource.cpp.

References allocated, and data.

exists()

bool Resource::exists ( ) const

inline

Definition at line 31 of file Resource.h.

References size.

getData()

void* Resource::getData ( )

inline

Get pointer to data.

This may be NULL if no buffer is assigned yet.

Definition at line 20 of file Resource.h.

References data.

getName()

const char* Resource::getName ( ) const

inline

Get resource name.

Definition at line 42 of file Resource.h.

References name.

getSize()

size_t Resource::getSize ( ) const

inline

Get buffer size in bytes.

Definition at line 27 of file Resource.h.

References size.

hasData()

bool Resource::hasData ( ) const

inline

Check if data is available.

Definition at line 13 of file Resource.h.

References data.

Referenced by load().

isMutable()

bool Resource::isMutable ( ) const

inline

Definition at line 35 of file Resource.h.

References allocated.

load()

Resource * Resource::load ( const char *  name )

static

Open resource and load data.

Allocates extra memory to hold the resource if required. Returned object must be garbage collected with Resource::destroy()

Parameters

name	resource name

Returns

NULL if resource does not exist or can't be read.

Definition at line 36 of file Resource.cpp.

References allocated, data, hasData(), name, open(), and size.

open()

Resource * Resource::open ( const char *  name )

static

Get resource from storage.

Returned object must be garbage collected with Resource::destroy()

Parameters

name	resource name

Returns

NULL if resource does not exist or can't be read.

Definition at line 24 of file Resource.cpp.

References data, name, Resource(), and size.

Referenced by load().

read()

size_t Resource::read	(	void *	dest,
		size_t	len,
		size_t	offset = 0
	)

Read data from resource into memory.

Parameters

len	maximum number of bytes to read
offset	index of first byte to read from

Returns

number of bytes actually read

Definition at line 57 of file Resource.cpp.

References data, min, name, and size.

Field Documentation

allocated

bool Resource::allocated

protected

Definition at line 101 of file Resource.h.

Referenced by destroy(), isMutable(), and load().

data

uint8_t* Resource::data

protected

Definition at line 100 of file Resource.h.

Referenced by asArray(), destroy(), getData(), hasData(), load(), open(), and read().

name

const char* Resource::name

protected

Definition at line 98 of file Resource.h.

Referenced by getName(), load(), open(), and read().

size

size_t Resource::size

protected

Definition at line 99 of file Resource.h.

Referenced by asArray(), exists(), getSize(), load(), open(), and read().

---

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

• Resource.h
• Resource.cpp