Name

cgGetParameterSettingMode - get the parameter setting mode for a context

Synopsis

#include <Cg/cg.h>

CGenum cgGetParameterSettingMode( CGcontext context );

Parameters

context

The context from which the parameter setting mode will be retrieved.

Return Values

Returns the parameter setting mode enumerant for context.

Returns CG_UNKNOWN if an error occurs.

Description

cgGetParameterSettingMode returns the current parameter setting mode enumerant for context. See cgSetParameterSettingMode for more information.

Examples

/* assumes cgGetProgramContext(program) == context */

if (cgGetParameterSettingMode(context) == CG_DEFERRED_PARAMETER_SETTING) {
  cgUpdateProgramParameters(program);
}

Errors

CG_INVALID_CONTEXT_HANDLE_ERROR is generated if context is not a valid context.

History

cgGetParameterSettingMode was introduced in Cg 2.0.

See Also

cgSetParameterSettingMode, cgUpdatePassParameters, cgUpdateProgramParameters