nCine::MouseState class

Current state of the mouse.

Derived classes

class AndroidMouseState
Information about Android mouse state.
class GlfwMouseState
Information about GLFW mouse state.
class Qt5MouseState
Information about Qt5 mouse state.
class SdlMouseState
Information about SDL2 mouse state.
class UwpMouseState
Information about UWP mouse state.

Public functions

auto IsButtonDown(MouseButton button) const -> bool pure virtual
Returns true if the specified button is currently down.

Public variables

std::int32_t X
Pointer position on the X axis.
std::int32_t Y
Pointer position on the Y axis.
std::uint32_t WindowId
Window the pointer is over, 0 for the main one.

Protected static variables

static const unsigned int NumButtons

Variable documentation

std::uint32_t nCine::MouseState::WindowId

Window the pointer is over, 0 for the main one.

Over an auxiliary window (see IGfxDevice::CreateAuxiliaryWindow()), the position is still relative to the main window, so it can be outside of it.