NAME

cgGetFloatAnnotationValues - get a float-valued annotation's values

SYNOPSIS

  #include <Cg/cg.h>

  const float * cgGetFloatAnnotationValues( CGannotation ann,
                                            int * nvalues );

PARAMETERS

ann

The annotation from which the values will be retrieved.

nvalues

Pointer to integer where the number of values returned will be stored.

RETURN VALUES

Returns a pointer to an array of float values. The number of values in the array is returned via the nvalues parameter.

If no values are available, NULL will be returned and nvalues will be 0.

DESCRIPTION

cgFloatAnnotationValues allows the application to retrieve the value(s) of a floating-point typed annotation.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if the handle ann is invalid.

CG_INVALID_PARAMETER_ERROR is generated if nvalues is NULL.

HISTORY

cgGetFloatAnnotationValues was introduced in Cg 1.4.

SEE ALSO

cgGetAnnotationType, cgGetIntAnnotationValues, cgGetStringAnnotationValues, cgGetBooleanAnnotationValues