Cg Core Runtime API                         cgDestroyParameter(3)



NAME
     cgDestroyParameter - destroy a parameter

SYNOPSIS
       #include 

       void cgDestroyParameter( CGparameter param );


PARAMETERS
     param   The parameter to destroy.

RETURN VALUES
     None.

DESCRIPTION
     cgDestroyParameter destroys parameters created with
     cgCreateParameter, cgCreateParameterArray, or
     cgCreateParameterMultiDimArray.

     Upon destruction, param will become invalid.  Any
     connections (see cgConnectParameter) in which param is the
     destination parameter will be disconnected.  An error will
     be thrown if param is a source parameter in any connections.

     The parameter being destroyed may not be one of the children
     parameters of a struct or array parameter.  In other words
     it must be a CGparameter returned by one of the
     cgCreateParameter family of entry points.

EXAMPLES
       CGcontext context = cgCreateContext();
       CGparameter floatParam = cgCreateParameter(context, CGFLOAT);
       CGparameter floatParamArray = cgCreateParameterArray(context, CGFLOAT, 5);

       /* ... */

       cgDestroyParameter(floatParam);
       cgDestroyParameter(floatParamArray);


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

     CGNOTROTPARAMETEREROR is generated if the param isn't
     the top-level parameter of a struct or array that was
     created.

     CGPARAMETERISNOTSHAREDEROR is generated if param does
     not refer to a parameter created by one of the
     cgCreateParameter family of entry points.



Cg Toolkit 2.1            Last change:                          1






Cg Core Runtime API                         cgDestroyParameter(3)



     CGCANOTDESTROYPARAMETEREROR is generated if param is a
     source parameter in a connection made by cgConnectParameter.
     cgDisconnectParameter should be used before calling
     cgDestroyParameter in such a case.

HISTORY
     cgDestroyParameter was introduced in Cg 1.2.

SEE ALSO
     cgCreateParameter, cgCreateParameterArray,
     cgCreateParameterMultiDimArray












































Cg Toolkit 2.1            Last change:                          2