Orx

Macros
#define	__orxEXTERN__   /* Not compiling orx library */
#define	__orxPLUGIN__
#define	_orx_H_

Functions
static orxSTATUS orxFASTCALL	orx_DefaultEventHandler (const orxEVENT *_pstEvent)
static orxINLINE void	orx_Execute (orxU32 _u32NbParams, orxSTRING _azParams[], const orxMODULE_INIT_FUNCTION _pfnInit, const orxMODULE_RUN_FUNCTION _pfnRun, const orxMODULE_EXIT_FUNCTION _pfnExit)
static void orxFASTCALL	orx_MainSetup ()

Variables
static orxBOOL	sbStopByEvent = orxFALSE

Detailed Description

Main orx include, execution convenience helpers, freely modifiable by users

Local include file

Kernel include file

Plugin include file

Utils (tools) include file

Macro Definition Documentation

__orxEXTERN__

#define __orxEXTERN__   /* Not compiling orx library */

Definition at line 52 of file orx.h.

__orxPLUGIN__

#define __orxPLUGIN__

Definition at line 46 of file orxPluginAPI.h.

_orx_H_

#define _orx_H_

Definition at line 50 of file orx.h.

Function Documentation

orx_DefaultEventHandler()

orxSTATUS orxFASTCALL orx_DefaultEventHandler ( const orxEVENT * _pstEvent )

static

Orx default basic event handler

Parameters

[in]

_pstEvent

Sent event

Returns

orxSTATUS_SUCCESS if handled / orxSTATUS_FAILURE otherwise

Definition at line 78 of file orx.h.

orx_Execute()

orxINLINE void orx_Execute ( orxU32 _u32NbParams, orxSTRING _azParams[], const orxMODULE_INIT_FUNCTION _pfnInit, const orxMODULE_RUN_FUNCTION _pfnRun, const orxMODULE_EXIT_FUNCTION _pfnExit )

static

Orx main execution function

Parameters

[in]	_u32NbParams	Main function parameters number (argc)
[in]	_azParams	Main function parameter list (argv)
[in]	_pfnInit	Main init function (should init all the main stuff and register the main event handler to override the default one)
[in]	_pfnRun	Main run function (will be called once per frame, should return orxSTATUS_SUCCESS to continue processing)
[in]	_pfnExit	Main exit function (should clean all the main stuff)

Definition at line 366 of file orx.h.

orx_MainSetup()

void orxFASTCALL orx_MainSetup ( )

static

Default main setup (module dependencies)

Definition at line 95 of file orx.h.

Variable Documentation

sbStopByEvent

orxBOOL sbStopByEvent = orxFALSE

static

Should stop execution by default event handling?

Definition at line 67 of file orx.h.