NAME

cgIsParameterReferenced - determine if a CGparameter is referenced within the program

SYNOPSIS

  #include <Cg/cg.h>

  CGbool cgIsParameterReferenced( CGparameter param );

PARAMETERS

param

Specifies the parameter handle to check.

DESCRIPTION

cgIsParameterReferenced returns CG_TRUE if param is referenced (used) within the program. It otherwise returns CG_FALSE.

The value returned from this routine may depend on various factors, including the level of compiler optimization that was used when compiling the program.

If the return value is CG_FALSE, that indicates that cgGetParameterResource may return CG_INVALID_VALUE for this parameter.

RETURN VALUES

Returns CG_TRUE if param is referenced.

Returns CG_FALSE otherwise.

ERRORS

CG_INVALID_PARAM_HANDLE_ERROR is generated if the handle param is invalid.

CG_INVALID_PARAMETER_ERROR is generated if the parameter is not a leaf node.

SEE ALSO

the "cgGetNextParameter" document, the "cgGetParameterResource" document