Edit

Share via


dxcapi.h header

This header is used by Reference for HLSL. For more info, see:

dxcapi.h contains the following programming interfaces:

Functions

 
DxcCreateInstance

Creates a single uninitialized object of the class associated with a specified CLSID.
DxcCreateInstance2

Creates a single uninitialized object of the class associated with a specified CLSID (can be used to create an instance of the compiler with a custom memory allocator).

Callback functions

 
DxcCreateInstance2Proc

The DxcCreateInstance2Proc typedef is provided to make it more convenient for you to use GetProcAddress to call DxcCreateInstance2.
DxcCreateInstanceProc

The DxcCreateInstanceProc typedef is provided to make it more convenient for you to use GetProcAddress to call DxcCreateInstance.

Structures

 
DxcArgPair

TBD
DxcDefine

Structure for supplying defines to Dxc APIs.
DxcShaderHash

Hash digest type for ShaderHash.
DxcText

Structure for supplying bytes or text input to Dxc APIs.
IDxcAssembler

Interface representing the DxcAssembler.
IDxcBlob

A sized buffer that can be passed into and out of DXC APIs. IDxcBlob is an alias of ID3D10Blob and ID3DBlob.
IDxcBlobEncoding

A blob that might have a known encoding.
IDxcBlobUtf8

TBD
IDxcCompiler

IDxcCompiler is deprecated; use IDxcCompiler3 instead.
IDxcCompiler2

IDxcCompiler2 is deprecated; use IDxcCompiler3 instead.
IDxcCompiler3

Interface that represents the DirectX Shader Compiler.
IDxcCompilerArgs

An interface for managing arguments passed to DXC.
IDxcContainerBuilder

Interface representing the DXC container builder.
IDxcContainerReflection

Interface representing DxcContainerReflection.
IDxcExtraOutputs

Represents additional outputs from a DXC operation.
IDxcIncludeHandler

Interface for handling include directives. To customize the handling of include directives, you can provide an implementation of this interface.
IDxcLibrary

IDxcUtils replaces IDxcLibrary; use IDxcUtils insted.
IDxcLinker

The DXC linker interface.
IDxcOperationResult

The results of a DXC operation. IDxcResult replaces IDxcOperationResult, and should be used wherever possible.
IDxcOptimizer

Interface representing DxcOptimizer.
IDxcOptimizerPass

Interface representing an optimizer pass.
IDxcPdbUtils

Represents PDB version information.
IDxcResult

Represents the result of a DXC operation. A DXC operation might have multiple outputs, such as a shader object and errors. This interface provides access to the outputs.
IDxcUtils

Various utility functions for DXC.
IDxcValidator

Interface representing the DXC shader validator.
IDxcValidator2

Interface representing the DXC shader validator.
IDxcVersionInfo

Represents PDB version information.
IDxcVersionInfo2

Represents PDB version information.
IDxcVersionInfo3

Represents PDB version information.

Enumerations

 
DXC_OUT_KIND

Specifies the kind of output to retrieve from an IDxcResult.