RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Classes | Namespaces | Typedefs | Enumerations
Types.h File Reference
#include <stdint.h>
#include "ramses-framework-api/RamsesFrameworkTypes.h"

Go to the source code of this file.

Classes

struct  ramses::rendererResourceId_t
 Resource identifier used to refer to a resource on the renderer. More...
 

Namespaces

 ramses
 The RAMSES namespace contains all client side objects and functions used to implement RAMSES applications. RAMSES refers to these applications as clients.
 

Typedefs

using ramses::effectId_t = rendererResourceId_t
 Effect identifier used by the renderer to refer to an effect. More...
 

Enumerations

enum  ramses::ESceneResourceStatus { ramses::ESceneResourceStatus_Pending = 0 , ramses::ESceneResourceStatus_Ready }
 
enum  ramses::ERendererEventResult { ramses::ERendererEventResult_OK = 0 , ramses::ERendererEventResult_INDIRECT , ramses::ERendererEventResult_FAIL }
 Specifies the result of the operation referred to by renderer event. More...
 
enum  ramses::EMouseEvent {
  ramses::EMouseEvent_Invalid = 0 , ramses::EMouseEvent_LeftButtonDown , ramses::EMouseEvent_LeftButtonUp , ramses::EMouseEvent_RightButtonDown ,
  ramses::EMouseEvent_RightButtonUp , ramses::EMouseEvent_MiddleButtonDown , ramses::EMouseEvent_MiddleButtonUp , ramses::EMouseEvent_WheelUp ,
  ramses::EMouseEvent_WheelDown , ramses::EMouseEvent_Move , ramses::EMouseEvent_WindowEnter , ramses::EMouseEvent_WindowLeave
}
 Specifies events for mouse input. More...
 
enum  ramses::EKeyEvent { ramses::EKeyEvent_Invalid = 0 , ramses::EKeyEvent_Pressed , ramses::EKeyEvent_Released }
 Specifies keypress events for keyboard input. More...
 
enum  ramses::EKeyCode {
  ramses::EKeyCode_Unknown = 0 , ramses::EKeyCode_A , ramses::EKeyCode_B , ramses::EKeyCode_C ,
  ramses::EKeyCode_D , ramses::EKeyCode_E , ramses::EKeyCode_F , ramses::EKeyCode_G ,
  ramses::EKeyCode_H , ramses::EKeyCode_I , ramses::EKeyCode_J , ramses::EKeyCode_K ,
  ramses::EKeyCode_L , ramses::EKeyCode_M , ramses::EKeyCode_N , ramses::EKeyCode_O ,
  ramses::EKeyCode_P , ramses::EKeyCode_Q , ramses::EKeyCode_R , ramses::EKeyCode_S ,
  ramses::EKeyCode_T , ramses::EKeyCode_U , ramses::EKeyCode_V , ramses::EKeyCode_W ,
  ramses::EKeyCode_X , ramses::EKeyCode_Y , ramses::EKeyCode_Z , ramses::EKeyCode_0 ,
  ramses::EKeyCode_1 , ramses::EKeyCode_2 , ramses::EKeyCode_3 , ramses::EKeyCode_4 ,
  ramses::EKeyCode_5 , ramses::EKeyCode_6 , ramses::EKeyCode_7 , ramses::EKeyCode_8 ,
  ramses::EKeyCode_9 , ramses::EKeyCode_NumLock , ramses::EKeyCode_Numpad_Add , ramses::EKeyCode_Numpad_Subtract ,
  ramses::EKeyCode_Numpad_Multiply , ramses::EKeyCode_Numpad_Divide , ramses::EKeyCode_Numpad_Enter , ramses::EKeyCode_Numpad_Decimal ,
  ramses::EKeyCode_Numpad_0 , ramses::EKeyCode_Numpad_1 , ramses::EKeyCode_Numpad_2 , ramses::EKeyCode_Numpad_3 ,
  ramses::EKeyCode_Numpad_4 , ramses::EKeyCode_Numpad_5 , ramses::EKeyCode_Numpad_6 , ramses::EKeyCode_Numpad_7 ,
  ramses::EKeyCode_Numpad_8 , ramses::EKeyCode_Numpad_9 , ramses::EKeyCode_Return , ramses::EKeyCode_Escape ,
  ramses::EKeyCode_Backspace , ramses::EKeyCode_Tab , ramses::EKeyCode_Space , ramses::EKeyCode_Menu ,
  ramses::EKeyCode_CapsLock , ramses::EKeyCode_ShiftLeft , ramses::EKeyCode_ShiftRight , ramses::EKeyCode_AltLeft ,
  ramses::EKeyCode_AltRight , ramses::EKeyCode_ControlLeft , ramses::EKeyCode_ControlRight , ramses::EKeyCode_WindowsLeft ,
  ramses::EKeyCode_WindowsRight , ramses::EKeyCode_F1 , ramses::EKeyCode_F2 , ramses::EKeyCode_F3 ,
  ramses::EKeyCode_F4 , ramses::EKeyCode_F5 , ramses::EKeyCode_F6 , ramses::EKeyCode_F7 ,
  ramses::EKeyCode_F8 , ramses::EKeyCode_F9 , ramses::EKeyCode_F10 , ramses::EKeyCode_F11 ,
  ramses::EKeyCode_F12 , ramses::EKeyCode_PrintScreen , ramses::EKeyCode_ScrollLock , ramses::EKeyCode_Pause ,
  ramses::EKeyCode_Insert , ramses::EKeyCode_Home , ramses::EKeyCode_PageUp , ramses::EKeyCode_Delete ,
  ramses::EKeyCode_End , ramses::EKeyCode_PageDown , ramses::EKeyCode_Right , ramses::EKeyCode_Left ,
  ramses::EKeyCode_Up , ramses::EKeyCode_Down , ramses::EKeyCode_Minus , ramses::EKeyCode_Equals ,
  ramses::EKeyCode_LeftBracket , ramses::EKeyCode_RightBracket , ramses::EKeyCode_Backslash , ramses::EKeyCode_Semicolon ,
  ramses::EKeyCode_Comma , ramses::EKeyCode_Period , ramses::EKeyCode_Slash , ramses::EKeyCode_Apostrophe ,
  ramses::EKeyCode_Grave , ramses::EKeyCode_NumberSign
}
 Specifies key codes for keyboard input. More...
 
enum  ramses::EKeyModifier {
  ramses::EKeyModifier_NoModifier = 0 , ramses::EKeyModifier_Ctrl = 1 << 0 , ramses::EKeyModifier_Shift = 1 << 1 , ramses::EKeyModifier_Alt = 1 << 2 ,
  ramses::EKeyModifier_Function = 1 << 3 , ramses::EKeyModifier_Numpad = 1 << 4
}
 Specifies key modifiers for keyboard input. More...
 
enum  ramses::ELoopMode { ramses::ELoopMode_UpdateAndRender = 0 , ramses::ELoopMode_UpdateOnly }
 Specifies behavior of render loop. More...
 
enum  ramses::EDepthBufferType { ramses::EDepthBufferType_None = 0 , ramses::EDepthBufferType_Depth , ramses::EDepthBufferType_DepthStencil }
 Specifies type of depth buffer created within an offscreen buffer. More...