NAME

cgGetFirstEffect - get the first effect in a context

SYNOPSIS

  #include <Cg/cg.h>

  CGeffect cgGetFirstEffect( CGcontext context );

PARAMETERS

context

The context from which to retrieve the first effect.

RETURN VALUES

cgGetFirstEffect returns a the first CGeffect object in context. If context contains no effects, NULL is returned.

DESCRIPTION

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

EXAMPLES

to-be-written

ERRORS

CG_INVALID_CONTEXT_HANDLE_ERROR is generated if context does not refer to a valid context.

HISTORY

cgGetFirstEffect was introduced in Cg 1.4.

SEE ALSO

cgGetNextEffect, cgCreateEffect, cgCreateEffectFromFile, cgDestroyEffect, cgIsEffect