Direct3D 11 Deployment for Game Developers
This article describes how to deploy the Direct3D 11 components on a system if necessary.
- Integrating into Installation Programs
- Debugging Tips
- Corporate Settings
- Related Articles
The Direct3D 11 API extends the existing Direct3D 10.1 API with support for multithreaded rendering and resource creation, Compute Shader, hardware tessellation, BC6H/BC7 texture compression, and HLSL Shader Model 5.0 with Dynamic Shader Linkage. In addition to the Direct3D 11 component, a number of additional graphics components are included in the DirectX 11 runtime: Direct3D 11, DXGI 1.1, 10level9 feature levels, WARP10 software rendering device, Direct2D, DirectWrite, and an updated Direct3D 10.1 with support for 10level9 and WARP10. For information on these and other Windows graphics components, see Graphics APIs in Windows.
All of these new graphics components are built into the Windows 7 and Windows Server 2008 R2 operating systems. The Direct3D 11 API and related components can also be installed on Windows Vista by using a system update from Windows Update; see Knowledge Base article KB 971644. This update requires Windows Vista and Service Pack 2. End-users with automatic updates enabled will, therefore, likely already have the Direct3D 11 components installed, as will all Windows 7 users.
The D3D11InstallHelper sample is designed to simplify detection of the Direct3D 11 API, automatically install the system update if applicable to an end-user's computer, and to provide appropriate messages to the end-user on manual procedure if a newer Service Pack is required.
Note The HLSL compiler (D3DCompile*.dll) and the D3DX utility library for Direct3D 11 (D3DX11*.dll) are not built into any version of the Windows operating system, but they can be deployed as part of an application's installer by using the existing DirectSetup technology; for more information about using DirectSetup, see DirectX Installation for Game Developers. "Effects 11" is available as a support library in the DirectX SDK, provided with full source, and it can be included directly into an application (much like the DXUT utility library). Thus, it does not have any additional run-time redistribution requirements.
You can download source and executable for D3D11InstallHelper.dll from the D3D11InstallHelper sample.
D3D11InstallHelper.dll hosts the core functionality for detecting Direct3D 11 components, and performing the system update through the Windows Update service if applicable. The DLL displays no messages or dialog boxes directly.
The DLL consists of the following entry points:
This function performs the necessary checks and returns the status of Direct3D 11 on this computer. This function does not require administrator rights.
- A status of D3D11IH_STATUS_INSTALLED indicates that Direct3D 11 is already installed on the computer and is ready for use.
- D3D11IH_STATUS_NOT_SUPPORTED indicates that this version of Windows does not support Direct3D 11 or related technologies.
- A status of D3D11IH_STATUS_NEED_LATEST_SP indicates that the latest Windows Vista Service Pack should be installed by the user.
- Finally, a status of D3D11IH_STATUS_REQUIRES_UPDATE indicates that the system does not have Direct3D 11 installed, but that the system update does apply to this version of Windows.
This function uses the Windows Update API to perform the system update for installing Direct3D 11 on this system, if applicable. Note that this function requires network connectivity to Windows Update to succeed, as well as administrative rights. It takes an optional progress callback function and user-context pointer, and returns a final result code when complete.
- The D3D11IH_RESULT_SUCCESS result indicates that the system update was applied and is ready for use, while D3D11IH_RESULT_SUCCESS_REBOOT indicates that the system update requires the computer is restarted before it is complete. Note that this function does not schedule a system restart.
- D3D11IH_RESULT_NOT_SUPPORTED indicates that the system update does not apply to this version of Windows. This result should not occur if this function is only called after getting a D3D11IH_STATUS_REQUIRES_UPDATE status from CheckDirect3D11Status.
- A result of D3D11IH_RESULT_UPDATE_NOT_FOUND indicates that the system update package was not found on the Windows Update servers.
- If the Windows Update download or installation fails, then D3D11IH_RESULT_UPDATE_DOWNLOAD_FAILED or D3D11IH_RESULT_UPDATE_INSTALL_FAILED will be returned as the result.
- If a network connectivity error is returned from the Windows Update API, then the D3D11IH_RESULT_WU_SERVICE_ERROR result is returned, indicating that the problem might be intermittent or related to network configuration or firewall settings. Trying the update function again may succeed.
For more information on the Windows Update API, see Windows Update Agent API.
You can download source and executable for D3D11Install.exe from the D3D11InstallHelper sample.
Note D3D11Install.exe requires D3D11InstallHelper.dll to execute.
D3D11Install.exe is a tool for using D3D11InstallHelper.dll as a stand-alone installer complete with UI and end-user messages, as well as acting as an example for proper use of the DLL. The process exits with a 0 if Direct3D 11 is already installed, if the system update applies successfully without requiring a system restart, if a Service Pack installation is required, or if Direct3D 11 is not supported by this computer. A 1 is returned if the system update is applied successfully and requires a system restart to complete. A 2 is returned for other error conditions. Note that this executable file requires administrator rights to run, and it has a manifest that requests elevation when run on Windows Vista or Windows 7 with UAC enabled. D3D11Install.exe can be used as a stand-alone tool for deploying the Direct3D 11 update, or it can be used directly by installers.
It supports the following command-line switches:
Displays no messages, prompts, progress dialog boxes, or error messages.
Displays no messages, prompts, or error messages, but will show the progress dialog box.
Shows only minimal prompts.
Suppresses prompting to confirm installing the update, if needed and applicable, for a standard and minimal installation.
- /langid decimal
Forces which language identifier code to use when displaying end-user messages and dialog box resources. The default value is 1024, which uses the system default language setting.
Forces use of Windows Update rather than the system default, which may be Windows Server Update Services (WSUS) running on a managed server or some other non-standard configuration.
To comply with Support Easy Installation, Technical Requirement 3.1 for Games for Windows, care needs to be taken so that any end-user prompts are presented early in the installation process, and to ensure that there are not multiple UAC-related elevation prompts. There are three basic choices for achieving this goal:
- The most basic method is to execute the D3D11Install.exe with the command-line switch /minimal. This should be done early in the installer Q&A, and the installation should use the return value of 1 to indicate that a restart should be scheduled at the end of the installation. Executing the program requires administrative rights.
- Use D3D11InstallHelper.dll directly to detect the need for the update, providing any end-user messages necessary for the status D3D11IH_STATUS_NEED_LATEST_SP, where the resolution requires manual user operations. The status result of D3D11IH_STATUS_NOT_SUPPORTED could be used to control installation of Direct3D 11–related assets, or as an error condition for Direct3D 11–only applications, but it is otherwise not necessarily a useful end-user message. For the status D3D11IH_STATUS_REQUIRES_UPDATE, the installer can directly use the DLL entry point DoUpdateForDirect3D11 to perform the update and handle the various resulting end-user messages. Examples of standard messages can be found by examining the D3D11Install.exe dialog box and string table resources. The update entry point requires administrator rights.
- A hybrid approach is to check status with D3D11InstallHelper.dll, and in the case of the status code D3D11IH_STATUS_NEED_LATEST_SP or D3D11IH_STATUS_REQUIRES_UPDATE, D3D11Install.exe can be executed with the switches /minimal and /y to display the dialog box or to perform the update, as needed. These steps should be performed early in the installation process, usually immediately after the Q&A, and running the executable requires administrative rights.
Handling the Direct3D 11 deployment from InstallShield's InstallScript is easily done using the D3D11InstallHelper sample. The steps required to integrate with InstallShield using InstallScript are as follows (using method 3, described in the previous section):
- Open an InstallScript project in the InstallShield editor.
- Add D3D11InstallHelper.dll and D3D11Install.exe to the project in Support Files.
To add the files to the InstallShield Project
- On the Installation Designer tab, click Support Files/Billboards under Behavior and Logic in the navigation pane on the left.
- Click Language Independent, then right-click in the Files window and select Insert Files. Browse to add D3D11InstallHelper.dll and D3D11Install.exe. The default location for these files is: SDK root\Samples\C++\Misc\Bin\x86
- In the InstallScript explorer, click the InstallScript file (usually Setup.rul) that will call the DLL or executable, located under Behavior and Logic in the navigation pane on the left.
- Paste the following InstallScript into the file near the top:
#define D3D11IH_STATUS_INSTALLED 0 #define D3D11IH_STATUS_NOT_SUPPORTED 1 #define D3D11IH_STATUS_REQUIRES_UPDATE 2 #define D3D11IH_STATUS_NEED_LATEST_SP 3 #define D3D11IH_STATUS_ERROR -1 prototype NUMBER D3D11InstallHelper.CheckDirect3D11StatusIS(); #define D3D11IH_RESULT_SUCCESS 0 #define D3D11IH_RESULT_SUCCESS_REBOOT 1 #define D3D11IH_RESULT_NOT_SUPPORTED 2 #define D3D11IH_RESULT_UPDATE_NOT_FOUND 3 #define D3D11IH_RESULT_UPDATE_DOWNLOAD_FAILED 4 #define D3D11IH_RESULT_UPDATE_INSTALL_FAILED 5 #define D3D11IH_RESULT_WU_SERVICE_ERROR 6 #define D3D11IH_RESULT_ERROR -1 prototype NUMBER D3D11InstallHelper.DoUpdateForDirect3D11IS(BOOL);
- Paste the following InstallScript into the file in the OnFirstUIBefore function, just before the return 0:
Dlg_D3D11: UseDLL( SUPPORTDIR ^ "D3D11InstallHelper.DLL" ); nResult = D3D11InstallHelper.CheckDirect3D11StatusIS(); UnUseDLL( SUPPORTDIR ^ "D3D11InstallHelper.DLL" ); if ( nResult = D3D11IH_STATUS_REQUIRES_UPDATE || nResult = D3D11IH_STATUS_NEED_LATEST_SP) then nResult = LaunchAppAndWait( SUPPORTDIR^"D3D11Install.exe", "/minimal /y", WAIT); if ( nResult < 0 ) then MessageBox("Unable to launch D3D11Install.exe", SEVERE); elseif ( nResult == 1 ) then BATCH_INSTALL = 1; endif; endif;
The following is a high-level description of the steps required to integrate Direct3D 11 deployment using MSI custom actions (using method 3, described earlier in this topic):
- Add a property to the MSI Property table called RelativePathToD3D11IH that contains the relative path to D3D11Install.exe and D3D11InstallHelper.dll during installation (this is typically in the media image). This also sets an MSI property D3D11IH_STATUS to the status returned by CheckDirect3D11Status (a string property equal to the enumeration symbol or "ERROR").
- After the CostFinalize action, call the D3D11InstallHelper.dll function SetD3D11InstallMSIProperties as an immediate custom action to set the appropriate MSI properties for the other custom actions.
- Upon installation, trigger a deferred custom action after the InstallFiles action that calls the D3D11InstallHelper.dll function DoD3D11InstallUsingMSI. The custom action must set the flag msidbCustomActionTypeNoImpersonate to run in an elevated context.
- After the InstallFinalize action, call the D3D11InstallHelper.dll function FinishD3D11InstallUsingMSI as an immediate custom action to handle the successful reboot request result code, if needed.
This procedure is described in detail in the following instructions, which describe a process that can be done using an MSI editor, such as the Orca editor found in the Windows SDK. Some MSI editors have wizards that simplify some of these configuration steps.
To configure an MSI package for integration with D3D11InstallHelper.dll
- Open the MSI package in Orca.
- Add the row shown in the following table to the Binary table in the MSI package.
Name Data D3D11IH File path to the DLL\D3D11InstallHelper.dll
Note This file will be embedded in the MSI package, so you must do this step every time that you recompile D3D11InstallHelper.dll.
- Add the rows shown in the following table to the CustomAction table in the MSI package.
Action Type Source Target Direct3D11SetProps msidbCustomActionTypeDll + msidbCustomActionTypeBinaryData + msidbCustomActionTypeContinue = 65 D3D11IH SetD3D11InstallMSIProperties Direct3D11DoInstall msidbCustomActionTypeDll + msidbCustomActionTypeBinaryData + msidbCustomActionTypeContinue + msidbCustomActionTypeInScript + msidbCustomActionTypeNoImpersonate = 3137 D3D11IH DoD3D11InstallUsingMSI Direct3D11Finish msidbCustomActionTypeDll + msidbCustomActionTypeBinaryData + msidbCustomActionTypeContinue = 65 D3D11IH FinishD3D11InstallUsingMSI
- Add the values shown for Action, Condition, and Sequence in the following table to the InstallExecuteSequence table in the MSI package.
Action Condition Sequence Notes Direct3D11SetProps 1016 The sequence number places the action soon after CostFinalize. Direct3D11DoInstall NOT Installed 4004 This custom action will only happen during a new installation for all users. The sequence number places the action after InstallFiles and after the rollbacks. Direct3D11Finish 6615 The sequence number places the action soon after InstallFinalize.
- Add the row shown in the following table to the Property table in the MSI package.
Property Value RelativePathToD3D11IH relative file path that contains D3D11Install.exe and D3D11InstallHelper.dll
Note The location specified by the path is relative to the location specified by the installation path—for example, "redist\".
- Save the MSI package. For more detailed information about MSI packages and Windows Installer, see Windows Installer.
Both D3D11InstallHelper.dll and D3D11Install.exe can be built with the Debug configuration in Visual Studio, and these versions will print messages to the standard Windows debug output mechanism.
The D3D11InstallHelper sample is designed for standard deployment through Windows Update, which is the most common scenario for installation of a game by consumers. However, Many game developers, working for publishers and in development studios, do so in enterprise settings that have a locally managed server providing software updates by using Windows Server Update Services (WSUS) technology. In this type of environment, the local IT administrator has approval control over which updates are made available to computers within the corporate network, and the standard consumer version of update KB 971644 is not available.
There are three basic solutions for deploying DirectX 11 in corporate/enterprise settings:
- In some configurations, it is possible to directly check Windows Update rather than use the locally managed WSUS server. For this reason, D3D11InstallHelper supports the /wu command-line switch. However, not all corporate networks allow connections to the public Microsoft servers.
- The local IT administrator can approve KB 971512, an enterprise-supported update deployed from WSUS, that includes the Direct3D 11 API. This is the only option for a Standard User to obtain the Direct3D 11 update in an environment that is fully locked down.
- Alternatively, KB 971512 can be manually installed.
It is very rare that a gamer's computer can only get updates from a locally managed WSUS server, and it is only developers in large organizations who are likely to be in such environments.
Build date: 2/27/2013