Foray Library
rapid prototyping framework for crossplatform development of vulkan hardware ray tracing applications
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
foray::osi::EventInput Class Reference

Base class for events originating from input devices. More...

#include <foray_event.hpp>

Inheritance diagram for foray::osi::EventInput:
foray::osi::Event foray::Polymorphic foray::osi::EventInputAnalogue foray::osi::EventInputBinary foray::osi::EventInputDeviceAvailability foray::osi::EventInputDirectional foray::osi::EventInputMouseMoved

Public Member Functions

 EventInput ()=default
 
 EventInput (Window *const source, const uint32_t timestamp, const EType type, InputDevice *const device)
 
- Public Member Functions inherited from foray::osi::Event
 Event ()=default
 
 Event (Window *const source, const uint32_t timestamp, const EType type)
 
 Event (Window *const source, const uint32_t timestamp, const int8_t customtype)
 
virtual ~Event ()
 

Public Attributes

InputDeviceSourceDevice = nullptr
 Input Device that the input was read from.
 
- Public Attributes inherited from foray::osi::Event
WindowSource = nullptr
 Source window that recorded the event, if applicable.
 
uint32_t Timestamp = 0
 Timestamp when the action was recorded.
 
EType Type = EType::Undefined
 Event type.
 
int16_t CustomType = 0
 For custom event type overloads, this value may be set.
 
SDL_Event RawSdlEventData = {}
 Raw SDL_Event data this event was derived from.
 

Additional Inherited Members

- Public Types inherited from foray::osi::Event
enum class  EType : int16_t {
  Undefined = -1 , InputAnalogue , InputBinary , InputDirectional ,
  InputMouseMoved , WindowResized , WindowFocusChanged , WindowCloseRequested ,
  WindowItemDropped , InputDeviceAvailability , Custom , ENUM_MAX
}
 Event type enum, allows handling events in switch structures. More...
 
- Protected Member Functions inherited from foray::Polymorphic
virtual void __makeMePolymorphic ()
 

Detailed Description

Base class for events originating from input devices.

Constructor & Destructor Documentation

◆ EventInput() [1/2]

foray::osi::EventInput::EventInput ( )
inlinedefault

◆ EventInput() [2/2]

foray::osi::EventInput::EventInput ( Window *const  source,
const uint32_t  timestamp,
const EType  type,
InputDevice *const  device 
)
inline

Member Data Documentation

◆ SourceDevice

InputDevice* foray::osi::EventInput::SourceDevice = nullptr

Input Device that the input was read from.


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