NAME
cgGLGetParameterArray2f - get the values from an array parameter
SYNOPSIS
#include <Cg/cgGL.h> void cgGLGetParameterArray2f( CGparameter param, long offset, long nelements, const float * v );PARAMETERS
- param
The array parameter.
- offset
An offset into the array parameter from which to start getting. A value of 0 will start getting from the first element of the array.
- nelements
The number of elements to get. A value of 0 will default to the number of elements in the array minus the offset value.
- v
Destination buffer into which the parameter values will be written. The size of the array must be 2 * nelements.
RETURN VALUES
None.
DESCRIPTION
cgGLGetParameterArray2f retrieves an array of values from a given scalar or vector array parameter.
The function will retrieve either 2 values per array element.
EXAMPLES
to-be-written
ERRORS
CG_INVALID_PROFILE_ERROR is generated if param's profile is not a supported OpenGL profile.
CG_ARRAY_PARAM_ERROR is generated if param is not an array parameter.
CG_OUT_OF_ARRAY_BOUNDS_ERROR is generated if the offset and/or the nelements parameter are out of the array bounds.
CG_INVALID_PARAM_HANDLE_ERROR is generated if param is not a valid parameter handle.
CG_INVALID_PARAMETER_ERROR is generated if the parameter fails to set for any other reason.
HISTORY
cgGLGetParameterArray2f was introduced in Cg 1.1.
SEE ALSO