AzFramework::InputDeviceMouse::Button Struct Reference

#include <InputDeviceMouse.h>

Static Public Attributes
static constexpr InputChannelId	Left {"mouse_button_left"}
	The left mouse button.
static constexpr InputChannelId	Right {"mouse_button_right"}
	The right mouse button.
static constexpr InputChannelId	Middle {"mouse_button_middle"}
	The middle mouse button.
static constexpr InputChannelId	Other1 {"mouse_button_other1"}
	DEPRECATED: the x1 mouse button.
static constexpr InputChannelId	Other2 {"mouse_button_other2"}
	DEPRECATED: the x2 mouse button.
static constexpr AZStd::array	All

Detailed Description

All the input channel ids that identify standard mouse buttons. Though some mice support more than 5 buttons, it would be strange for a game to explicitly map them as this would exclude the majority of players who use a regular 3-button mouse. Developers should most likely expect players to assign additional mouse buttons to keyboard keys using software.

Additionally, macOSX only supports three mouse buttons (left, right, and middle), so any cross-platform game should entirely ignore the 'Other1' and 'Other2' buttons, which have been implemented for windows simply to provide for backwards compatibility with CryInput.

Member Data Documentation

All

constexpr AZStd::array AzFramework::InputDeviceMouse::Button::All

inlinestaticconstexpr

Initial value:

{
                Left,
                Right,
                Middle,
                Other1,
                Other2
            }

Other2

constexpr InputChannelId AzFramework::InputDeviceMouse::Button::Other2 {"mouse_button_other2"}

inlinestaticconstexpr

DEPRECATED: the x2 mouse button.

All mouse button ids

---

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

• Code/Framework/AzFramework/AzFramework/Input/Devices/Mouse/InputDeviceMouse.h