IGameInputReading::GetSequenceNumber
Retrieve the sequence number for the input reading.
Syntax
uint64_t GetSequenceNumber(
GameInputKind inputKind
)
Parameters
inputKind _In_
Type: GameInputKind
The GameInputKind to retrieve the sequence number for.
While GameInputKind is normally a flag type enum, you may only use one value for this parameter.
Return value
Type: uint64_t
This function is not yet implemented Currently returns 0.
Once implemented, returns the sequence number of the input reading.
Remarks
Each kind of input represented by GameInputKind maintains its own sequence number which is only updated when that inputkind's state changes. This is important because one device may have multiple input kinds which it supports and therefore also has multiple input kind views which can be interpreted from its raw input. Two sequential readings from the same device may have the same sequence number on one input kind view of the raw data, and different sequence numbers for a different input kind's interpretation of the raw data. This would indicate that the game controller gave input of some particular kind and so only that sequence number was incremented. This function can be used to tell whether or not a particular kind of input has changed from reading to reading. The sequence number can also be used to order and differentiate between readings in the event that two readings have the same timestamp.
Requirements
Header: GameInput.h
Library: xgameruntime.lib
Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles