ID3DXEffectCompiler::GetLiteral

Gets a literal status of a parameter. A literal parameter has a value that doesn't change during the lifetime of an effect.

HRESULT GetLiteral(
  D3DXHANDLE hParameter,
  BOOL* pLiteral
);

Parameters

hParameter
[in] Unique identifier to a parameter. See Handles.
pLiteral
[out] Returns True if the parameter is a literal, and False otherwise.

Return Values

If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

This methods only changes whether the parameter is a literal or not. To change the value of a parameter, use a method like ID3DXBaseEffect::SetBool or ID3DXBaseEffect::SetValue.

Requirements

Header: Declared in D3dx9shader.h.

See Also

Usages and Literals, ID3DXEffectCompiler::SetLiteral