Foray Library
rapid prototyping framework for crossplatform development of vulkan hardware ray tracing applications
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
foray::osi::InputBinary Class Referenceabstract

Represents a single input with a state represented by a boolean value. More...

#include <foray_input.hpp>

Inheritance diagram for foray::osi::InputBinary:
foray::osi::InputBase foray::osi::InputDevice::ButtonJoystick foray::osi::InputDevice::ButtonKeyboard foray::osi::InputDevice::ButtonMouse

Public Member Functions

virtual bool State () const =0
 Button id of the input.
 

Protected Member Functions

 InputBinary ()
 
 InputBinary (InputDevice *device, int32_t id, std::string_view name, EButton button)
 
- Protected Member Functions inherited from foray::osi::InputBase
 InputBase ()=default
 
 InputBase (InputDevice *device, int32_t id, std::string_view name)
 

Protected Attributes

EButton mButtonId = {}
 
- Protected Attributes inherited from foray::osi::InputBase
InputDevicemDevice = {}
 Device providing this input.
 
int32_t mId = {}
 
std::string mName = {}
 

Detailed Description

Represents a single input with a state represented by a boolean value.

Constructor & Destructor Documentation

◆ InputBinary() [1/2]

foray::osi::InputBinary::InputBinary ( )
inlineprotected

◆ InputBinary() [2/2]

foray::osi::InputBinary::InputBinary ( InputDevice device,
int32_t  id,
std::string_view  name,
EButton  button 
)
inlineprotected

Member Function Documentation

◆ State()

virtual bool foray::osi::InputBinary::State ( ) const
pure virtual

Button id of the input.

Fetches the inputs current state

Implemented in foray::osi::InputDevice::ButtonJoystick, foray::osi::InputDevice::ButtonMouse, and foray::osi::InputDevice::ButtonKeyboard.

Member Data Documentation

◆ mButtonId

EButton foray::osi::InputBinary::mButtonId = {}
protected

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