Types.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2015 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_RENDERERAPI_TYPES_H
#define RAMSES_RENDERERAPI_TYPES_H
 
#include <stdint.h>
#include "ramses-framework-api/RamsesFrameworkTypes.h"
 
namespace ramses
{
    enum ESceneResourceStatus
    {
        ESceneResourceStatus_Pending = 0, 
        ESceneResourceStatus_Ready        
    };
 
    struct rendererResourceId_t
    {
        constexpr rendererResourceId_t()
            : lowPart(0)
            , highPart(0)
        {
        }
 
        constexpr rendererResourceId_t(uint64_t low, uint64_t high)
            : lowPart(low)
            , highPart(high)
        {
        }
 
        constexpr bool operator==(const rendererResourceId_t& rhs) const
        {
            return (lowPart == rhs.lowPart && highPart == rhs.highPart);
        }
 
        constexpr bool operator!=(const rendererResourceId_t& rhs) const
        {
            return !(*this == rhs);
        }
 
        uint64_t lowPart;
        uint64_t highPart;
    };
 
    using effectId_t = rendererResourceId_t;
 
    enum ERendererEventResult
    {
        ERendererEventResult_OK = 0,   
        ERendererEventResult_INDIRECT, 
        ERendererEventResult_FAIL      
    };
 
    enum EMouseEvent
    {
        EMouseEvent_Invalid = 0,
 
        EMouseEvent_LeftButtonDown,
        EMouseEvent_LeftButtonUp,
        EMouseEvent_RightButtonDown,
        EMouseEvent_RightButtonUp,
        EMouseEvent_MiddleButtonDown,
        EMouseEvent_MiddleButtonUp,
 
        EMouseEvent_WheelUp,
        EMouseEvent_WheelDown,
 
        EMouseEvent_Move,
 
        EMouseEvent_WindowEnter,
        EMouseEvent_WindowLeave
    };
 
    enum EKeyEvent
    {
        EKeyEvent_Invalid = 0,
 
        EKeyEvent_Pressed,
        EKeyEvent_Released
    };
 
    enum EKeyCode
    {
        EKeyCode_Unknown = 0,
 
        EKeyCode_A,
        EKeyCode_B,
        EKeyCode_C,
        EKeyCode_D,
        EKeyCode_E,
        EKeyCode_F,
        EKeyCode_G,
        EKeyCode_H,
        EKeyCode_I,
        EKeyCode_J,
        EKeyCode_K,
        EKeyCode_L,
        EKeyCode_M,
        EKeyCode_N,
        EKeyCode_O,
        EKeyCode_P,
        EKeyCode_Q,
        EKeyCode_R,
        EKeyCode_S,
        EKeyCode_T,
        EKeyCode_U,
        EKeyCode_V,
        EKeyCode_W,
        EKeyCode_X,
        EKeyCode_Y,
        EKeyCode_Z,
 
        EKeyCode_0,
        EKeyCode_1,
        EKeyCode_2,
        EKeyCode_3,
        EKeyCode_4,
        EKeyCode_5,
        EKeyCode_6,
        EKeyCode_7,
        EKeyCode_8,
        EKeyCode_9,
 
        EKeyCode_NumLock,
        EKeyCode_Numpad_Add,
        EKeyCode_Numpad_Subtract,
        EKeyCode_Numpad_Multiply,
        EKeyCode_Numpad_Divide,
        EKeyCode_Numpad_Enter,
        EKeyCode_Numpad_Decimal,
        EKeyCode_Numpad_0,
        EKeyCode_Numpad_1,
        EKeyCode_Numpad_2,
        EKeyCode_Numpad_3,
        EKeyCode_Numpad_4,
        EKeyCode_Numpad_5,
        EKeyCode_Numpad_6,
        EKeyCode_Numpad_7,
        EKeyCode_Numpad_8,
        EKeyCode_Numpad_9,
 
        EKeyCode_Return,
        EKeyCode_Escape,
        EKeyCode_Backspace,
        EKeyCode_Tab,
        EKeyCode_Space,
        EKeyCode_Menu,
        EKeyCode_CapsLock,
        EKeyCode_ShiftLeft,
        EKeyCode_ShiftRight,
        EKeyCode_AltLeft,
        EKeyCode_AltRight,
        EKeyCode_ControlLeft,
        EKeyCode_ControlRight,
        EKeyCode_WindowsLeft,
        EKeyCode_WindowsRight,
 
        EKeyCode_F1,
        EKeyCode_F2,
        EKeyCode_F3,
        EKeyCode_F4,
        EKeyCode_F5,
        EKeyCode_F6,
        EKeyCode_F7,
        EKeyCode_F8,
        EKeyCode_F9,
        EKeyCode_F10,
        EKeyCode_F11,
        EKeyCode_F12,
 
        EKeyCode_PrintScreen,
        EKeyCode_ScrollLock,
        EKeyCode_Pause,
 
        EKeyCode_Insert,
        EKeyCode_Home,
        EKeyCode_PageUp,
        EKeyCode_Delete,
        EKeyCode_End,
        EKeyCode_PageDown,
 
        EKeyCode_Right,
        EKeyCode_Left,
        EKeyCode_Up,
        EKeyCode_Down,
 
        EKeyCode_Minus,
        EKeyCode_Equals,
        EKeyCode_LeftBracket,
        EKeyCode_RightBracket,
        EKeyCode_Backslash,
        EKeyCode_Semicolon,
        EKeyCode_Comma,
        EKeyCode_Period,
        EKeyCode_Slash,
        EKeyCode_Apostrophe,
        EKeyCode_Grave,
        EKeyCode_NumberSign
    };
 
    enum EKeyModifier
    {
        EKeyModifier_NoModifier = 0,
        EKeyModifier_Ctrl = 1 << 0,
        EKeyModifier_Shift = 1 << 1,
        EKeyModifier_Alt = 1 << 2,
        EKeyModifier_Function = 1 << 3,
        EKeyModifier_Numpad = 1 << 4
    };
 
    enum ELoopMode
    {
        ELoopMode_UpdateAndRender = 0,  
        ELoopMode_UpdateOnly            
    };
 
    enum EDepthBufferType
    {
        EDepthBufferType_None = 0,
        EDepthBufferType_Depth,
        EDepthBufferType_DepthStencil
    };
}
 
#endif