NAME

cgGetEffectParameterBySemantic - get the a parameter in an effect via its semantic

SYNOPSIS

  #include <Cg/cg.h>

  CGparameter cgGetEffectParameterBySemantic( CGeffect effect, const char *semantic );

PARAMETERS

effect

Specifies the effect to retrieve the parameter from.

semantic

Specifies the name of the semantic.

DESCRIPTION

cgGetEffectParameterBySemantic returns the parameter in an effect with the given semantic associated with it. It more than one parameter in the effect has the same semantic, an arbitrary one of them will be returned.

RETURN VALUES

cgGetEffectParameterBySemantic returns a CGparameter object in effect that has the given semantic. NULL is returned if effect is invalid or if effect does not have any parameters with the given semantic.

ERRORS

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

CG_INVALID_PARAMETER_ERROR is generated if semantic is NULL or the empty string.

SEE ALSO

the "cgGetNamedEffectParameter" document