d3d9.dllGetLiteral
Microsoft DirectX 9.0 SDK Update (October 2004)

ID3DXEffectCompiler::GetLiteral Method


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

Syntax

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 Value

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 ID3DXEffectCompiler::SetBool or ID3DXEffectCompiler::SetValue.

See Also

Usages and Literals, ID3DXEffectCompiler::SetLiteral


© 2004 Microsoft Corporation. All rights reserved.
Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center.