Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
A per-process singleton used to access the device input stream.
The IGameInput interface is the starting point for using the GameInput API. This interface provides methods for synchronously retrieving cached readings from the input stream (the polling API), and methods for registering asynchronous callbacks for state changes (the event-based API).
Syntax
class IGameInput : public IUnknown
Methods
| Method | Description |
|---|---|
| CreateDispatcher | Creates a dispatcher for background tasks. |
| FindDeviceFromId | Retrieves an IGameInputDevice interface using its identifier. |
| FindDeviceFromPlatformString | Retrieves an IGameInputDevice interface using a matching platform string. |
| GetCurrentReading | Gets the latest reading from the input stream that matches a specified filter. |
| GetCurrentTimestamp | Gets the current time in microseconds. |
| GetNextReading | Gets the next available IGameInputReading interface based on a reference reading from an optionally filtered input stream. |
| GetPreviousReading | Gets the previous IGameInputReading based on a reference reading from an optionally filtered input stream. |
| RegisterDeviceCallback | Registers a callback function that is called when the device status changes. |
| RegisterKeyboardLayoutCallback | Registers a callback function for keyboard layout changes. |
| RegisterReadingCallback | Registers a callback function that is called when a new reading is available. |
| RegisterSystemButtonCallback | Registers a callback function for Guide or Share button press and release events. |
| SetFocusPolicy | Sets the focus policy for a game's input devices. |
| StopCallback | Stops a registered callback without waiting for any executing callbacks to complete. |
| UnregisterCallback | Stops a registered callback, waiting for any executing callbacks to complete. |
Requirements
Header: GameInput.h
Supported platforms: Windows