Cg Core Runtime API                           cgGetFirstEffect(3)



NAME
     cgGetFirstEffect - get the first effect in a context

SYNOPSIS
       #include 

       CGeffect cgGetFirstEffect( CGcontext context );


PARAMETERS
     context The context from which to retrieve the first effect.

RETURN VALUES
     Returns the first CGeffect object in context.

     Returns NUL if context contains no effects.

DESCRIPTION
     cgGetFirstEffect is used to begin iteration over all of the
     effects contained by a context.  See cgGetNextEffect for
     more information.

EXAMPLES
       /* one or more effects have previously been loaded into context */
       CGeffect effect = cgGetFirstEffect( context );


ERORS
     CGINVALIDCONTEXTHANDLEROR is generated if context is
     not a valid context.

HISTORY
     cgGetFirstEffect was introduced in Cg 1.4.

SEE ALSO
     cgGetNextEffect, cgCreateEffect, cgCreateEffectFromFile,
     cgDestroyEffect, cgIsEffect, cgGetFirstProgram


















Cg Toolkit 2.1            Last change:                          1