NAME

cgGetFirstEffect - get the first effect in a context

SYNOPSIS

  #include <Cg/cg.h>

  CGprogram cgGetFirstEffect( CGcontext ctx );

PARAMETERS

ctx

Specifies the context to retrieve the first effect from.

DESCRIPTION

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

RETURN VALUES

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

ERRORS

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

SEE ALSO

the "cgGetNextEffect" document, the "cgCreateEffect" document, the "cgCreateEffectFromFile" document, the "cgDestroyEffect" document, and the "cgIsEffect" document