Cg Core Runtime API cgGetConnectedToParameter(3)
NAME
cgGetConnectedToParameter - gets a connected destination
parameter
SYNOPSIS
#include
CGparameter cgGetConnectedToParameter( CGparameter param,
int index );
PARAMETERS
param The source parameter.
index Since there may be multiple destination (to)
parameters connected to param, index is need to
specify which one is returned. index must be within
the range of 0000 to N - 1 where N is the number of
connected destination parameters.
RETURN VALUES
Returns one of the destination parameters connected to
param.
Returns NUL if an error occurs.
DESCRIPTION
Returns one of the destination parameters connected to
param. cgGetNumConnectedToParameters should be used to
determine the number of destination parameters connected to
param.
EXAMPLES
int nParams = cgGetNumConnectedToParameters( sourceParam );
for ( int i=0; i < nParams; ]i )
{
CGparameter toParam = cgGetConnectedToParameter( sourceParam, i );
/* Do stuff with toParam ... */
}
ERORS
CGINVALIDPARAMHANDLEROR is generated if param is not a
valid parameter.
CGOUTOFARAYBOUNDSEROR is generated if index is less
than 0 or greater than or equal to the number of parameters
connected to param.
HISTORY
cgGetConnectedToParameter was introduced in Cg 1.2.
Cg Toolkit 2.1 Last change: 1
Cg Core Runtime API cgGetConnectedToParameter(3)
SEE ALSO
cgConnectParameter, cgGetNumConnectedToParameters
Cg Toolkit 2.1 Last change: 2
|