Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 2.34 KB

nf-d3d12-id3d12sdkconfiguration-setsdkversion.md

File metadata and controls

78 lines (60 loc) · 2.34 KB
UID title description tech.root ms.date req.construct-type req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist f1_keywords dev_langs topic_type api_type api_location api_name
NF:d3d12.ID3D12SDKConfiguration.SetSDKVersion
ID3D12SDKConfiguration::SetSDKVersion
Configures the SDK version to use.
direct3d12
08/25/2021
function
d3d12.h
Windows
Windows 10 Build 20348
Windows 10 Build 20348
D3D12.lib
D3D12.dll
Windows
ID3D12SDKConfiguration::SetSDKVersion
d3d12/ID3D12SDKConfiguration::SetSDKVersion
c++
APIRef
kbSyntax
COM
D3D12.dll
ID3D12SDKConfiguration::SetSDKVersion

-description

Configures the SDK version to use.

-parameters

-param SDKVersion

Type: UINT

The SDK version to set.

-param SDKPath

Type: _In_z_ LPCSTR

A NULL-terminated string that provides the relative path to d3d12core.dll at the specified SDKVersion. The path is relative to the process exe of the caller. If d3d12core.dll isn't found, or isn't of the specified SDKVersion, then Direct3D 12 device creation fails.

-returns

Type: HRESULT

If the function succeeds, then it returns S_OK. Otherwise, it returns one of the Direct3D 12 return codes.

-remarks

This method can be used only in Windows Developer Mode.

To set the SDK version using this API, you must call it before you create the Direct3D 12 device. Calling this API after creating the Direct3D 12 device will cause the Direct3D 12 runtime to remove the device.

If the d3d12core.dll installed with the OS is newer than the SDK version specified, then the OS version is used instead.

You can retrieve the version of a particular D3D12Core.dll from the exported symbol D3D12SDKVersion, which is a variable of type UINT, just like the variables exported from applications to enable use of the Agility SDK.

-see-also