NAME

cgGetParameterClass - get a parameter's class

SYNOPSIS

  #include <Cg/cg.h>

  CGparameterclass cgGetParameterClass( CGparameter param );

PARAMETERS

param

Specifies the parameter.

DESCRIPTION

cgGetParameterClass allows the application to retrieve the class of a parameter.

The returned CGparameterclass value enumerates the high-level paramater classes:

CG_PARAMETERCLASS_SCALAR

The parameter if of a scalar type, such as CG_INT, or CG_FLOAT.

CG_PARAMETERCLASS_VECTOR

The parameter is of a vector type, such as CG_INT1, or CG_FLOAT4.

CG_PARAMETERCLASS_MATRIX

The parameter is of a matrix type, such as CG_INT1x1, or CG_FLOAT4x4.

CG_PARAMETERCLASS_STRUCT

The parameter is a struct or interface.

CG_PARAMETERCLASS_ARRAY

The parameter is an array.

CG_PARAMETERCLASS_SAMPLER

The parameter is a sampler.

CG_PARAMETERCLASS_OBJECT

The parameter is a texture, string, or program.

RETURN VALUES

Returns the parameter class enumerant of param. If an error occurs, CG_PARAMETERCLASS_UNKNOWN will be returned.

ERRORS

CG_INVALID_PARAM_HANDLE_ERROR is generated if param does not refer to a valid parameter.

SEE ALSO

the "cgGetParameterType" document, the "cgGetType" document, the "cgGetTypeString" document