NAME

cgGLGetMatrixParameterArraydr - get the values from a matrix array parameter

SYNOPSIS

  #include <Cg/cgGL.h>

  void cgGLGetMatrixParameterArraydr( CGparameter param,
                                      long offset,
                                      long nelements,
                                      double * 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

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

RETURN VALUES

None.

DESCRIPTION

cgGLGetMatrixParameterArraydr retrieves an array of values in row-major order from a given matrix array parameter.

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_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.

HISTORY

cgGLGetMatrixParameterArraydr was introduced in Cg 1.1.

SEE ALSO

cgGLGetParameter, cgGLSetParameter, cgGLSetParameterArray