Mouse Class Reference

Mouse device state. More...

#include <InputDevices.hpp>

Inheritance diagram for Mouse:

Collaboration diagram for Mouse:

Public Member Functions
BRK_API	~Mouse () override=default
const Point2f &	GetPosition () const
const Size2f &	GetDelta () const
const StringName &	GetName () const
InputDeviceState	GetState () const
const std::vector< InputAction > &	GetButtonsStates () const
Public Member Functions inherited from RefCnt
virtual	~RefCnt ()
bool	IsUnique () const
std::int32_t	GetRefs () const
std::int32_t	AddRef () const
std::int32_t	RelRef () const

Static Public Attributes
static const uint32	MAX_BUTTONS = 2

Protected Attributes
StringName	mName
Point2f	mPosition {}
Size2f	mDelta {}
InputDeviceState	mState
std::vector< InputAction >	mButtons

Additional Inherited Members
Protected Member Functions inherited from RefCnt
virtual void	Destroy () const

Detailed Description

Mouse device state.

Constructor & Destructor Documentation

~Mouse()

BRK_API Mouse::~Mouse ( )

overridedefault

Member Function Documentation

GetButtonsStates()

const std::vector<InputAction>& Mouse::GetButtonsStates ( ) const

inline

Returns

Current states of device buttons

GetDelta()

const Size2f& Mouse::GetDelta ( ) const

inline

Returns

Mouse prev-frame delta

GetName()

const StringName& Mouse::GetName ( ) const

inline

Returns

Name of this device

GetPosition()

const Point2f& Mouse::GetPosition ( ) const

inline

Returns

Mouse position

GetState()

InputDeviceState Mouse::GetState ( ) const

inline

Returns

Current device state

Member Data Documentation

MAX_BUTTONS

const uint32 Mouse::MAX_BUTTONS = 2

static

mButtons

std::vector<InputAction> Mouse::mButtons

protected

mDelta

Size2f Mouse::mDelta {}

protected

mName

StringName Mouse::mName

protected

mPosition

Point2f Mouse::mPosition {}

protected

mState

InputDeviceState Mouse::mState

protected

---

The documentation for this class was generated from the following file:

• code/runtime/platform/InputDevices.hpp