NAME

cgGetFirstEffectParameter - get the first parameter in an effect

SYNOPSIS

  #include <Cg/cg.h>

  CGparameter cgGetFirstEffectParameter( CGeffect effect );

PARAMETERS

effect

The effect from which to retrieve the first parameter.

RETURN VALUES

cgGetFirstEffectParameter returns a the first CGparameter object in effect. NULL is returned if effect is invalid or if effect does not have any parameters.

DESCRIPTION

cgGetFirstEffectParameter returns the first top-level parameter in an effect. cgGetFirstEffectParameter is used for recursing through all parameters in an effect. See cgGetNextParameter for more information on parameter traversal.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_EFFECT_HANDLE_ERROR is generated if effect does not refer to a valid effect.

HISTORY

cgGetFirstEffectParameter was introduced in Cg 1.4.

SEE ALSO

cgNextParameter