NAME

cgGetArrayDimension - get the dimension of an array parameter

SYNOPSIS

  #include <Cg/cg.h>

  int cgGetArrayDimension( CGparameter param );

PARAMETERS

param

Specifies the array parameter handle.

DESCRIPTION

cgGetArrayDimension returns the dimension of the array specified by param. This function is used when inspecting an array parameter in a program.

RETURN VALUES

Returns the dimension of param if param references an array.

Returns 0 otherwise.

ERRORS

CG_INVALID_PARAM_HANDLE_ERROR is generated if param is invalid.

CG_ARRAY_PARAM_ERROR is generated if the handle param does not refer to an array parameter.

SEE ALSO

the "cgGetNextParameter" document, the "cgGetArraySize" document, and the "cgGetArrayParameter" document