Browse Source

Platform: try to clarify what PointerMoveEvent::pointer() is for.

pull/653/head
Vladimír Vondruš 2 years ago
parent
commit
7808658587
  1. 12
      src/Magnum/Platform/AbstractXApplication.h
  2. 12
      src/Magnum/Platform/AndroidApplication.h
  3. 12
      src/Magnum/Platform/EmscriptenApplication.h
  4. 12
      src/Magnum/Platform/GlfwApplication.h
  5. 11
      src/Magnum/Platform/Sdl2Application.h

12
src/Magnum/Platform/AbstractXApplication.h

@ -1410,11 +1410,13 @@ class AbstractXApplication::PointerMoveEvent: public InputEvent {
/**
* @brief Pointer type that was added or removed from the set of pressed pointers
*
* Is non-empty only in case a mouse button was pressed in addition to
* an already pressed button, or if one mouse button from multiple
* pressed buttons was released. If non-empty and @ref pointers() don't
* contain given @ref Pointer value, the button was released, if they
* contain given value, the button was pressed.
* Use @ref pointers() to query the set of pointers pressed in this
* event. This field is is non-empty only in case a mouse button was
* pressed in addition to an already pressed button, or if one mouse
* button from multiple pressed buttons was released. If non-empty and
* @ref pointers() don't contain given @ref Pointer value, the button
* was released, if they contain given value, the button was pressed.
* @see @ref source()
*/
Containers::Optional<Pointer> pointer() const { return _pointer; }

12
src/Magnum/Platform/AndroidApplication.h

@ -1152,11 +1152,13 @@ class AndroidApplication::PointerMoveEvent: public InputEvent {
/**
* @brief Pointer type that was added or removed from the set of pressed pointers
*
* Is non-empty only in case a mouse button was pressed in addition to
* an already pressed button, or if one mouse button from multiple
* pressed buttons was released. If non-empty and @ref pointers() don't
* contain given @ref Pointer value, the button was released, if they
* contain given value, the button was pressed.
* Use @ref pointers() to query the set of pointers pressed in this
* event. This field is is non-empty only in case a mouse button was
* pressed in addition to an already pressed button, or if one mouse
* button from multiple pressed buttons was released. If non-empty and
* @ref pointers() don't contain given @ref Pointer value, the button
* was released, if they contain given value, the button was pressed.
* @see @ref source()
*/
Containers::Optional<Pointer> pointer() const { return _pointer; }

12
src/Magnum/Platform/EmscriptenApplication.h

@ -2250,11 +2250,13 @@ class EmscriptenApplication::PointerMoveEvent: public InputEvent {
/**
* @brief Pointer type that was added or removed from the set of pressed pointers
*
* Is non-empty only in case a mouse button was pressed in addition to
* an already pressed button, or if one mouse button from multiple
* pressed buttons was released. If non-empty and @ref pointers() don't
* contain given @ref Pointer value, the button was released, if they
* contain given value, the button was pressed.
* Use @ref pointers() to query the set of pointers pressed in this
* event. This field is is non-empty only in case a mouse button was
* pressed in addition to an already pressed button, or if one mouse
* button from multiple pressed buttons was released. If non-empty and
* @ref pointers() don't contain given @ref Pointer value, the button
* was released, if they contain given value, the button was pressed.
* @see @ref source()
*/
Containers::Optional<Pointer> pointer() const { return _pointer; }

12
src/Magnum/Platform/GlfwApplication.h

@ -2381,11 +2381,13 @@ class GlfwApplication::PointerMoveEvent: public InputEvent {
/**
* @brief Pointer type that was added or removed from the set of pressed pointers
*
* Is non-empty only in case a mouse button was pressed in addition to
* an already pressed button, or if one mouse button from multiple
* pressed buttons was released. If non-empty and @ref pointers() don't
* contain given @ref Pointer value, the button was released, if they
* contain given value, the button was pressed.
* Use @ref pointers() to query the set of pointers pressed in this
* event. This field is is non-empty only in case a mouse button was
* pressed in addition to an already pressed button, or if one mouse
* button from multiple pressed buttons was released. If non-empty and
* @ref pointers() don't contain given @ref Pointer value, the button
* was released, if they contain given value, the button was pressed.
* @see @ref source()
*/
Containers::Optional<Pointer> pointer() const { return _pointer; }

11
src/Magnum/Platform/Sdl2Application.h

@ -3176,11 +3176,12 @@ class Sdl2Application::PointerMoveEvent: public InputEvent {
/**
* @brief Pointer type that was added or removed from the set of pressed pointers
*
* Is non-empty only in case a mouse button was pressed in addition to
* an already pressed button, or if one mouse button from multiple
* pressed buttons was released. If non-empty and @ref pointers() don't
* contain given @ref Pointer value, the button was released, if they
* contain given value, the button was pressed.
* Use @ref pointers() to query the set of pointers pressed in this
* event. This field is is non-empty only in case a mouse button was
* pressed in addition to an already pressed button, or if one mouse
* button from multiple pressed buttons was released. If non-empty and
* @ref pointers() don't contain given @ref Pointer value, the button
* was released, if they contain given value, the button was pressed.
* @see @ref source()
*/
Containers::Optional<Pointer> pointer() const { return _pointer; }

Loading…
Cancel
Save