D3DXCreateEffectFromFile

Create an effect from an ASCII or binary effect description.

HRESULT D3DXCreateEffectFromFile(
  LPDIRECT3DDEVICE9 pDevice,
  LPCTSTR pSrcFile,
  CONST D3DXMACRO * pDefines,
  LPD3DXINCLUDE pInclude,
  DWORD Flags,
  LPD3DXEFFECTPOOL pPool,
  LPD3DXEFFECT * ppEffect,
  LPD3DXBUFFER * ppCompilationErrors
);

Parameters

pDevice

[in] Pointer to the device that will create the effect. See IDirect3DDevice9.

pSrcFile

[in] Pointer to the filename. This parameter supports both Unicode and ANSI strings. See Remarks.

pDefines

[in] Optional NULL-terminated array of preprocessor macro definitions. See D3DXMACRO.

pInclude

[in] Optional interface pointer, ID3DXInclude, to use for handling #include directives. If this value is NULL, #includes will either be honored when compiling from a file or will cause an error when compiled from a resource or memory.

Flags

[in] If pSrcFile contains a text effect, flags can be a combination of D3DXSHADER Flags and D3DXFX flags; otherwise, pSrcFile contains a binary effect and the only flags honored are D3DXFX flags.

pPool

[in] Pointer to a ID3DXEffectPool object to use for shared parameters. If this value is NULL, no parameters will be shared.

ppEffect

[out] Returns a pointer to a buffer containing the compiled effect. See ID3DXEffect.

ppCompilationErrors

[out] Returns a pointer to a buffer containing a listing of compile errors. See ID3DXBuffer.

Return Values

If the function succeeds, the return value is D3D_OK. If the function fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DXERR_INVALIDDATA.

Remarks

If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the LPCTSTR data type resolves to LPCSTR.

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to D3DXCreateEffectFromFileW. Otherwise, the function call resolves to D3DXCreateEffectFromFileA because ANSI strings are being used.

Requirements

Header: Declared in D3dx9effect.h.

See Also

D3DXCompileShader, D3DXCompileShaderFromResource