Name

cgGetContextBehavior - get the behavior enumerant for a context

Synopsis

#include <Cg/cg.h>

CGbehavior cgGetContextBehavior( CGcontext context );

Parameters

context

The context for which the behavior enumerant will be returned.

Return Values

Returns the behavior enumerant for context.

Returns CG_BEHAVIOR_UNKNOWN if an error occurs.

Description

cgGetContextBehavior allows the application to retrieve the behavior enumerant for a context. The valid enumerants and their meanings are described in cgSetContextBehavior.

Examples

/* create a context and get the default context behavior enum */

CGcontext context = cgCreateContext();
CGbehavior cb = cgGetContextBehavior(context);

Errors

CG_INVALID_CONTEXT_HANDLE_ERROR is generated if context is not a valid context.

History

cgGetContextBehavior was introduced in Cg 3.0.

See Also

cgCreateContext, cgSetContextBehavior, cgGetBehavior, cgGetBehaviorString