Package apple.gamecontroller.protocol

Interface GCDevice

All Known Implementing Classes:

GCController, GCKeyboard, GCMouse

public interface GCDevice

API-Since: 14.0

Method Summary

Modifier and Type	Method	Description
@NotNull dispatch_queue_t	handlerQueue()	The dispatch queue that element value change handlers are submitted on.
@NotNull GCPhysicalInputProfile	physicalInputProfile()	Deprecated.
@NotNull java.lang.String	productCategory()	The product category the device belongs to.
void	setHandlerQueue(@NotNull dispatch_queue_t value)	The dispatch queue that element value change handlers are submitted on.
@Nullable java.lang.String	vendorName()	A vendor supplied name.

Method Detail

handlerQueue

@NotNull
@NotNull dispatch_queue_t handlerQueue()

The dispatch queue that element value change handlers are submitted on. The default queue is main, and setting this to any other queue will make value change handlers dispatch async on the given queue. This is useful if the main game loop of the application is not on main, or if input logic is handled on another thread from the main game loop.

See Also:

GCControllerAxisInput.valueChangedHandler, GCControllerButtonInput.valueChangedHandler, GCControllerButtonInput.pressedChangedHandler, GCControllerDirectionPad.valueChangedHandler, API-Since: 7.0

physicalInputProfile

@NotNull
@Deprecated
@NotNull GCPhysicalInputProfile physicalInputProfile()

Deprecated.

Gets the physical input profile for the device. [@note] This is equivalent to the controller's gamepad, microGamepad, or extendedGamepad instance.

See Also:

GCController.microGamepad, API-Since: 14.0 Deprecated-Since: 16.0 Deprecated-Message: Use the physicalInputProfile property on GCController instead. For GCKeyboard, use the keyboardInput property. For GCMouse, use the mouseInput property.

productCategory

@NotNull
@NotNull java.lang.String productCategory()

The product category the device belongs to. This is useful for setting appropriate UI elements based on what type of device is connected.

See Also:

API-Since: 13.0

setHandlerQueue

void setHandlerQueue(@NotNull
                     @NotNull dispatch_queue_t value)

The dispatch queue that element value change handlers are submitted on. The default queue is main, and setting this to any other queue will make value change handlers dispatch async on the given queue. This is useful if the main game loop of the application is not on main, or if input logic is handled on another thread from the main game loop.

See Also:

GCControllerAxisInput.valueChangedHandler, GCControllerButtonInput.valueChangedHandler, GCControllerButtonInput.pressedChangedHandler, GCControllerDirectionPad.valueChangedHandler, API-Since: 7.0

vendorName

@Nullable
@Nullable java.lang.String vendorName()

A vendor supplied name. May be nil, and is not guaranteed to be unique. This should not be used as a key in a dictionary, but simply as a way to present some basic information about the device in testing or to the user. API-Since: 7.0