DXCoreAdapterProperty enumeration (dxcore_interface.h)

Important

Some information relates to a prerelease product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines constants that specify DXCore adapter properties. Pass one of these constants to the IDXCoreAdapter::GetPropertySize method to retrieve the buffer size necessary to receive the value of the corresponding property; then pass the same constant to the IDXCoreAdapter::GetProperty method to retrieve the property's value in a buffer that you allocate.

Syntax

typedef enum DXCoreAdapterProperty {
  InstanceLuid = 0,
  DriverVersion = 1,
  DriverDescription = 2,
  HardwareID = 3,
  KmdModelVersion = 4,
  ComputePreemptionGranularity = 5,
  GraphicsPreemptionGranularity = 6,
  DedicatedAdapterMemory = 7,
  DedicatedSystemMemory = 8,
  SharedSystemMemory = 9,
  AcgCompatible = 10,
  IsHardware = 11,
  IsIntegrated = 12,
  IsDetachable = 13,
  HardwareIDParts = 14,
  PhysicalAdapterCount = 15,
  AdapterEngineCount = 16,
  AdapterEngineName = 17
} ;

Constants

InstanceLuid Value: 0 Specifies the InstanceLuid adapter property, which contains a locally unique identifier representing the adapter. This value remains constant for the lifetime of this adapter. The LUID of an adapter changes on reboot, driver upgrade, or device disablement/enablement. The InstanceLuid adapter property has type LUID.
DriverVersion Value: 1 Specifies the DriverVersion adapter property, which contains the driver version, represented in WORDs as a LARGE_INTEGER. The DriverVersion adapter property has type uint64_t, representing a Boolean value.
DriverDescription Value: 2 Specifies the DriverDescription adapter property, which contains a NULL-terminated array of CHARs describing the driver, as specified by the driver, in UTF-8 encoding. The DriverDescription adapter property has type char*.
HardwareID Value: 3 Specifies the HardwareID adapter property, which represents the PnP hardware ID parts. But use HardwareIDParts instead, if available. The HardwareID adapter property has type DXCoreHardwareID.
KmdModelVersion Value: 4 Specifies the KmdModelVersion adapter property, which represents the driver model. The KmdModelVersion adapter property has type D3DKMT_DRIVERVERSION.
ComputePreemptionGranularity Value: 5 Specifies the ComputePreemptionGranularity adapter property, which represents the compute preemption granularity. The ComputePreemptionGranularity adapter property has type uint16_t, representing a D3DKMDT_COMPUTE_PREEMPTION_GRANULARITY value.
GraphicsPreemptionGranularity Value: 6 Specifies the GraphicsPreemptionGranularity adapter property, which represents the graphics preemption granularity. The GraphicsPreemptionGranularity adapter property has type uint16_t, representing a D3DKMDT_GRAPHICS_PREEMPTION_GRANULARITY value.
DedicatedAdapterMemory Value: 7 Specifies the DedicatedAdapterMemory adapter property, which represents the number of bytes of dedicated adapter memory that are not shared with the CPU. The DedicatedVideoMemory adapter property has type uint64_t.
DedicatedSystemMemory Value: 8 Specifies the DedicatedSystemMemory adapter property, which represents the number of bytes of dedicated system memory that are not shared with the CPU. This memory is allocated from available system memory at boot time. The DedicatedSystemMemory adapter property has type uint64_t.
SharedSystemMemory Value: 9 Specifies the SharedSystemMemory adapter property, which represents the number of bytes of shared system memory. This is the maximum value of system memory that may be consumed by the adapter during operation. Any incidental memory consumed by the driver as it manages and uses video memory is additional. The SharedSystemMemory adapter property has type uint64_t.
AcgCompatible Value: 10 Specifies the AcgCompatible adapter property, which indicates whether the adapter is compatible with processes that enforce Arbitrary Code Guard. The AcgCompatible adapter property has type bool.
IsHardware Value: 11 Specifies the IsHardware adapter property, which determines whether or not this is a hardware adapter. An adapter that's not a hardware adapter is a software adapter. The IsHardware adapter property has type bool.
IsIntegrated Value: 12 Specifies the IsIntegrated adapter property, which determines whether the adapter is reported to be an integrated graphics processor (iGPU). The IsIntegrated adapter property has type bool.
IsDetachable Value: 13 Specifies the IsDetachable adapter property, which determines whether the adapter has been reported to be detachable, or removable. The IsDetachable adapter property has type bool. Note. Even if IDXCoreAdapter::GetProperty indicates false for this property, the adapter still has the ability to be reported as removed, such as in the case of malfunction, or driver update.
HardwareIDParts Value: 14 Specifies the HardwareIDParts adapter property, which represents the PnP hardware ID parts. The HardwareIDParts adapter property has type DXCoreHardwareID.
PhysicalAdapterCount Value: 15 This query outputs the number of physical adapters grouped under the logical adapter.
AdapterEngineCount Value: 16 This query takes physical adapter index as input, and outputs the count of engines on the physical adapter.
AdapterEngineName Value: 17 This query takes physical adapter index and engine ID as input, and outputs engine type.

Requirements

Requirement	Value
Minimum supported client	Windows 10 (Build 18936)
Header	dxcore_interface.h (include dxcore.h)

See also

IDXCoreAdapter::GetPropertySize, IDXCoreAdapter::GetProperty, DXCore reference, Using DXCore to enumerate adapters