XSystemGetDeviceType

Syntax

XSystemDeviceType XSystemGetDeviceType(  
)  

Parameters

None.

Return value

XSystemDeviceType enumeration value corresponding to the device currently being used.

This function has no explicit error state, but will return a value of XSystemDeviceType::Unknown if it is not possible to determine the device type in use.

Remarks

This query will return the console mode, as opposed to the actual hardware type, meaning that it is possible for a developer console to masquerade as a different device type when polled by a title.

A Microsoft Game Development Kit (GDK) title built for the XBOX One family will not return a device code within the XBOX Series consoles unless the XboxCompatibility setting in the MicrosoftGame.config file is set to Scarlett. Instead, it will return a code from the XBOX One family based on the current device.

Actual Device / Mode	Built for XBOX One family	Built for XBOX Series consoles
XBOX Series X Dev Kit	XboxOneXDevkit	XboxScarlettDevkit
XBOX Series X Anaconda Profiling Mode	XboxOneX	XboxScarlettAnaconda
XBOX Series S Lockhart Profiling Mode XBOX Series S Test Kit	XboxOneS	XboxScarlettLockhart

For more information on the target device family usage, see MicrosoftGame.config overview.

It is possible to execute this query before calling XGameRuntimeInitialize in order to allow its usage during early title initialization.

This example gets the type of the device currently being used. If it is running on a devkit, it runs custom code to enable developer features within the game.

const XSystemDeviceType deviceType = XSystemGetDeviceType(); 
const bool deviceIsDevkit = 
    deviceType == XSystemDeviceType::XboxOneXDevkit || 
    deviceType == XSystemDeviceType::XboxScarlettDevkit; 
 
if (deviceIsDevkit) 
{ 
    EnableGameSpecificDevkitFeatures(); 
}

(all) API references

Error codes

Audio API reference

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

XSystemGetDeviceType

Syntax

Parameters

Return value

Remarks

Requirements

See also

​XSystemGetDeviceType

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

XSystemGetDeviceType

Syntax

Parameters

Return value

Remarks

Requirements

See also