orx  1.11
Portable Game Engine
orxRender.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2020 Orx-Project
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  *
18  * 2. Altered source versions must be plainly marked as such, and must not be
19  * misrepresented as being the original software.
20  *
21  * 3. This notice may not be removed or altered from any source
22  * distribution.
23  */
24 
43 #ifndef _orxRENDER_H_
44 #define _orxRENDER_H_
45 
46 
47 #include "orxInclude.h"
48 #include "plugin/orxPluginCore.h"
49 
50 #include "display/orxDisplay.h"
51 #include "object/orxFrame.h"
52 #include "object/orxObject.h"
53 #include "render/orxViewport.h"
54 
55 
58 #define orxRENDER_KZ_CONFIG_SECTION "Render"
59 #define orxRENDER_KZ_CONFIG_SHOW_FPS "ShowFPS"
60 #define orxRENDER_KZ_CONFIG_SHOW_PROFILER "ShowProfiler"
61 #define orxRENDER_KZ_CONFIG_MIN_FREQUENCY "MinFrequency"
62 #define orxRENDER_KZ_CONFIG_PROFILER_ORIENTATION "ProfilerOrientation"
63 #define orxRENDER_KZ_CONFIG_CONSOLE_COLOR "ConsoleColor"
64 #define orxRENDER_KZ_CONFIG_CONSOLE_ALPHA "ConsoleAlpha"
65 
66 #define orxRENDER_KZ_CONFIG_CONSOLE_BACKGROUND_COLOR "ConsoleBackgroundColor"
67 #define orxRENDER_KZ_CONFIG_CONSOLE_BACKGROUND_ALPHA "ConsoleBackgroundAlpha"
68 #define orxRENDER_KZ_CONFIG_CONSOLE_SEPARATOR_COLOR "ConsoleSeparatorColor"
69 #define orxRENDER_KZ_CONFIG_CONSOLE_SEPARATOR_ALPHA "ConsoleSeparatorAlpha"
70 #define orxRENDER_KZ_CONFIG_CONSOLE_INPUT_COLOR "ConsoleInputColor"
71 #define orxRENDER_KZ_CONFIG_CONSOLE_INPUT_ALPHA "ConsoleInputAlpha"
72 #define orxRENDER_KZ_CONFIG_CONSOLE_COMPLETION_COLOR "ConsoleCompletionColor"
73 #define orxRENDER_KZ_CONFIG_CONSOLE_COMPLETION_ALPHA "ConsoleCompletionAlpha"
74 #define orxRENDER_KZ_CONFIG_CONSOLE_LOG_COLOR "ConsoleLogColor"
75 #define orxRENDER_KZ_CONFIG_CONSOLE_LOG_ALPHA "ConsoleLogAlpha"
76 
77 
80 #define orxRENDER_KZ_INPUT_SET "-=RenderSet=-"
81 
82 #define orxRENDER_KZ_INPUT_PROFILER_TOGGLE_HISTORY "ProfilerToggleHistory"
83 #define orxRENDER_KZ_INPUT_PROFILER_PAUSE "ProfilerPause"
84 #define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_FRAME "ProfilerPreviousFrame"
85 #define orxRENDER_KZ_INPUT_PROFILER_NEXT_FRAME "ProfilerNextFrame"
86 #define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_DEPTH "ProfilerPreviousDepth"
87 #define orxRENDER_KZ_INPUT_PROFILER_NEXT_DEPTH "ProfilerNextDepth"
88 #define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_THREAD "ProfilerPreviousThread"
89 #define orxRENDER_KZ_INPUT_PROFILER_NEXT_THREAD "ProfilerNextThread"
90 
91 
94 typedef enum __orxRENDER_EVENT_t
95 {
108 
109  orxRENDER_EVENT_NONE = orxENUM_NONE
110 
112 
115 typedef struct __orxRENDER_EVENT_PAYLOAD_t
116 {
117  struct
118  {
120  } stObject;
121 
123 
124 
125 /***************************************************************************
126  * Functions directly implemented by orx core
127  ***************************************************************************/
128 
131 extern orxDLLAPI void orxFASTCALL orxRender_Setup();
132 
133 
134 /***************************************************************************
135  * Functions extended by plugins
136  ***************************************************************************/
137 
141 extern orxDLLAPI orxSTATUS orxFASTCALL orxRender_Init();
142 
145 extern orxDLLAPI void orxFASTCALL orxRender_Exit();
146 
153 extern orxDLLAPI orxVECTOR *orxFASTCALL orxRender_GetWorldPosition(const orxVECTOR *_pvScreenPosition, const orxVIEWPORT *_pstViewport, orxVECTOR *_pvWorldPosition);
154 
161 extern orxDLLAPI orxVECTOR *orxFASTCALL orxRender_GetScreenPosition(const orxVECTOR *_pvWorldPosition, const orxVIEWPORT *_pstViewport, orxVECTOR *_pvScreenPosition);
162 
163 #endif /* _orxRENDER_H_ */
164 
orxDLLAPI void orxFASTCALL orxRender_Setup()
orxDLLAPI void orxFASTCALL orxRender_Exit()
orxSTATUS
Definition: orxType.h:246
orxDLLAPI orxSTATUS orxFASTCALL orxRender_Init()
orxRENDER_EVENT
Definition: orxRender.h:94
#define orxDLLAPI
Definition: orxDecl.h:381
orxDLLAPI orxVECTOR *orxFASTCALL orxRender_GetScreenPosition(const orxVECTOR *_pvWorldPosition, const orxVIEWPORT *_pstViewport, orxVECTOR *_pvScreenPosition)
orxDISPLAY_TRANSFORM * pstTransform
Definition: orxRender.h:119
orxDLLAPI orxVECTOR *orxFASTCALL orxRender_GetWorldPosition(const orxVECTOR *_pvScreenPosition, const orxVIEWPORT *_pstViewport, orxVECTOR *_pvWorldPosition)
struct __orxVIEWPORT_t orxVIEWPORT
Definition: orxViewport.h:71

Generated for orx by doxygen 1.8.11