OrxRender

Data Structures
struct	orxRENDER_EVENT_PAYLOAD

Macros
#define	orxRENDER_KZ_CONFIG_CONSOLE_ALPHA   "ConsoleAlpha"
#define	orxRENDER_KZ_CONFIG_CONSOLE_BACKGROUND_ALPHA   "ConsoleBackgroundAlpha"
#define	orxRENDER_KZ_CONFIG_CONSOLE_BACKGROUND_COLOR   "ConsoleBackgroundColor"
#define	orxRENDER_KZ_CONFIG_CONSOLE_COLOR   "ConsoleColor"
#define	orxRENDER_KZ_CONFIG_CONSOLE_COMPLETION_ALPHA   "ConsoleCompletionAlpha"
#define	orxRENDER_KZ_CONFIG_CONSOLE_COMPLETION_COLOR   "ConsoleCompletionColor"
#define	orxRENDER_KZ_CONFIG_CONSOLE_FONT_SCALE   "ConsoleFontScale"
#define	orxRENDER_KZ_CONFIG_CONSOLE_INPUT_ALPHA   "ConsoleInputAlpha"
#define	orxRENDER_KZ_CONFIG_CONSOLE_INPUT_COLOR   "ConsoleInputColor"
#define	orxRENDER_KZ_CONFIG_CONSOLE_LOG_ALPHA   "ConsoleLogAlpha"
#define	orxRENDER_KZ_CONFIG_CONSOLE_LOG_COLOR   "ConsoleLogColor"
#define	orxRENDER_KZ_CONFIG_CONSOLE_SEPARATOR_ALPHA   "ConsoleSeparatorAlpha"
#define	orxRENDER_KZ_CONFIG_CONSOLE_SEPARATOR_COLOR   "ConsoleSeparatorColor"
#define	orxRENDER_KZ_CONFIG_MIN_FREQUENCY   "MinFrequency"
#define	orxRENDER_KZ_CONFIG_PROFILER_ORIENTATION   "ProfilerOrientation"
#define	orxRENDER_KZ_CONFIG_SECTION   "Render"
#define	orxRENDER_KZ_CONFIG_SHOW_FPS   "ShowFPS"
#define	orxRENDER_KZ_CONFIG_SHOW_PROFILER   "ShowProfiler"
#define	orxRENDER_KZ_INPUT_PROFILER_NEXT_DEPTH   "ProfilerNextDepth"
#define	orxRENDER_KZ_INPUT_PROFILER_NEXT_FRAME   "ProfilerNextFrame"
#define	orxRENDER_KZ_INPUT_PROFILER_NEXT_THREAD   "ProfilerNextThread"
#define	orxRENDER_KZ_INPUT_PROFILER_PAUSE   "ProfilerPause"
#define	orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_DEPTH   "ProfilerPreviousDepth"
#define	orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_FRAME   "ProfilerPreviousFrame"
#define	orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_THREAD   "ProfilerPreviousThread"
#define	orxRENDER_KZ_INPUT_PROFILER_TOGGLE_HISTORY   "ProfilerToggleHistory"
#define	orxRENDER_KZ_INPUT_SET   "-=RenderSet=-"

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_CONSOLE_START, orxRENDER_EVENT_CONSOLE_STOP,   orxRENDER_EVENT_PROFILER_START, orxRENDER_EVENT_PROFILER_STOP, orxRENDER_EVENT_NUMBER, orxRENDER_EVENT_NONE = orxENUM_NONE }

Functions
orxDLLAPI void orxFASTCALL	orxRender_Exit ()
orxDLLAPI orxVECTOR *orxFASTCALL	orxRender_GetScreenPosition (const orxVECTOR *_pvWorldPosition, const orxVIEWPORT *_pstViewport, orxVECTOR *_pvScreenPosition)
orxDLLAPI orxVECTOR *orxFASTCALL	orxRender_GetWorldPosition (const orxVECTOR *_pvScreenPosition, const orxVIEWPORT *_pstViewport, 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.

Macro Definition Documentation

#define orxRENDER_KZ_CONFIG_CONSOLE_ALPHA   "ConsoleAlpha"

Definition at line 64 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_BACKGROUND_ALPHA   "ConsoleBackgroundAlpha"

Definition at line 67 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_BACKGROUND_COLOR   "ConsoleBackgroundColor"

Definition at line 66 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_COLOR   "ConsoleColor"

Definition at line 63 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_COMPLETION_ALPHA   "ConsoleCompletionAlpha"

Definition at line 73 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_COMPLETION_COLOR   "ConsoleCompletionColor"

Definition at line 72 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_FONT_SCALE   "ConsoleFontScale"

Definition at line 76 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_INPUT_ALPHA   "ConsoleInputAlpha"

Definition at line 71 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_INPUT_COLOR   "ConsoleInputColor"

Definition at line 70 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_LOG_ALPHA   "ConsoleLogAlpha"

Definition at line 75 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_LOG_COLOR   "ConsoleLogColor"

Definition at line 74 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_SEPARATOR_ALPHA   "ConsoleSeparatorAlpha"

Definition at line 69 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_CONSOLE_SEPARATOR_COLOR   "ConsoleSeparatorColor"

Definition at line 68 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_MIN_FREQUENCY   "MinFrequency"

Definition at line 61 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_PROFILER_ORIENTATION   "ProfilerOrientation"

Definition at line 62 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_SECTION   "Render"

Misc defines

Definition at line 58 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_SHOW_FPS   "ShowFPS"

Definition at line 59 of file orxRender.h.

#define orxRENDER_KZ_CONFIG_SHOW_PROFILER   "ShowProfiler"

Definition at line 60 of file orxRender.h.

#define orxRENDER_KZ_INPUT_PROFILER_NEXT_DEPTH   "ProfilerNextDepth"

Definition at line 88 of file orxRender.h.

#define orxRENDER_KZ_INPUT_PROFILER_NEXT_FRAME   "ProfilerNextFrame"

Definition at line 86 of file orxRender.h.

#define orxRENDER_KZ_INPUT_PROFILER_NEXT_THREAD   "ProfilerNextThread"

Definition at line 90 of file orxRender.h.

#define orxRENDER_KZ_INPUT_PROFILER_PAUSE   "ProfilerPause"

Definition at line 84 of file orxRender.h.

#define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_DEPTH   "ProfilerPreviousDepth"

Definition at line 87 of file orxRender.h.

#define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_FRAME   "ProfilerPreviousFrame"

Definition at line 85 of file orxRender.h.

#define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_THREAD   "ProfilerPreviousThread"

Definition at line 89 of file orxRender.h.

#define orxRENDER_KZ_INPUT_PROFILER_TOGGLE_HISTORY   "ProfilerToggleHistory"

Definition at line 83 of file orxRender.h.

#define orxRENDER_KZ_INPUT_SET   "-=RenderSet=-"

Inputs

Definition at line 81 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_CONSOLE_START	Event sent when console rendering starts
orxRENDER_EVENT_CONSOLE_STOP	Event sent when console rendering stops
orxRENDER_EVENT_PROFILER_START	Event sent when profiler rendering starts
orxRENDER_EVENT_PROFILER_STOP	Event sent when profiler rendering stops
orxRENDER_EVENT_NUMBER
orxRENDER_EVENT_NONE

Definition at line 95 of file orxRender.h.

Function Documentation

orxDLLAPI void orxFASTCALL orxRender_Exit

(

)

Exits from the render module

orxDLLAPI orxVECTOR* orxFASTCALL orxRender_GetScreenPosition	(	const orxVECTOR *	_pvWorldPosition,
		const orxVIEWPORT *	_pstViewport,
		orxVECTOR *	_pvScreenPosition
	)

Get a screen position given a world one and a viewport (rendering position)

Parameters

[in]	_pvWorldPosition	Concerned world position
[in]	_pstViewport	Concerned viewport, if orxNULL then the last viewport with a camera will be used
[out]	_pvScreenPosition	Corresponding screen position

Returns

orxVECTOR if found (can be off-screen), orxNULL otherwise

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

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

Parameters

[in]	_pvScreenPosition	Concerned screen position
[in]	_pstViewport	Concerned viewport, if orxNULL then either the last viewport that contains the position (if any), or the last viewport with a camera in the list if none contains the position
[out]	_pvWorldPosition	Corresponding world position

Returns

orxVECTOR if found inside the display surface, orxNULL otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxRender_Init

(

)

Inits the render module

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxRender_Setup

(

)

Render module setup