NAME

cgGetMatrixSize - get the size of one dimension of an array parameter

SYNOPSIS

  #include <Cg/cg.h>

  void cgGetMatrixSize( CGtype type,
                        int * nrows,
                        int * ncols );

PARAMETERS

type

The type enumerant.

nrows

A pointer to the location the routine will write the number of rows the type has.

ncols

A pointer to the location the routine will write the number of columns the type has.

RETURN VALUES

None.

DESCRIPTION

cgGetMatrixSize writes the number of rows and columns the specified type enumerant has into the specified nrows and ncols locations respectively. If the type enumerant is not a matrix type, zeros are written for both the rows and columns.

Contrast this routine with cgGetTypeSizes where the number of rows and columns will be set to 1 row and 1 column for both scalar and non-numeric types but for vector types, the number of rows and columns will be set to 1 row and N columns where N is the number of components in the vector.

EXAMPLES

to-be-written

ERRORS

cgGetMatrixSize does not generate any errors.

HISTORY

cgGetMatrixSize was introduced in Cg 1.5.

SEE ALSO

cgGetArrayTotalSize, cgGetArrayDimension, cgGetArrayParameter, cgGetTypeSizes