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()
|
pure virtual |
Get the number of buttons available in the device.
- Returns
- The number of buttons.
◆ IsButtonPressed()
|
pure virtual |
Check if a specified mouse button is pressed.
A valid mouse button identifier is [0 .. GetNumberOfButtons() - 1].
- Parameters
-
button The mouse button identifier.
- Returns
- true if the button is pressed.
◆ WasButtonPressed()
|
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
-
button The mouse button identifier.
- Returns
- true if the button was pressed in the most recent tick.
◆ WasButtonReleased()
|
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
-
button The 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