Class Hint.Joystick

Namespace

Sdl3Sharp

Assembly

Sdl3Sharp.dll

SDL_HINT_JOYSTICK_*

public static class Hint.Joystick

Inheritance

object

Hint.Joystick

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowBackgroundEvents

Gets a hint that lets you enable joystick (and gamecontroller) events even when your app is in the background

public static Hint AllowBackgroundEvents { get; }

Property Value

Hint

A hint that lets you enable joystick (and gamecontroller) events even when your app is in the background

Remarks

The hint can be set to the following values:

• "0"Disable joystick & gamecontroller input events when the application is in the background (default)
• "1"Enable joystick & gamecontroller input events when the application is in the background

This hint can be set anytime.

See Also

SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS

Device

Gets a hint containing a comma separated list of devices to open as joysticks

public static Hint Device { get; }

Property Value

Hint

A hint containing a comma separated list of devices to open as joysticks

Remarks

This hint is currently only used by the Linux joystick driver

See Also

SDL_HINT_JOYSTICK_DEVICE

DirectInput

Gets a hint controlling whether DirectInput should be used for controllers

public static Hint DirectInput { get; }

Property Value

Hint

A hint controlling whether DirectInput should be used for controllers

Remarks

The hint can be set to the following values:

• "0"Disable DirectInput detection
• "1"Enable DirectInput detection (default)

This hint should be set before SDL is initialized.

See Also

SDL_HINT_JOYSTICK_DIRECTINPUT

EnhancedReports

Gets a hint controlling whether enhanced reports should be used for controllers when using the HIDAPI driver

public static Hint EnhancedReports { get; }

Property Value

Hint

A hint controlling whether enhanced reports should be used for controllers when using the HIDAPI driver

Remarks

Enhanced reports allow rumble and effects on Bluetooth PlayStation controllers and gyro on Nintendo Switch controllers, but break Windows DirectInput for other applications that don't use SDL.

Once enhanced reports are enabled, they can't be disabled on PlayStation controllers without power cycling the controller.

The hint can be set to the following values:

• "0"Enhanced reports are not enabled
• "1"Enhanced reports are enabled (default)
• "auto"Enhanced features are advertised to the application, but SDL doesn't change the controller report mode unless the application uses them

This hint can be set anytime.

See Also

SDL_HINT_JOYSTICK_ENHANCED_REPORTS

GameInput

Gets a hint controlling whether GameInput should be used for controller handling on Windows

public static Hint GameInput { get; }

Property Value

Hint

A hint controlling whether GameInput should be used for controller handling on Windows

Remarks

The hint can be set to the following values:

• "0"GameInput is not used
• "1"GameInput is used

The default is "1" on GDK platforms, and "0" otherwise.

This hint should be set before SDL is initialized.

See Also

SDL_HINT_JOYSTICK_GAMEINPUT

HapticAxes

Gets a hint containing a list of devices and their desired number of haptic (force feedback) enabled axis

public static Hint HapticAxes { get; }

Property Value

Hint

A hint containing a list of devices and their desired number of haptic (force feedback) enabled axis

Remarks

The format of this hint is a comma separated list of USB VID/PID pairs in hexadecimal form plus the number of desired axes, e.g. "0xAAAA/0xBBBB/1,0xCCCC/0xDDDD/3".

This hint supports a "wildcard" device that will set the number of haptic axes on all initialized haptic devices which were not defined explicitly in this hint: "0xFFFF/0xFFFF/1".

This hint should be set before . The number of haptic axes won't exceed the number of real axes found on the device.

See Also

SDL_HINT_JOYSTICK_HAPTIC_AXES

IOKit

Gets a hint controlling whether IOKit should be used for controller handling

public static Hint IOKit { get; }

Property Value

Hint

A hint controlling whether IOKit should be used for controller handling

Remarks

The hint can be set to the following values:

• "0"IOKit is not used
• "1"IOKit is used (default)

This hint should be set before SDL is initialized.

See Also

SDL_HINT_JOYSTICK_IOKIT

Mfi

Gets a hint controlling whether GCController should be used for controller handling

public static Hint Mfi { get; }

Property Value

Hint

A hint controlling whether GCController should be used for controller handling

Remarks

The hint can be set to the following values:

• "0"GCController is not used
• "1"GCController is used (default)

This hint should be set before SDL is initialized.

See Also

SDL_HINT_JOYSTICK_MFI

RogChakram

Gets a hint controlling whether the ROG Chakram mice should show up as joysticks

public static Hint RogChakram { get; }

Property Value

Hint

A hint controlling whether the ROG Chakram mice should show up as joysticks

Remarks

The hint can be set to the following values:

• "0"ROG Chakram mice do not show up as joysticks (default)
• "1"ROG Chakram mice show up as joysticks

This hint should be set before SDL is initialized.

See Also

SDL_HINT_JOYSTICK_ROG_CHAKRAM

Thread

Gets a hint controlling whether a separate thread should be used for handling joystick detection and raw input messages on Windows

public static Hint Thread { get; }

Property Value

Hint

A hint controlling whether a separate thread should be used for handling joystick detection and raw input messages on Windows

Remarks

The hint can be set to the following values:

• "0"A separate thread is not used
• "1"A separate thread is used for handling raw input messages (default)

This hint should be set before SDL is initialized.

See Also

SDL_HINT_JOYSTICK_THREAD

Wgi

Gets a hint controlling whether Windows.Gaming.Input should be used for controller handling

public static Hint Wgi { get; }

Property Value

Hint

A hint controlling whether Windows.Gaming.Input should be used for controller handling

Remarks

The hint can be set to the following values:

• "0"WGI is not used
• "1"WGI is used (default)

This hint should be set before SDL is initialized.

See Also

SDL_HINT_JOYSTICK_WGI

ZeroCenteredDevices

Gets a hint containing a list of devices known to have all axes centered at zero

public static Hint ZeroCenteredDevices { get; }

Property Value

Hint

A hint containing a list of devices known to have all axes centered at zero

Remarks

The format of this hint is a comma separated list of USB VID/PID pairs in hexadecimal form, e.g. "0xAAAA/0xBBBB,0xCCCC/0xDDDD".

The hint can also take the form of "@file", in which case the named file will be loaded and interpreted as the value of the hint.

This hint should be set before .

See Also

SDL_HINT_JOYSTICK_ZERO_CENTERED_DEVICES