Aether3D_API Class Reference

Handles DLL loading and engine object creation. More...

#include <Aether3D.hpp>

Public Member Functions
Error::Enum	LoadDLL (const std::string &path)
Audio *	MakeAudio ()
Camera *	MakeCamera ()
KeyboardInput *	MakeKeyboardInput ()
Light *	MakeLight (Light::Type lightType)
Material *	MakeMaterial ()
MouseInput *	MakeMouseInput ()
Model *	MakeModel (const std::string &path, Error::Enum &outError)
Renderer *	MakeRenderer (const std::string &builtinAssetPath)
Scene *	MakeScene ()
Texture *	MakeTexture (const std::string &path, bool useMipmaps, bool sRGB, Texture::Tiling tiling, Texture::Filter filter)
Texture *	MakeTexture (const char *left, const char *right, const char *top, const char *bottom, const char *front, const char *back)
Texture *	MakeRenderTexture (int width, int height)
Texture *	MakeRenderTextureCube (int size)
Texture *	MakeTexture (const std::string &atlasPath, const std::string &atlasMetadataPath, const std::string &fileName)

Static Public Member Functions
static const std::string &	ReturnCodeToErrorString (int returnCode)

Detailed Description

Handles DLL loading and engine object creation.

Member Function Documentation

LoadDLL()

Error::Enum Aether3D_API::LoadDLL

(

const std::string &

path

)

Loads the engine DLL. Must be called before doing anything else with the engine.

Parameters

path	DLL path. If extension is omitted, it's automatically added depending on the running platform.

Returns

NO_ERRORS if loading DLL succeeded.

DLL_NOT_FOUND if DLL could not be found or read.

UNSUPPORTED_RENDERER if GPU driver doesn't support requested renderer.

FACTORY_NOT_FOUND if DLL is found but could not be loaded by LoadLibraryA() on Windows or dlopen() on OSX or Linux.

MakeAudio()

Audio * Aether3D_API::MakeAudio

(

)

Returns

new Audio. Caller is responsible for freeing the allocated memory.

MakeCamera()

Camera * Aether3D_API::MakeCamera

(

)

Returns

new Camera. Caller is responsible for freeing the allocated memory.

MakeKeyboardInput()

KeyboardInput * Aether3D_API::MakeKeyboardInput

(

)

Returns

new KeyboardInput. Caller is responsible for freeing the allocated memory.

MakeLight()

Light * Aether3D_API::MakeLight

(

Light::Type

lightType

)

Parameters

lightType

Light Type.

Returns

new Light. Caller is responsible for freeing the allocated memory.

MakeMaterial()

Material * Aether3D_API::MakeMaterial

(

)

Returns

new Material. Caller is responsible for freeing the allocated memory. Must be called after Renderer::OpenWindow().

MakeModel()

Model * Aether3D_API::MakeModel	(	const std::string &	path,
		Error::Enum &	outError
	)

Loads a model from .ae3d file. Caller is responsible for freeing the allocated memory. Must be called after Renderer::OpenWindow().

Parameters

path	Model path.
outError	Error.

Returns

Model.

MakeMouseInput()

MouseInput * Aether3D_API::MakeMouseInput

(

)

Returns

new MouseInput. Caller is responsible for freeing the allocated memory.

MakeRenderer()

Renderer * Aether3D_API::MakeRenderer

(

const std::string &

builtinAssetPath

)

Creates a renderer and returns its instance. It's a singleton. Doesn't allocate memory so must not be deleted.

Returns

Instance to Renderer.

MakeRenderTexture()

Texture * Aether3D_API::MakeRenderTexture	(	int	width,
		int	height
	)

Creates a 2D render texture. Must be called after Renderer::OpenWindow().

Parameters

width	Width in pixels.
height	Height in pixels.

Returns

Texture.

MakeRenderTextureCube()

Texture * Aether3D_API::MakeRenderTextureCube

(

int

size

)

Creates a cube map render texture. Must be called after Renderer::OpenWindow().

Parameters

size	Width and height in pixels.

Returns

Texture.

MakeScene()

Scene * Aether3D_API::MakeScene

(

)

Returns

new Scene. Caller is responsible for freeing the allocated memory.

MakeTexture() [1/3]

Texture * Aether3D_API::MakeTexture	(	const char *	left,
		const char *	right,
		const char *	top,
		const char *	bottom,
		const char *	front,
		const char *	back
	)

Loads a cube map texture. Formats supported: .png, .jpg, .tga, .bmp etc. Must be called after Renderer::OpenWindow().

Todo:

Document sides also in API-friendly way: "positive z" etc.

Parameters

left	Left.
right	Right.
top	Top.
bottom	Bottom.
front	Front.
back	Back.

MakeTexture() [2/3]

Texture * Aether3D_API::MakeTexture	(	const std::string &	atlasPath,
		const std::string &	atlasMetadataPath,
		const std::string &	fileName
	)

Loads a texture from an atlas. Formats supported: .png, .jpg, .tga, .bmp etc. Must be called after Renderer::OpenWindow().

Parameters

atlasPath	Texture path.
atlasMetadataPath	Meta data path. Format must be CEGUI/Ogre (eg. Texture Packer exports them).
fileName	Name of texture in atlas.

Returns

Texture.

MakeTexture() [3/3]

Texture * Aether3D_API::MakeTexture	(	const std::string &	path,
		bool	useMipmaps,
		bool	sRGB,
		Texture::Tiling	tiling,
		Texture::Filter	filter
	)

Loads a texture. Formats supported: .png, .jpg, .tga, .bmp, .dds and .pvr depending on platform. Must be called after Renderer::OpenWindow().

Parameters

path	Texture path.
useMipmaps	True, if mipmaps should be generated.
sRGB	True, if the texture is sRGB. Normal maps should use false.
tiling	Tiling.
filter	Filter.

Returns

Texture.

ReturnCodeToErrorString()

const std::string & Aether3D_API::ReturnCodeToErrorString ( int  returnCode )

static

Converts return code to an error string.

Parameters

returnCode

Integer representation of Error::Enum.

Returns

Error string.

---

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

• /home/glaze/Documents/src/Aether3D_2013/Include/Aether3D.hpp
• /home/glaze/Documents/src/Aether3D_2013/Include/Aether3D.cpp