#include <Joystick.h>

Inheritance diagram for PLInput::Joystick:

[legend]

Public Member Functions
PLINPUT_API	Joystick (const PLCore::String &sName, DeviceImpl *pImpl)
	Constructor.
virtual PLINPUT_API	~Joystick ()
	Destructor.
PLINPUT_API int	GetThreshold () const
	Get threshold.
PLINPUT_API void	SetThreshold (int nThreshold=12000)
	Set threshold.
virtual PLINPUT_API void	Update () override
	Update device once per frame.
virtual PLINPUT_API void	UpdateOutputControl (Control *pControl) override
	Update output controls (LEDs, effects etc.)

Detailed Description

Joystick input device.

Remarks:

This class supports the following device backend types:

Constructor & Destructor Documentation

PLINPUT_API PLInput::Joystick::Joystick	(	const PLCore::String &	sName,
		DeviceImpl *	pImpl
	)

Constructor.

Parameters:

[in]	sName	Device name
[in]	pImpl	System specific device implementation, can, but shouldn't be a null pointer

virtual PLINPUT_API PLInput::Joystick::~Joystick ( ) [virtual]

Destructor.

PLINPUT_API int PLInput::Joystick::GetThreshold ( ) const

Get threshold.

PLINPUT_API void PLInput::Joystick::SetThreshold ( int nThreshold = 12000 )

Set threshold.

Parameters:

[in] nThreshold Threshold

virtual PLINPUT_API void PLInput::Joystick::Update ( ) [override, virtual]

Update device once per frame.

Remarks:: This function can be used e.g. to reset any data of a device once per frame. Usually this is not needed, but some devices (e.g. RawInput mice etc.) need to reset their data once per frame.

Note:

Reimplemented from PLInput::Controller.

virtual PLINPUT_API void PLInput::Joystick::UpdateOutputControl ( Control * pControl ) [override, virtual]

Update output controls (LEDs, effects etc.)

Parameters:

[in] pControl Output control that has been changed, must be valid!

Remarks:: This function is called whenever an output control such as LED or Effect has been changed. A device should use this function to update the specific control state on the device (or update all output controls at the same time)

Note:

Reimplemented from PLInput::Controller.

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