Edit

Share via

IDxcCompiler2::CompileWithDebug function (dxcapi.h)

  • Article

Compile a single entry point to the target shader model with debug information. IDxcCompiler::CompileWithDebug is deprecated; use IDxcCompiler3::Compile instead.

Syntax

HRESULT CompileWithDebug(
  IDxcBlob            *pSource,
  LPCWSTR             pSourceName,
  LPCWSTR             pEntryPoint,
  LPCWSTR             pTargetProfile,
  LPCWSTR             *pArguments,
  UINT32              argCount,
  const DxcDefine     *pDefines,
  UINT32              defineCount,
  IDxcIncludeHandler  *pIncludeHandler,
  IDxcOperationResult **ppResult,
  LPWSTR              *ppDebugBlobName,
  IDxcBlob            **ppDebugBlob
);

Parameters

pSource

The source text to compile.

pSourceName

An optional file name for pSource. Used in errors and include handlers.

pEntryPoint

Entry point name.

pTargetProfile

Shader profile to compile.

pArguments

An array of pointers to arguments.

argCount

The number of arguments.

pDefines

An array of defines.

defineCount

The number of defines.

pIncludeHandler

An optional user-provided interface to handle #include directives.

ppResult

The compiler output status, buffer, and errors.

ppDebugBlobName

A suggested file name for the debug blob. You must free this memory by using CoTaskMemFree.

ppDebugBlob

The debug blob.

Requirements

Requirement Value
Header dxcapi.h