orx  stable
Portable Game Engine
OrxDisplay

Data Structures

struct  orxCHARACTER_GLYPH
 
struct  orxCHARACTER_MAP
 
struct  orxCOLOR
 
struct  orxDISPLAY_EVENT_PAYLOAD
 
struct  orxDISPLAY_TRANSFORM
 
struct  orxDISPLAY_VERTEX
 
struct  orxDISPLAY_VIDEO_MODE
 
struct  orxRGBA
 

Macros

#define orx2RGBA(R, G, B, A)    orxRGBA_Set((orxU8)(R), (orxU8)(G), (orxU8)(B), (orxU8)(A))
 
#define orxCOLOR_DENORMALIZER   (orx2F(255.0f))
 
#define orxCOLOR_NORMALIZER   (orx2F(1.0f / 255.0f))
 
#define orxDISPLAY_KC_SHADER_EXTENSION_ADD   '+'
 
#define orxDISPLAY_KC_SHADER_EXTENSION_REMOVE   '-'
 
#define orxDISPLAY_KZ_CONFIG_ALLOW_RESIZE   "AllowResize"
 
#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_POSITION   "ScreenPosition"
 
#define orxDISPLAY_KZ_CONFIG_REFRESH_RATE   "RefreshRate"
 
#define orxDISPLAY_KZ_CONFIG_SECTION   "Display"
 
#define orxDISPLAY_KZ_CONFIG_SHADER_EXTENSION_LIST   "ShaderExtensionList"
 
#define orxDISPLAY_KZ_CONFIG_SHADER_VERSION   "ShaderVersion"
 
#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)    RGBA.u8A
 
#define orxRGBA_B(RGBA)    RGBA.u8B
 
#define orxRGBA_G(RGBA)    RGBA.u8G
 
#define orxRGBA_R(RGBA)    RGBA.u8R
 

Typedefs

typedef struct __orxBITMAP_t orxBITMAP
 

Enumerations

enum  orxDISPLAY_BLEND_MODE {
  orxDISPLAY_BLEND_MODE_ALPHA = 0, orxDISPLAY_BLEND_MODE_MULTIPLY, orxDISPLAY_BLEND_MODE_ADD, orxDISPLAY_BLEND_MODE_PREMUL,
  orxDISPLAY_BLEND_MODE_NUMBER, orxDISPLAY_BLEND_MODE_NONE = orxENUM_NONE
}
 
enum  orxDISPLAY_EVENT { orxDISPLAY_EVENT_SET_VIDEO_MODE = 0, orxDISPLAY_EVENT_LOAD_BITMAP, 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 orxCOLORorxColor_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 orxCOLORorxColor_Set (orxCOLOR *_pstColor, const orxVECTOR *_pvRGB, orxFLOAT _fAlpha)
 
static orxINLINE orxCOLORorxColor_SetAlpha (orxCOLOR *_pstColor, orxFLOAT _fAlpha)
 
static orxINLINE orxCOLORorxColor_SetRGB (orxCOLOR *_pstColor, const orxVECTOR *_pvRGB)
 
static orxINLINE orxCOLORorxColor_SetRGBA (orxCOLOR *_pstColor, orxRGBA _stRGBA)
 
static orxINLINE orxRGBA orxColor_ToRGBA (const orxCOLOR *_pstColor)
 
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 *_azCodeList, orxU32 _u32Size, const orxLINKLIST *_pstParamList, orxBOOL _bUseCustomParam)
 
orxDLLAPI void orxFASTCALL orxDisplay_DeleteBitmap (orxBITMAP *_pstBitmap)
 
orxDLLAPI void orxFASTCALL orxDisplay_DeleteShader (orxHANDLE _hShader)
 
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawCircle (const orxVECTOR *_pvCenter, orxFLOAT _fRadius, orxRGBA _stColor, orxBOOL _bFill)
 
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawLine (const orxVECTOR *_pvStart, const orxVECTOR *_pvEnd, orxRGBA _stColor)
 
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawMesh (const orxBITMAP *_pstBitmap, orxDISPLAY_SMOOTHING _eSmoothing, orxDISPLAY_BLEND_MODE _eBlendMode, orxU32 _u32VertexNumber, const orxDISPLAY_VERTEX *_astVertexList)
 
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawOBox (const orxOBOX *_pstBox, orxRGBA _stColor, orxBOOL _bFill)
 
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawPolygon (const orxVECTOR *_avVertexList, orxU32 _u32VertexNumber, orxRGBA _stColor, orxBOOL _bFill)
 
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawPolyline (const orxVECTOR *_avVertexList, orxU32 _u32VertexNumber, orxRGBA _stColor)
 
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 (const orxBITMAP *_pstBitmap, orxU8 *_au8Data, orxU32 _u32ByteNumber)
 
orxDLLAPI orxU32 orxFASTCALL orxDisplay_GetBitmapID (const orxBITMAP *_pstBitmap)
 
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_GetBitmapSize (const orxBITMAP *_pstBitmap, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight)
 
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxDisplay_GetBlendModeFromString (const orxSTRING _zBlendMode)
 
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 const orxBITMAP *orxFASTCALL orxDisplay_GetTempBitmap ()
 
orxDLLAPI orxDISPLAY_VIDEO_MODE *orxFASTCALL orxDisplay_GetVideoMode (orxU32 _u32Index, orxDISPLAY_VIDEO_MODE *_pstVideoMode)
 
orxDLLAPI orxU32 orxFASTCALL orxDisplay_GetVideoModeCounter ()
 
orxDLLAPI orxBOOL orxFASTCALL orxDisplay_HasShaderSupport ()
 
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_SetBlendMode (orxDISPLAY_BLEND_MODE _eBlendMode)
 
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetDestinationBitmaps (orxBITMAP **_apstBitmapList, orxU32 _u32Number)
 
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 orxSTATUS orxFASTCALL orxDisplay_SetTempBitmap (const orxBITMAP *_pstBitmap)
 
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)
 
static orxINLINE orxRGBA orxRGBA_Set (orxU8 _u8R, orxU8 _u8G, orxU8 _u8B, orxU8 _u8A)
 

Detailed Description

Display plugin module Module that handles display

Macro Definition Documentation

#define orx2RGBA (   R,
  G,
  B,
 
)    orxRGBA_Set((orxU8)(R), (orxU8)(G), (orxU8)(B), (orxU8)(A))

Definition at line 73 of file orxDisplay.h.

#define orxCOLOR_DENORMALIZER   (orx2F(255.0f))

Definition at line 80 of file orxDisplay.h.

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

Definition at line 79 of file orxDisplay.h.

#define orxDISPLAY_KC_SHADER_EXTENSION_ADD   '+'

Shader extension actions

Definition at line 208 of file orxDisplay.h.

#define orxDISPLAY_KC_SHADER_EXTENSION_REMOVE   '-'

Definition at line 209 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_ALLOW_RESIZE   "AllowResize"

Definition at line 188 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_DECORATION   "Decoration"

Definition at line 189 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_DEPTH   "ScreenDepth"

Definition at line 184 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_DEPTHBUFFER   "DepthBuffer"

Definition at line 193 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_FULLSCREEN   "FullScreen"

Definition at line 187 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_HEIGHT   "ScreenHeight"

Definition at line 183 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_POSITION   "ScreenPosition"

Definition at line 185 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_REFRESH_RATE   "RefreshRate"

Definition at line 186 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_SECTION   "Display"

Config parameters

Definition at line 181 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_SHADER_EXTENSION_LIST   "ShaderExtensionList"

Definition at line 195 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_SHADER_VERSION   "ShaderVersion"

Definition at line 194 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_SMOOTH   "Smoothing"

Definition at line 191 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_TITLE   "Title"

Definition at line 190 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_VSYNC   "VSync"

Definition at line 192 of file orxDisplay.h.

#define orxDISPLAY_KZ_CONFIG_WIDTH   "ScreenWidth"

Definition at line 182 of file orxDisplay.h.

#define orxDISPLAY_KZ_SHADER_SUFFIX_BOTTOM   "_bottom"

Definition at line 202 of file orxDisplay.h.

#define orxDISPLAY_KZ_SHADER_SUFFIX_LEFT   "_left"

Definition at line 201 of file orxDisplay.h.

#define orxDISPLAY_KZ_SHADER_SUFFIX_RIGHT   "_right"

Definition at line 203 of file orxDisplay.h.

#define orxDISPLAY_KZ_SHADER_SUFFIX_TOP   "_top"

Shader texture suffixes

Definition at line 200 of file orxDisplay.h.

#define orxRGBA_A (   RGBA)    RGBA.u8A

Definition at line 77 of file orxDisplay.h.

#define orxRGBA_B (   RGBA)    RGBA.u8B

Definition at line 76 of file orxDisplay.h.

#define orxRGBA_G (   RGBA)    RGBA.u8G

Definition at line 75 of file orxDisplay.h.

#define orxRGBA_R (   RGBA)    RGBA.u8R

Definition at line 74 of file orxDisplay.h.

Typedef Documentation

typedef struct __orxBITMAP_t orxBITMAP

Definition at line 82 of file orxDisplay.h.

Enumeration Type Documentation

Bitmap blend enum

Enumerator
orxDISPLAY_BLEND_MODE_ALPHA 
orxDISPLAY_BLEND_MODE_MULTIPLY 
orxDISPLAY_BLEND_MODE_ADD 
orxDISPLAY_BLEND_MODE_PREMUL 
orxDISPLAY_BLEND_MODE_NUMBER 
orxDISPLAY_BLEND_MODE_NONE 

Definition at line 151 of file orxDisplay.h.

Event enum

Enumerator
orxDISPLAY_EVENT_SET_VIDEO_MODE 
orxDISPLAY_EVENT_LOAD_BITMAP 
orxDISPLAY_EVENT_NUMBER 
orxDISPLAY_EVENT_NONE 

Definition at line 214 of file orxDisplay.h.

Bitmap smoothing enum

Enumerator
orxDISPLAY_SMOOTHING_DEFAULT 
orxDISPLAY_SMOOTHING_ON 
orxDISPLAY_SMOOTHING_OFF 
orxDISPLAY_SMOOTHING_NUMBER 
orxDISPLAY_SMOOTHING_NONE 

Definition at line 137 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]_pstDstDestination color
[in]_pstSrcSource color
Returns
orxCOLOR

Definition at line 451 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]_pstDstDestination color
[in]_pstSrcSource color
Returns
orxCOLOR

Definition at line 546 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]_pstDstDestination color
[in]_pstSrcSource color
Returns
orxCOLOR

Definition at line 715 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]_pstDstDestination color
[in]_pstSrcSource color
Returns
orxCOLOR

Definition at line 469 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]_pstDstDestination color
[in]_pstSrcSource color
Returns
orxCOLOR

Definition at line 640 of file orxDisplay.h.

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

Sets all components

Parameters
[in]_pstColorConcerned color
[in]_pvRGBRGB components
[in]_fAlphaNormalized alpha component
Returns
orxCOLOR

Definition at line 361 of file orxDisplay.h.

static orxINLINE orxCOLOR* orxColor_SetAlpha ( orxCOLOR _pstColor,
orxFLOAT  _fAlpha 
)
static

Sets alpha component

Parameters
[in]_pstColorConcerned color
[in]_fAlphaNormalized alpha component
Returns
orxCOLOR / orxNULL

Definition at line 403 of file orxDisplay.h.

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

Sets RGB components

Parameters
[in]_pstColorConcerned color
[in]_pvRGBRGB components
Returns
orxCOLOR

Definition at line 383 of file orxDisplay.h.

static orxINLINE orxCOLOR* orxColor_SetRGBA ( orxCOLOR _pstColor,
orxRGBA  _stRGBA 
)
static

Sets all components from an orxRGBA

Parameters
[in]_pstColorConcerned color
[in]_stRGBARGBA values to set
Returns
orxCOLOR

Definition at line 338 of file orxDisplay.h.

static orxINLINE orxRGBA orxColor_ToRGBA ( const orxCOLOR _pstColor)
static

Gets orxRGBA from an orxCOLOR

Parameters
[in]_pstColorConcerned color
Returns
orxRGBA

Definition at line 421 of file orxDisplay.h.

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_ClearBitmap ( orxBITMAP _pstBitmap,
orxRGBA  _stColor 
)

Clears a bitmap

Parameters
[in]_pstBitmapConcerned bitmap, if orxNULL all the current destination bitmaps will be cleared instead
[in]_stColorColor to clear the bitmap with
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxBITMAP* orxFASTCALL orxDisplay_CreateBitmap ( orxU32  _u32Width,
orxU32  _u32Height 
)

Creates a bitmap

Parameters
[in]_u32WidthBitmap width
[in]_u32HeightBitmap height
Returns
orxBITMAP / orxNULL
orxDLLAPI orxHANDLE orxFASTCALL orxDisplay_CreateShader ( const orxSTRING *  _azCodeList,
orxU32  _u32Size,
const orxLINKLIST _pstParamList,
orxBOOL  _bUseCustomParam 
)

Creates (compiles) a shader

Parameters
[in]_azCodeListList of shader code to compile, in order
[in]_u32SizeSize of the shader code list
[in]_pstParamListShader parameters (should be a link list of orxSHADER_PARAM)
[in]_bUseCustomParamShader uses custom parameters
Returns
orxHANDLE of the compiled shader is successful, orxHANDLE_UNDEFINED otherwise
orxDLLAPI void orxFASTCALL orxDisplay_DeleteBitmap ( orxBITMAP _pstBitmap)

Deletes a bitmap

Parameters
[in]_pstBitmapConcerned bitmap
orxDLLAPI void orxFASTCALL orxDisplay_DeleteShader ( orxHANDLE  _hShader)

Deletes a compiled shader

Parameters
[in]_hShaderShader to delete
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawCircle ( const orxVECTOR _pvCenter,
orxFLOAT  _fRadius,
orxRGBA  _stColor,
orxBOOL  _bFill 
)

Draws a circle

Parameters
[in]_pvCenterCenter
[in]_fRadiusRadius
[in]_stColorColor
[in]_bFillIf true, the polygon will be filled otherwise only its outline will be drawn
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawLine ( const orxVECTOR _pvStart,
const orxVECTOR _pvEnd,
orxRGBA  _stColor 
)

Draws a line

Parameters
[in]_pvStartStart point
[in]_pvEndEnd point
[in]_stColorColor
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawMesh ( const orxBITMAP _pstBitmap,
orxDISPLAY_SMOOTHING  _eSmoothing,
orxDISPLAY_BLEND_MODE  _eBlendMode,
orxU32  _u32VertexNumber,
const orxDISPLAY_VERTEX _astVertexList 
)

Draws a textured mesh

Parameters
[in]_pstBitmapBitmap to use for texturing, orxNULL to use the current one
[in]_eSmoothingBitmap smoothing type
[in]_eBlendModeBlend mode
[in]_u32VertexNumberNumber of vertices in the mesh
[in]_astVertexListList of vertices (XY coordinates are in pixels and UV ones are normalized)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawOBox ( const orxOBOX _pstBox,
orxRGBA  _stColor,
orxBOOL  _bFill 
)

Draws an oriented box

Parameters
[in]_pstBoxBox to draw
[in]_stColorColor
[in]_bFillIf true, the polygon will be filled otherwise only its outline will be drawn
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawPolygon ( const orxVECTOR _avVertexList,
orxU32  _u32VertexNumber,
orxRGBA  _stColor,
orxBOOL  _bFill 
)

Draws a (closed) polygon; filled polygons need to be either convex or star-shaped concave with the first vertex part of the polygon's kernel

Parameters
[in]_avVertexListList of vertices
[in]_u32VertexNumberNumber of vertices in the list
[in]_stColorColor
[in]_bFillIf true, the polygon will be filled otherwise only its outline will be drawn
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawPolyline ( const orxVECTOR _avVertexList,
orxU32  _u32VertexNumber,
orxRGBA  _stColor 
)

Draws a polyline (aka open polygon)

Parameters
[in]_avVertexListList of vertices
[in]_u32VertexNumberNumber of vertices in the list
[in]_stColorColor
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_EnableVSync ( orxBOOL  _bEnable)

Enables / disables vertical synchro

Parameters
[in]_bEnableEnable / 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]_pstBitmapConcerned bitmap
Returns
orxRGBA
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_GetBitmapData ( const orxBITMAP _pstBitmap,
orxU8 *  _au8Data,
orxU32  _u32ByteNumber 
)

Gets a bitmap data (RGBA memory format)

Parameters
[in]_pstBitmapConcerned bitmap
[in]_au8DataOutput buffer (4 channels, RGBA)
[in]_u32ByteNumberNumber of bytes of the buffer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxU32 orxFASTCALL orxDisplay_GetBitmapID ( const orxBITMAP _pstBitmap)

Gets a bitmap (internal) ID

Parameters
[in]_pstBitmapConcerned bitmap
Returns
orxU32
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_GetBitmapSize ( const orxBITMAP _pstBitmap,
orxFLOAT *  _pfWidth,
orxFLOAT *  _pfHeight 
)

Gets a bitmap size

Parameters
[in]_pstBitmapConcerned bitmap
[out]_pfWidthBitmap width
[out]_pfHeightBitmap height
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxDisplay_GetBlendModeFromString ( const orxSTRING  _zBlendMode)

Gets blend mode from a string

Parameters
[in]_zBlendModeString to evaluate
Returns
orxDISPLAY_BLEND_MODE
orxDLLAPI orxS32 orxFASTCALL orxDisplay_GetParameterID ( orxHANDLE  _hShader,
const orxSTRING  _zParam,
orxS32  _s32Index,
orxBOOL  _bIsTexture 
)

Gets a shader parameter's ID

Parameters
[in]_hShaderConcerned shader
[in]_zParamParameter name
[in]_s32IndexParameter index, -1 for non-array types
[in]_bIsTextureIs 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]_pfWidthScreen width
[out]_pfHeightScreen height
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI const orxBITMAP* orxFASTCALL orxDisplay_GetTempBitmap ( )

Gets current temp bitmap

Returns
orxBITMAP, if non-null, load operations are currently asynchronous, otherwise they're synchronous
orxDLLAPI orxDISPLAY_VIDEO_MODE* orxFASTCALL orxDisplay_GetVideoMode ( orxU32  _u32Index,
orxDISPLAY_VIDEO_MODE _pstVideoMode 
)

Gets an available video mode

Parameters
[in]_u32IndexVideo mode index, pass _u32Index < orxDisplay_GetVideoModeCounter() for an available listed mode, orxU32_UNDEFINED for the the default (desktop) mode and any other value for current mode
[out]_pstVideoModeStorage 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 orxBOOL orxFASTCALL orxDisplay_HasShaderSupport ( )

Has shader support?

Returns
orxTRUE / orxFALSE
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]_pstVideoModeVideo 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 (an event of ID orxDISPLAY_EVENT_BITMAP_LOAD will be sent upon completion, whether the loading is asynchronous or not)

Parameters
[in]_zFileNameName 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]_pstBitmapConcerned bitmap
[in]_zFileNameName 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]_pstBitmapConcerned bitmap
[in]_u32TLXTop left X coord in pixels
[in]_u32TLYTop left Y coord in pixels
[in]_u32BRXBottom right X coord in pixels
[in]_u32BRYBottom 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]_pstBitmapConcerned bitmap
[in]_stColorColor 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]_pstBitmapConcerned bitmap
[in]_stColorColor to use as transparent one
[in]_bEnableEnable / 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]_pstBitmapConcerned bitmap
[in]_au8DataData (4 channels, RGBA)
[in]_u32ByteNumberNumber of bytes
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetBlendMode ( orxDISPLAY_BLEND_MODE  _eBlendMode)

Sets current blend mode

Parameters
[in]_eBlendModeBlend mode to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetDestinationBitmaps ( orxBITMAP **  _apstBitmapList,
orxU32  _u32Number 
)

Sets destination bitmaps

Parameters
[in]_apstBitmapListDestination bitmap list
[in]_u32NumberNumber of destination bitmaps
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetFullScreen ( orxBOOL  _bFullScreen)

Sets full screen mode

Parameters
[in]_bFullScreenorxTRUE / 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]_hShaderConcerned shader
[in]_s32IDID of parameter to set
[in]_pstValueValue (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]_hShaderConcerned shader
[in]_s32IDID of parameter to set
[in]_fValueValue (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]_hShaderConcerned shader
[in]_s32IDID of parameter to set
[in]_pvValueValue (orxVECTOR) for this parameter
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetTempBitmap ( const orxBITMAP _pstBitmap)

Sets temp bitmap, if a valid temp bitmap is given, load operations will be asynchronous

Parameters
[in]_pstBitmapConcerned bitmap, orxNULL for forcing synchronous load operations
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]_pstVideoModeVideo mode to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_StartShader ( const orxHANDLE  _hShader)

Starts a shader rendering

Parameters
[in]_hShaderShader to start
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_StopShader ( const orxHANDLE  _hShader)

Stops a shader rendering

Parameters
[in]_hShaderShader 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]_pstSrcBitmap to transform and draw
[in]_pstTransformTransformation info (position, scale, rotation, ...)
[in]_eSmoothingBitmap smoothing type
[in]_eBlendModeBlend 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 (onto a bitmap)

Parameters
[in]_zStringString to display
[in]_pstFontFont bitmap
[in]_pstMapCharacter map
[in]_pstTransformTransformation info (position, scale, rotation, ...)
[in]_eSmoothingBitmap smoothing type
[in]_eBlendModeBlend mode
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
static orxINLINE orxRGBA orxRGBA_Set ( orxU8  _u8R,
orxU8  _u8G,
orxU8  _u8B,
orxU8  _u8A 
)
static

Sets all components of an orxRGBA

Parameters
[in]_u8RRed value to set
[in]_u8GGreen value to set
[in]_u8BBlue value to set
[in]_u8AAlpha value to set
Returns
orxRGBA

Definition at line 318 of file orxDisplay.h.


Generated for orx by doxygen 1.5.6