OrxRender

Data Structures
struct	orxRENDER_EVENT_OBJECT_PAYLOAD
Defines
#define	orxRENDER_KZ_CONFIG_MIN_FREQUENCY   "MinFrequency"
#define	orxRENDER_KZ_CONFIG_SECTION   "Render"
#define	orxRENDER_KZ_CONFIG_SHOW_FPS   "ShowFPS"
#define	orxRENDER_KZ_CONFIG_SHOW_PROFILER   "ShowProfiler"
Enumerations
enum	orxRENDER_EVENT {   orxRENDER_EVENT_START = 0, orxRENDER_EVENT_STOP, orxRENDER_EVENT_VIEWPORT_START, orxRENDER_EVENT_VIEWPORT_STOP,   orxRENDER_EVENT_OBJECT_START, orxRENDER_EVENT_OBJECT_STOP, orxRENDER_EVENT_NUMBER, orxRENDER_EVENT_NONE = orxENUM_NONE }
Functions
orxDLLAPI void orxFASTCALL	orxRender_Exit ()
orxDLLAPI orxVECTOR *orxFASTCALL	orxRender_GetWorldPosition (const orxVECTOR *_pvScreenPosition, orxVECTOR *_pvWorldPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxRender_Init ()
orxDLLAPI void orxFASTCALL	orxRender_Setup ()

---

Detailed Description

Render plugin module Renders visible objects on screen, using active cameras/viewports.

---

Define Documentation

#define orxRENDER_KZ_CONFIG_MIN_FREQUENCY   "MinFrequency"

Definition at line 59 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_SECTION   "Render"

Misc defines

Definition at line 56 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_SHOW_FPS   "ShowFPS"

Definition at line 57 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_SHOW_PROFILER   "ShowProfiler"

Definition at line 58 of file orxRender.h.

---

Enumeration Type Documentation

enum orxRENDER_EVENT

Event enum

Enumerator:

orxRENDER_EVENT_START	Event sent when rendering starts
orxRENDER_EVENT_STOP	Event sent when rendering stops
orxRENDER_EVENT_VIEWPORT_START	Event sent when a viewport rendering starts
orxRENDER_EVENT_VIEWPORT_STOP	Event sent when a viewport rendering stops
orxRENDER_EVENT_OBJECT_START	Event sent when an object rendering starts
orxRENDER_EVENT_OBJECT_STOP	Event sent when an object rendering stops
orxRENDER_EVENT_NUMBER
orxRENDER_EVENT_NONE

Definition at line 64 of file orxRender.h.

---

Function Documentation

orxDLLAPI void orxFASTCALL orxRender_Exit

(

)

Exits from the render module

orxDLLAPI orxVECTOR* orxFASTCALL orxRender_GetWorldPosition	(	const orxVECTOR *	_pvScreenPosition,
		orxVECTOR *	_pvWorldPosition
	)

Get a world position given a screen one (absolute picking)

Parameters:

[in]	_pvScreenPosition	Concerned screen position
[out]	_pvWorldPosition	Corresponding world position

Returns:

orxVECTOR if found, orxNULL otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxRender_Init

(

)

Inits the render module

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxRender_Setup

(

)

Render module setup