Data Structures
struct	orxCHARACTER_GLYPH
struct	orxCHARACTER_MAP
struct	orxCOLOR
struct	orxDISPLAY_EVENT_PAYLOAD
struct	orxDISPLAY_TRANSFORM
struct	orxDISPLAY_VIDEO_MODE
Defines
#define	orx2RGBA(R, G, B, A) ((((A) & 0xFF) << 24) \| (((B) & 0xFF) << 16) \| (((G) & 0xFF) << 8) \| ((R) & 0xFF))
#define	orxCOLOR_DENORMALIZER (orx2F(255.0f))
#define	orxCOLOR_NORMALIZER (orx2F(1.0f / 255.0f))
#define	orxDISPLAY_KZ_CONFIG_DECORATION "Decoration"
#define	orxDISPLAY_KZ_CONFIG_DEPTH "ScreenDepth"
#define	orxDISPLAY_KZ_CONFIG_DEPTHBUFFER "DepthBuffer"
#define	orxDISPLAY_KZ_CONFIG_FULLSCREEN "FullScreen"
#define	orxDISPLAY_KZ_CONFIG_HEIGHT "ScreenHeight"
#define	orxDISPLAY_KZ_CONFIG_SECTION "Display"
#define	orxDISPLAY_KZ_CONFIG_SMOOTH "Smoothing"
#define	orxDISPLAY_KZ_CONFIG_TITLE "Title"
#define	orxDISPLAY_KZ_CONFIG_VSYNC "VSync"
#define	orxDISPLAY_KZ_CONFIG_WIDTH "ScreenWidth"
#define	orxDISPLAY_KZ_SHADER_SUFFIX_BOTTOM "_bottom"
#define	orxDISPLAY_KZ_SHADER_SUFFIX_LEFT "_left"
#define	orxDISPLAY_KZ_SHADER_SUFFIX_RIGHT "_right"
#define	orxDISPLAY_KZ_SHADER_SUFFIX_TOP "_top"
#define	orxRGBA_A(RGBA) (orxU8)(((RGBA) >> 24) & 0xFF)
#define	orxRGBA_B(RGBA) (orxU8)(((RGBA) >> 16) & 0xFF)
#define	orxRGBA_G(RGBA) (orxU8)(((RGBA) >> 8) & 0xFF)
#define	orxRGBA_R(RGBA) (orxU8)((RGBA) & 0xFF)
Typedefs
typedef struct __orxBITMAP_t	orxBITMAP
typedef orxU32	orxRGBA
Enumerations
enum	orxDISPLAY_BLEND_MODE { orxDISPLAY_BLEND_MODE_ALPHA = 0, orxDISPLAY_BLEND_MODE_MULTIPLY, orxDISPLAY_BLEND_MODE_ADD, orxDISPLAY_BLEND_MODE_NUMBER, orxDISPLAY_BLEND_MODE_NONE = orxENUM_NONE }
enum	orxDISPLAY_EVENT { orxDISPLAY_EVENT_SET_VIDEO_MODE = 0, orxDISPLAY_EVENT_NUMBER, orxDISPLAY_EVENT_NONE = orxENUM_NONE }
enum	orxDISPLAY_SMOOTHING { orxDISPLAY_SMOOTHING_DEFAULT = 0, orxDISPLAY_SMOOTHING_ON, orxDISPLAY_SMOOTHING_OFF, orxDISPLAY_SMOOTHING_NUMBER, orxDISPLAY_SMOOTHING_NONE = orxENUM_NONE }
Functions
static orxINLINE orxCOLOR *	orxColor_Copy (orxCOLOR _pstDst, const orxCOLOR _pstSrc)
static orxCOLOR *orxFASTCALL	orxColor_FromHSLToRGB (orxCOLOR _pstDst, const orxCOLOR _pstSrc)
static orxCOLOR *orxFASTCALL	orxColor_FromHSVToRGB (orxCOLOR _pstDst, const orxCOLOR _pstSrc)
static orxCOLOR *orxFASTCALL	orxColor_FromRGBToHSL (orxCOLOR _pstDst, const orxCOLOR _pstSrc)
static orxCOLOR *orxFASTCALL	orxColor_FromRGBToHSV (orxCOLOR _pstDst, const orxCOLOR _pstSrc)
static orxINLINE orxCOLOR *	orxColor_Set (orxCOLOR _pstColor, const orxVECTOR _pvRGB, orxFLOAT _fAlpha)
static orxINLINE orxCOLOR *	orxColor_SetAlpha (orxCOLOR *_pstColor, orxFLOAT _fAlpha)
static orxINLINE orxCOLOR *	orxColor_SetRGB (orxCOLOR _pstColor, const orxVECTOR _pvRGB)
static orxINLINE orxCOLOR *	orxColor_SetRGBA (orxCOLOR *_pstColor, orxRGBA _stRGBA)
static orxINLINE orxRGBA	orxColor_ToRGBA (const orxCOLOR *_pstColor)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_BlitBitmap (const orxBITMAP *_pstSrc, orxFLOAT _fPosX, orxFLOAT _fPosY, orxDISPLAY_SMOOTHING _eSmoothing, orxDISPLAY_BLEND_MODE _eBlendMode)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_ClearBitmap (orxBITMAP *_pstBitmap, orxRGBA _stColor)
orxDLLAPI orxBITMAP *orxFASTCALL	orxDisplay_CreateBitmap (orxU32 _u32Width, orxU32 _u32Height)
orxDLLAPI orxHANDLE orxFASTCALL	orxDisplay_CreateShader (const orxSTRING _zCode, const orxLINKLIST *_pstParamList)
orxDLLAPI void orxFASTCALL	orxDisplay_DeleteBitmap (orxBITMAP *_pstBitmap)
orxDLLAPI void orxFASTCALL	orxDisplay_DeleteShader (orxHANDLE _hShader)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_EnableVSync (orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxDisplay_Exit ()
orxDLLAPI orxRGBA orxFASTCALL	orxDisplay_GetBitmapColor (const orxBITMAP *_pstBitmap)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_GetBitmapData (orxBITMAP _pstBitmap, orxU8 _au8Data, orxU32 _u32ByteNumber)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_GetBitmapSize (const orxBITMAP _pstBitmap, orxFLOAT _pfWidth, orxFLOAT *_pfHeight)
orxDLLAPI orxS32 orxFASTCALL	orxDisplay_GetParameterID (orxHANDLE _hShader, const orxSTRING _zParam, orxS32 _s32Index, orxBOOL _bIsTexture)
orxDLLAPI orxBITMAP *orxFASTCALL	orxDisplay_GetScreenBitmap ()
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_GetScreenSize (orxFLOAT _pfWidth, orxFLOAT _pfHeight)
orxDLLAPI orxDISPLAY_VIDEO_MODE *orxFASTCALL	orxDisplay_GetVideoMode (orxU32 _u32Index, orxDISPLAY_VIDEO_MODE *_pstVideoMode)
orxDLLAPI orxU32 orxFASTCALL	orxDisplay_GetVideoModeCounter ()
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxDisplay_IsFullScreen ()
orxDLLAPI orxBOOL orxFASTCALL	orxDisplay_IsVideoModeAvailable (const orxDISPLAY_VIDEO_MODE *_pstVideoMode)
orxDLLAPI orxBOOL orxFASTCALL	orxDisplay_IsVSyncEnabled ()
orxDLLAPI orxBITMAP *orxFASTCALL	orxDisplay_LoadBitmap (const orxSTRING _zFileName)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SaveBitmap (const orxBITMAP *_pstBitmap, const orxSTRING _zFileName)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetBitmapClipping (orxBITMAP *_pstBitmap, orxU32 _u32TLX, orxU32 _u32TLY, orxU32 _u32BRX, orxU32 _u32BRY)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetBitmapColor (orxBITMAP *_pstBitmap, orxRGBA _stColor)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetBitmapColorKey (orxBITMAP *_pstBitmap, orxRGBA _stColor, orxBOOL _bEnable)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetBitmapData (orxBITMAP _pstBitmap, const orxU8 _au8Data, orxU32 _u32ByteNumber)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetDestinationBitmap (orxBITMAP *_pstDst)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetFullScreen (orxBOOL _bFullScreen)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetShaderBitmap (orxHANDLE _hShader, orxS32 _s32ID, const orxBITMAP *_pstValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetShaderFloat (orxHANDLE _hShader, orxS32 _s32ID, orxFLOAT _fValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetShaderVector (orxHANDLE _hShader, orxS32 _s32ID, const orxVECTOR *_pvValue)
orxDLLAPI void orxFASTCALL	orxDisplay_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_SetVideoMode (const orxDISPLAY_VIDEO_MODE *_pstVideoMode)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_StartShader (const orxHANDLE _hShader)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_StopShader (const orxHANDLE _hShader)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_Swap ()
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_TransformBitmap (const orxBITMAP _pstSrc, const orxDISPLAY_TRANSFORM _pstTransform, orxDISPLAY_SMOOTHING _eSmoothing, orxDISPLAY_BLEND_MODE _eBlendMode)
orxDLLAPI orxSTATUS orxFASTCALL	orxDisplay_TransformText (const orxSTRING _zString, const orxBITMAP _pstFont, const orxCHARACTER_MAP _pstMap, const orxDISPLAY_TRANSFORM *_pstTransform, orxDISPLAY_SMOOTHING _eSmoothing, orxDISPLAY_BLEND_MODE _eBlendMode)

Detailed Description

Display plugin module Module that handles display

Define Documentation

#define orx2RGBA	(	R,
		G,
		B,
		A
	)	((((A) & 0xFF) << 24) \| (((B) & 0xFF) << 16) \| (((G) & 0xFF) << 8) \| ((R) & 0xFF))

Definition at line 70 of file orxDisplay.h.

#define orxCOLOR_DENORMALIZER (orx2F(255.0f))

Definition at line 79 of file orxDisplay.h.

#define orxCOLOR_NORMALIZER (orx2F(1.0f / 255.0f))

Definition at line 78 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_DECORATION "Decoration"

Definition at line 173 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_DEPTH "ScreenDepth"

Definition at line 171 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_DEPTHBUFFER "DepthBuffer"

Definition at line 177 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_FULLSCREEN "FullScreen"

Definition at line 172 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_HEIGHT "ScreenHeight"

Definition at line 170 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_SECTION "Display"

Config parameters

Definition at line 168 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_SMOOTH "Smoothing"

Definition at line 175 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_TITLE "Title"

Definition at line 174 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_VSYNC "VSync"

Definition at line 176 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_WIDTH "ScreenWidth"

Definition at line 169 of file orxDisplay.h.

#define orxDISPLAY_KZ_SHADER_SUFFIX_BOTTOM "_bottom"

Definition at line 184 of file orxDisplay.h.

#define orxDISPLAY_KZ_SHADER_SUFFIX_LEFT "_left"

Definition at line 183 of file orxDisplay.h.

#define orxDISPLAY_KZ_SHADER_SUFFIX_RIGHT "_right"

Definition at line 185 of file orxDisplay.h.

#define orxDISPLAY_KZ_SHADER_SUFFIX_TOP "_top"

Shader texture suffixes

Definition at line 182 of file orxDisplay.h.

#define orxRGBA_A ( RGBA ) (orxU8)(((RGBA) >> 24) & 0xFF)

Definition at line 74 of file orxDisplay.h.

#define orxRGBA_B ( RGBA ) (orxU8)(((RGBA) >> 16) & 0xFF)

Definition at line 73 of file orxDisplay.h.

#define orxRGBA_G ( RGBA ) (orxU8)(((RGBA) >> 8) & 0xFF)

Definition at line 72 of file orxDisplay.h.

#define orxRGBA_R ( RGBA ) (orxU8)((RGBA) & 0xFF)

Definition at line 71 of file orxDisplay.h.

Typedef Documentation

typedef struct __orxBITMAP_t orxBITMAP

Definition at line 82 of file orxDisplay.h.

typedef orxU32 orxRGBA

Misc defines

Definition at line 58 of file orxDisplay.h.

Enumeration Type Documentation

enum orxDISPLAY_BLEND_MODE

Bitmap blend enum

Enumerator:

orxDISPLAY_BLEND_MODE_ALPHA
orxDISPLAY_BLEND_MODE_MULTIPLY
orxDISPLAY_BLEND_MODE_ADD
orxDISPLAY_BLEND_MODE_NUMBER
orxDISPLAY_BLEND_MODE_NONE

Definition at line 139 of file orxDisplay.h.

enum orxDISPLAY_EVENT

Event enum

Enumerator:

orxDISPLAY_EVENT_SET_VIDEO_MODE
orxDISPLAY_EVENT_NUMBER
orxDISPLAY_EVENT_NONE

Definition at line 190 of file orxDisplay.h.

enum orxDISPLAY_SMOOTHING

Bitmap smoothing enum

Enumerator:

orxDISPLAY_SMOOTHING_DEFAULT
orxDISPLAY_SMOOTHING_ON
orxDISPLAY_SMOOTHING_OFF
orxDISPLAY_SMOOTHING_NUMBER
orxDISPLAY_SMOOTHING_NONE

Definition at line 125 of file orxDisplay.h.

Function Documentation

static orxINLINE orxCOLOR* orxColor_Copy	(	orxCOLOR *	_pstDst,
		const orxCOLOR *	_pstSrc
	)		`[static]`

Copies an orxCOLOR into another one

Parameters:

[in]	_pstDst	Destination color
[in]	_pstSrc	Source color

Returns:: orxCOLOR

Definition at line 373 of file orxDisplay.h.

static orxCOLOR* orxFASTCALL orxColor_FromHSLToRGB	(	orxCOLOR *	_pstDst,
		const orxCOLOR *	_pstSrc
	)		`[static]`

Converts from HSL color space to RGB one

Parameters:

[in]	_pstDst	Destination color
[in]	_pstSrc	Source color

Returns:: orxCOLOR

Definition at line 468 of file orxDisplay.h.

static orxCOLOR* orxFASTCALL orxColor_FromHSVToRGB	(	orxCOLOR *	_pstDst,
		const orxCOLOR *	_pstSrc
	)		`[static]`

Converts from HSV color space to RGB one

Parameters:

[in]	_pstDst	Destination color
[in]	_pstSrc	Source color

Returns:: orxCOLOR

Definition at line 637 of file orxDisplay.h.

static orxCOLOR* orxFASTCALL orxColor_FromRGBToHSL	(	orxCOLOR *	_pstDst,
		const orxCOLOR *	_pstSrc
	)		`[static]`

Converts from RGB color space to HSL one

Parameters:

[in]	_pstDst	Destination color
[in]	_pstSrc	Source color

Returns:: orxCOLOR

Definition at line 391 of file orxDisplay.h.

static orxCOLOR* orxFASTCALL orxColor_FromRGBToHSV	(	orxCOLOR *	_pstDst,
		const orxCOLOR *	_pstSrc
	)		`[static]`

Converts from RGB color space to HSV one

Parameters:

[in]	_pstDst	Destination color
[in]	_pstSrc	Source color

Returns:: orxCOLOR

Definition at line 562 of file orxDisplay.h.

static orxINLINE orxCOLOR* orxColor_Set	(	orxCOLOR *	_pstColor,
		const orxVECTOR *	_pvRGB,
		orxFLOAT	_fAlpha
	)		`[static]`

Sets all components

Parameters:

[in]	_pstColor	Concerned color
[in]	_pvRGB	RGB components
[in]	_fAlpha	Normalized alpha component

Returns:: orxCOLOR

Definition at line 283 of file orxDisplay.h.

static orxINLINE orxCOLOR* orxColor_SetAlpha	(	orxCOLOR *	_pstColor,
		orxFLOAT	_fAlpha
	)		`[static]`

Sets alpha component

Parameters:

[in]	_pstColor	Concerned color
[in]	_fAlpha	Normalized alpha component

Returns:: orxCOLOR / orxNULL

Definition at line 325 of file orxDisplay.h.

static orxINLINE orxCOLOR* orxColor_SetRGB	(	orxCOLOR *	_pstColor,
		const orxVECTOR *	_pvRGB
	)		`[static]`

Sets RGB components

Parameters:

[in]	_pstColor	Concerned color
[in]	_pvRGB	RGB components

Returns:: orxCOLOR

Definition at line 305 of file orxDisplay.h.

static orxINLINE orxCOLOR* orxColor_SetRGBA	(	orxCOLOR *	_pstColor,
		orxRGBA	_stRGBA
	)		`[static]`

Sets all components from an orxRGBA

Parameters:

[in]	_pstColor	Concerned color
[in]	_stRGBA	RGBA values to set

Returns:: orxCOLOR

Definition at line 260 of file orxDisplay.h.

static orxINLINE orxRGBA orxColor_ToRGBA ( const orxCOLOR * _pstColor ) [static]

Gets orxRGBA from an orxCOLOR

Parameters:

[in] _pstColor Concerned color

Returns:: orxRGBA

Definition at line 343 of file orxDisplay.h.

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_BlitBitmap	(	const orxBITMAP *	_pstSrc,
		orxFLOAT	_fPosX,
		orxFLOAT	_fPosY,
		orxDISPLAY_SMOOTHING	_eSmoothing,
		orxDISPLAY_BLEND_MODE	_eBlendMode
	)

Blits a bitmap (no transformation)

Parameters:

[in]	_pstSrc	Bitmap to blit (will begin at top left corner)
[in]	_fPosX	X-axis value of the position where to blit the source bitmap
[in]	_fPosY	Y-axis value of the position where to blit the source bitmap
[in]	_eSmoothing	Bitmap smoothing type
[in]	_eBlendMode	Blend mode

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_ClearBitmap	(	orxBITMAP *	_pstBitmap,
		orxRGBA	_stColor
	)

Clears a bitmap

Parameters:

[in]	_pstBitmap	Concerned bitmap
[in]	_stColor	Color to clear the bitmap with

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBITMAP* orxFASTCALL orxDisplay_CreateBitmap	(	orxU32	_u32Width,
		orxU32	_u32Height
	)

Creates a bitmap

Parameters:

[in]	_u32Width	Bitmap width
[in]	_u32Height	Bitmap height

Returns:: orxBITMAP / orxNULL

orxDLLAPI orxHANDLE orxFASTCALL orxDisplay_CreateShader	(	const orxSTRING	_zCode,
		const orxLINKLIST *	_pstParamList
	)

Creates (compiles) a shader

Parameters:

[in]	_zCode	Shader code to compile
[in]	_pstParamList	Shader parameters (should be a link list of orxSHADER_PARAM)

Returns:: orxHANDLE of the compiled shader is successful, orxHANDLE_UNDEFINED otherwise

orxDLLAPI void orxFASTCALL orxDisplay_DeleteBitmap ( orxBITMAP * _pstBitmap )

Deletes a bitmap

Parameters:

[in] _pstBitmap Concerned bitmap

orxDLLAPI void orxFASTCALL orxDisplay_DeleteShader ( orxHANDLE _hShader )

Deletes a compiled shader

Parameters:

[in] _hShader Shader to delete

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_EnableVSync ( orxBOOL _bEnable )

Enables / disables vertical synchro

Parameters:

[in] _bEnable Enable / disable

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxDisplay_Exit ( )

Exits from the display module

orxDLLAPI orxRGBA orxFASTCALL orxDisplay_GetBitmapColor ( const orxBITMAP * _pstBitmap )

Gets bitmap color (lighting/hue)

Parameters:

[in] _pstBitmap Concerned bitmap

Returns:: orxRGBA

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_GetBitmapData	(	orxBITMAP *	_pstBitmap,
		orxU8 *	_au8Data,
		orxU32	_u32ByteNumber
	)

Gets a bitmap data (RGBA memory format)

Parameters:

[in]	_pstBitmap	Concerned bitmap
[in]	_au8Data	Output buffer (4 channels, RGBA)
[in]	_u32ByteNumber	Number of bytes of the buffer

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_GetBitmapSize	(	const orxBITMAP *	_pstBitmap,
		orxFLOAT *	_pfWidth,
		orxFLOAT *	_pfHeight
	)

Gets a bitmap size

Parameters:

[in]	_pstBitmap	Concerned bitmap
[out]	_pfWidth	Bitmap width
[out]	_pfHeight	Bitmap height

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxS32 orxFASTCALL orxDisplay_GetParameterID	(	orxHANDLE	_hShader,
		const orxSTRING	_zParam,
		orxS32	_s32Index,
		orxBOOL	_bIsTexture
	)

Gets a shader parameter's ID

Parameters:

[in]	_hShader	Concerned shader
[in]	_zParam	Parameter name
[in]	_s32Index	Parameter index, -1 for non-array types
[in]	_bIsTexture	Is parameter a texture?

Returns:: Parameter ID

orxDLLAPI orxBITMAP* orxFASTCALL orxDisplay_GetScreenBitmap ( )

Gets screen bitmap

Returns:: orxBITMAP / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_GetScreenSize	(	orxFLOAT *	_pfWidth,
		orxFLOAT *	_pfHeight
	)

Gets screen size

Parameters:

[out]	_pfWidth	Screen width
[out]	_pfHeight	Screen height

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxDISPLAY_VIDEO_MODE* orxFASTCALL orxDisplay_GetVideoMode	(	orxU32	_u32Index,
		orxDISPLAY_VIDEO_MODE *	_pstVideoMode
	)

Gets an available video mode

Parameters:

[in]	_u32Index	Video mode index, must be lesser than orxDisplay_GetVideoModeCounter()
[out]	_pstVideoMode	Storage for the video mode

Returns:: orxDISPLAY_VIDEO_MODE / orxNULL if invalid

orxDLLAPI orxU32 orxFASTCALL orxDisplay_GetVideoModeCounter ( )

Gets available video mode counter

Returns:: Available video mode counter

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_Init ( )

Inits the display module

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxDisplay_IsFullScreen ( )

Is in full screen mode?

Returns:: orxTRUE if full screen, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxDisplay_IsVideoModeAvailable ( const orxDISPLAY_VIDEO_MODE * _pstVideoMode )

Is video mode available

Parameters:

[in] _pstVideoMode Video mode to test

Returns:: orxTRUE is available, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxDisplay_IsVSyncEnabled ( )

Is vertical synchro enabled?

Returns:: orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxBITMAP* orxFASTCALL orxDisplay_LoadBitmap ( const orxSTRING _zFileName )

Loads a bitmap from file

Parameters:

[in] _zFileName Name of the file to load

Returns:: orxBITMAP * / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SaveBitmap	(	const orxBITMAP *	_pstBitmap,
		const orxSTRING	_zFileName
	)

Saves a bitmap to file

Parameters:

[in]	_pstBitmap	Concerned bitmap
[in]	_zFileName	Name of the file where to store the bitmap

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetBitmapClipping	(	orxBITMAP *	_pstBitmap,
		orxU32	_u32TLX,
		orxU32	_u32TLY,
		orxU32	_u32BRX,
		orxU32	_u32BRY
	)

Sets a bitmap clipping for blitting (both as source and destination)

Parameters:

[in]	_pstBitmap	Concerned bitmap
[in]	_u32TLX	Top left X coord in pixels
[in]	_u32TLY	Top left Y coord in pixels
[in]	_u32BRX	Bottom right X coord in pixels
[in]	_u32BRY	Bottom right Y coord in pixels

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetBitmapColor	(	orxBITMAP *	_pstBitmap,
		orxRGBA	_stColor
	)

Sets a bitmap color (lighting/hue)

Parameters:

[in]	_pstBitmap	Concerned bitmap
[in]	_stColor	Color to apply on the bitmap

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetBitmapColorKey	(	orxBITMAP *	_pstBitmap,
		orxRGBA	_stColor,
		orxBOOL	_bEnable
	)

Sets a bitmap color key (used with non alpha transparency)

Parameters:

[in]	_pstBitmap	Concerned bitmap
[in]	_stColor	Color to use as transparent one
[in]	_bEnable	Enable / disable transparence for this color

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetBitmapData	(	orxBITMAP *	_pstBitmap,
		const orxU8 *	_au8Data,
		orxU32	_u32ByteNumber
	)

Sets a bitmap data (RGBA memory format)

Parameters:

[in]	_pstBitmap	Concerned bitmap
[in]	_au8Data	Data (4 channels, RGBA)
[in]	_u32ByteNumber	Number of bytes

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetDestinationBitmap ( orxBITMAP * _pstDst )

Sets destination bitmap

Parameters:

[in] _pstDst Destination bitmap

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetFullScreen ( orxBOOL _bFullScreen )

Sets full screen mode

Parameters:

[in] _bFullScreen orxTRUE / orxFALSE

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetShaderBitmap	(	orxHANDLE	_hShader,
		orxS32	_s32ID,
		const orxBITMAP *	_pstValue
	)

Sets a shader parameter (orxBITMAP)

Parameters:

[in]	_hShader	Concerned shader
[in]	_s32ID	ID of parameter to set
[in]	_pstValue	Value (orxBITMAP) for this parameter

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetShaderFloat	(	orxHANDLE	_hShader,
		orxS32	_s32ID,
		orxFLOAT	_fValue
	)

Sets a shader parameter (orxFLOAT)

Parameters:

[in]	_hShader	Concerned shader
[in]	_s32ID	ID of parameter to set
[in]	_fValue	Value (orxFLOAT) for this parameter

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetShaderVector	(	orxHANDLE	_hShader,
		orxS32	_s32ID,
		const orxVECTOR *	_pvValue
	)

Sets a shader parameter (orxVECTOR)

Parameters:

[in]	_hShader	Concerned shader
[in]	_s32ID	ID of parameter to set
[in]	_pvValue	Value (orxVECTOR) for this parameter

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxDisplay_Setup ( )

Display module setup

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetVideoMode ( const orxDISPLAY_VIDEO_MODE * _pstVideoMode )

Gets an available video mode

Parameters:

[in] _pstVideoMode Video mode to set

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_StartShader ( const orxHANDLE _hShader )

Starts a shader rendering

Parameters:

[in] _hShader Shader to start

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_StopShader ( const orxHANDLE _hShader )

Stops a shader rendering

Parameters:

[in] _hShader Shader to stop

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_Swap ( )

Swaps/flips bufers (display on screen the current frame)

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_TransformBitmap	(	const orxBITMAP *	_pstSrc,
		const orxDISPLAY_TRANSFORM *	_pstTransform,
		orxDISPLAY_SMOOTHING	_eSmoothing,
		orxDISPLAY_BLEND_MODE	_eBlendMode
	)

Transforms (and blits onto another) a bitmap

Parameters:

[in]	_pstSrc	Bitmap to transform and draw
[in]	_pstTransform	Transformation info (position, scale, rotation, ...)
[in]	_eSmoothing	Bitmap smoothing type
[in]	_eBlendMode	Blend mode

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_TransformText	(	const orxSTRING	_zString,
		const orxBITMAP *	_pstFont,
		const orxCHARACTER_MAP *	_pstMap,
		const orxDISPLAY_TRANSFORM *	_pstTransform,
		orxDISPLAY_SMOOTHING	_eSmoothing,
		orxDISPLAY_BLEND_MODE	_eBlendMode
	)

Transforms a text (on a bitmap)

Parameters:

[in]	_zString	String to display
[in]	_pstFont	Font bitmap
[in]	_pstMap	Character map
[in]	_pstTransform	Transformation info (position, scale, rotation, ...)
[in]	_eSmoothing	Bitmap smoothing type
[in]	_eBlendMode	Blend mode

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

OrxDisplay

Data Structures

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation