Gamp Windowing Toolkit

Windowing toolkit functionality. More...

Classes
class	gamp::wt::Capabilities
	Specifies a set of capabilities that a window's rendering context must support, such as color depth per channel. More...
class	gamp::wt::event::InputEvent
class	gamp::wt::event::KeyboardTracker
class	gamp::wt::event::KeyEvent
	More...
class	gamp::wt::event::KeyEventManager
class	gamp::wt::event::KeyListener
	Listener for multiple KeyEvent. More...
class	gamp::wt::event::PointerEvent
	Pointer event of type PointerType. More...
class	gamp::wt::event::PointerEventManager
class	gamp::wt::event::PointerListener
	Listener for PointerEvent. More...
class	gamp::wt::RenderListener
class	gamp::wt::Surface
class	gamp::wt::Window
class	gamp::wt::event::WindowEvent
class	gamp::wt::event::WindowEventManager
class	gamp::wt::event::WindowListener
	Listener for multiple WindowEvent. More...
class	gamp::wt::event::WTEvent

Typedefs
typedef std::unique_ptr< Capabilities >	gamp::wt::CapabilitiesPtr
typedef std::shared_ptr< KeyListener >	gamp::wt::event::KeyListenerRef
typedef std::shared_ptr< PointerListener >	gamp::wt::event::PointerListenerRef
typedef std::shared_ptr< RenderListener >	gamp::wt::RenderListenerRef
typedef std::shared_ptr< Surface >	gamp::wt::SurfaceRef
typedef std::shared_ptr< WindowListener >	gamp::wt::event::WindowListenerRef
typedef std::shared_ptr< Window >	gamp::wt::WindowRef

Enumerations
enum class	gamp::wt::event::InputButton : uint16_t {   gamp::wt::event::InputButton::none = 0 , gamp::wt::event::InputButton::button1 = 1 , gamp::wt::event::InputButton::button2 = 2 , gamp::wt::event::InputButton::button3 = 3 ,   gamp::wt::event::InputButton::button4 = 4 , gamp::wt::event::InputButton::button5 = 5 , gamp::wt::event::InputButton::button6 = 6 , gamp::wt::event::InputButton::button7 = 7 ,   gamp::wt::event::InputButton::button8 = 8 , gamp::wt::event::InputButton::button9 = 9 , gamp::wt::event::InputButton::button10 = 10 , gamp::wt::event::InputButton::button11 = 11 ,   gamp::wt::event::InputButton::button12 = 12 , gamp::wt::event::InputButton::button13 = 13 , gamp::wt::event::InputButton::button14 = 14 , gamp::wt::event::InputButton::button15 = 15 ,   gamp::wt::event::InputButton::button16 = 16 , gamp::wt::event::InputButton::button_count = 16 }
enum class	gamp::wt::event::InputModifier : uint32_t {   gamp::wt::event::InputModifier::none = 0 , gamp::wt::event::InputModifier::lshift = 1U << 0 , gamp::wt::event::InputModifier::rshift = 1U << 1 , gamp::wt::event::InputModifier::lctrl = 1U << 2 ,   gamp::wt::event::InputModifier::rctrl = 1U << 3 , gamp::wt::event::InputModifier::lalt = 1U << 4 , gamp::wt::event::InputModifier::ralt = 1U << 5 , gamp::wt::event::InputModifier::lmeta = 1U << 6 ,   gamp::wt::event::InputModifier::rmeta = 1U << 7 , gamp::wt::event::InputModifier::shift = lshift | rshift , gamp::wt::event::InputModifier::ctrl = lctrl | rctrl , gamp::wt::event::InputModifier::alt = lalt | ralt ,   gamp::wt::event::InputModifier::meta = lmeta | rmeta , gamp::wt::event::InputModifier::modifier = shift | ctrl | alt | meta , gamp::wt::event::InputModifier::button1_bit = 8 , gamp::wt::event::InputModifier::button1 = 1U << button1_bit ,   gamp::wt::event::InputModifier::button2 = 1U << 9 , gamp::wt::event::InputModifier::button3 = 1U << 10 , gamp::wt::event::InputModifier::button4 = 1U << 11 , gamp::wt::event::InputModifier::button5 = 1U << 12 ,   gamp::wt::event::InputModifier::button6 = 1U << 13 , gamp::wt::event::InputModifier::button7 = 1U << 14 , gamp::wt::event::InputModifier::button8 = 1U << 15 , gamp::wt::event::InputModifier::button9 = 1U << 16 ,   gamp::wt::event::InputModifier::button10 = 1U << 17 , gamp::wt::event::InputModifier::button11 = 1U << 18 , gamp::wt::event::InputModifier::button12 = 1U << 19 , gamp::wt::event::InputModifier::button13 = 1U << 20 ,   gamp::wt::event::InputModifier::button14 = 1U << 21 , gamp::wt::event::InputModifier::button15 = 1U << 22 , gamp::wt::event::InputModifier::button16 = 1U << 23 , gamp::wt::event::InputModifier::button_last = button16 ,   gamp::wt::event::InputModifier::button_all = 0xffffU << 8 , gamp::wt::event::InputModifier::repeat = 1U << 29 , gamp::wt::event::InputModifier::confined = 1U << 30 , gamp::wt::event::InputModifier::invisible = 1U << 31 }
enum class	gamp::wt::event::PointerClass : uint16_t { gamp::wt::event::PointerClass::none = 0 , gamp::wt::event::PointerClass::offscreen = 1U << 14 , gamp::wt::event::PointerClass::onscreen = 1U << 15 }
	Class of pointer types. More...
enum class	gamp::wt::event::PointerType : uint16_t {   gamp::wt::event::PointerType::none = 0 , gamp::wt::event::PointerType::mouse = number(PointerClass::offscreen) | 1U << 0 , gamp::wt::event::PointerType::touchpad = number(PointerClass::offscreen) | 1U << 1 , gamp::wt::event::PointerType::touchscreen = number(PointerClass::onscreen) | 1U << 2 ,   gamp::wt::event::PointerType::pen = number(PointerClass::offscreen) | 1U << 3 }
	Type of pointer devices. More...
enum class	gamp::wt::RenderActions : uint16_t { gamp::wt::RenderActions::none = 0 , gamp::wt::RenderActions::init = 1 , gamp::wt::RenderActions::reshape = 2 }
enum class	gamp::wt::event::VKeyCode : uint16_t {   gamp::wt::event::VKeyCode::VK_UNDEFINED = 0 , gamp::wt::event::VKeyCode::none = VK_UNDEFINED , gamp::wt::event::VKeyCode::VK_FREE01 = 0x01u , gamp::wt::event::VKeyCode::VK_HOME = 0x02u ,   gamp::wt::event::VKeyCode::VK_END = 0x03u , gamp::wt::event::VKeyCode::VK_FINAL = 0x04u , gamp::wt::event::VKeyCode::VK_PRINTSCREEN = 0x05u , gamp::wt::event::VKeyCode::VK_FREE06 = 0x06u ,   gamp::wt::event::VKeyCode::VK_FREE07 = 0x07u , gamp::wt::event::VKeyCode::VK_BACK_SPACE = 0x08u , gamp::wt::event::VKeyCode::VK_TAB = 0x09u , gamp::wt::event::VKeyCode::VK_LINEFEED = 0x0Au ,   gamp::wt::event::VKeyCode::VK_PAGE_DOWN = 0x0Bu , gamp::wt::event::VKeyCode::VK_CLEAR = 0x0Cu , gamp::wt::event::VKeyCode::VK_ENTER = 0x0Du , gamp::wt::event::VKeyCode::VK_FREE0E = 0x0Eu ,   gamp::wt::event::VKeyCode::VK_SHIFT = 0x0Fu , gamp::wt::event::VKeyCode::VK_PAGE_UP = 0x10u , gamp::wt::event::VKeyCode::VK_CONTROL = 0x11u , gamp::wt::event::VKeyCode::VK_ALT = 0x12u ,   gamp::wt::event::VKeyCode::VK_FREE13 = 0x13u , gamp::wt::event::VKeyCode::VK_CAPS_LOCK = 0x14u , gamp::wt::event::VKeyCode::VK_FREE15 = 0x15u , gamp::wt::event::VKeyCode::VK_PAUSE = 0x16u ,   gamp::wt::event::VKeyCode::VK_SCROLL_LOCK = 0x17u , gamp::wt::event::VKeyCode::VK_CANCEL = 0x18u , gamp::wt::event::VKeyCode::VK_FREE19 = 0x19u , gamp::wt::event::VKeyCode::VK_INSERT = 0x1Au ,   gamp::wt::event::VKeyCode::VK_ESCAPE = 0x1Bu , gamp::wt::event::VKeyCode::VK_CONVERT = 0x1Cu , gamp::wt::event::VKeyCode::VK_NONCONVERT = 0x1Du , gamp::wt::event::VKeyCode::VK_ACCEPT = 0x1Eu ,   gamp::wt::event::VKeyCode::VK_MODECHANGE = 0x1Fu , gamp::wt::event::VKeyCode::VK_SPACE = 0x20u , gamp::wt::event::VKeyCode::VK_EXCLAMATION_MARK = 0x21u , gamp::wt::event::VKeyCode::VK_QUOTEDBL = 0x22u ,   gamp::wt::event::VKeyCode::VK_NUMBER_SIGN = 0x23u , gamp::wt::event::VKeyCode::VK_DOLLAR = 0x24u , gamp::wt::event::VKeyCode::VK_PERCENT = 0x25u , gamp::wt::event::VKeyCode::VK_AMPERSAND = 0x26u ,   gamp::wt::event::VKeyCode::VK_QUOTE = 0x27u , gamp::wt::event::VKeyCode::VK_LEFT_PARENTHESIS = 0x28u , gamp::wt::event::VKeyCode::VK_RIGHT_PARENTHESIS = 0x29u , gamp::wt::event::VKeyCode::VK_ASTERISK = 0x2Au ,   gamp::wt::event::VKeyCode::VK_PLUS = 0x2Bu , gamp::wt::event::VKeyCode::VK_COMMA = 0x2Cu , gamp::wt::event::VKeyCode::VK_MINUS = 0x2Du , gamp::wt::event::VKeyCode::VK_PERIOD = 0x2Eu ,   gamp::wt::event::VKeyCode::VK_SLASH = 0x2Fu , gamp::wt::event::VKeyCode::VK_0 = 0x30u , gamp::wt::event::VKeyCode::VK_1 = 0x31u , gamp::wt::event::VKeyCode::VK_2 = 0x32u ,   gamp::wt::event::VKeyCode::VK_3 = 0x33u , gamp::wt::event::VKeyCode::VK_4 = 0x34u , gamp::wt::event::VKeyCode::VK_5 = 0x35u , gamp::wt::event::VKeyCode::VK_6 = 0x36u ,   gamp::wt::event::VKeyCode::VK_7 = 0x37u , gamp::wt::event::VKeyCode::VK_8 = 0x38u , gamp::wt::event::VKeyCode::VK_9 = 0x39u , gamp::wt::event::VKeyCode::VK_COLON = 0x3Au ,   gamp::wt::event::VKeyCode::VK_SEMICOLON = 0x3Bu , gamp::wt::event::VKeyCode::VK_LESS = 0x3Cu , gamp::wt::event::VKeyCode::VK_EQUALS = 0x3Du , gamp::wt::event::VKeyCode::VK_GREATER = 0x3Eu ,   gamp::wt::event::VKeyCode::VK_QUESTIONMARK = 0x3Fu , gamp::wt::event::VKeyCode::VK_AT = 0x40u , gamp::wt::event::VKeyCode::VK_A = 0x41u , gamp::wt::event::VKeyCode::VK_B = 0x42u ,   gamp::wt::event::VKeyCode::VK_C = 0x43u , gamp::wt::event::VKeyCode::VK_D = 0x44u , gamp::wt::event::VKeyCode::VK_E = 0x45u , gamp::wt::event::VKeyCode::VK_F = 0x46u ,   gamp::wt::event::VKeyCode::VK_G = 0x47u , gamp::wt::event::VKeyCode::VK_H = 0x48u , gamp::wt::event::VKeyCode::VK_I = 0x49u , gamp::wt::event::VKeyCode::VK_J = 0x4Au ,   gamp::wt::event::VKeyCode::VK_K = 0x4Bu , gamp::wt::event::VKeyCode::VK_L = 0x4Cu , gamp::wt::event::VKeyCode::VK_M = 0x4Du , gamp::wt::event::VKeyCode::VK_N = 0x4Eu ,   gamp::wt::event::VKeyCode::VK_O = 0x4Fu , gamp::wt::event::VKeyCode::VK_P = 0x50u , gamp::wt::event::VKeyCode::VK_Q = 0x51u , gamp::wt::event::VKeyCode::VK_R = 0x52u ,   gamp::wt::event::VKeyCode::VK_S = 0x53u , gamp::wt::event::VKeyCode::VK_T = 0x54u , gamp::wt::event::VKeyCode::VK_U = 0x55u , gamp::wt::event::VKeyCode::VK_V = 0x56u ,   gamp::wt::event::VKeyCode::VK_W = 0x57u , gamp::wt::event::VKeyCode::VK_X = 0x58u , gamp::wt::event::VKeyCode::VK_Y = 0x59u , gamp::wt::event::VKeyCode::VK_Z = 0x5Au ,   gamp::wt::event::VKeyCode::VK_OPEN_BRACKET = 0x5Bu , gamp::wt::event::VKeyCode::VK_BACK_SLASH = 0x5Cu , gamp::wt::event::VKeyCode::VK_CLOSE_BRACKET = 0x5Du , gamp::wt::event::VKeyCode::VK_CIRCUMFLEX = 0x5Eu ,   gamp::wt::event::VKeyCode::VK_UNDERSCORE = 0x5Fu , gamp::wt::event::VKeyCode::VK_BACK_QUOTE = 0x60u , gamp::wt::event::VKeyCode::VK_F1 = ( 0x60U + 1U ) , gamp::wt::event::VKeyCode::VK_F2 = ( 0x60U + 2U ) ,   gamp::wt::event::VKeyCode::VK_F3 = ( 0x60U + 3U ) , gamp::wt::event::VKeyCode::VK_F4 = ( 0x60U + 4U ) , gamp::wt::event::VKeyCode::VK_F5 = ( 0x60U + 5U ) , gamp::wt::event::VKeyCode::VK_F6 = ( 0x60U + 6U ) ,   gamp::wt::event::VKeyCode::VK_F7 = ( 0x60U + 7U ) , gamp::wt::event::VKeyCode::VK_F8 = ( 0x60U + 8U ) , gamp::wt::event::VKeyCode::VK_F9 = ( 0x60U + 9U ) , gamp::wt::event::VKeyCode::VK_F10 = ( 0x60U +10U ) ,   gamp::wt::event::VKeyCode::VK_F11 = ( 0x60U +11U ) , gamp::wt::event::VKeyCode::VK_F12 = ( 0x60U +12U ) , gamp::wt::event::VKeyCode::VK_F13 = ( 0x60U +13U ) , gamp::wt::event::VKeyCode::VK_F14 = ( 0x60U +14U ) ,   gamp::wt::event::VKeyCode::VK_F15 = ( 0x60U +15U ) , gamp::wt::event::VKeyCode::VK_F16 = ( 0x60U +16U ) , gamp::wt::event::VKeyCode::VK_F17 = ( 0x60U +17U ) , gamp::wt::event::VKeyCode::VK_F18 = ( 0x60U +18U ) ,   gamp::wt::event::VKeyCode::VK_F19 = ( 0x60U +19U ) , gamp::wt::event::VKeyCode::VK_F20 = ( 0x60U +20U ) , gamp::wt::event::VKeyCode::VK_F21 = ( 0x60U +21U ) , gamp::wt::event::VKeyCode::VK_F22 = ( 0x60U +22U ) ,   gamp::wt::event::VKeyCode::VK_F23 = ( 0x60U +23U ) , gamp::wt::event::VKeyCode::VK_F24 = ( 0x60U +24U ) , gamp::wt::event::VKeyCode::VK_LEFT_BRACE = 0x7Bu , gamp::wt::event::VKeyCode::VK_PIPE = 0x7Cu ,   gamp::wt::event::VKeyCode::VK_RIGHT_BRACE = 0x7Du , gamp::wt::event::VKeyCode::VK_TILDE = 0x7Eu , gamp::wt::event::VKeyCode::VK_SEPARATOR = 0x7Fu , gamp::wt::event::VKeyCode::VK_NUMPAD0 = 0x80u ,   gamp::wt::event::VKeyCode::VK_NUMPAD1 = 0x81u , gamp::wt::event::VKeyCode::VK_NUMPAD2 = 0x82u , gamp::wt::event::VKeyCode::VK_NUMPAD3 = 0x83u , gamp::wt::event::VKeyCode::VK_NUMPAD4 = 0x84u ,   gamp::wt::event::VKeyCode::VK_NUMPAD5 = 0x85u , gamp::wt::event::VKeyCode::VK_NUMPAD6 = 0x86u , gamp::wt::event::VKeyCode::VK_NUMPAD7 = 0x87u , gamp::wt::event::VKeyCode::VK_NUMPAD8 = 0x88u ,   gamp::wt::event::VKeyCode::VK_NUMPAD9 = 0x89u , gamp::wt::event::VKeyCode::VK_DECIMAL = 0x8Au , gamp::wt::event::VKeyCode::VK_ADD = 0x8Bu , gamp::wt::event::VKeyCode::VK_SUBTRACT = 0x8Cu ,   gamp::wt::event::VKeyCode::VK_MULTIPLY = 0x8Du , gamp::wt::event::VKeyCode::VK_DIVIDE = 0x8Eu , gamp::wt::event::VKeyCode::VK_DELETE = 0x93u , gamp::wt::event::VKeyCode::VK_NUM_LOCK = 0x94u ,   gamp::wt::event::VKeyCode::VK_LEFT = 0x95u , gamp::wt::event::VKeyCode::VK_UP = 0x96u , gamp::wt::event::VKeyCode::VK_RIGHT = 0x97u , gamp::wt::event::VKeyCode::VK_DOWN = 0x98u ,   gamp::wt::event::VKeyCode::VK_CONTEXT_MENU = 0x99u , gamp::wt::event::VKeyCode::VK_WINDOWS = 0x9Au , gamp::wt::event::VKeyCode::VK_META = 0x9Bu , gamp::wt::event::VKeyCode::VK_HELP = 0x9Cu ,   gamp::wt::event::VKeyCode::VK_COMPOSE = 0x9Du , gamp::wt::event::VKeyCode::VK_BEGIN = 0x9Eu , gamp::wt::event::VKeyCode::VK_STOP = 0x9Fu , gamp::wt::event::VKeyCode::VK_INVERTED_EXCLAMATION_MARK = 0xA1u ,   gamp::wt::event::VKeyCode::VK_EURO_SIGN = 0x20ACu , gamp::wt::event::VKeyCode::VK_CUT = 0xF879u , gamp::wt::event::VKeyCode::VK_COPY = 0xF87Au , gamp::wt::event::VKeyCode::VK_PASTE = 0xF87Bu ,   gamp::wt::event::VKeyCode::VK_UNDO = 0xF87Cu , gamp::wt::event::VKeyCode::VK_AGAIN = 0xF87Du , gamp::wt::event::VKeyCode::VK_FIND = 0xF87Eu , gamp::wt::event::VKeyCode::VK_PROPS = 0xF87Fu ,   gamp::wt::event::VKeyCode::VK_INPUT_METHOD_ON_OFF = 0xF890u , gamp::wt::event::VKeyCode::VK_CODE_INPUT = 0xF891u , gamp::wt::event::VKeyCode::VK_ROMAN_CHARACTERS = 0xF892u , gamp::wt::event::VKeyCode::VK_ALL_CANDIDATES = 0xF893u ,   gamp::wt::event::VKeyCode::VK_PREVIOUS_CANDIDATE = 0xF894u , gamp::wt::event::VKeyCode::VK_ALPHANUMERIC = 0xF895u , gamp::wt::event::VKeyCode::VK_KATAKANA = 0xF896u , gamp::wt::event::VKeyCode::VK_HIRAGANA = 0xF897u ,   gamp::wt::event::VKeyCode::VK_FULL_WIDTH = 0xF898u , gamp::wt::event::VKeyCode::VK_HALF_WIDTH = 0xF89Au , gamp::wt::event::VKeyCode::VK_JAPANESE_KATAKANA = 0xF89Bu , gamp::wt::event::VKeyCode::VK_JAPANESE_HIRAGANA = 0xF89Cu ,   gamp::wt::event::VKeyCode::VK_JAPANESE_ROMAN = 0xF89Du , gamp::wt::event::VKeyCode::VK_KANA_LOCK = 0xF89Fu , gamp::wt::event::VKeyCode::VK_KEYBOARD_INVISIBLE = 0xF8FFu }
	Virtual key code following UTF16 specification. More...
enum class	gamp::wt::WindowState : uint16_t { gamp::wt::WindowState::none = 0 , gamp::wt::WindowState::focused = 1 , gamp::wt::WindowState::visible = 2 }

Functions
constexpr PointerClass	gamp::wt::event::getPointerClass (PointerType pt) noexcept
constexpr bool	gamp::wt::event::isModifierKey (VKeyCode vKey)
	Returns true if the given virtualKey represents a modifier key, otherwise false.
bool	gamp::wt::event::isPrintableKey (uint16_t uniChar, bool isKeyChar) noexcept
	Returns true if given uniChar represents a printable character, i.e.
bool	gamp::wt::event::isPrintableKey (VKeyCode vKey, bool isKeyChar) noexcept
	Returns true if given uniCode represents a printable character, i.e.
	gamp::wt::event::JAU_MAKE_BITFIELD_ENUM_STRING (InputModifier, lshift, rshift, lctrl, rctrl, lalt, ralt, lmeta, rmeta, button1, button2, button3, button4, button5, button6, button7, button8, button9, button10, button11, button12, button13, button14, button15, button16, repeat, confined, invisible)
	gamp::wt::JAU_MAKE_BITFIELD_ENUM_STRING (RenderActions, init, reshape)
	gamp::wt::JAU_MAKE_BITFIELD_ENUM_STRING (WindowState, focused, visible)
	gamp::wt::event::JAU_MAKE_ENUM_INFO (InputButton, button1, button2, button3, button4, button5, button6, button7, button8, button9, button10, button11, button12, button13, button14, button15, button16)
	gamp::wt::JAU_MAKE_ENUM_INFO (RenderActions, init, reshape)
	gamp::wt::JAU_MAKE_ENUM_INFO (WindowState, focused, visible)
	gamp::wt::event::JAU_MAKE_ENUM_STRING (InputButton, button1, button2, button3, button4, button5, button6, button7, button8, button9, button10, button11, button12, button13, button14, button15, button16)
	gamp::wt::event::JAU_MAKE_ENUM_STRING (PointerClass, offscreen, onscreen)
	gamp::wt::event::JAU_MAKE_ENUM_STRING (PointerType, mouse, touchpad, touchscreen, pen)
constexpr uint16_t	gamp::wt::event::operator* (const VKeyCode v) noexcept
std::ostream &	gamp::wt::event::operator<< (std::ostream &out, const InputEvent &v)
std::ostream &	gamp::wt::event::operator<< (std::ostream &out, const KeyEvent &v)
std::ostream &	gamp::wt::event::operator<< (std::ostream &out, const WindowEvent &v)
std::ostream &	gamp::wt::event::operator<< (std::ostream &out, const WTEvent &v)
constexpr bool	gamp::wt::event::operator== (const VKeyCode lhs, const VKeyCode rhs) noexcept
constexpr VKeyCode	gamp::wt::event::toVKeyCode (uint16_t keyChar) noexcept

Variables
static constexpr uint16_t	gamp::wt::event::EVENT_KEY_PRESSED = 300
	A key has been pressed, excluding auto-repeat-modifier keys.
static constexpr uint16_t	gamp::wt::event::EVENT_KEY_RELEASED = 301
	A key has been released, excluding auto-repeat-modifier keys.
static constexpr short	gamp::wt::event::EVENT_POINTER_CLICKED = 200
static constexpr short	gamp::wt::event::EVENT_POINTER_DRAGGED = 206
static constexpr short	gamp::wt::event::EVENT_POINTER_ENTERED = 201
	Only generated for PointerType::mouse.
static constexpr short	gamp::wt::event::EVENT_POINTER_EXITED = 202
	Only generated for PointerType::mouse.
static constexpr short	gamp::wt::event::EVENT_POINTER_MOVED = 205
static constexpr short	gamp::wt::event::EVENT_POINTER_PRESSED = 203
static constexpr short	gamp::wt::event::EVENT_POINTER_RELEASED = 204
static constexpr short	gamp::wt::event::EVENT_POINTER_WHEEL = 207
static constexpr uint16_t	gamp::wt::event::EVENT_WINDOW_DESTROY_NOTIFY = 102
static constexpr uint16_t	gamp::wt::event::EVENT_WINDOW_DESTROYED = 105
static constexpr uint16_t	gamp::wt::event::EVENT_WINDOW_FOCUS_CHANGED = 103
static constexpr uint16_t	gamp::wt::event::EVENT_WINDOW_MOVED = 101
static constexpr uint16_t	gamp::wt::event::EVENT_WINDOW_REPAINT = 104
static constexpr uint16_t	gamp::wt::event::EVENT_WINDOW_RESIZED = 100
static constexpr uint16_t	gamp::wt::event::EVENT_WINDOW_VISIBILITY_CHANGED = 106

Detailed Description

Windowing toolkit functionality.

Typedef Documentation

CapabilitiesPtr

typedef std::unique_ptr<Capabilities> gamp::wt::CapabilitiesPtr

Definition at line 27 of file Capabilities.hpp.

KeyListenerRef

typedef std::shared_ptr<KeyListener> gamp::wt::event::KeyListenerRef

Definition at line 909 of file KeyEvent.hpp.

PointerListenerRef

typedef std::shared_ptr<PointerListener> gamp::wt::event::PointerListenerRef

Definition at line 504 of file PointerEvent.hpp.

WindowListenerRef

typedef std::shared_ptr<WindowListener> gamp::wt::event::WindowListenerRef

Definition at line 113 of file WinEvent.hpp.

SurfaceRef

typedef std::shared_ptr< Surface > gamp::wt::SurfaceRef

Definition at line 27 of file RenderContext.hpp.

WindowRef

typedef std::shared_ptr< Window > gamp::wt::WindowRef

Examples

GearsES2.cpp, GearsES2.hpp, GraphShapes01.cpp, Primitives02.cpp, RedSquareES2.cpp, and RedSquareES2.hpp.

Definition at line 36 of file Event.hpp.

RenderListenerRef

typedef std::shared_ptr<RenderListener> gamp::wt::RenderListenerRef

Definition at line 122 of file Window.hpp.

Enumeration Type Documentation

InputButton

enum class gamp::wt::event::InputButton : uint16_t

strong

Enumerator
none
button1
button2
button3
button4
button5
button6
button7
button8
button9
button10
button11
button12
button13
button14
button15
button16
button_count	button property description, no actual bitmask value

Definition at line 103 of file Event.hpp.

InputModifier

enum class gamp::wt::event::InputModifier : uint32_t

strong

Enumerator
none
lshift
rshift
lctrl
rctrl
lalt
ralt
lmeta
rmeta
shift
ctrl
alt
meta
modifier
button1_bit	button property description, no actual bitmask value
button1
button2
button3
button4
button5
button6
button7
button8
button9
button10
button11
button12
button13
button14
button15
button16
button_last	button property description, no actual bitmask value
button_all	mask for all 16 buttons, see InputButton::button_count
repeat	Event is caused by auto-repeat.
confined	Pointer is confined, see Window#confinePointer(boolean).
invisible	Pointer is invisible, see Window#setPointerVisible(boolean).

Definition at line 132 of file Event.hpp.

VKeyCode

enum class gamp::wt::event::VKeyCode : uint16_t

strong

Virtual key code following UTF16 specification.

Enumerator
VK_UNDEFINED	This value, {@value}, is used to indicate that the keyCode is unknown.
none	Alias for VK_UNDEFINED.
VK_FREE01
VK_HOME	Constant for the HOME function key. ASCII: Start Of Text.
VK_END	Constant for the END function key. ASCII: End Of Text.
VK_FINAL	Constant for the END function key. ASCII: End Of Transmission.
VK_PRINTSCREEN	Constant for the PRINT function key. ASCII: Enquiry.
VK_FREE06
VK_FREE07
VK_BACK_SPACE	Constant for the BACK SPACE key "\b"u, matching ASCII. Printable!
VK_TAB	Constant for the HORIZ TAB key "\t"u, matching ASCII. Printable!
VK_LINEFEED	LINE_FEED "\n"u, matching ASCIIu, n/a on keyboard.
VK_PAGE_DOWN	Constant for the PAGE DOWN function key. ASCII: Vertical Tabulation.
VK_CLEAR	Constant for the CLEAR keyu, i.e. FORM FEEDu, matching ASCII.
VK_ENTER	Constant for the ENTER keyu, i.e. CARRIAGE RETURNu, matching ASCII. Printable!
VK_FREE0E
VK_SHIFT	Constant for the SHIFT function key. ASCII: shift-in.
VK_PAGE_UP	Constant for the PAGE UP function key. ASCII: Data Link Escape.
VK_CONTROL	Constant for the CTRL function key. ASCII: device-ctrl-one.
VK_ALT	Constant for the ALT function key. ASCII: device-ctrl-two.
VK_FREE13
VK_CAPS_LOCK	Constant for the CAPS LOCK function key. ASCII: device-ctrl-four.
VK_FREE15
VK_PAUSE	Constant for the PAUSE function key. ASCII: sync-idle.
VK_SCROLL_LOCK	scroll lock key. ASCII: End Of Transmission Block.
VK_CANCEL	Constant for the CANCEL function key. ASCII: Cancel.
VK_FREE19
VK_INSERT	Constant for the INSERT function key. ASCII: Substitute.
VK_ESCAPE	Constant for the ESCAPE function key. ASCII: Escape.
VK_CONVERT	Constant for the Convert function keyu, Japanese "henkan". ASCII: File Separator.
VK_NONCONVERT	Constant for the Don't Convert function keyu, Japanese "muhenkan". ASCII: Group Separator.
VK_ACCEPT	Constant for the Accept or Commit function keyu, Japanese "kakutei". ASCII: Record Separator.
VK_MODECHANGE	Constant for the Mode Change (?). ASCII: Unit Separator.
VK_SPACE	Constant for the SPACE function key. ASCII: SPACE.
VK_EXCLAMATION_MARK	Constant for the "!" key.
VK_QUOTEDBL	Constant for the """ key.
VK_NUMBER_SIGN	Constant for the "#" key.
VK_DOLLAR	Constant for the "$" key.
VK_PERCENT	Constant for the "%" key.
VK_AMPERSAND	Constant for the "&" key.
VK_QUOTE	Constant for the "'" key.
VK_LEFT_PARENTHESIS	Constant for the "(" key.
VK_RIGHT_PARENTHESIS	Constant for the ")" key.
VK_ASTERISK	Constant for the "*" key.
VK_PLUS	Constant for the "+" key.
VK_COMMA	Constant for the comma keyu, "u,".
VK_MINUS	Constant for the minus keyu, "-".
VK_PERIOD	Constant for the period keyu, ".".
VK_SLASH	Constant for the forward slash keyu, "/".
VK_0	VK_0 thru VK_9 are the same as UTF16/ASCII '0' thru '9' [0x30 - 0x39].
VK_1	See VK_0.
VK_2	See VK_0.
VK_3	See VK_0.
VK_4	See VK_0.
VK_5	See VK_0.
VK_6	See VK_0.
VK_7	See VK_0.
VK_8	See VK_0.
VK_9	See VK_0.
VK_COLON	Constant for the ":" key.
VK_SEMICOLON	Constant for the semicolon keyu, "u,".
VK_LESS	Constant for the equals keyu, "<".
VK_EQUALS	Constant for the equals keyu, "=".
VK_GREATER	Constant for the equals keyu, ">".
VK_QUESTIONMARK	Constant for the equals keyu, "?".
VK_AT	Constant for the equals keyu, "@".
VK_A	VK_A thru VK_Z are the same as Capital UTF16/ASCII 'A' thru 'Z' (0x41 - 0x5A)
VK_B	See VK_A.
VK_C	See VK_A.
VK_D	See VK_A.
VK_E	See VK_A.
VK_F	See VK_A.
VK_G	See VK_A.
VK_H	See VK_A.
VK_I	See VK_A.
VK_J	See VK_A.
VK_K	See VK_A.
VK_L	See VK_A.
VK_M	See VK_A.
VK_N	See VK_A.
VK_O	See VK_A.
VK_P	See VK_A.
VK_Q	See VK_A.
VK_R	See VK_A.
VK_S	See VK_A.
VK_T	See VK_A.
VK_U	See VK_A.
VK_V	See VK_A.
VK_W	See VK_A.
VK_X	See VK_A.
VK_Y	See VK_A.
VK_Z	See VK_A.
VK_OPEN_BRACKET	Constant for the open bracket keyu, "[".
VK_BACK_SLASH	Constant for the back slash keyu, "\".
VK_CLOSE_BRACKET	Constant for the close bracket keyu, "]".
VK_CIRCUMFLEX	Constant for the "^" key.
VK_UNDERSCORE	Constant for the "_" key.
VK_BACK_QUOTE	Constant for the "`" key.
VK_F1	Small UTF/ASCII 'a' thru 'z' (0x61 - 0x7a) - Not used for keyCode / keySym. Constant for the Fn function keys. F1..F24u, i.e. Fnu, are mapped from on 0x60+n -> [0x61 .. 0x78]. Warning: The Fn function keys do collide with unicode characters small 'a' thru 'x'! See Unicode Collision for details.
VK_F2	Constant for the F2 function key. See VK_F1.
VK_F3	Constant for the F3 function key. See VK_F1.
VK_F4	Constant for the F4 function key. See VK_F1.
VK_F5	Constant for the F5 function key. See VK_F1.
VK_F6	Constant for the F6 function key. See VK_F1.
VK_F7	Constant for the F7 function key. See VK_F1.
VK_F8	Constant for the F8 function key. See VK_F1.
VK_F9	Constant for the F9 function key. See VK_F1.
VK_F10	Constant for the F11 function key. See VK_F1.
VK_F11	Constant for the F11 function key. See VK_F1.
VK_F12	Constant for the F12 function key. See VK_F1.
VK_F13	Constant for the F13 function key. See VK_F1.
VK_F14	Constant for the F14 function key. See VK_F1.
VK_F15	Constant for the F15 function key. See VK_F1.
VK_F16	Constant for the F16 function key. See VK_F1.
VK_F17	Constant for the F17 function key. See VK_F1.
VK_F18	Constant for the F18 function key. See VK_F1.
VK_F19	Constant for the F19 function key. See VK_F1.
VK_F20	Constant for the F20 function key. See VK_F1.
VK_F21	Constant for the F21 function key. See VK_F1.
VK_F22	Constant for the F22 function key. See VK_F1.
VK_F23	Constant for the F23 function key. See VK_F1.
VK_F24	Constant for the F24 function key. See VK_F1.
VK_LEFT_BRACE	Constant for the "{" key.
VK_PIPE	Constant for the "|" key.
VK_RIGHT_BRACE	Constant for the "}" key.
VK_TILDE	Constant for the "~" keyu, matching ASCII.
VK_SEPARATOR	Numeric keypad decimal separator key. Non printable UTF control.
VK_NUMPAD0	Numeric keypad VK_NUMPAD0 thru VK_NUMPAD9 are mapped to UTF control (0x80 - 0x89). Non printable UTF control.
VK_NUMPAD1	See VK_NUMPAD0.
VK_NUMPAD2	See VK_NUMPAD0.
VK_NUMPAD3	See VK_NUMPAD0.
VK_NUMPAD4	See VK_NUMPAD0.
VK_NUMPAD5	See VK_NUMPAD0.
VK_NUMPAD6	See VK_NUMPAD0.
VK_NUMPAD7	See VK_NUMPAD0.
VK_NUMPAD8	See VK_NUMPAD0.
VK_NUMPAD9	See VK_NUMPAD0.
VK_DECIMAL	Numeric keypad decimal separator key. Non printable UTF control.
VK_ADD	Numeric keypad add key. Non printable UTF control.
VK_SUBTRACT	Numeric keypad subtract key. Non printable UTF control.
VK_MULTIPLY	Numeric keypad multiply key. Non printable UTF control.
VK_DIVIDE	Numeric keypad divide key. Non printable UTF control.
VK_DELETE	Constant for the DEL keyu, matching ASCII. Non printable UTF control.
VK_NUM_LOCK	Numeric keypad num lock key. Non printable UTF control.
VK_LEFT	Constant for the cursor- or numerical-pad left arrow key. Non printable UTF control.
VK_UP	Constant for the cursor- or numerical-pad up arrow key. Non printable UTF control.
VK_RIGHT	Constant for the cursor- or numerical-pad right arrow key. Non printable UTF control.
VK_DOWN	Constant for the cursor- or numerical pad down arrow key. Non printable UTF control.
VK_CONTEXT_MENU	Constant for the Context Menu key. Non printable UTF control.
VK_WINDOWS	Constant for the MS "Windows" function key. It is used for both the left and right version of the key.
VK_META	Constant for the Meta function key.
VK_HELP	Constant for the Help function key.
VK_COMPOSE	Constant for the Compose function key.
VK_BEGIN	Constant for the Begin function key.
VK_STOP	Constant for the Stop function key.
VK_INVERTED_EXCLAMATION_MARK	Constant for the inverted exclamation mark key.
VK_EURO_SIGN	Constant for the Euro currency sign key.
VK_CUT
VK_COPY
VK_PASTE
VK_UNDO
VK_AGAIN
VK_FIND
VK_PROPS
VK_INPUT_METHOD_ON_OFF	Constant for the input method on/off key.
VK_CODE_INPUT	Constant for the Code Input function key.
VK_ROMAN_CHARACTERS	Constant for the Roman Characters function key.
VK_ALL_CANDIDATES	Constant for the All Candidates function key.
VK_PREVIOUS_CANDIDATE	Constant for the Previous Candidate function key.
VK_ALPHANUMERIC	Constant for the Alphanumeric function key.
VK_KATAKANA	Constant for the Katakana function key.
VK_HIRAGANA	Constant for the Hiragana function key.
VK_FULL_WIDTH	Constant for the Full-Width Characters function key.
VK_HALF_WIDTH	Constant for the Half-Width Characters function key.
VK_JAPANESE_KATAKANA	Constant for the Japanese-Katakana function key. This key switches to a Japanese input method and selects its Katakana input mode.
VK_JAPANESE_HIRAGANA	Constant for the Japanese-Hiragana function key. This key switches to a Japanese input method and selects its Hiragana input mode.
VK_JAPANESE_ROMAN	Constant for the Japanese-Roman function key. This key switches to a Japanese input method and selects its Roman-Direct input mode.
VK_KANA_LOCK	Constant for the locking Kana function key. This key locks the keyboard into a Kana layout.
VK_KEYBOARD_INVISIBLE	Constant for Keyboard became invisible, e.g. Android's soft keyboard Back button hit while keyboard is visible.

Examples

GearsES2.cpp.

Definition at line 45 of file KeyEvent.hpp.

PointerClass

enum class gamp::wt::event::PointerClass : uint16_t

strong

Class of pointer types.

Enumerator
none
offscreen	Desktop compatibility profile.
onscreen	Desktop core profile.

Definition at line 53 of file PointerEvent.hpp.

PointerType

enum class gamp::wt::event::PointerType : uint16_t

strong

Type of pointer devices.

Enumerator
none
mouse	Mouse.
touchpad	Touch pad, fingers off screen.
touchscreen	Touch screen, fingers on screen.
pen	Pen usually off-screen.

Definition at line 63 of file PointerEvent.hpp.

RenderActions

enum class gamp::wt::RenderActions : uint16_t

strong

Enumerator
none
init
reshape

Definition at line 43 of file Window.hpp.

WindowState

enum class gamp::wt::WindowState : uint16_t

strong

Enumerator
none
focused
visible

Definition at line 124 of file Window.hpp.

Function Documentation

operator<<() [1/4]

std::ostream & gamp::wt::event::operator<< ( std::ostream & out, const WTEvent & v )

inline

Definition at line 99 of file Event.hpp.

JAU_MAKE_ENUM_INFO() [1/3]

gamp::wt::event::JAU_MAKE_ENUM_INFO	(	InputButton	,
		button1	,
		button2	,
		button3	,
		button4	,
		button5	,
		button6	,
		button7	,
		button8	,
		button9	,
		button10	,
		button11	,
		button12	,
		button13	,
		button14	,
		button15	,
		button16	)

JAU_MAKE_ENUM_STRING() [1/3]

gamp::wt::event::JAU_MAKE_ENUM_STRING	(	InputButton	,
		button1	,
		button2	,
		button3	,
		button4	,
		button5	,
		button6	,
		button7	,
		button8	,
		button9	,
		button10	,
		button11	,
		button12	,
		button13	,
		button14	,
		button15	,
		button16	)

JAU_MAKE_BITFIELD_ENUM_STRING() [1/3]

gamp::wt::event::JAU_MAKE_BITFIELD_ENUM_STRING	(	InputModifier	,
		lshift	,
		rshift	,
		lctrl	,
		rctrl	,
		lalt	,
		ralt	,
		lmeta	,
		rmeta	,
		button1	,
		button2	,
		button3	,
		button4	,
		button5	,
		button6	,
		button7	,
		button8	,
		button9	,
		button10	,
		button11	,
		button12	,
		button13	,
		button14	,
		button15	,
		button16	,
		repeat	,
		confined	,
		invisible	)

operator<<() [2/4]

std::ostream & gamp::wt::event::operator<< ( std::ostream & out, const InputEvent & v )

inline

Definition at line 310 of file Event.hpp.

operator*()

uint16_t gamp::wt::event::operator* ( const VKeyCode v )

constexprnoexcept

Definition at line 609 of file KeyEvent.hpp.

operator==()

bool gamp::wt::event::operator== ( const VKeyCode lhs, const VKeyCode rhs )

constexprnoexcept

Definition at line 611 of file KeyEvent.hpp.

isPrintableKey() [1/2]

bool gamp::wt::event::isPrintableKey ( uint16_t uniChar, bool isKeyChar )

noexcept

Returns true if given uniChar represents a printable character, i.e.

a value other than VKeyCode::VK_UNDEFINED and not a control or non-printable private code.

A printable character is neither a modifier key, nor an action key.

Otherwise returns false.

Distinction of key character and virtual key code is made due to unicode collision.

Parameters

uniChar	the UTF-16 unicode value, which maybe a virtual key code or key character.
isKeyChar	true if uniChar is a key character, otherwise a virtual key code

Definition at line 55 of file gamp_wt.cpp.

Here is the caller graph for this function:

isPrintableKey() [2/2]

bool gamp::wt::event::isPrintableKey ( VKeyCode vKey, bool isKeyChar )

inlinenoexcept

Returns true if given uniCode represents a printable character, i.e.

a value other than VKeyCode::VK_UNDEFINED and not a control or non-printable private code.

A printable character is neither a KeyEvent::isModifierKey(), nor an KeyEvent::isActionKey().

Otherwise returns false.

Parameters

uniChar

the UTF-16 VKeyCode unicode value.

Definition at line 644 of file KeyEvent.hpp.

toVKeyCode()

VKeyCode gamp::wt::event::toVKeyCode ( uint16_t keyChar )

constexprnoexcept

Parameters

keyChar

UTF16 value to map. It is expected that the incoming keyChar value is unshifted and unmodified, however, lower case a-z is mapped to KeyEvent#VK_A - KeyEvent#VK_Z.

Returns

KeyEvent virtual key (VK) value.

Definition at line 651 of file KeyEvent.hpp.

isModifierKey()

bool gamp::wt::event::isModifierKey ( VKeyCode vKey )

constexpr

Returns true if the given virtualKey represents a modifier key, otherwise false.

A modifier key is one of VKeyCode::VK_SHIFT, VKeyCode::VK_CONTROL, VKeyCode::VK_ALT, VKeyCode::VK_META.

Definition at line 664 of file KeyEvent.hpp.

operator<<() [3/4]

std::ostream & gamp::wt::event::operator<< ( std::ostream & out, const KeyEvent & v )

inline

Definition at line 874 of file KeyEvent.hpp.

JAU_MAKE_ENUM_STRING() [2/3]

gamp::wt::event::JAU_MAKE_ENUM_STRING	(	PointerClass	,
		offscreen	,
		onscreen	)

JAU_MAKE_ENUM_STRING() [3/3]

gamp::wt::event::JAU_MAKE_ENUM_STRING	(	PointerType	,
		mouse	,
		touchpad	,
		touchscreen	,
		pen	)

getPointerClass()

PointerClass gamp::wt::event::getPointerClass ( PointerType pt )

constexprnoexcept

Definition at line 76 of file PointerEvent.hpp.

operator<<() [4/4]

std::ostream & gamp::wt::event::operator<< ( std::ostream & out, const WindowEvent & v )

inline

Definition at line 69 of file WinEvent.hpp.

JAU_MAKE_ENUM_INFO() [2/3]

gamp::wt::JAU_MAKE_ENUM_INFO	(	RenderActions	,
		init	,
		reshape	)

JAU_MAKE_BITFIELD_ENUM_STRING() [2/3]

gamp::wt::JAU_MAKE_BITFIELD_ENUM_STRING	(	RenderActions	,
		init	,
		reshape	)

JAU_MAKE_ENUM_INFO() [3/3]

gamp::wt::JAU_MAKE_ENUM_INFO	(	WindowState	,
		focused	,
		visible	)

JAU_MAKE_BITFIELD_ENUM_STRING() [3/3]

gamp::wt::JAU_MAKE_BITFIELD_ENUM_STRING	(	WindowState	,
		focused	,
		visible	)

Variable Documentation

EVENT_WINDOW_RESIZED

uint16_t gamp::wt::event::EVENT_WINDOW_RESIZED = 100

inlinestaticconstexpr

Definition at line 48 of file Event.hpp.

EVENT_WINDOW_MOVED

uint16_t gamp::wt::event::EVENT_WINDOW_MOVED = 101

inlinestaticconstexpr

Definition at line 49 of file Event.hpp.

EVENT_WINDOW_DESTROY_NOTIFY

uint16_t gamp::wt::event::EVENT_WINDOW_DESTROY_NOTIFY = 102

inlinestaticconstexpr

Definition at line 50 of file Event.hpp.

EVENT_WINDOW_FOCUS_CHANGED

uint16_t gamp::wt::event::EVENT_WINDOW_FOCUS_CHANGED = 103

inlinestaticconstexpr

Definition at line 51 of file Event.hpp.

EVENT_WINDOW_REPAINT

uint16_t gamp::wt::event::EVENT_WINDOW_REPAINT = 104

inlinestaticconstexpr

Definition at line 52 of file Event.hpp.

EVENT_WINDOW_DESTROYED

uint16_t gamp::wt::event::EVENT_WINDOW_DESTROYED = 105

inlinestaticconstexpr

Definition at line 53 of file Event.hpp.

EVENT_WINDOW_VISIBILITY_CHANGED

uint16_t gamp::wt::event::EVENT_WINDOW_VISIBILITY_CHANGED = 106

inlinestaticconstexpr

Definition at line 54 of file Event.hpp.

EVENT_KEY_PRESSED

uint16_t gamp::wt::event::EVENT_KEY_PRESSED = 300

inlinestaticconstexpr

A key has been pressed, excluding auto-repeat-modifier keys.

Definition at line 57 of file Event.hpp.

EVENT_KEY_RELEASED

uint16_t gamp::wt::event::EVENT_KEY_RELEASED = 301

inlinestaticconstexpr

A key has been released, excluding auto-repeat-modifier keys.

Definition at line 59 of file Event.hpp.

EVENT_POINTER_CLICKED

short gamp::wt::event::EVENT_POINTER_CLICKED = 200

inlinestaticconstexpr

Definition at line 61 of file Event.hpp.

EVENT_POINTER_ENTERED

short gamp::wt::event::EVENT_POINTER_ENTERED = 201

inlinestaticconstexpr

Only generated for PointerType::mouse.

Definition at line 63 of file Event.hpp.

EVENT_POINTER_EXITED

short gamp::wt::event::EVENT_POINTER_EXITED = 202

inlinestaticconstexpr

Only generated for PointerType::mouse.

Definition at line 65 of file Event.hpp.

EVENT_POINTER_PRESSED

short gamp::wt::event::EVENT_POINTER_PRESSED = 203

inlinestaticconstexpr

Definition at line 66 of file Event.hpp.

EVENT_POINTER_RELEASED

short gamp::wt::event::EVENT_POINTER_RELEASED = 204

inlinestaticconstexpr

Definition at line 67 of file Event.hpp.

EVENT_POINTER_MOVED

short gamp::wt::event::EVENT_POINTER_MOVED = 205

inlinestaticconstexpr

Definition at line 68 of file Event.hpp.

EVENT_POINTER_DRAGGED

short gamp::wt::event::EVENT_POINTER_DRAGGED = 206

inlinestaticconstexpr

Definition at line 69 of file Event.hpp.

EVENT_POINTER_WHEEL

short gamp::wt::event::EVENT_POINTER_WHEEL = 207

inlinestaticconstexpr

Definition at line 70 of file Event.hpp.