Namespace UnityEngine.InputSystem.LowLevel | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.InputSystem.LowLevel

    Classes

    InputEventTrace

    The InputEventTrace lets you record input events for later processing.

    InputState

    Low-level APIs for working with input state memory.

    InputStateHistory

    Record a history of state changes applied to one or more controls.

    InputStateHistory<TValue>

    Records value changes of a given control over time.

    Structs

    DeltaStateEvent

    Partial state update for an input device.

    DeviceConfigurationEvent

    Indicates that the configuration of a device has changed.

    DeviceRemoveEvent

    Notifies about the removal of an input device.

    DisableDeviceCommand

    Command to tell the runtime to no longer send events for the given device.

    EnableDeviceCommand

    Command to re-enable a device that has been disabled with DisableDeviceCommand.

    EnableIMECompositionCommand

    Device Command that enables IME Composition within the application. Primarily handled by Keyboard devices.

    GamepadState

    Default state layout for gamepads.

    IMECompositionEvent

    A specialized event that contains the current IME Composition string, if IME is enabled and active. This event contains the entire current string to date, and once a new composition is submitted will send a blank string event.

    IMECompositionString

    A struct representing an string of characters generated by an IME for text input.

    InitiateUserAccountPairingCommand

    Device command to instruct the underlying platform to pair a user account to the targeted device.

    InputDeviceCommand

    Data header for a command send to an InputDevice.

    InputEvent

    A chunk of memory signaling a data transfer in the input system.

    InputEventBuffer

    A buffer of raw memory holding a sequence of InputEvent.

    InputEventPtr

    Pointer to an InputEvent. Makes it easier to work with InputEvents and hides the unsafe operations necessary to work with events.

    InputMetrics

    Provides information on the level of throughput going through the system.

    InputStateBlock

    Information about a memory region storing state.

    InputStateHistory.Record

    InputStateHistory.RecordHeader

    InputStateHistory<TValue>.Record

    KeyboardState

    Default state layout for keyboards.

    MouseState

    Combine a single pointer with buttons and a scroll wheel.

    QueryCanRunInBackground

    Queries to see if this device is able to continue to send updates and state changes when the application is not if focus.

    QueryDimensionsCommand

    Query dimensions of a device.

    QueryEnabledStateCommand

    Command to find out whether a device is currently enabled or not.

    QueryKeyboardLayoutCommand

    Command to query the name of the current keyboard layout from a device.

    QueryKeyNameCommand

    Command to query the current name of a key according to the current keyboard layout.

    QueryPairedUserAccountCommand

    Query the ID and the name of the user paired to the device the command is sent to.

    RequestResetCommand

    A command to tell the runtime to reset the device to it's default state.

    RequestSyncCommand

    A command to tell the runtime to sync the device to it's last known state.

    SetIMECursorPositionCommand

    Sets the position for IME dialogs. This is in pixels, from the upper left corner going down and to the right.

    SetSamplingFrequencyCommand

    For a device that is sampled periodically, set the frequency at which the device is sampled.

    StateEvent

    A complete state snapshot for an entire input device.

    TextEvent

    A single character text input event.

    TouchscreenState

    Default state layout for touch devices.

    TouchState

    State layout for a single touch.

    Interfaces

    IInputDeviceCommandInfo

    Interface implemented by all input device command structs which reports the data format identifier of the command.

    IInputEventTypeInfo

    Interface implemented by all input event structs which reports the data format identifier of the command.

    IInputRuntime

    Input functions that have to be performed by the underlying input runtime.

    IInputStateCallbackReceiver

    Interface for devices that implement their own state update handling.

    IInputStateChangeMonitor

    Interface used to monitor input system state changes.

    IInputStateTypeInfo

    Interface implemented by all input device state structs which reports the data format identifier of the state.

    Enums

    GamepadButton

    Enum of common gamepad buttons.

    InitiateUserAccountPairingCommand.Result

    InputUpdateType

    Enum of different player loop positions where the input system can invoke it's update mechanism.

    MouseButton

    Button indices for buttons.

    QueryPairedUserAccountCommand.Result

    Delegates

    InputDeviceCommandDelegate

    Delegate used by onDeviceCommand.

    InputUpdateDelegate

    Delegate used by .

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023