OrxTexture

Defines
#define	orxTEXTURE_KZ_SCREEN_NAME   "-=SCREEN=-"
Typedefs
typedef struct __orxTEXTURE_t	orxTEXTURE
Enumerations
enum	orxTEXTURE_EVENT { orxTEXTURE_EVENT_CREATE = 0, orxTEXTURE_EVENT_DELETE, orxTEXTURE_EVENT_NUMBER, orxTEXTURE_EVENT_NONE = orxENUM_NONE }
Functions
orxDLLAPI orxTEXTURE *orxFASTCALL	orxTexture_Create ()
orxDLLAPI orxTEXTURE *orxFASTCALL	orxTexture_CreateFromFile (const orxSTRING _zBitmapFileName)
orxDLLAPI orxSTATUS orxFASTCALL	orxTexture_Delete (orxTEXTURE *_pstTexture)
orxDLLAPI void orxFASTCALL	orxTexture_Exit ()
orxDLLAPI orxBITMAP *orxFASTCALL	orxTexture_GetBitmap (const orxTEXTURE *_pstTexture)
orxDLLAPI const orxSTRING orxFASTCALL	orxTexture_GetName (const orxTEXTURE *_pstTexture)
orxDLLAPI orxTEXTURE *orxFASTCALL	orxTexture_GetScreenTexture ()
orxDLLAPI orxSTATUS orxFASTCALL	orxTexture_GetSize (const orxTEXTURE *_pstTexture, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight)
orxDLLAPI orxSTATUS orxFASTCALL	orxTexture_Init ()
orxDLLAPI orxSTATUS orxFASTCALL	orxTexture_LinkBitmap (orxTEXTURE *_pstTexture, const orxBITMAP *_pstBitmap, const orxSTRING _zDataName)
orxDLLAPI orxSTATUS orxFASTCALL	orxTexture_SetColor (orxTEXTURE *_pstTexture, const orxCOLOR *_pstColor)
orxDLLAPI void orxFASTCALL	orxTexture_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxTexture_UnlinkBitmap (orxTEXTURE *_pstTexture)

---

Detailed Description

Texture module Module that handles textures

---

Define Documentation

#define orxTEXTURE_KZ_SCREEN_NAME   "-=SCREEN=-"

Defines

Definition at line 54 of file orxTexture.h.

---

Typedef Documentation

typedef struct __orxTEXTURE_t orxTEXTURE

Internal texture structure

Definition at line 72 of file orxTexture.h.

---

Enumeration Type Documentation

enum orxTEXTURE_EVENT

Event enum

Enumerator:

orxTEXTURE_EVENT_CREATE
orxTEXTURE_EVENT_DELETE
orxTEXTURE_EVENT_NUMBER
orxTEXTURE_EVENT_NONE

Definition at line 59 of file orxTexture.h.

---

Function Documentation

orxDLLAPI orxTEXTURE* orxFASTCALL orxTexture_Create

(

)

Creates an empty texture

Returns:

orxTEXTURE / orxNULL

orxDLLAPI orxTEXTURE* orxFASTCALL orxTexture_CreateFromFile

(

const orxSTRING

_zBitmapFileName )

Creates a texture from a bitmap file

Parameters:

[in]

_zBitmapFileName

Name of the bitmap

Returns:

orxTEXTURE / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxTexture_Delete

(

orxTEXTURE *

_pstTexture )

Deletes a texture (and its referenced bitmap)

Parameters:

[in]

_pstTexture

Concerned texture

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxTexture_Exit

(

)

Exits from the texture module

orxDLLAPI orxBITMAP* orxFASTCALL orxTexture_GetBitmap

(

const orxTEXTURE *

_pstTexture )

Gets texture bitmap

Parameters:

[in]

_pstTexture

Concerned texture

Returns:

orxBITMAP / orxNULL

orxDLLAPI const orxSTRING orxFASTCALL orxTexture_GetName

(

const orxTEXTURE *

_pstTexture )

Gets texture name

Parameters:

[in]

_pstTexture

Concerned texture

Returns:

Texture name / orxNULL

orxDLLAPI orxTEXTURE* orxFASTCALL orxTexture_GetScreenTexture

(

)

Gets screen texture

Returns:

Screen texture / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxTexture_GetSize	(	const orxTEXTURE *	_pstTexture,
		orxFLOAT *	_pfWidth,
		orxFLOAT *	_pfHeight
	)

Gets texture size

Parameters:

[in]	_pstTexture	Concerned texture
[out]	_pfWidth	Texture's width
[out]	_pfHeight	Texture's height

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxTexture_Init

(

)

Inits the texture module

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxTexture_LinkBitmap	(	orxTEXTURE *	_pstTexture,
		const orxBITMAP *	_pstBitmap,
		const orxSTRING	_zDataName
	)

Links a bitmap

Parameters:

[in]	_pstTexture	Concerned texture
[in]	_pstBitmap	Bitmap to link
[in]	_zDataName	Name associated with the bitmap (usually filename)

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxTexture_SetColor	(	orxTEXTURE *	_pstTexture,
		const orxCOLOR *	_pstColor
	)

Sets texture color

Parameters:

[in]	_pstTexture	Concerned texture
[in]	_pstColor	Color to set

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxTexture_Setup

(

)

Setups the texture module

orxDLLAPI orxSTATUS orxFASTCALL orxTexture_UnlinkBitmap

(

orxTEXTURE *

_pstTexture )

Unlinks (and deletes if not used anymore) a bitmap

Parameters:

[in]

_pstTexture

Concerned texture

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE