Data Structures
struct	orxCHARACTER_GLYPH
struct	orxCHARACTER_MAP
struct	orxCOLOR
struct	orxDISPLAY_EVENT_PAYLOAD
struct	orxDISPLAY_MESH
struct	orxDISPLAY_TRANSFORM
struct	orxDISPLAY_VERTEX
struct	orxDISPLAY_VIDEO_MODE
struct	orxRGBA

Macros
#define	orx2RGBA(R, G, B, A)
#define	orxCOLOR_DENORMALIZER (orx2F(255.0f))
#define	orxCOLOR_KZ_CONFIG_SECTION "Color"
#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_CONTENT_SCALE "ContentScale"
#define	orxDISPLAY_KZ_CONFIG_CURSOR "Cursor"
#define	orxDISPLAY_KZ_CONFIG_DEBUG_OUTPUT "DebugOutput"
#define	orxDISPLAY_KZ_CONFIG_DECORATION "Decoration"
#define	orxDISPLAY_KZ_CONFIG_DEPTH "ScreenDepth"
#define	orxDISPLAY_KZ_CONFIG_DEPTHBUFFER "DepthBuffer"
#define	orxDISPLAY_KZ_CONFIG_DRAW_BUFFER_NUMBER "DrawBufferNumber"
#define	orxDISPLAY_KZ_CONFIG_FRAMEBUFFER_SIZE "FramebufferSize"
#define	orxDISPLAY_KZ_CONFIG_FULLSCREEN "FullScreen"
#define	orxDISPLAY_KZ_CONFIG_HEIGHT "ScreenHeight"
#define	orxDISPLAY_KZ_CONFIG_ICON_LIST "IconList"
#define	orxDISPLAY_KZ_CONFIG_MAX_TEXTURE_SIZE "MaxTextureSize"
#define	orxDISPLAY_KZ_CONFIG_MONITOR "Monitor"
#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_TEXTURE_UNIT_NUMBER "TextureUnitNumber"
#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)
#define	orxRGBA_B(RGBA)
#define	orxRGBA_G(RGBA)
#define	orxRGBA_R(RGBA)

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_ORIENTATION { orxDISPLAY_ORIENTATION_UP = 0 , orxDISPLAY_ORIENTATION_LEFT , orxDISPLAY_ORIENTATION_DOWN , orxDISPLAY_ORIENTATION_RIGHT , orxDISPLAY_ORIENTATION_NUMBER , orxDISPLAY_ORIENTATION_NONE = orxENUM_NONE }
enum	orxDISPLAY_PRIMITIVE { orxDISPLAY_PRIMITIVE_POINTS = 0 , orxDISPLAY_PRIMITIVE_LINES , orxDISPLAY_PRIMITIVE_LINE_LOOP , orxDISPLAY_PRIMITIVE_LINE_STRIP , orxDISPLAY_PRIMITIVE_TRIANGLES , orxDISPLAY_PRIMITIVE_TRIANGLE_STRIP , orxDISPLAY_PRIMITIVE_TRIANGLE_FAN , orxDISPLAY_PRIMITIVE_NUMBER , orxDISPLAY_PRIMITIVE_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_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 orxDISPLAY_MESH _pstMesh, const orxBITMAP _pstBitmap, orxDISPLAY_SMOOTHING _eSmoothing, orxDISPLAY_BLEND_MODE _eBlendMode)
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 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 orxU32 orxFASTCALL	orxDisplay_GetShaderID (const orxHANDLE _hShader)
orxDLLAPI const orxBITMAP *orxFASTCALL	orxDisplay_GetTempBitmap ()
orxDLLAPI orxDISPLAY_VIDEO_MODE *orxFASTCALL	orxDisplay_GetVideoMode (orxU32 _u32Index, orxDISPLAY_VIDEO_MODE *_pstVideoMode)
orxDLLAPI orxU32 orxFASTCALL	orxDisplay_GetVideoModeCount ()
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 orxBITMAP *orxFASTCALL	orxDisplay_LoadFont (const orxSTRING _zFileName, const orxSTRING _zCharacterList, const orxVECTOR _pvCharacterSize, const orxVECTOR _pvCharacterSpacing, const orxVECTOR _pvCharacterPadding, orxBOOL _bSDF, orxFLOAT _afCharacterWidthList)
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_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_SetPartialBitmapData (orxBITMAP _pstBitmap, const orxU8 _au8Data, orxU32 _u32X, orxU32 _u32Y, orxU32 _u32Width, orxU32 _u32Height)
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, orxRGBA _stColor, 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, orxRGBA _stColor, 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

◆ orx2RGBA

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

Value:

orxRGBA_Set((orxU8)(R), (orxU8)(G), (orxU8)(B), (orxU8)(A))

orxRGBA_Set

static orxINLINE orxRGBA orxRGBA_Set(orxU8 _u8R, orxU8 _u8G, orxU8 _u8B, orxU8 _u8A)

Definition orxDisplay.h:375

Definition at line 73 of file orxDisplay.h.

◆ orxCOLOR_DENORMALIZER

#define orxCOLOR_DENORMALIZER (orx2F(255.0f))

Definition at line 80 of file orxDisplay.h.

◆ orxCOLOR_KZ_CONFIG_SECTION

#define orxCOLOR_KZ_CONFIG_SECTION "Color"

Definition at line 252 of file orxDisplay.h.

◆ orxCOLOR_NORMALIZER

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

Definition at line 79 of file orxDisplay.h.

◆ orxDISPLAY_KC_SHADER_EXTENSION_ADD

#define orxDISPLAY_KC_SHADER_EXTENSION_ADD '+'

Shader extension actions

Definition at line 265 of file orxDisplay.h.

◆ orxDISPLAY_KC_SHADER_EXTENSION_REMOVE

#define orxDISPLAY_KC_SHADER_EXTENSION_REMOVE '-'

Definition at line 266 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_ALLOW_RESIZE

#define orxDISPLAY_KZ_CONFIG_ALLOW_RESIZE "AllowResize"

Definition at line 234 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_CONTENT_SCALE

#define orxDISPLAY_KZ_CONFIG_CONTENT_SCALE "ContentScale"

Definition at line 246 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_CURSOR

#define orxDISPLAY_KZ_CONFIG_CURSOR "Cursor"

Definition at line 243 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_DEBUG_OUTPUT

#define orxDISPLAY_KZ_CONFIG_DEBUG_OUTPUT "DebugOutput"

Definition at line 250 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_DECORATION

#define orxDISPLAY_KZ_CONFIG_DECORATION "Decoration"

Definition at line 235 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_DEPTH

#define orxDISPLAY_KZ_CONFIG_DEPTH "ScreenDepth"

Definition at line 230 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_DEPTHBUFFER

#define orxDISPLAY_KZ_CONFIG_DEPTHBUFFER "DepthBuffer"

Definition at line 239 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_DRAW_BUFFER_NUMBER

#define orxDISPLAY_KZ_CONFIG_DRAW_BUFFER_NUMBER "DrawBufferNumber"

Definition at line 248 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_FRAMEBUFFER_SIZE

#define orxDISPLAY_KZ_CONFIG_FRAMEBUFFER_SIZE "FramebufferSize"

Definition at line 245 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_FULLSCREEN

#define orxDISPLAY_KZ_CONFIG_FULLSCREEN "FullScreen"

Definition at line 233 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_HEIGHT

#define orxDISPLAY_KZ_CONFIG_HEIGHT "ScreenHeight"

Definition at line 229 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_ICON_LIST

#define orxDISPLAY_KZ_CONFIG_ICON_LIST "IconList"

Definition at line 244 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_MAX_TEXTURE_SIZE

#define orxDISPLAY_KZ_CONFIG_MAX_TEXTURE_SIZE "MaxTextureSize"

Definition at line 249 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_MONITOR

#define orxDISPLAY_KZ_CONFIG_MONITOR "Monitor"

Definition at line 242 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_POSITION

#define orxDISPLAY_KZ_CONFIG_POSITION "ScreenPosition"

Definition at line 231 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_REFRESH_RATE

#define orxDISPLAY_KZ_CONFIG_REFRESH_RATE "RefreshRate"

Definition at line 232 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_SECTION

#define orxDISPLAY_KZ_CONFIG_SECTION "Display"

Config parameters

Definition at line 227 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_SHADER_EXTENSION_LIST

#define orxDISPLAY_KZ_CONFIG_SHADER_EXTENSION_LIST "ShaderExtensionList"

Definition at line 241 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_SHADER_VERSION

#define orxDISPLAY_KZ_CONFIG_SHADER_VERSION "ShaderVersion"

Definition at line 240 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_SMOOTH

#define orxDISPLAY_KZ_CONFIG_SMOOTH "Smoothing"

Definition at line 237 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_TEXTURE_UNIT_NUMBER

#define orxDISPLAY_KZ_CONFIG_TEXTURE_UNIT_NUMBER "TextureUnitNumber"

Definition at line 247 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_TITLE

#define orxDISPLAY_KZ_CONFIG_TITLE "Title"

Definition at line 236 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_VSYNC

#define orxDISPLAY_KZ_CONFIG_VSYNC "VSync"

Definition at line 238 of file orxDisplay.h.

◆ orxDISPLAY_KZ_CONFIG_WIDTH

#define orxDISPLAY_KZ_CONFIG_WIDTH "ScreenWidth"

Definition at line 228 of file orxDisplay.h.

◆ orxDISPLAY_KZ_SHADER_SUFFIX_BOTTOM

#define orxDISPLAY_KZ_SHADER_SUFFIX_BOTTOM "_bottom"

Definition at line 259 of file orxDisplay.h.

◆ orxDISPLAY_KZ_SHADER_SUFFIX_LEFT

#define orxDISPLAY_KZ_SHADER_SUFFIX_LEFT "_left"

Definition at line 258 of file orxDisplay.h.

◆ orxDISPLAY_KZ_SHADER_SUFFIX_RIGHT

#define orxDISPLAY_KZ_SHADER_SUFFIX_RIGHT "_right"

Definition at line 260 of file orxDisplay.h.

◆ orxDISPLAY_KZ_SHADER_SUFFIX_TOP

#define orxDISPLAY_KZ_SHADER_SUFFIX_TOP "_top"

Shader texture suffixes

Definition at line 257 of file orxDisplay.h.

◆ orxRGBA_A

#define orxRGBA_A ( RGBA )

Value:

RGBA.u8A

Definition at line 77 of file orxDisplay.h.

◆ orxRGBA_B

#define orxRGBA_B ( RGBA )

Value:

RGBA.u8B

Definition at line 76 of file orxDisplay.h.

◆ orxRGBA_G

#define orxRGBA_G ( RGBA )

Value:

RGBA.u8G

Definition at line 75 of file orxDisplay.h.

◆ orxRGBA_R

#define orxRGBA_R ( RGBA )

Value:

RGBA.u8R

Definition at line 74 of file orxDisplay.h.

Typedef Documentation

◆ orxBITMAP

typedef struct __orxBITMAP_t orxBITMAP

Definition at line 82 of file orxDisplay.h.

Enumeration Type Documentation

◆ orxDISPLAY_BLEND_MODE

enum orxDISPLAY_BLEND_MODE

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 197 of file orxDisplay.h.

◆ orxDISPLAY_EVENT

enum orxDISPLAY_EVENT

Event enum

Enumerator
orxDISPLAY_EVENT_SET_VIDEO_MODE
orxDISPLAY_EVENT_LOAD_BITMAP
orxDISPLAY_EVENT_NUMBER
orxDISPLAY_EVENT_NONE

Definition at line 271 of file orxDisplay.h.

◆ orxDISPLAY_ORIENTATION

enum orxDISPLAY_ORIENTATION

Orientation enum

Enumerator
orxDISPLAY_ORIENTATION_UP
orxDISPLAY_ORIENTATION_LEFT
orxDISPLAY_ORIENTATION_DOWN
orxDISPLAY_ORIENTATION_RIGHT
orxDISPLAY_ORIENTATION_NUMBER
orxDISPLAY_ORIENTATION_NONE

Definition at line 87 of file orxDisplay.h.

◆ orxDISPLAY_PRIMITIVE

enum orxDISPLAY_PRIMITIVE

Primitive enum

Enumerator
orxDISPLAY_PRIMITIVE_POINTS
orxDISPLAY_PRIMITIVE_LINES
orxDISPLAY_PRIMITIVE_LINE_LOOP
orxDISPLAY_PRIMITIVE_LINE_STRIP
orxDISPLAY_PRIMITIVE_TRIANGLES
orxDISPLAY_PRIMITIVE_TRIANGLE_STRIP
orxDISPLAY_PRIMITIVE_TRIANGLE_FAN
orxDISPLAY_PRIMITIVE_NUMBER
orxDISPLAY_PRIMITIVE_NONE

Definition at line 125 of file orxDisplay.h.

◆ orxDISPLAY_SMOOTHING

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 183 of file orxDisplay.h.

Function Documentation

◆ orxColor_Copy()

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 508 of file orxDisplay.h.

◆ orxColor_FromHSLToRGB()

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 603 of file orxDisplay.h.

◆ orxColor_FromHSVToRGB()

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 772 of file orxDisplay.h.

◆ orxColor_FromRGBToHSL()

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 526 of file orxDisplay.h.

◆ orxColor_FromRGBToHSV()

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 697 of file orxDisplay.h.

◆ orxColor_Set()

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 418 of file orxDisplay.h.

◆ orxColor_SetAlpha()

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 460 of file orxDisplay.h.

◆ orxColor_SetRGB()

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 440 of file orxDisplay.h.

◆ orxColor_SetRGBA()

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 395 of file orxDisplay.h.

◆ orxColor_ToRGBA()

orxINLINE orxRGBA orxColor_ToRGBA ( const orxCOLOR * _pstColor )

static

Gets orxRGBA from an orxCOLOR

Parameters

[in] _pstColor Concerned color

Returns: orxRGBA

Definition at line 478 of file orxDisplay.h.

◆ orxDisplay_ClearBitmap()

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

extern

Clears a bitmap

Parameters

[in]	_pstBitmap	Concerned bitmap, if orxNULL all the current destination bitmaps will be cleared instead
[in]	_stColor	Color to clear the bitmap with

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_CreateBitmap()

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

extern

Creates a bitmap

Parameters

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

Returns: orxBITMAP / orxNULL

◆ orxDisplay_CreateShader()

orxDLLAPI orxHANDLE orxFASTCALL orxDisplay_CreateShader	(	const orxSTRING *	_azCodeList,
		orxU32	_u32Size,
		const orxLINKLIST *	_pstParamList,
		orxBOOL	_bUseCustomParam )

extern

Creates (compiles) a shader

Parameters

[in]	_azCodeList	List of shader code to compile, in order
[in]	_u32Size	Size of the shader code list
[in]	_pstParamList	Shader parameters (should be a link list of orxSHADER_PARAM)
[in]	_bUseCustomParam	Shader uses custom parameters

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

◆ orxDisplay_DeleteBitmap()

orxDLLAPI void orxFASTCALL orxDisplay_DeleteBitmap ( orxBITMAP * _pstBitmap )

extern

Deletes a bitmap

Parameters

[in] _pstBitmap Concerned bitmap

◆ orxDisplay_DeleteShader()

orxDLLAPI void orxFASTCALL orxDisplay_DeleteShader ( orxHANDLE _hShader )

extern

Deletes a compiled shader

Parameters

[in] _hShader Shader to delete

◆ orxDisplay_DrawCircle()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawCircle	(	const orxVECTOR *	_pvCenter,
		orxFLOAT	_fRadius,
		orxRGBA	_stColor,
		orxBOOL	_bFill )

extern

Draws a circle

Parameters

[in]	_pvCenter	Center
[in]	_fRadius	Radius
[in]	_stColor	Color
[in]	_bFill	If true, the polygon will be filled otherwise only its outline will be drawn

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_DrawLine()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawLine	(	const orxVECTOR *	_pvStart,
		const orxVECTOR *	_pvEnd,
		orxRGBA	_stColor )

extern

Draws a line

Parameters

[in]	_pvStart	Start point
[in]	_pvEnd	End point
[in]	_stColor	Color

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_DrawMesh()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawMesh	(	const orxDISPLAY_MESH *	_pstMesh,
		const orxBITMAP *	_pstBitmap,
		orxDISPLAY_SMOOTHING	_eSmoothing,
		orxDISPLAY_BLEND_MODE	_eBlendMode )

extern

Draws a textured mesh

Parameters

[in]	_pstMesh	Mesh to draw, if no primitive and no index buffer is given, separate quads arrangement will be assumed
[in]	_pstBitmap	Bitmap to use for texturing, orxNULL to use the current one
[in]	_eSmoothing	Bitmap smoothing type
[in]	_eBlendMode	Blend mode

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_DrawOBox()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawOBox	(	const orxOBOX *	_pstBox,
		orxRGBA	_stColor,
		orxBOOL	_bFill )

extern

Draws an oriented box

Parameters

[in]	_pstBox	Box to draw
[in]	_stColor	Color
[in]	_bFill	If true, the polygon will be filled otherwise only its outline will be drawn

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_DrawPolygon()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawPolygon	(	const orxVECTOR *	_avVertexList,
		orxU32	_u32VertexNumber,
		orxRGBA	_stColor,
		orxBOOL	_bFill )

extern

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]	_avVertexList	List of vertices
[in]	_u32VertexNumber	Number of vertices in the list
[in]	_stColor	Color
[in]	_bFill	If true, the polygon will be filled otherwise only its outline will be drawn

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_DrawPolyline()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_DrawPolyline	(	const orxVECTOR *	_avVertexList,
		orxU32	_u32VertexNumber,
		orxRGBA	_stColor )

extern

Draws a polyline (aka open polygon)

Parameters

[in]	_avVertexList	List of vertices
[in]	_u32VertexNumber	Number of vertices in the list
[in]	_stColor	Color

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_EnableVSync()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_EnableVSync ( orxBOOL _bEnable )

extern

Enables / disables vertical synchro

Parameters

[in] _bEnable Enable / disable

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_Exit()

orxDLLAPI void orxFASTCALL orxDisplay_Exit ( )

extern

Exits from the display module

◆ orxDisplay_GetBitmapData()

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

extern

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

◆ orxDisplay_GetBitmapID()

orxDLLAPI orxU32 orxFASTCALL orxDisplay_GetBitmapID ( const orxBITMAP * _pstBitmap )

extern

Gets a bitmap (internal) ID

Parameters

[in] _pstBitmap Concerned bitmap

Returns: orxU32

◆ orxDisplay_GetBitmapSize()

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

extern

Gets a bitmap size

Parameters

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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_GetBlendModeFromString()

orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxDisplay_GetBlendModeFromString ( const orxSTRING _zBlendMode )

extern

Gets blend mode from a string

Parameters

[in] _zBlendMode String to evaluate

Returns: orxDISPLAY_BLEND_MODE

◆ orxDisplay_GetParameterID()

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

extern

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

◆ orxDisplay_GetScreenBitmap()

orxDLLAPI orxBITMAP *orxFASTCALL orxDisplay_GetScreenBitmap ( )

extern

Gets screen bitmap

Returns: orxBITMAP / orxNULL

◆ orxDisplay_GetScreenSize()

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

extern

Gets screen size

Parameters

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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_GetShaderID()

orxDLLAPI orxU32 orxFASTCALL orxDisplay_GetShaderID ( const orxHANDLE _hShader )

extern

Gets a shader (internal) ID

Parameters

[in] _hShader Concerned bitmap

Returns: orxU32

◆ orxDisplay_GetTempBitmap()

orxDLLAPI const orxBITMAP *orxFASTCALL orxDisplay_GetTempBitmap ( )

extern

Gets current temp bitmap

Returns: orxBITMAP, if non-null, load operations are currently asynchronous, otherwise they're synchronous

◆ orxDisplay_GetVideoMode()

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

extern

Gets an available video mode

Parameters

[in]	_u32Index	Video mode index, pass _u32Index < orxDisplay_GetVideoModeCount() for an available listed mode, orxU32_UNDEFINED for the the default (desktop) mode and any other value for current mode
[out]	_pstVideoMode	Storage for the video mode

Returns: orxDISPLAY_VIDEO_MODE / orxNULL if invalid

◆ orxDisplay_GetVideoModeCount()

orxDLLAPI orxU32 orxFASTCALL orxDisplay_GetVideoModeCount ( )

extern

Gets available video mode count

Returns: Available video mode count

◆ orxDisplay_HasShaderSupport()

orxDLLAPI orxBOOL orxFASTCALL orxDisplay_HasShaderSupport ( )

extern

Has shader support?

Returns: orxTRUE / orxFALSE

◆ orxDisplay_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_Init ( )

extern

Inits the display module

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_IsFullScreen()

orxDLLAPI orxBOOL orxFASTCALL orxDisplay_IsFullScreen ( )

extern

Is in full screen mode?

Returns: orxTRUE if full screen, orxFALSE otherwise

◆ orxDisplay_IsVideoModeAvailable()

orxDLLAPI orxBOOL orxFASTCALL orxDisplay_IsVideoModeAvailable ( const orxDISPLAY_VIDEO_MODE * _pstVideoMode )

extern

Is video mode available

Parameters

[in] _pstVideoMode Video mode to test

Returns: orxTRUE is available, orxFALSE otherwise

◆ orxDisplay_IsVSyncEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxDisplay_IsVSyncEnabled ( )

extern

Is vertical synchro enabled?

Returns: orxTRUE if enabled, orxFALSE otherwise

◆ orxDisplay_LoadBitmap()

orxDLLAPI orxBITMAP *orxFASTCALL orxDisplay_LoadBitmap ( const orxSTRING _zFileName )

extern

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] _zFileName Name of the file to load

Returns: orxBITMAP / orxNULL

◆ orxDisplay_LoadFont()

orxDLLAPI orxBITMAP *orxFASTCALL orxDisplay_LoadFont	(	const orxSTRING	_zFileName,
		const orxSTRING	_zCharacterList,
		const orxVECTOR *	_pvCharacterSize,
		const orxVECTOR *	_pvCharacterSpacing,
		const orxVECTOR *	_pvCharacterPadding,
		orxBOOL	_bSDF,
		orxFLOAT *	_afCharacterWidthList )

extern

Loads a font from a TrueType/OpenType file (an event of ID orxDISPLAY_EVENT_BITMAP_LOAD will be sent upon completion, whether the loading is asynchronous or not)

Parameters

[in]	_zFileName	Name of the file to load
[in]	_zCharacterList	Ordered list of characters for which to create glyphs
[in]	_pvCharacterSize	Size of characters, X = 0 for variable width
[in]	_pvCharacterSpacing	Spacing to be kept between glyphs in the font bitmap
[in]	_pvCharacterPadding	Padding added on all sides, inside a glyph
[in]	_bSDF	Will generate a SDF (Signed Distance Field) texture if set to true or a regular texture otherwise
[out]	_afCharacterWidthList	Resulting list of character/glyph widths

Returns: orxBITMAP / orxNULL

◆ orxDisplay_SaveBitmap()

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

extern

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

◆ orxDisplay_SetBitmapClipping()

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

extern

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

Parameters

[in]	_pstBitmap	Concerned bitmap, orxNULL to target the first destination 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

◆ orxDisplay_SetBitmapData()

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

extern

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

◆ orxDisplay_SetBlendMode()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetBlendMode ( orxDISPLAY_BLEND_MODE _eBlendMode )

extern

Sets current blend mode

Parameters

[in] _eBlendMode Blend mode to set

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_SetDestinationBitmaps()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetDestinationBitmaps	(	orxBITMAP **	_apstBitmapList,
		orxU32	_u32Number )

extern

Sets destination bitmaps

Parameters

[in]	_apstBitmapList	Destination bitmap list
[in]	_u32Number	Number of destination bitmaps

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_SetFullScreen()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetFullScreen ( orxBOOL _bFullScreen )

extern

Sets full screen mode

Parameters

[in] _bFullScreen orxTRUE / orxFALSE

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_SetPartialBitmapData()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetPartialBitmapData	(	orxBITMAP *	_pstBitmap,
		const orxU8 *	_au8Data,
		orxU32	_u32X,
		orxU32	_u32Y,
		orxU32	_u32Width,
		orxU32	_u32Height )

extern

Sets a partial (rectangle) bitmap data (RGBA memory format)

Parameters

[in]	_pstBitmap	Concerned bitmap
[in]	_au8Data	Data (4 channels, RGBA)
[in]	_u32X	Origin's X coord of the rectangle area to set
[in]	_u32Y	Origin's Y coord of the rectangle area to set
[in]	_u32Width	Width of the rectangle area to set
[in]	_u32Height	Height of the rectangle area to set

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_SetShaderBitmap()

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

extern

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

◆ orxDisplay_SetShaderFloat()

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

extern

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

◆ orxDisplay_SetShaderVector()

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

extern

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

◆ orxDisplay_SetTempBitmap()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetTempBitmap ( const orxBITMAP * _pstBitmap )

extern

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

Parameters

[in] _pstBitmap Concerned bitmap, orxNULL for forcing synchronous load operations

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_Setup()

orxDLLAPI void orxFASTCALL orxDisplay_Setup ( )

extern

Display module setup

◆ orxDisplay_SetVideoMode()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_SetVideoMode ( const orxDISPLAY_VIDEO_MODE * _pstVideoMode )

extern

Sets a video mode

Parameters

[in] _pstVideoMode Video mode to set, if width, height, depth or refresh rate are 0, the monitor's default values will be used instead

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_StartShader()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_StartShader ( const orxHANDLE _hShader )

extern

Starts a shader rendering

Parameters

[in] _hShader Shader to start

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_StopShader()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_StopShader ( const orxHANDLE _hShader )

extern

Stops a shader rendering

Parameters

[in] _hShader Shader to stop

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_Swap()

orxDLLAPI orxSTATUS orxFASTCALL orxDisplay_Swap ( )

extern

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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_TransformBitmap()

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

extern

Transforms (and blits onto another) a bitmap

Parameters

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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxDisplay_TransformText()

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

extern

Transforms a text (onto a bitmap)

Parameters

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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxRGBA_Set()

orxINLINE orxRGBA orxRGBA_Set	(	orxU8	_u8R,
		orxU8	_u8G,
		orxU8	_u8B,
		orxU8	_u8A )

static

Sets all components of an orxRGBA

Parameters

[in]	_u8R	Red value to set
[in]	_u8G	Green value to set
[in]	_u8B	Blue value to set
[in]	_u8A	Alpha value to set

Returns: orxRGBA

Definition at line 375 of file orxDisplay.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ orx2RGBA

◆ orxCOLOR_DENORMALIZER

◆ orxCOLOR_KZ_CONFIG_SECTION

◆ orxCOLOR_NORMALIZER

◆ orxDISPLAY_KC_SHADER_EXTENSION_ADD

◆ orxDISPLAY_KC_SHADER_EXTENSION_REMOVE

◆ orxDISPLAY_KZ_CONFIG_ALLOW_RESIZE

◆ orxDISPLAY_KZ_CONFIG_CONTENT_SCALE

◆ orxDISPLAY_KZ_CONFIG_CURSOR

◆ orxDISPLAY_KZ_CONFIG_DEBUG_OUTPUT

◆ orxDISPLAY_KZ_CONFIG_DECORATION

◆ orxDISPLAY_KZ_CONFIG_DEPTH

◆ orxDISPLAY_KZ_CONFIG_DEPTHBUFFER

◆ orxDISPLAY_KZ_CONFIG_DRAW_BUFFER_NUMBER

◆ orxDISPLAY_KZ_CONFIG_FRAMEBUFFER_SIZE

◆ orxDISPLAY_KZ_CONFIG_FULLSCREEN

◆ orxDISPLAY_KZ_CONFIG_HEIGHT

◆ orxDISPLAY_KZ_CONFIG_ICON_LIST

◆ orxDISPLAY_KZ_CONFIG_MAX_TEXTURE_SIZE

◆ orxDISPLAY_KZ_CONFIG_MONITOR

◆ orxDISPLAY_KZ_CONFIG_POSITION

◆ orxDISPLAY_KZ_CONFIG_REFRESH_RATE

◆ orxDISPLAY_KZ_CONFIG_SECTION

◆ orxDISPLAY_KZ_CONFIG_SHADER_EXTENSION_LIST

◆ orxDISPLAY_KZ_CONFIG_SHADER_VERSION

◆ orxDISPLAY_KZ_CONFIG_SMOOTH

◆ orxDISPLAY_KZ_CONFIG_TEXTURE_UNIT_NUMBER

◆ orxDISPLAY_KZ_CONFIG_TITLE

◆ orxDISPLAY_KZ_CONFIG_VSYNC

◆ orxDISPLAY_KZ_CONFIG_WIDTH

◆ orxDISPLAY_KZ_SHADER_SUFFIX_BOTTOM

◆ orxDISPLAY_KZ_SHADER_SUFFIX_LEFT

◆ orxDISPLAY_KZ_SHADER_SUFFIX_RIGHT

◆ orxDISPLAY_KZ_SHADER_SUFFIX_TOP

◆ orxRGBA_A

◆ orxRGBA_B

◆ orxRGBA_G

◆ orxRGBA_R

Typedef Documentation

◆ orxBITMAP

Enumeration Type Documentation

◆ orxDISPLAY_BLEND_MODE

◆ orxDISPLAY_EVENT

◆ orxDISPLAY_ORIENTATION

◆ orxDISPLAY_PRIMITIVE

◆ orxDISPLAY_SMOOTHING

Function Documentation

◆ orxColor_Copy()

◆ orxColor_FromHSLToRGB()

◆ orxColor_FromHSVToRGB()

◆ orxColor_FromRGBToHSL()

◆ orxColor_FromRGBToHSV()

◆ orxColor_Set()

◆ orxColor_SetAlpha()

◆ orxColor_SetRGB()

◆ orxColor_SetRGBA()

◆ orxColor_ToRGBA()

◆ orxDisplay_ClearBitmap()

◆ orxDisplay_CreateBitmap()

◆ orxDisplay_CreateShader()

◆ orxDisplay_DeleteBitmap()

◆ orxDisplay_DeleteShader()

◆ orxDisplay_DrawCircle()

◆ orxDisplay_DrawLine()

◆ orxDisplay_DrawMesh()

◆ orxDisplay_DrawOBox()

◆ orxDisplay_DrawPolygon()

◆ orxDisplay_DrawPolyline()

◆ orxDisplay_EnableVSync()

◆ orxDisplay_Exit()

◆ orxDisplay_GetBitmapData()

◆ orxDisplay_GetBitmapID()

◆ orxDisplay_GetBitmapSize()