View source

final class GameInputDevice

package openfl.ui

@:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.ui.GameInputControl)@:final

Available on all platforms

Static variables

@:value(32000)staticinlineread onlyMAX_BUFFER_SIZE:Int = 32000

Specifies the maximum size for the buffer used to cache sampled control values. If startCachingSamples returns samples that require more memory than you specify, it throws a memory error.

Variables

enabled:Bool

Enables or disables this device.

read onlyid:String

Returns the ID of this device.

read onlyname:String

Returns the name of this device.

read onlynumControls:Int

Returns the number of controls on this device.

sampleInterval:Int

Specifies the rate (in milliseconds) at which to retrieve control values.

Methods

@:value({ append : false })getCachedSamples(data:ByteArray, append:Bool = false):Int

Writes cached sample values to the ByteArray. @return

Parameters:

data
append

getControlAt(i:Int):GameInputControl

Retrieves a specific control from a device. @return

Parameters:

i

startCachingSamples(numSamples:Int, controls:Vector<String>):Void

Requests this device to start keeping a cache of sampled values.

Parameters:

numSamples
null

controls

stopCachingSamples():Void

Stops sample caching.