<HTML>
<HEAD>
<TITLE>cgCreateState</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>cgCreateState</B> - create a state definition
</P>
<H1><A NAME="SYNOPSIS"><A NAME="2">SYNOPSIS
</A></A></H1>
<PRE> #include <Cg/cg.h>
CGstate cgCreateState( CGcontext context,
const char * name,
CGtype type );
</PRE>
<H1><A NAME="PARAMETERS"><A NAME="3">PARAMETERS
</A></A></H1>
<DL>
<DT><STRONG>context
</STRONG></DT>
<DD>
<P>
The context in which to define the new state.
</P>
<DT><STRONG>name
</STRONG></DT>
<DD>
<P>
The name of the new state.
</P>
<DT><STRONG>type
</STRONG></DT>
<DD>
<P>
The type of the new state.
</P>
</DD></DL>
<H1><A NAME="RETURN_VALUES"><A NAME="4">RETURN VALUES
</A></A></H1>
<P>
Returns a handle to the newly created <B>CGstate</B>.
</P>
<P>
Returns <B>NULL</B> if there is an error.
</P>
<H1><A NAME="DESCRIPTION"><A NAME="5">DESCRIPTION
</A></A></H1>
<P>
<B>cgCreateState</B> adds a new state definition to the context. When a CgFX
file is added to the context, all state assignments in the file must have
already been defined via a call to <B>cgCreateState</B> or <A HREF="cgCreateArrayState.html">cgCreateArrayState</A>.
</P>
<P>
Applications will typically call <A HREF="cgSetStateCallbacks.html">cgSetStateCallbacks</A> shortly after
creating a new state with <B>cgCreateState</B>.
</P>
<H1><A NAME="EXAMPLES"><A NAME="6">EXAMPLES
</A></A></H1>
<P>
Example callback functions for a state to register:
</P>
<PRE> CGbool foo_set( CGstateassignment sa )
{
int nVals = 0;
const CGbool *val = cgGetBoolStateAssignmentValues( sa, &nVals );
printf( "\nFooState set called with value %d.\n", *val );
return CG_TRUE;
}
CGbool foo_reset( CGstateassignment sa )
{
printf( "\nFooState reset called.\n" );
return CG_TRUE;
}
CGbool foo_validate( CGstateassignment sa )
{
printf( "FooState validate called.\n" );
return CG_TRUE;
}
</PRE><P>
Registering the state:
</P>
<PRE> // Create and register new state FooState
CGstate fooState = cgCreateState( myCgContext, "FooState", CG_BOOL );
cgSetStateCallbacks( fooState, foo_set, foo_reset, foo_validate );
</PRE>
<H1><A NAME="ERRORS"><A NAME="7">ERRORS
</A></A></H1>
<P>
<B>CG_INVALID_CONTEXT_HANDLE_ERROR</B> is generated if <B>context</B> is not a valid context.
</P>
<P>
<B>CG_INVALID_PARAMETER_ERROR</B> is generated if <B>name</B> is <B>NULL</B> or not a
valid identifier, or if <B>type</B> is not a simple scalar, vector, or
matrix-type. Array-typed state should be created with
<A HREF="cgCreateArrayState.html">cgCreateArrayState</A>.
</P>
<H1><A NAME="HISTORY"><A NAME="8">HISTORY
</A></A></H1>
<P>
<B>cgCreateState</B> was introduced in Cg 1.4.
</P>
<H1><A NAME="SEE_ALSO"><A NAME="9">SEE ALSO
</A></A></H1>
<P>
<A HREF="cgCreateArrayState.html">cgCreateArrayState</A>,
<A HREF="cgGetStateContext.html">cgGetStateContext</A>,
<A HREF="cgGetStateName.html">cgGetStateName</A>,
<A HREF="cgGetStateType.html">cgGetStateType</A>,
<A HREF="cgIsState.html">cgIsState</A>,
<A HREF="cgSetStateCallbacks.html">cgSetStateCallbacks</A>,
<A HREF="cgGLRegisterStates.html">cgGLRegisterStates</A>,
<A HREF="cgD3D9RegisterStates.html">cgD3D9RegisterStates</A>,
<A HREF="cgCreateContext.html">cgCreateContext</A>
</P>
</BLOCKQUOTE>
</BODY>
