Direct3D 11

https://learn.microsoft.com/en-us/windows/win32/direct3d11/
Admin
Direct3D 11 is a graphics API for creating 3D graphics for games, scientific applications, and...
Tokens:194,784
Snippets:1,681
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Domain shader example

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/direct3d-11-advanced-stages-tessellation

Example of a domain shader that outputs a vertex position using SV_DomainPoint, hull shader outputs, and tessellation factors. The shader is invoked once per tessellator output point and uses EvaluateSurfaceUV to compute the position.

```hlsl
void main( out    MyDSOutput result, 
           float2 myInputUV : SV_DomainPoint, 
           MyDSInput DSInputs,
           OutputPatch<MyOutPoint, 12> ControlPts, 
           MyTessFactors tessFactors)
{
     ...

     result.Position = EvaluateSurfaceUV(ControlPoints, myInputUV);
}

```

--------------------------------

### Initialize a Direct3D 11 device and immediate context with D3D11CreateDeviceAndSwapChain

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-devices-initialize

First fill the DXGI_SWAP_CHAIN_DESC structure with buffer format and dimension details, then call D3D11CreateDeviceAndSwapChain to initialize the device and swap chain together. The first block sets up a 640x480 back buffer with DXGI_FORMAT_R8G8B8A8_UNORM and a refresh rate of 60 Hz. The second block requests D3D_FEATURE_LEVEL_11_0 and uses D3D_DRIVER_TYPE_HARDWARE; on failure it returns the HRESULT.

```cpp
DXGI_SWAP_CHAIN_DESC sd;
ZeroMemory( &sd, sizeof( sd ) );
sd.BufferCount = 1;
sd.BufferDesc.Width = 640;
sd.BufferDesc.Height = 480;
sd.BufferDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
sd.BufferDesc.RefreshRate.Numerator = 60;
sd.BufferDesc.RefreshRate.Denominator = 1;
sd.BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT;
sd.OutputWindow = g_hWnd;
sd.SampleDesc.Count = 1;
sd.SampleDesc.Quality = 0;
sd.Windowed = TRUE;
```

```cpp
D3D_FEATURE_LEVEL  FeatureLevelsRequested = D3D_FEATURE_LEVEL_11_0;
UINT               numLevelsRequested = 1;
D3D_FEATURE_LEVEL  FeatureLevelsSupported;

if( FAILED (hr = D3D11CreateDeviceAndSwapChain( NULL, 
                D3D_DRIVER_TYPE_HARDWARE, 
                NULL, 
                0,
                &FeatureLevelsRequested, 
                numFeatureLevelsRequested, 
                D3D11_SDK_VERSION, 
                &sd, 
                &g_pSwapChain, 
                &g_pd3dDevice, 
                &FeatureLevelsSupported,
                &g_pImmediateContext )))
{
    return hr;
}
```

--------------------------------

### Get display modes with IDXGIOutput::GetDisplayModeList

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-devices-get-adapter-info

Retrieves the display modes for an output using IDXGIOutput::GetDisplayModeList. First call gets the count, then a buffer is allocated and the list is filled. Uses DXGI_FORMAT_R32G32B32A32_FLOAT as the format.

```cpp
UINT numModes = 0;
DXGI_MODE_DESC* displayModes = NULL;
DXGI_FORMAT format = DXGI_FORMAT_R32G32B32A32_FLOAT;

    // Get the number of elements
    hr = pOutput->GetDisplayModeList( format, 0, &numModes, NULL);

    displayModes = new DXGI_MODE_DESC[numModes]; 

    // Get the list
    hr = pOutput->GetDisplayModeList( format, 0, &numModes, displayModes);

```

--------------------------------

### GetMemberName

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effecttype

Get the name of a member.

```APIDOC
## GetMemberName

### Description
Get the name of a member.

### Method
GetMemberName

### Parameters
None.

### Return Value
The name of a member.

### Remarks
None.

### Requirements
- Header: D3dx11effect.h
- Library: N/A (An Effects 11 library is available online as shared source.)

```

--------------------------------

### Set up uniform box 3D tiled resource

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/volume-tiled-resources

Sets up a uniform box tiled resource with bUseBox = true, a 3x3x3 box, and 27 tiles.

```cpp
D3D11_TILED_RESOURCE_COORDINATE trCoord;
trCoord.X = 0;
trCoord.Y = 1;
trCoord.Z = 0;
trCoord.Subresource = 0;

D3D11_TILE_REGION_SIZE trSize;
trSize.bUseBox = true;
trSize.NumTiles = 27;
trSize.Width = 3;
trSize.Height = 3;
trSize.Depth = 3;

```

--------------------------------

### Set up single tile 3D tiled resource

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/volume-tiled-resources

Sets up a single tile resource using a box region (bUseBox = true) with dimensions 3x3x3 and 27 tiles.

```cpp
D3D11_TILED_RESOURCE_COORDINATE trCoord;
trCoord.X = 1;
trCoord.Y = 1;
trCoord.Z = 1;
trCoord.Subresource = 0;

D3D11_TILE_REGION_SIZE trSize;
trSize.bUseBox = true;
trSize.NumTiles = 27;
trSize.Width = 3;
trSize.Height = 3;
trSize.Depth = 3;

```

--------------------------------

### GetDesc

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effecttype

Get an effect-type description.

```APIDOC
## GetDesc

### Description
Get an effect-type description.

### Method
GetDesc

### Parameters
None.

### Return Value
An effect-type description.

### Remarks
None.

### Requirements
- Header: D3dx11effect.h
- Library: N/A (An Effects 11 library is available online as shared source.)

```

--------------------------------

### Create a reference device with D3D11CreateDeviceAndSwapChain

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-devices-create-ref

Steps to create a reference device and swap chain: initialize a DXGI_SWAP_CHAIN_DESC, request D3D_FEATURE_LEVEL_11_0, then call D3D11CreateDeviceAndSwapChain with D3D_DRIVER_TYPE_REFERENCE. The call returns the swap chain, device, granted feature level, and immediate context.

```cpp
    DXGI_SWAP_CHAIN_DESC sd;
    ZeroMemory( &sd, sizeof( sd ) );
    sd.BufferCount = 1;
    sd.BufferDesc.Width = 640;
    sd.BufferDesc.Height = 480;
    sd.BufferDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
    sd.BufferDesc.RefreshRate.Numerator = 60;
    sd.BufferDesc.RefreshRate.Denominator = 1;
    sd.BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT;
    sd.OutputWindow = g_hWnd;
    sd.SampleDesc.Count = 1;
    sd.SampleDesc.Quality = 0;
    sd.Windowed = TRUE;

```

```cpp
    D3D_FEATURE_LEVEL FeatureLevels = D3D_FEATURE_LEVEL_11_0;

```

```cpp
    HRESULT hr = S_OK;
    D3D_FEATURE_LEVEL FeatureLevel;

    if( FAILED (hr = D3D11CreateDeviceAndSwapChain( NULL, 
                    D3D_DRIVER_TYPE_REFERENCE,
                    NULL, 
                    0,
                    &FeatureLevels, 
                    1, 
                    D3D11_SDK_VERSION, 
                    &sd, 
                    &g_pSwapChain, 
                    &g_pd3dDevice, 
                    &FeatureLevel,
                    &g_pImmediateContext )))
    {
        return hr;
    }

```

--------------------------------

### GetDepthStencil

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effectdepthstencilviewvariable

Gets a depth-stencil-view resource.

```APIDOC
## GetDepthStencil

### Description
Gets a depth-stencil-view resource.

### Method
GetDepthStencil

### Parameters
None documented.

### Return Value
A depth-stencil-view resource.

### Remarks
This method is part of the ID3DX11EffectDepthStencilViewVariable interface.
```

--------------------------------

### GetMemberTypeBySemantic

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effecttype

Get a member type by semantic.

```APIDOC
## GetMemberTypeBySemantic

### Description
Get a member type by semantic.

### Method
GetMemberTypeBySemantic

### Parameters
None.

### Return Value
A member type by semantic.

### Remarks
None.

### Requirements
- Header: D3dx11effect.h
- Library: N/A (An Effects 11 library is available online as shared source.)

```

--------------------------------

### Set up 3D tiled resource at most detailed mip

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/volume-tiled-resources

Sets up a 3D tiled resource at the most detailed mip (Subresource 0) with a non-box region of 63 tiles.

```cpp
D3D11_TILED_RESOURCE_COORDINATE trCoord;
trCoord.X = 1;
trCoord.Y = 0;
trCoord.Z = 0;
trCoord.Subresource = 0;

D3D11_TILE_REGION_SIZE trSize;
trSize.bUseBox = false;
trSize.NumTiles = 63;

```

--------------------------------

### Create and bind a render-target view

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-devices-initialize

Creates a render-target view by calling ID3D11Device::CreateRenderTargetView and binds the back-buffer as a render target by calling ID3D11DeviceContext::OMSetRenderTargets. Requires a swap chain (g_pSwapChain) and a device (g_pd3dDevice) already created.

```cpp
ID3D11Texture2D* pBackBuffer;
// Get a pointer to the back buffer
hr = g_pSwapChain->GetBuffer( 0, __uuidof( ID3D11Texture2D ),
( LPVOID* )&pBackBuffer );
// Create a render-target view
g_pd3dDevice->CreateRenderTargetView( pBackBuffer, NULL,
&g_pRenderTargetView );
// Bind the view
g_pImmediateContext->OMSetRenderTargets( 1, &g_pRenderTargetView, NULL );
```

--------------------------------

### GetMemberTypeByName

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effecttype

Get a member type by name.

```APIDOC
## GetMemberTypeByName

### Description
Get a member type by name.

### Method
GetMemberTypeByName

### Parameters
None.

### Return Value
A member type by name.

### Remarks
None.

### Requirements
- Header: D3dx11effect.h
- Library: N/A (An Effects 11 library is available online as shared source.)

```

--------------------------------

### GetMemberTypeByIndex

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effecttype

Get a member type by index.

```APIDOC
## GetMemberTypeByIndex

### Description
Get a member type by index.

### Method
GetMemberTypeByIndex

### Parameters
None.

### Return Value
A member type by index.

### Remarks
None.

### Requirements
- Header: D3dx11effect.h
- Library: N/A (An Effects 11 library is available online as shared source.)

```

--------------------------------

### Set up 3D tiled resource at second most detailed mip

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/volume-tiled-resources

Sets up a 3D tiled resource for the second most detailed mip (Subresource 1) with a non-box region of 6 tiles.

```cpp
D3D11_TILED_RESOURCE_COORDINATE trCoord;
trCoord.X = 1;
trCoord.Y = 0;
trCoord.Z = 0;
trCoord.Subresource = 1;

D3D11_TILE_REGION_SIZE trSize;
trSize.bUseBox = false;
trSize.NumTiles = 6;

```

--------------------------------

### GetMemberSemantic

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effecttype

Get the semantic attached to a member.

```APIDOC
## GetMemberSemantic

### Description
Get the semantic attached to a member.

### Method
GetMemberSemantic

### Parameters
None.

### Return Value
The semantic attached to a member.

### Remarks
None.

### Requirements
- Header: D3dx11effect.h
- Library: N/A (An Effects 11 library is available online as shared source.)

```

--------------------------------

### Create an Index Buffer with D3D11_BUFFER_DESC and ID3D11Device::CreateBuffer

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-resources-buffers-index-how-to

Initializes an index buffer by filling a D3D11_BUFFER_DESC with D3D11_BIND_INDEX_BUFFER and a D3D11_SUBRESOURCE_DATA pointing to the index array, then calls ID3D11Device::CreateBuffer and binds the result with IASetIndexBuffer. Assumes g_pd3dDevice and g_pd3dContext are valid ID3D11Device and ID3D11DeviceContext objects.

```cpp
g_pd3dDevice
```

```cpp
g_pd3dContext
```

```cpp
ID3D11Buffer *g_pIndexBuffer = NULL;

// Create indices.
unsigned int indices[] = { 0, 1, 2 };

// Fill in a buffer description.
D3D11_BUFFER_DESC bufferDesc;
bufferDesc.Usage           = D3D11_USAGE_DEFAULT;
bufferDesc.ByteWidth       = sizeof( unsigned int ) * 3;
bufferDesc.BindFlags       = D3D11_BIND_INDEX_BUFFER;
bufferDesc.CPUAccessFlags  = 0;
bufferDesc.MiscFlags       = 0;

// Define the resource data.
D3D11_SUBRESOURCE_DATA InitData;
InitData.pSysMem = indices;
InitData.SysMemPitch = 0;
InitData.SysMemSlicePitch = 0;

// Create the buffer with the device.
hr = g_pd3dDevice->CreateBuffer( &bufferDesc, &InitData, &g_pIndexBuffer );
if( FAILED( hr ) )
    return hr;

// Set the buffer.
g_pd3dContext->IASetIndexBuffer( g_pIndexBuffer, DXGI_FORMAT_R32_UINT, 0 );
```

--------------------------------

### GetMatrix

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effectmatrixvariable

Gets a matrix from the effect variable.

```APIDOC
## GetMatrix

### Description
Gets a matrix.

### Syntax
```cpp
HRESULT GetMatrix(
  D3DXMATRIX *pMatrix
);
```

### Parameters
- **pMatrix** (D3DXMATRIX*) - Required - Pointer to the matrix to get.

### Return Value
Returns an HRESULT. If the method succeeds, the return value is S_OK. Otherwise, it returns an error code.

### Remarks
This method is part of the ID3DX11EffectMatrixVariable interface.
```

--------------------------------

### Compile vertex and pixel shaders with CompileShader

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/how-to--compile-a-shader

Complete example that compiles a vertex shader and a pixel shader using the CompileShader helper, which wraps D3DCompileFromFile. Requires the Windows SDK 8.0 and d3dcompiler_44.dll from the %PROGRAM_FILE%\Windows Kits\8.0\Redist\D3D\<arch> folder. Windows Store apps support run time compilation for development but not for deployment.

```cpp
#define _WIN32_WINNT 0x600
#include <stdio.h>

#include <d3dcompiler.h>

#pragma comment(lib,"d3dcompiler.lib")

HRESULT CompileShader( _In_ LPCWSTR srcFile, _In_ LPCSTR entryPoint, _In_ LPCSTR profile, _Outptr_ ID3DBlob** blob )
{
    if ( !srcFile || !entryPoint || !profile || !blob )
       return E_INVALIDARG;

    *blob = nullptr;

    UINT flags = D3DCOMPILE_ENABLE_STRICTNESS;
#if defined( DEBUG ) || defined( _DEBUG )
    flags |= D3DCOMPILE_DEBUG;
#endif

    const D3D_SHADER_MACRO defines[] = 
    {
        "EXAMPLE_DEFINE", "1",
        NULL, NULL
    };

    ID3DBlob* shaderBlob = nullptr;
    ID3DBlob* errorBlob = nullptr;
    HRESULT hr = D3DCompileFromFile( srcFile, defines, D3D_COMPILE_STANDARD_FILE_INCLUDE,
                                     entryPoint, profile,
                                     flags, 0, &shaderBlob, &errorBlob );
    if ( FAILED(hr) )
    {
        if ( errorBlob )
        {
            OutputDebugStringA( (char*)errorBlob->GetBufferPointer() );
            errorBlob->Release();
        }

        if ( shaderBlob )
           shaderBlob->Release();

        return hr;
    }    

    *blob = shaderBlob;

    return hr;
}

int main()
{
    // Compile vertex shader
    ID3DBlob *vsBlob = nullptr;
    HRESULT hr = CompileShader( L"BasicHLSL11_VS.hlsl", "VSMain", "vs_4_0_level_9_1", &vsBlob );
    if ( FAILED(hr) )
    {
        printf("Failed compiling vertex shader %08X\n", hr );
        return -1;
    }

    // Compile pixel shader
    ID3DBlob *psBlob = nullptr;
    hr = CompileShader( L"BasicHLSL11_PS.hlsl", "PSMain", "ps_4_0_level_9_1", &psBlob );
    if ( FAILED(hr) )
    {
        vsBlob->Release();
        printf("Failed compiling pixel shader %08X\n", hr );
        return -1;
    }

    printf("Success\n");

    // Clean up
    vsBlob->Release();
    psBlob->Release();

    return 0;
}

```

--------------------------------

### Create IDXGIFactory with CreateDXGIFactory

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-devices-enum

Initializes an IDXGIFactory object by calling CreateDXGIFactory. The factory is required to enumerate adapters. The code does not include error handling.

```cpp
IDXGIFactory * pFactory = NULL;

CreateDXGIFactory(__uuidof(IDXGIFactory) ,(void**)&pFactory)

```

--------------------------------

### GetDepthStencilArray

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effectdepthstencilviewvariable

Gets an array of depth-stencil-view resources.

```APIDOC
## GetDepthStencilArray

### Description
Gets an array of depth-stencil-view resources.

### Method
GetDepthStencilArray

### Parameters
None documented.

### Return Value
An array of depth-stencil-view resources.

### Remarks
This method is part of the ID3DX11EffectDepthStencilViewVariable interface.
```

--------------------------------

### ID3DX11EffectDepthStencilViewVariable::GetDepthStencil

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effectdepthstencilviewvariable-getdepthstencil

Gets a depth-stencil-view resource.

```APIDOC
## ID3DX11EffectDepthStencilViewVariable::GetDepthStencil

### Description
Gets a depth-stencil-view resource.

### Method
GetDepthStencil

### Syntax
```cpp
HRESULT GetDepthStencil(
   ID3D11DepthStencilView **ppResource
);
```

### Parameters
- **ppResource** (ID3D11DepthStencilView**) - Required - The address of a pointer to a depth-stencil-view interface. See **ID3D11DepthStencilView**.

### Return Value
Type: **HRESULT**
Returns one of the following Direct3D 11 Return Codes.

### Remarks
Note: The DirectX SDK does not supply any compiled binaries for effects. You must use Effects 11 source to build your effects-type application. For more information about using Effects 11 source, see Differences Between Effects 10 and Effects 11.

### Requirements
- Header: D3dx11effect.h
- Library: N/A (An Effects 11 library is available online as shared source.)

### See Also
- ID3DX11EffectDepthStencilViewVariable
```

--------------------------------

### D3DX11PreprocessShaderFromFile

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/d3dx11preprocessshaderfromfile

Documentation for the D3DX11PreprocessShaderFromFile function, including syntax, parameters, return value, and requirements.

```APIDOC
## D3DX11PreprocessShaderFromFile

### Description
Creates a shader from a file without compiling it. This function is deprecated; use D3DPreprocess instead.

### Syntax
```cpp
HRESULT D3DX11PreprocessShaderFromFile(
  _In_        LPCTSTR            pFileName,
  _In_  const D3D11_SHADER_MACRO *pDefines,
  _In_        LPD3D10INCLUDE     pInclude,
  _In_        ID3DX11ThreadPump  *pPump,
  _Out_       ID3D10Blob         **ppShaderText,
  _Out_       ID3D10Blob         **ppErrorMsgs,
  _Out_       HRESULT            *pHResult
);
```

### Parameters
- **pFileName** [in] (LPCTSTR) - Name of the shader file.
- **pDefines** [in] (const D3D11_SHADER_MACRO*) - A NULL-terminated array of shader macros; set to NULL to specify no macros.
- **pInclude** [in] (LPD3D10INCLUDE) - A pointer to an include interface; set to NULL to specify there is no include file.
- **pPump** [in] (ID3DX11ThreadPump*) - A pointer to a thread pump interface. Use NULL to specify that the function should not return until it is completed.
- **ppShaderText** [out] (ID3D10Blob**) - A pointer to memory that contains the uncompiled shader.
- **ppErrorMsgs** [out] (ID3D10Blob**) - The address of a pointer to memory that contains effect-creation errors, if any occurred.
- **pHResult** [out] (HRESULT*) - A pointer to the return value. May be NULL. If pPump is not NULL, then pHResult must be a valid memory location until the asynchronous execution completes.

### Return Value
Type: HRESULT
The return value is one of the values listed in Direct3D 11 Return Codes.

### Requirements
- Header: D3DX11async.h
- Library: D3DX11.lib

### Remarks
- The D3DX utility library is deprecated for Windows 8 and is not supported for Windows Store apps.
- Instead of using this function, use the D3DPreprocess API.
```

--------------------------------

### Finish and record the command list with ID3D11DeviceContext::FinishCommandList

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-render-multi-thread-command-list-record

Creates and records a command list by calling FinishCommandList on the deferred context. The boolean parameter FALSE means the deferred context state is not restored after recording. The resulting command list contains all the render commands.

```cpp
ID3D11CommandList* pd3dCommandList = NULL;
HRESULT hr;
hr = pDeferredContext->FinishCommandList(FALSE, &pd3dCommandList);

```

--------------------------------

### GetDepthStencilState

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/id3dx11effectdepthstencilvariable

Get a pointer to a depth-stencil interface.

```APIDOC
## GetDepthStencilState

### Description
Get a pointer to a depth-stencil interface.

### Method
GetDepthStencilState

### Parameters
None explicitly documented.

### Return Value
A pointer to a depth-stencil interface.

```

--------------------------------

### Set up a viewport with D3D11_VIEWPORT

Source: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-devices-initialize

Defines a viewport using the D3D11_VIEWPORT structure and sets it with ID3D11DeviceContext::RSSetViewports. The viewport determines which parts of the render target will be visible; this example uses a 640x480 viewport with full depth range.

```cpp
    // Setup the viewport
    D3D11_VIEWPORT vp;
    vp.Width = 640;
    vp.Height = 480;
    vp.MinDepth = 0.0f;
    vp.MaxDepth = 1.0f;
    vp.TopLeftX = 0;
    vp.TopLeftY = 0;
    g_pImmediateContext->RSSetViewports( 1, &vp );
```
Tokens:
Raw