D3DPreprocess

Preprocesses uncompiled HLSL code.

Syntax

HRESULT D3DPreprocess(
         LPCVOID pSrcData,
         SIZE_T SrcDataSize,
         LPCSTR pSourceName,
         const D3D_SHADER_MACRO *pDefines,
         ID3DInclude *pInclude,
         ID3DBlob **ppCodeText,
         ID3DBlob **ppErrorMsgs
)  

Parameters

pSrcData
Type: LPCVOID 

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

SrcDataSize
Type: SIZE_T 

[in] Length of pSrcData.

pSourceName
Type: LPCSTR 

[in, optional] Optional. The name of the file that contains the uncompiled HLSL code.

pDefines
Type: D3D_SHADER_MACRO *

[in, optional] Optional. An array of NULL-terminated macro definitions (see D3D_SHADER_MACRO).

pInclude
Type: ID3DInclude *

[in, optional] Optional. 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)  

ppCodeText
Type: ID3DBlob **

[out] The address of a ID3DBlob that contains the compiled code.

ppErrorMsgs
Type: ID3DBlob **

[out, optional] Optional. 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 10 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

Header: Declared in d3dcompiler.h.

Library: Use d3d11.lib.