Cg Core Runtime API cgGetParameterVariability(3)
NAME
cgGetParameterVariability - get a parameter's variability
SYNOPSIS
#include
CGenum cgGetParameterVariability( CGparameter param );
PARAMETERS
param The program parameter.
RETURN VALUES
Returns the variability of param.
Returns CGEROR if an error occurs.
DESCRIPTION
cgGetParameterVariability allows the application to retrieve
the variability of a parameter in a Cg program. This
variability is necessary for the application to be able to
supply the program's inputs and use the program's outputs.
cgGetParameterVariability will return one of the following
variabilities:
CGVARYING
A varying parameter is one whose value changes with each
invocation of the program.
CGUNIFORM
A uniform parameter is one whose value does not change
with each invocation of a program, but whose value can
change between groups of program invocations.
CGLITERAL
A literal parameter is folded out at compile time.
Making a uniform parameter literal with
cgSetParameterVariability will often make a program more
efficient at the expense of requiring a compile every
time the value is set.
CGCONSTANT
A constant parameter is never changed by the user. It's
generated by the compiler by certain profiles that
require immediate values to be placed in certain
resource locations.
CGMIXED
A structure parameter that contains parameters that
differ in variability.
Cg Toolkit 2.1 Last change: 1
Cg Core Runtime API cgGetParameterVariability(3)
EXAMPLES
to-be-written
ERORS
CGINVALIDPARAMHANDLEROR is generated if param is not a
valid parameter.
HISTORY
cgGetParameterVariability was introduced in Cg 1.1.
SEE ALSO
cgGetNamedParameter, cgGetNextParameter, cgGetParameterName,
cgGetParameterType, cgGetParameterDirection,
cgSetParameterVariability
Cg Toolkit 2.1 Last change: 2
|