Class JoystickComponent

Inheritance
object
JoystickComponent
Implements
Inherited Members
Namespace: OpenTK.Platform.Native.Windows
Assembly: OpenTK.Platform.dll
Syntax
public class JoystickComponent : IJoystickComponent, IPalComponent

Properties

Logger

The logger that this component uses to log diagnostic messages.

Declaration
public ILogger? Logger { get; set; }
Property Value
Type Description
ILogger
See Also

Name

Name of the abstraction layer component.

Declaration
public string Name { get; }
Property Value
Type Description
string

Provides

Specifies which PAL components this object provides.

Declaration
public PalComponents Provides { get; }
Property Value
Type Description
PalComponents

Methods

Close(JoystickHandle)

Declaration
public void Close(JoystickHandle joystick)
Parameters
Type Name Description
JoystickHandle joystick

GetAxis(JoystickHandle, int)

Declaration
public float GetAxis(JoystickHandle joystick, int axis)
Parameters
Type Name Description
JoystickHandle joystick
int axis
Returns
Type Description
float

GetButton(JoystickHandle, int)

Declaration
public bool GetButton(JoystickHandle joystick, int button)
Parameters
Type Name Description
JoystickHandle joystick
int button
Returns
Type Description
bool

GetCapabilities(JoystickHandle)

Declaration
public JoystickCapabilities GetCapabilities(JoystickHandle joystick)
Parameters
Type Name Description
JoystickHandle joystick
Returns
Type Description
JoystickCapabilities

GetGuid(JoystickHandle)

Declaration
public Guid GetGuid(JoystickHandle joystick)
Parameters
Type Name Description
JoystickHandle joystick
Returns
Type Description
Guid

GetHat(JoystickHandle, int)

Declaration
public HatState GetHat(JoystickHandle joystick, int hat)
Parameters
Type Name Description
JoystickHandle joystick
int hat
Returns
Type Description
HatState

GetJoystickCount()

Declaration
public int GetJoystickCount()
Returns
Type Description
int

GetName(JoystickHandle)

Declaration
public string GetName(JoystickHandle joystick)
Parameters
Type Name Description
JoystickHandle joystick
Returns
Type Description
string

GetNumberOfAxes(JoystickHandle)

Declaration
public int GetNumberOfAxes(JoystickHandle joystick)
Parameters
Type Name Description
JoystickHandle joystick
Returns
Type Description
int

GetNumberOfButtons(JoystickHandle)

Declaration
public int GetNumberOfButtons(JoystickHandle joystick)
Parameters
Type Name Description
JoystickHandle joystick
Returns
Type Description
int

GetNumberOfHats(JoystickHandle)

Declaration
public int GetNumberOfHats(JoystickHandle joystick)
Parameters
Type Name Description
JoystickHandle joystick
Returns
Type Description
int

Initialize(ToolkitOptions)

Initialize the component.

Declaration
public void Initialize(ToolkitOptions options)
Parameters
Type Name Description
ToolkitOptions options

The options to initialize the component with.
See Also

Open(int)

Declaration
public JoystickHandle Open(int index)
Parameters
Type Name Description
int index
Returns
Type Description
JoystickHandle

SetRumble(JoystickHandle, float, float)

Declaration
public bool SetRumble(JoystickHandle joystick, float lowFrequencyIntensity, float highFrequencyIntensity)
Parameters
Type Name Description
JoystickHandle joystick
float lowFrequencyIntensity
float highFrequencyIntensity
Returns
Type Description
bool

TryGetBatteryInfo(JoystickHandle, out GamepadBatteryInfo)

Declaration
public bool TryGetBatteryInfo(JoystickHandle joystick, out GamepadBatteryInfo batteryInfo)
Parameters
Type Name Description
JoystickHandle joystick
GamepadBatteryInfo batteryInfo
Returns
Type Description
bool

Uninitialize()

Uninitialize the component. Frees any native resources used by the component.

Declaration
public void Uninitialize()
See Also

Implements