Defines
#define	orxGRAPHIC_KU32_FLAG_2D 0x00000001
#define	orxGRAPHIC_KU32_FLAG_ALIGN_BOTTOM 0x00000080
#define	orxGRAPHIC_KU32_FLAG_ALIGN_CENTER 0x00000000
#define	orxGRAPHIC_KU32_FLAG_ALIGN_LEFT 0x00000010
#define	orxGRAPHIC_KU32_FLAG_ALIGN_RIGHT 0x00000020
#define	orxGRAPHIC_KU32_FLAG_ALIGN_ROUND 0x00000200
#define	orxGRAPHIC_KU32_FLAG_ALIGN_TOP 0x00000040
#define	orxGRAPHIC_KU32_FLAG_ALIGN_TRUNCATE 0x00000100
#define	orxGRAPHIC_KU32_FLAG_FLIP_X 0x00000004
#define	orxGRAPHIC_KU32_FLAG_FLIP_Y 0x00000008
#define	orxGRAPHIC_KU32_FLAG_NONE 0x00000000
#define	orxGRAPHIC_KU32_FLAG_TEXT 0x00000002
#define	orxGRAPHIC_KU32_MASK_FLIP_BOTH 0x0000000C
#define	orxGRAPHIC_KU32_MASK_TYPE 0x00000003
#define	orxGRAPHIC_KU32_MASK_USER_ALL 0x00000FFF
Typedefs
typedef struct __orxGRAPHIC_t	orxGRAPHIC
Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_ClearColor (orxGRAPHIC *_pstGraphic)
orxDLLAPI orxGRAPHIC *orxFASTCALL	orxGraphic_Create ()
orxDLLAPI orxGRAPHIC *orxFASTCALL	orxGraphic_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_Delete (orxGRAPHIC *_pstGraphic)
orxDLLAPI void orxFASTCALL	orxGraphic_Exit ()
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL	orxGraphic_GetBlendMode (const orxGRAPHIC *_pstGraphic)
orxDLLAPI orxCOLOR *orxFASTCALL	orxGraphic_GetColor (const orxGRAPHIC _pstGraphic, orxCOLOR _pstColor)
orxDLLAPI orxSTRUCTURE *orxFASTCALL	orxGraphic_GetData (const orxGRAPHIC *_pstGraphic)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_GetFlip (const orxGRAPHIC _pstGraphic, orxBOOL _pbFlipX, orxBOOL *_pbFlipY)
orxDLLAPI orxVECTOR *orxFASTCALL	orxGraphic_GetOrigin (const orxGRAPHIC _pstGraphic, orxVECTOR _pvOrigin)
orxDLLAPI orxVECTOR *orxFASTCALL	orxGraphic_GetPivot (const orxGRAPHIC _pstGraphic, orxVECTOR _pvPivot)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_GetRepeat (const orxGRAPHIC _pstGraphic, orxFLOAT _pfRepeatX, orxFLOAT *_pfRepeatY)
orxDLLAPI orxVECTOR *orxFASTCALL	orxGraphic_GetSize (const orxGRAPHIC _pstGraphic, orxVECTOR _pvSize)
orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL	orxGraphic_GetSmoothing (const orxGRAPHIC *_pstGraphic)
orxDLLAPI orxBOOL orxFASTCALL	orxGraphic_HasColor (const orxGRAPHIC *_pstGraphic)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_Init ()
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetBlendMode (orxGRAPHIC *_pstGraphic, orxDISPLAY_BLEND_MODE _eBlendMode)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetColor (orxGRAPHIC _pstGraphic, const orxCOLOR _pstColor)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetData (orxGRAPHIC _pstGraphic, orxSTRUCTURE _pstData)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetFlip (orxGRAPHIC *_pstGraphic, orxBOOL _bFlipX, orxBOOL _bFlipY)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetOrigin (orxGRAPHIC _pstGraphic, const orxVECTOR _pvOrigin)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetPivot (orxGRAPHIC _pstGraphic, const orxVECTOR _pvPivot)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetRelativePivot (orxGRAPHIC *_pstGraphic, orxU32 _u32AlignFlags)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetRepeat (orxGRAPHIC *_pstGraphic, orxFLOAT _fRepeatX, orxFLOAT _fRepeatY)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetSize (orxGRAPHIC _pstGraphic, const orxVECTOR _pvSize)
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_SetSmoothing (orxGRAPHIC *_pstGraphic, orxDISPLAY_SMOOTHING _eSmoothing)
orxDLLAPI void orxFASTCALL	orxGraphic_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxGraphic_UpdateSize (orxGRAPHIC *_pstGraphic)

Detailed Description

Graphic Module. Allows to creates and handle 2D/3D Graphics. They are used as texture/animation container, with associated properties. 2D Graphics are used by objects. They thus can be referenced by objects as structures.

Define Documentation

#define orxGRAPHIC_KU32_FLAG_2D 0x00000001

2D type graphic flag

Definition at line 60 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_ALIGN_BOTTOM 0x00000080

Bottom vertical alignment

Definition at line 73 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_ALIGN_CENTER 0x00000000

Center vertical / horizontal alignment

Definition at line 69 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_ALIGN_LEFT 0x00000010

Left horizontal alignment

Definition at line 70 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_ALIGN_RIGHT 0x00000020

Right horizontal alignment

Definition at line 71 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_ALIGN_ROUND 0x00000200

Round alignment value

Definition at line 75 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_ALIGN_TOP 0x00000040

Top vertical alignment

Definition at line 72 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_ALIGN_TRUNCATE 0x00000100

Truncate alignment value

Definition at line 74 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_FLIP_X 0x00000004

X axis flipping flag

Definition at line 65 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_FLIP_Y 0x00000008

Y axis flipping flag

Definition at line 66 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_NONE 0x00000000

Graphic flags No flags

Definition at line 58 of file orxGraphic.h.

#define orxGRAPHIC_KU32_FLAG_TEXT 0x00000002

Text type graphic flag

Definition at line 61 of file orxGraphic.h.

#define orxGRAPHIC_KU32_MASK_FLIP_BOTH 0x0000000C

Both axis flipping mask

Definition at line 67 of file orxGraphic.h.

#define orxGRAPHIC_KU32_MASK_TYPE 0x00000003

Type mask

Definition at line 63 of file orxGraphic.h.

#define orxGRAPHIC_KU32_MASK_USER_ALL 0x00000FFF

User all ID mask

Definition at line 77 of file orxGraphic.h.

Typedef Documentation

typedef struct __orxGRAPHIC_t orxGRAPHIC

Internal Graphic structure

Definition at line 82 of file orxGraphic.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_ClearColor ( orxGRAPHIC * _pstGraphic )

Clears graphic color

Parameters:

[in] _pstGraphic Concerned graphic

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxGRAPHIC* orxFASTCALL orxGraphic_Create ( )

Creates an empty graphic

Returns:: Created orxGRAPHIC / orxNULL

orxDLLAPI orxGRAPHIC* orxFASTCALL orxGraphic_CreateFromConfig ( const orxSTRING _zConfigID )

Creates a graphic from config

Parameters:

[in] _zConfigID Config ID @ return orxGRAPHIC / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_Delete ( orxGRAPHIC * _pstGraphic )

Deletes a graphic

Parameters:

[in] _pstGraphic Graphic to delete

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxGraphic_Exit ( )

Exits from the Graphic module

orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxGraphic_GetBlendMode ( const orxGRAPHIC * _pstGraphic )

Gets graphic blend mode

Parameters:

[in] _pstGraphic Concerned graphic

Returns:: Blend mode (alpha, multiply, add or none)

orxDLLAPI orxCOLOR* orxFASTCALL orxGraphic_GetColor	(	const orxGRAPHIC *	_pstGraphic,
		orxCOLOR *	_pstColor
	)

Gets graphic color

Parameters:

[in]	_pstGraphic	Concerned graphic
[out]	_pstColor	Object's color

Returns:: orxCOLOR / orxNULL

orxDLLAPI orxSTRUCTURE* orxFASTCALL orxGraphic_GetData ( const orxGRAPHIC * _pstGraphic )

Gets graphic data

Parameters:

[in] _pstGraphic Concerned graphic

Returns:: OrxSTRUCTURE / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_GetFlip	(	const orxGRAPHIC *	_pstGraphic,
		orxBOOL *	_pbFlipX,
		orxBOOL *	_pbFlipY
	)

Gets graphic flipping

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_pbFlipX	X axis flipping
[in]	_pbFlipY	Y axis flipping

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxVECTOR* orxFASTCALL orxGraphic_GetOrigin	(	const orxGRAPHIC *	_pstGraphic,
		orxVECTOR *	_pvOrigin
	)

Gets graphic origin

Parameters:

[in]	_pstGraphic	Concerned graphic
[out]	_pvOrigin	Origin coordinates

Returns:: Origin coordinates

orxDLLAPI orxVECTOR* orxFASTCALL orxGraphic_GetPivot	(	const orxGRAPHIC *	_pstGraphic,
		orxVECTOR *	_pvPivot
	)

Gets graphic pivot

Parameters:

[in]	_pstGraphic	Concerned graphic
[out]	_pvPivot	Graphic pivot

Returns:: orxPIVOT / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_GetRepeat	(	const orxGRAPHIC *	_pstGraphic,
		orxFLOAT *	_pfRepeatX,
		orxFLOAT *	_pfRepeatY
	)

Gets graphic repeat (wrap) values

Parameters:

[in]	_pstGraphic	Concerned graphic
[out]	_pfRepeatX	X-axis repeat value
[out]	_pfRepeatY	Y-axis repeat value

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxVECTOR* orxFASTCALL orxGraphic_GetSize	(	const orxGRAPHIC *	_pstGraphic,
		orxVECTOR *	_pvSize
	)

Gets graphic size

Parameters:

[in]	_pstGraphic	Concerned graphic
[out]	_pvSize	Object's size

Returns:: orxVECTOR / orxNULL

orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxGraphic_GetSmoothing ( const orxGRAPHIC * _pstGraphic )

Gets graphic smoothing

Parameters:

[in] _pstGraphic Concerned graphic

Returns:: Smoothing type (enabled, default or none)

orxDLLAPI orxBOOL orxFASTCALL orxGraphic_HasColor ( const orxGRAPHIC * _pstGraphic )

Graphic has color accessor

Parameters:

[in] _pstGraphic Concerned graphic

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_Init ( )

Inits the Graphic module

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetBlendMode	(	orxGRAPHIC *	_pstGraphic,
		orxDISPLAY_BLEND_MODE	_eBlendMode
	)

Sets object blend mode

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_eBlendMode	Blend mode (alpha, multiply, add or none)

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetColor	(	orxGRAPHIC *	_pstGraphic,
		const orxCOLOR *	_pstColor
	)

Sets graphic color

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_pstColor	Color to set

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetData	(	orxGRAPHIC *	_pstGraphic,
		orxSTRUCTURE *	_pstData
	)

Sets graphic data

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_pstData	Data structure to set / orxNULL

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetFlip	(	orxGRAPHIC *	_pstGraphic,
		orxBOOL	_bFlipX,
		orxBOOL	_bFlipY
	)

Sets graphic flipping

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_bFlipX	Flip it on X axis
[in]	_bFlipY	Flip it on Y axis

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetOrigin	(	orxGRAPHIC *	_pstGraphic,
		const orxVECTOR *	_pvOrigin
	)

Sets graphic origin

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_pvOrigin	Origin coordinates

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetPivot	(	orxGRAPHIC *	_pstGraphic,
		const orxVECTOR *	_pvPivot
	)

Sets graphic pivot

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_pvPivot	Pivot to set

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetRelativePivot	(	orxGRAPHIC *	_pstGraphic,
		orxU32	_u32AlignFlags
	)

Sets relative graphic pivot

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_u32AlignFlags	Alignment flags

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetRepeat	(	orxGRAPHIC *	_pstGraphic,
		orxFLOAT	_fRepeatX,
		orxFLOAT	_fRepeatY
	)

Sets graphic repeat (wrap) value

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_fRepeatX	X-axis repeat value
[in]	_fRepeatY	Y-axis repeat value

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetSize	(	orxGRAPHIC *	_pstGraphic,
		const orxVECTOR *	_pvSize
	)

Sets graphic size

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_pvSize	Size to set

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_SetSmoothing	(	orxGRAPHIC *	_pstGraphic,
		orxDISPLAY_SMOOTHING	_eSmoothing
	)

Sets graphic smoothing

Parameters:

[in]	_pstGraphic	Concerned graphic
[in]	_eSmoothing	Smoothing type (enabled, default or none)

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxGraphic_Setup ( )

Graphic module setup

orxDLLAPI orxSTATUS orxFASTCALL orxGraphic_UpdateSize ( orxGRAPHIC * _pstGraphic )

Updates graphic size (recompute)

Parameters:

[in] _pstGraphic Concerned graphic

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

OrxGraphic

Defines

Typedefs

Functions

Detailed Description

Define Documentation

Typedef Documentation

Function Documentation