Murl::Input::IMouseButtons Interface Referenceabstract

The IMouseButtons interface. More...

#include "murl_input_i_mouse_buttons.h"

Inheritance diagram for Murl::Input::IMouseButtons:

Public Member Functions

virtual UInt32 GetNumberOfButtons () const =0
 Get the number of buttons available in the device. More...
 
virtual Bool IsButtonPressed (IEnums::MouseButton button) const =0
 Check if a specified mouse button is pressed. More...
 
virtual Bool WasButtonPressed (IEnums::MouseButton button) const =0
 Check if a specified mouse button was pressed in the most recent tick. More...
 
virtual Bool WasButtonReleased (IEnums::MouseButton button) const =0
 Check if a specified mouse button was released in the most recent tick. More...
 

Detailed Description

The IMouseButtons interface.

The base interface of input device classes implementing mouse buttons.

Member Function Documentation

◆ GetNumberOfButtons()

virtual UInt32 Murl::Input::IMouseButtons::GetNumberOfButtons ( ) const
pure virtual

Get the number of buttons available in the device.

Returns
The number of buttons.

◆ IsButtonPressed()

virtual Bool Murl::Input::IMouseButtons::IsButtonPressed ( IEnums::MouseButton  button) const
pure virtual

Check if a specified mouse button is pressed.

A valid mouse button identifier is [0 .. GetNumberOfButtons() - 1].

Parameters
buttonThe mouse button identifier.
Returns
true if the button is pressed.

◆ WasButtonPressed()

virtual Bool Murl::Input::IMouseButtons::WasButtonPressed ( IEnums::MouseButton  button) const
pure virtual

Check if a specified mouse button was pressed in the most recent tick.

A valid mouse button identifier is [0 .. GetNumberOfButtons() - 1].

Parameters
buttonThe mouse button identifier.
Returns
true if the button was pressed in the most recent tick.

◆ WasButtonReleased()

virtual Bool Murl::Input::IMouseButtons::WasButtonReleased ( IEnums::MouseButton  button) const
pure virtual

Check if a specified mouse button was released in the most recent tick.

A valid mouse button identifier is [0 .. GetNumberOfButtons() - 1].

Parameters
buttonThe mouse button identifier.
Returns
true if the button was released in the most recent tick.

The documentation for this interface was generated from the following file:
  • murl_input_i_mouse_buttons.h


Copyright © 2011-2018 Spraylight GmbH.