Cg Core Runtime API cgSetParameterVariability(3)
NAME
cgSetParameterVariability - set a parameter's variability
SYNOPSIS
#include
void cgSetParameterVariability( CGparameter param,
CGenum vary );
PARAMETERS
param The parameter.
vary The variability to which param will be set.
RETURN VALUES
None.
DESCRIPTION
cgSetParameterVariability allows the application to change
the variability of a parameter.
Currently parameters may not be changed to or from
CGVARYING variability. However parameters of CGUNIFORM
and CGLITERAL variability may be changed.
Valid values for vary include :
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 will often make a
program more efficient at the expense of requiring a
compile every time the value is set.
CGDEFAULT
By default, the variability of a parameter will be
overridden by the a source parameter connected to it
unless it is changed with cgSetParameterVariability. If
it is set to CGDEFAULT it will restore the default
state of assuming the source parameters variability.
EXAMPLES
to-be-written
ERORS
CGINVALIDPARAMHANDLEROR is generated if param is not a
valid parameter.
Cg Toolkit 2.1 Last change: 1
Cg Core Runtime API cgSetParameterVariability(3)
CGINVALIDENUMERANTEROR is generated if vary is not
CGUNIFORM, CGLITERAL, or CGDEFAULT.
CGINVALIDPARAMETERVARIABILITYEROR is generated if the
parameter could not be changed to the variability indicated
by vary.
CGINVALIDPARAMETERTYPEROR is generated if vary is
CGLITERAL and param is a not a numeric parameter.
HISTORY
cgSetParameterVariability was introduced in Cg 1.2.
SEE ALSO
cgGetParameterVariability
Cg Toolkit 2.1 Last change: 2
|