Edit

Share via

D3DPreprocess function (d3dcompiler.h)

  • Article

Preprocesses uncompiled HLSL code.

Syntax

HRESULT D3DPreprocess(
  [in]            LPCVOID                pSrcData,
  [in]            SIZE_T                 SrcDataSize,
  [in, optional]  LPCSTR                 pSourceName,
  [in, optional]  const D3D_SHADER_MACRO *pDefines,
  [in, optional]  ID3DInclude            *pInclude,
  [out]           ID3DBlob               **ppCodeText,
  [out, optional] ID3DBlob               **ppErrorMsgs
);

Parameters

[in] pSrcData

Type: LPCVOID

A pointer to uncompiled shader data; either ASCII HLSL code or a compiled effect.

[in] SrcDataSize

Type: SIZE_T

Length of pSrcData.

[in, optional] pSourceName

Type: LPCSTR

The name of the file that contains the uncompiled HLSL code.

[in, optional] pDefines

Type: const D3D_SHADER_MACRO*

An array of NULL-terminated macro definitions (see D3D_SHADER_MACRO).

[in, optional] pInclude

Type: ID3DInclude*

A pointer to an ID3DInclude for handling include files. Setting this to NULL will cause a compile error if a shader contains a #include. You can pass the D3D_COMPILE_STANDARD_FILE_INCLUDE macro, which is a pointer to a default include handler. This default include handler includes files that are relative to the current directory and files that are relative to the directory of the initial source file. When you use D3D_COMPILE_STANDARD_FILE_INCLUDE, you must specify the source file name in the pSourceName parameter; the compiler will derive the initial relative directory from pSourceName.

#define D3D_COMPILE_STANDARD_FILE_INCLUDE ((ID3DInclude*)(UINT_PTR)1)

[out] ppCodeText

Type: ID3DBlob**

A pointer to a variable that receives a pointer to the ID3DBlob interface that you can use to access the preprocessed code.

[out, optional] ppErrorMsgs

Type: ID3DBlob**

A pointer to an ID3DBlob that contains compiler error messages, or NULL if there were no errors.

Return value

Type: HRESULT

Returns one of the Direct3D 11 return codes.

Remarks

D3DPreprocess outputs #line directives and preserves line numbering of source input so that output line numbering can be properly related to the input source.

Requirements

Requirement Value
Target Platform Windows
Header d3dcompiler.h
Library D3dcompiler_47.lib
DLL D3dcompiler_47.dll

See also

Functions