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::EventInputBinary Class Reference

Event type describing a binary input event. More...

#include <foray_event.hpp>

Inheritance diagram for foray::osi::EventInputBinary:
foray::osi::EventInput foray::osi::Event foray::Polymorphic

Public Member Functions

 EventInputBinary ()=default
 
 EventInputBinary (Window *const source, const uint32_t timestamp, InputDevice *device, const InputBinary *button, bool pressed)
 
- Public Member Functions inherited from foray::osi::EventInput
 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

const InputBinarySourceInput = nullptr
 The button that was pressed or released.
 
bool State = 0
 If true, the button was pressed - released otherwise.
 
- Public Attributes inherited from foray::osi::EventInput
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

Event type describing a binary input event.

Constructor & Destructor Documentation

◆ EventInputBinary() [1/2]

foray::osi::EventInputBinary::EventInputBinary ( )
inlinedefault

◆ EventInputBinary() [2/2]

foray::osi::EventInputBinary::EventInputBinary ( Window *const  source,
const uint32_t  timestamp,
InputDevice device,
const InputBinary button,
bool  pressed 
)
inline

Member Data Documentation

◆ SourceInput

const InputBinary* foray::osi::EventInputBinary::SourceInput = nullptr

The button that was pressed or released.

◆ State

bool foray::osi::EventInputBinary::State = 0

If true, the button was pressed - released otherwise.


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