Cg Core Runtime API                    cgIsParameterReferenced(3)



NAME
     cgIsParameterReferenced - determine if a program parameter
     is potentially referenced

SYNOPSIS
       #include 

       CGbool cgIsParameterReferenced( CGparameter param );


PARAMETERS
     param   The handle of the parameter to check.

RETURN VALUES
     Returns CGTRUE if param is a program parameter and is
     potentially referenced by the program.

     Returns CGFALSE otherwise.

DESCRIPTION
     cgIsParameterReferenced returns CGTRUE if param is a
     program parameter, and is potentially referenced (used)
     within the program.  It otherwise returns CGFALSE.

     Program parameters are those parameters associated directly
     with a CGprogram, whose handles are retrieved by calling,
     for example, cgGetNamedProgramParameter.

     The value returned by cgIsParameterReferenced is
     conservative, but not always exact.  A return value of
     CGTRUE indicates that the parameter may be used by its
     associated program.  A return value of CGFALSE indicates
     that the parameter is definintely not referenced by the
     program.

     If param is an aggregate program parameter (a struct or
     array), CGTRUE is returned if any of param's children are
     potentially referenced by the program.

     If param is a leaf parameter and the return value is
     CGFALSE, cgGetParameterResource may return CGINVALIDVALUE
     for this parameter.

EXAMPLES
     to-be-written

ERORS
     CGINVALIDPARAMHANDLEROR is generated if param is not a
     valid parameter.

HISTORY
     cgIsParameterReferenced was introduced in Cg 1.1.



Cg Toolkit 2.1            Last change:                          1






Cg Core Runtime API                    cgIsParameterReferenced(3)



SEE ALSO
     cgGetNamedProgramParameter, cgIsParameterUsed,
     cgGetParameterResource




















































Cg Toolkit 2.1            Last change:                          2