IGameInputDevice::GetInputReportInfo

Retrieves descriptions of the raw input reports that the device defines.

Syntax

uint32_t GetInputReportInfo(
    uint32_t infoArrayCount,
    GameInputRawDeviceReportInfo* infoArray
);

Parameters

infoArrayCount _In_
Type: uint32_t Number of elements in infoArray. To retrieve all input reports, pass the value returned by GetInputReportCount. infoArray _Out_writes_to_opt_(infoArrayCount, return)
Type: GameInputRawDeviceReportInfo* Pointer to an array that receives one structure per input report. Can be nullptr, in which case nothing is written and the method returns 0.

Return value

Type: uint32_t The number of elements written to infoArray. This is the smaller of infoArrayCount and the number of input reports on the device, or 0 if infoArray is nullptr or the device has no input reports.

Remarks

Each element is a GameInputRawDeviceReportInfo structure whose kind member is GameInputRawInputReport, whose id member is the device-defined report ID, and whose size member is the size of the report data in bytes. Call GetInputReportCount to get the number of input reports, allocate an array of that size, and then call GetInputReportInfo to fill it. If infoArrayCount is smaller than the number of input reports, only the first infoArrayCount elements are written. The input reports of a device don’t change while the device is connected, so you can query them once and cache the result. The id member of each element matches the report ID returned by IGameInputRawDeviceReport::GetReportInfo for the raw reports that IGameInputReading::GetRawReport returns from readings of this device. The following example shows how to retrieve the input reports of a device.

uint32_t reportCount = device->GetInputReportCount();
std::vector<GameInputRawDeviceReportInfo> reports(reportCount);
reports.resize(device->GetInputReportInfo(reportCount, reports.data()));

for (const GameInputRawDeviceReportInfo& report : reports)
{
    // report.id identifies an input report that can arrive in readings;
    // report.size is the size of its data in bytes.
}

In GameInput v3 and earlier, this information was available from the inputReportInfo member of the GameInputDeviceInfo structure returned by IGameInputDevice::GetDeviceInfo.

Requirements

Header: GameInput.h Library: gameinput.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Version History

Version	Changes
v4	Introduced.

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

​Version History

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History