NAME

cgGLGetMatrixParameter - retrieves the value of matrix parameters

SYNOPSIS

  #include <Cg/cgGL.h>

  /* type is either float or double */
  void cgGLGetMatrixParameter{fd}{rc}(CGparameter param, const type *matrix);

PARAMETERS

param

Specifies the parameter that will be retrieved.

matrix

An array to retrieve the matrix parameter to. The array must be the number of rows times the number of columns in size.

DESCRIPTION

The cgGLGetMatrixParameter functions retrieve the value of a given matrix 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.

The cgGLGetMatrixParameter functions may only be called with uniform parameters.

RETURN VALUES

The cgGLGetMatrixParameter functions do not return any values.

ERRORS

CG_INVALID_PROFILE_ERROR is generated if param's profile is not a supported OpenGL profile.

CG_NOT_MATRIX_PARAM_ERROR is generated if param is not a matrix parameter.

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

the "cgGLGetMatrixParameterArray" document, the "cgGLSetMatrixParameterArray" document and the "cgGLSetParameter" document