<HTML>
<HEAD>
<TITLE>cgGetParameterVariability</TITLE>
<STYLE TYPE="text/css" MEDIA=screen>
<!--
BODY {
font-family: Arial,Helvetica;
}
BLOCKQUOTE { margin: 10pt; }
H1,A { color: #336699; }
/*** Top menu style ****/
.mmenuon {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #ff6600; font-size: 10pt;
}
.mmenuoff {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #ffffff; font-size: 10pt;
}
.cpyright {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #ffffff; font-size: xx-small;
}
.cpyrightText {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #ffffff; font-size: xx-small;
}
.sections {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: 11pt;
}
.dsections {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: 12pt;
}
.slink {
font-family: Arial,Helvetica; font-weight: normal; text-decoration: none;
color: #336699; font-size: 9pt;
}
.slink2 { font-family: Arial,Helvetica; text-decoration: none; color: #336699; }
.maintitle {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: 18pt;
}
.dblArrow {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: small;
}
.menuSec {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: small;
}
.newstext {
font-family: Arial,Helvetica; font-size: small;
}
.linkmenu {
font-family: Arial,Helvetica; color: #000000; font-weight: bold;
text-decoration: none;
}
P {
font-family: Arial,Helvetica;
}
PRE {
font-family: monospace;
white-space: pre;
font-color: #333333;
font-weight: 100;
background-color: #eeeeee;
padding: 5px;
width: 90%;
border-style: solid;
border-width: 2px;
border-color: #bebebe;
}
.quote {
font-family: Times; text-decoration: none;
color: #000000; font-size: 9pt; font-style: italic;
}
.smstd { font-family: Arial,Helvetica; color: #000000; font-size: x-small; }
.std { font-family: Arial,Helvetica; color: #000000; }
.meerkatTitle {
font-family: sans-serif; font-size: x-small; color: black; }
.meerkatDescription { font-family: sans-serif; font-size: 10pt; color: black }
.meerkatCategory {
font-family: sans-serif; font-size: 9pt; font-weight: bold; font-style: italic;
color: brown; }
.meerkatChannel {
font-family: sans-serif; font-size: 9pt; font-style: italic; color: brown; }
.meerkatDate { font-family: sans-serif; font-size: xx-small; color: #336699; }
.tocTitle {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #333333; font-size: 10pt;
}
.toc-item {
font-family: Arial,Helvetica; font-weight: bold;
color: #336699; font-size: 10pt; text-decoration: underline;
}
.perlVersion {
font-family: Arial,Helvetica; font-weight: bold;
color: #336699; font-size: 10pt; text-decoration: none;
}
.docTitle {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #000000; font-size: 10pt;
}
.dotDot {
font-family: Arial,Helvetica; font-weight: bold;
color: #000000; font-size: 9pt;
}
.docSec {
font-family: Arial,Helvetica; font-weight: normal;
color: #333333; font-size: 9pt;
}
.docVersion {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: 10pt;
}
.docSecs-on {
font-family: Arial,Helvetica; font-weight: normal; text-decoration: none;
color: #ff0000; font-size: 10pt;
}
.docSecs-off {
font-family: Arial,Helvetica; font-weight: normal; text-decoration: none;
color: #333333; font-size: 10pt;
}
h3 {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: small;
}
h2 {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: medium;
}
h1 {
font-family: Verdana,Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: large;
}
DL {
font-family: Arial,Helvetica; font-weight: normal; text-decoration: none;
color: #333333; font-size: 10pt;
}
UL > LI > A {
font-family: Arial,Helvetica; font-weight: bold;
color: #336699; font-size: 10pt;
}
.moduleInfo {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #333333; font-size: 11pt;
}
.moduleInfoSec {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: 10pt;
}
.moduleInfoVal {
font-family: Arial,Helvetica; font-weight: normal; text-decoration: underline;
color: #000000; font-size: 10pt;
}
.cpanNavTitle {
font-family: Arial,Helvetica; font-weight: bold;
color: #ffffff; font-size: 10pt;
}
.cpanNavLetter {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #333333; font-size: 9pt;
}
.cpanCat {
font-family: Arial,Helvetica; font-weight: bold; text-decoration: none;
color: #336699; font-size: 9pt;
}
-->
</STYLE>
</HEAD>
<BODY>
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
</object>
<BLOCKQUOTE>
<H1><A NAME="NAME"><A NAME="1">NAME
</A></A></H1>
<P>
<B>cgGetParameterVariability</B> - get a parameter's variability
</P>
<H1><A NAME="SYNOPSIS"><A NAME="2">SYNOPSIS
</A></A></H1>
<PRE> #include <Cg/cg.h>
CGenum cgGetParameterVariability( CGparameter param );
</PRE>
<H1><A NAME="PARAMETERS"><A NAME="3">PARAMETERS
</A></A></H1>
<DL>
<DT><STRONG>param
</STRONG></DT>
<DD>
<P>
The program parameter.
</P>
</DD></DL>
<H1><A NAME="RETURN_VALUES"><A NAME="4">RETURN VALUES
</A></A></H1>
<P>
Returns the variability of <B>param</B>.
</P>
<P>
Returns <B>CG_ERROR</B> if an error occurs.
</P>
<H1><A NAME="DESCRIPTION"><A NAME="5">DESCRIPTION
</A></A></H1>
<P>
<B>cgGetParameterVariability</B> 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.
</P>
<P>
<B>cgGetParameterVariability</B> will return one of the following variabilities:
</P>
<DL>
<DT><STRONG><B>CG_VARYING</B>
</STRONG></DT>
<DD>
<P>
A varying parameter is one whose value changes with each invocation
of the program.
</P>
<DT><STRONG><B>CG_UNIFORM</B>
</STRONG></DT>
<DD>
<P>
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.
</P>
<DT><STRONG><B>CG_LITERAL</B>
</STRONG></DT>
<DD>
<P>
A literal parameter is folded out at compile time. Making a uniform
parameter literal with <A HREF="cgSetParameterVariability.html">cgSetParameterVariability</A>
will often make a program more efficient at the expense of requiring
a compile every time the value is set.
</P>
<DT><STRONG><B>CG_CONSTANT</B>
</STRONG></DT>
<DD>
<P>
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.
</P>
<DT><STRONG><B>CG_MIXED</B>
</STRONG></DT>
<DD>
<P>
A structure parameter that contains parameters that differ in variability.
</P>
</DD></DL>
<H1><A NAME="EXAMPLES"><A NAME="6">EXAMPLES
</A></A></H1>
<P>
<I>to-be-written</I>
</P>
<H1><A NAME="ERRORS"><A NAME="7">ERRORS
</A></A></H1>
<P>
<B>CG_INVALID_PARAM_HANDLE_ERROR</B> is generated if <B>param</B> is not a valid parameter.
</P>
<H1><A NAME="HISTORY"><A NAME="8">HISTORY
</A></A></H1>
<P>
<B>cgGetParameterVariability</B> was introduced in Cg 1.1.
</P>
<H1><A NAME="SEE_ALSO"><A NAME="9">SEE ALSO
</A></A></H1>
<P>
<A HREF="cgGetNamedParameter.html">cgGetNamedParameter</A>,
<A HREF="cgGetNextParameter.html">cgGetNextParameter</A>,
<A HREF="cgGetParameterName.html">cgGetParameterName</A>,
<A HREF="cgGetParameterType.html">cgGetParameterType</A>,
<A HREF="cgGetParameterDirection.html">cgGetParameterDirection</A>,
<A HREF="cgSetParameterVariability.html">cgSetParameterVariability</A>
</P>
</BLOCKQUOTE>
</BODY>
