Aether
SDL2 based UI Framework for NX
Public Member Functions | List of all members
Aether::InputEvent Class Reference

A class that represents an Aether input event. More...

#include <InputEvent.hpp>

Public Member Functions

 InputEvent (SDL_Event event)
 Construct a new Input Event object from a SDL_Event. More...
 
EventType type ()
 Getter function to get event type. More...
 
Button button ()
 Getter function to get button information for event. More...
 
int id ()
 Getter function to get event id. More...
 
int touchX ()
 Getter function to get the horizontal position for a touch event. More...
 
int touchY ()
 Getter function to get the vertical position for a touch event. More...
 
int touchDX ()
 Getter function to get the change of horizontal position for a touch move event. More...
 
int touchDY ()
 Getter function to get the change of vertical position for a touch move event. More...
 
 ~InputEvent ()
 Destroy the Input Event object.
 

Detailed Description

A class that represents an Aether input event.

This is basic stripped down version of SDL_Event only containing information that will be handled by Aether.

Constructor & Destructor Documentation

◆ InputEvent()

Aether::InputEvent::InputEvent ( SDL_Event  event)

Construct a new Input Event object from a SDL_Event.

Parameters
eventSDL_Event to make InputEvent from

Member Function Documentation

◆ button()

Button Aether::InputEvent::button ( )

Getter function to get button information for event.

Returns
Button button information for event that occured

◆ id()

int Aether::InputEvent::id ( )

Getter function to get event id.

Returns
int event id of event

◆ touchDX()

int Aether::InputEvent::touchDX ( )

Getter function to get the change of horizontal position for a touch move event.

Returns
int change in horizontal position

◆ touchDY()

int Aether::InputEvent::touchDY ( )

Getter function to get the change of vertical position for a touch move event.

Returns
int change in vertical position

◆ touchX()

int Aether::InputEvent::touchX ( )

Getter function to get the horizontal position for a touch event.

Returns
int horizontal position for a touch event

◆ touchY()

int Aether::InputEvent::touchY ( )

Getter function to get the vertical position for a touch event.

Returns
int vertical position for a touch event

◆ type()

EventType Aether::InputEvent::type ( )

Getter function to get event type.

Returns
EventType type for event that occured

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