NAME

cgGLGetParameterArray - retrieaves an array matrix parameters

SYNOPSIS

  #include <Cg/cgGL.h>

  /* type is either float or double */

  void cgGLGetMatrixParameterArray{fd}{rc}(CGparameter param,
                                           long offset,
                                           long nelements,
                                           const type *v);

PARAMETERS

param

Specifies the array parameter.

offset

An offset into the array parameter to start getting from. 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

The array retrieve the values into. The size of the array must be nelements times the number of elements in the matrix.

DESCRIPTION

The cgGLGetMatrixParameterArray functions retrieve an array of values from a give matrix array parameter. The functions are available in various combinations.

There are versions of each function that take either float or double values signified by the f or d in the function name.

There are versions of each function that assume the array of values are layed out in either row or column order signified by the r or c in the function name respectively.

There are versions of each function that assume the array of values are layed out in either row or column order signified by the r or c in the function name respectively.

RETURN VALUES

The cgGLGetParameter functions do not return any values.

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_NOT_MATRIX_PARAM_ERROR is generated if the elements of the array indicated by param are not matrix parameters.

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 retrieve for any other reason.

SEE ALSO

cgGLGetParameter, cgGLSetParameter, and cgGLSetParameterArray