orxRender.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008- Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */


 
 
#ifndef _orxRENDER_H_
#define _orxRENDER_H_
 
 
#include "orxInclude.h"
#include "plugin/orxPluginCore.h"
 
#include "display/orxDisplay.h"
#include "object/orxFrame.h"
#include "object/orxObject.h"
#include "render/orxViewport.h"
 

#define orxRENDER_KZ_CONFIG_SECTION                   "Render"
#define orxRENDER_KZ_CONFIG_SHOW_FPS                  "ShowFPS"
#define orxRENDER_KZ_CONFIG_SHOW_PROFILER             "ShowProfiler"
#define orxRENDER_KZ_CONFIG_MIN_FREQUENCY             "MinFrequency"
#define orxRENDER_KZ_CONFIG_PROFILER_ORIENTATION      "ProfilerOrientation"
#define orxRENDER_KZ_CONFIG_CONSOLE_COLOR             "ConsoleColor"
#define orxRENDER_KZ_CONFIG_CONSOLE_ALPHA             "ConsoleAlpha"
 
#define orxRENDER_KZ_CONFIG_CONSOLE_BACKGROUND_COLOR  "ConsoleBackgroundColor"
#define orxRENDER_KZ_CONFIG_CONSOLE_BACKGROUND_ALPHA  "ConsoleBackgroundAlpha"
#define orxRENDER_KZ_CONFIG_CONSOLE_SEPARATOR_COLOR   "ConsoleSeparatorColor"
#define orxRENDER_KZ_CONFIG_CONSOLE_SEPARATOR_ALPHA   "ConsoleSeparatorAlpha"
#define orxRENDER_KZ_CONFIG_CONSOLE_INPUT_COLOR       "ConsoleInputColor"
#define orxRENDER_KZ_CONFIG_CONSOLE_INPUT_ALPHA       "ConsoleInputAlpha"
#define orxRENDER_KZ_CONFIG_CONSOLE_COMPLETION_COLOR  "ConsoleCompletionColor"
#define orxRENDER_KZ_CONFIG_CONSOLE_COMPLETION_ALPHA  "ConsoleCompletionAlpha"
#define orxRENDER_KZ_CONFIG_CONSOLE_LOG_COLOR         "ConsoleLogColor"
#define orxRENDER_KZ_CONFIG_CONSOLE_LOG_ALPHA         "ConsoleLogAlpha"
#define orxRENDER_KZ_CONFIG_CONSOLE_FONT_SCALE        "ConsoleFontScale"
 

#define orxRENDER_KZ_INPUT_SET                        "orx:input:profiler"
 
#define orxRENDER_KZ_INPUT_PROFILER_TOGGLE_HISTORY    "ToggleHistory"
#define orxRENDER_KZ_INPUT_PROFILER_PAUSE             "Pause"
#define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_FRAME    "PreviousFrame"
#define orxRENDER_KZ_INPUT_PROFILER_NEXT_FRAME        "NextFrame"
#define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_DEPTH    "PreviousDepth"
#define orxRENDER_KZ_INPUT_PROFILER_NEXT_DEPTH        "NextDepth"
#define orxRENDER_KZ_INPUT_PROFILER_PREVIOUS_THREAD   "PreviousThread"
#define orxRENDER_KZ_INPUT_PROFILER_NEXT_THREAD       "NextThread"
 

typedef enum __orxRENDER_EVENT_t
{
  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
 
} orxRENDER_EVENT;

typedef struct __orxRENDER_EVENT_PAYLOAD_t
{
  struct
  {
    orxDISPLAY_TRANSFORM *pstTransform;   
  } stObject;
 
} orxRENDER_EVENT_PAYLOAD;
 
 
/***************************************************************************
 * Functions directly implemented by orx core
 ***************************************************************************/

extern orxDLLAPI void orxFASTCALL             orxRender_Setup();
 
 
/***************************************************************************
 * Functions extended by plugins
 ***************************************************************************/

extern orxDLLAPI orxSTATUS orxFASTCALL        orxRender_Init();

extern orxDLLAPI void orxFASTCALL             orxRender_Exit();

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

extern orxDLLAPI orxVECTOR *orxFASTCALL       orxRender_GetScreenPosition(const orxVECTOR *_pvWorldPosition, const orxVIEWPORT *_pstViewport, orxVECTOR *_pvScreenPosition);
 
#endif /* _orxRENDER_H_ */