engine_resources.h File Reference

#include <string>
#include <vector>

Go to the source code of this file.

Classes
struct	BlamResource
	Structure containing data for an engine resource. More...

Namespaces
	Blam
	Namespace surrounding all major engine components.
	Blam::EngineResources
	Namespace for things related to game engine resources.

Macros
#define	BLAM

Enumerations
enum	BlamResourceType {   XmlResource, ConfigResource, PngResource, RawResource,   Invalid }
	Enum defining all valid types of engine resources. More...

Functions
BLAM bool	Blam::EngineResources::LoadEngineResources ()
	Loads all required engine resources. More...
BLAM void	Blam::EngineResources::ReleaseEngineResources ()
	Releases all engine resources. More...
BLAM BlamResource	Blam::EngineResources::GetResource (std::string file_path)
	Retrieves a resource. More...
BLAM BlamResource *	Blam::EngineResources::GetResourcePointer (std::string file_path)
	Retrieves a pointer to a resource. More...
BLAM bool	Blam::EngineResources::SaveResource (std::string file_path)
	Saves a resource back to the disk. More...

Macro Definition Documentation

BLAM

#define BLAM

Enumeration Type Documentation

BlamResourceType

enum BlamResourceType

Enum defining all valid types of engine resources.

Setting this flag doesn't change how the data is stored, but rather is used as a mechanism to check the type of a resource - in order to avoid things such as reading a PNG resource as a plain text resource, or vice versa.

Enumerator
XmlResource	Indicates that the resource refers to an XML file.
ConfigResource	Indicates that the resource refers to a configuration file.
PngResource	Indicates that the resource refers to a PNG image.
RawResource	Indicates that the resource refers to a binary file. Anything stored as a raw resource should usually be given a new resource type instead - as RawResource could refer to virtually any kind of file.
Invalid	Indicates that the resource is invalid. This is only used when Blam::EngineResources::GetResource() is called and fails to find any matching resource.