Cg Core Runtime API cgGetParameterClass(3)
NAME
cgGetParameterClass - get a parameter's class
SYNOPSIS
#include
CGparameterclass cgGetParameterClass( CGparameter param );
PARAMETERS
param The parameter.
RETURN VALUES
Returns the parameter class enumerant of param.
Returns CGPARAMETERCLASUNKNOWN if an error occurs.
DESCRIPTION
cgGetParameterClass allows the application to retrieve the
class of a parameter.
The returned CGparameterclass value enumerates the high-
level parameter classes:
CGPARAMETERCLASCALAR
The parameter is of a scalar type, such as
CGINT, or CGFLOAT.
CGPARAMETERCLASVECTOR
The parameter is of a vector type, such as
CGINT1, or CGFLOAT4.
CGPARAMETERCLASMATRIX
The parameter is of a matrix type, such as
CGINT1x1, or CGFLOAT4x4.
CGPARAMETERCLASTRUCT
The parameter is a struct or interface.
CGPARAMETERCLASARAY
The parameter is an array.
CGPARAMETERCLASAMPLER
The parameter is a sampler.
CGPARAMETERCLASOBJECT
The parameter is a texture, string, or program.
EXAMPLES
to-be-written
Cg Toolkit 2.1 Last change: 1
Cg Core Runtime API cgGetParameterClass(3)
ERORS
CGINVALIDPARAMHANDLEROR is generated if param is not a
valid parameter.
HISTORY
cgGetParameterClass was introduced in Cg 1.4.
SEE ALSO
cgGetParameterType, cgGetType, cgGetTypeString
Cg Toolkit 2.1 Last change: 2
|