Cg Core Runtime API                      cgGetParameterValueir(3)



NAME
     cgGetParameterValueir - get the value of any numeric
     parameter

SYNOPSIS
       #include 

       int cgGetParameterValueir( CGparameter param,
                                  int nelements,
                                  int * v );


PARAMETERS
     param   The parameter whose value will be retrieved.

     nelements
             The number of elements in array v.

     v       Destination buffer into which the parameter values
             will be written.

RETURN VALUES
     Returns the total number of values written to v.

DESCRIPTION
     cgGetParameterValueir allows the application to get the
     value(s) from any numeric parameter or parameter array.  The
     value(s) are returned as ints in v.

     The given parameter must be a scalar, vector, matrix, or a
     (possibly multidimensional) array of scalars, vectors, or
     matrices.

     Any matrices referenced by param will be copied in row-major
     order.

     The size of v is passed as nelements.  If v is smaller than
     the total number of values in the given source parameter,
     CGNOTENOUGHDATAEROR is generated.

     The total number of values in a parameter, ntotal, may be
     computed as follow:

         int nrows = cgGetParameterRows(param);
         int ncols = cgGetParameterColumns(param);
         int asize = cgGetArrayTotalSize(param);
         int ntotal = nrows*ncols;
         if (asize > 0) ntotal *= asize;


EXAMPLES
     to-be-written



Cg Toolkit 2.1            Last change:                          1






Cg Core Runtime API                      cgGetParameterValueir(3)



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

     CGINVALIDPOINTEREROR is generated if v is NUL.

     CGNOTENOUGHDATAEROR is generated if nelements is less
     than the total size of param.

     CGNONUMERICPARAMETEREROR is generated if param is of a
     non-numeric type.

HISTORY
     cgGetParameterValueir was introduced in Cg 1.4.

SEE ALSO
     cgGetParameterDefaultValueir, cgGetParameterValue,
     cgSetParameterValue, cgGetParameterRows,
     cgGetParameterColumns, cgGetArrayTotalSize




































Cg Toolkit 2.1            Last change:                          2