NAME

cgIsParameter - determine if a CGparameter references a valid Cg parameter object

SYNOPSIS

  #include <Cg/cg.h>

  CGbool cgIsParameter( CGparameter param );

PARAMETERS

param

Specifies the parameter handle to check.

DESCRIPTION

cgIsParameter returns CG_TRUE if param references a valid parameter object. This function is typically used for iterating through the parameters of an object. It can also be used as a consistency check when the application caches CGparameter handles. Certain program operations like deleting the program or context object that the parameter is contained in will cause a parameter object to become invalid.

RETURN VALUES

Returns CG_TRUE if param references a valid parameter object.

Returns CG_FALSE otherwise.

ERRORS

SEE ALSO

the "cgGetNextParameter" document