SLI Zone
NVIDIA.com Developer Home

NVAPI Reference: group__oglfunctions

OpenGL Functions
[OpenGL APIs]


NvAPI_OGL_ExpertModeSet[Get] Functions

NVAPI_INTERFACE NvAPI_OGL_ExpertModeSet (NvU32 expertDetailLevel, NvU32 expertReportMask, NvU32 expertOutputMask, NVAPI_OGLEXPERT_CALLBACK expertCallback)
NVAPI_INTERFACE NvAPI_OGL_ExpertModeGet (NvU32 *pExpertDetailLevel, NvU32 *pExpertReportMask, NvU32 *pExpertOutputMask, NVAPI_OGLEXPERT_CALLBACK *pExpertCallback)

NvAPI_OGL_ExpertModeDefaultsSet[Get] Functions

NVAPI_INTERFACE NvAPI_OGL_ExpertModeDefaultsSet (NvU32 expertDetailLevel, NvU32 expertReportMask, NvU32 expertOutputMask)
NVAPI_INTERFACE NvAPI_OGL_ExpertModeDefaultsGet (NvU32 *pExpertDetailLevel, NvU32 *pExpertReportMask, NvU32 *pExpertOutputMask)

Typedefs

typedef void(* NVAPI_OGLEXPERT_CALLBACK )(unsigned int categoryId, unsigned int messageId, unsigned int detailLevel, int objectId, const char *messageStr)

Typedef Documentation

typedef void(* NVAPI_OGLEXPERT_CALLBACK)(unsigned int categoryId, unsigned int messageId, unsigned int detailLevel, int objectId, const char *messageStr)

DESCRIPTION: Used in conjunction with OUTPUT_TO_CALLBACK, this is a simple callback function the user may use to obtain the feedback stream. The function will be called once per fully qualified feedback stream entry.

Parameters:
categoryId Contains the bit from the NVAPI_OGLEXPERT_REPORT mask that corresponds to the current message
messageId Unique ID for the current message
detailLevel Contains the bit from the NVAPI_OGLEXPERT_DETAIL mask that corresponds to the current message
objectId Unique ID of the object that corresponds to the current message
messageStr Text string from the current message


Function Documentation

NVAPI_INTERFACE NvAPI_OGL_ExpertModeDefaultsGet ( NvU32 pExpertDetailLevel,
NvU32 pExpertReportMask,
NvU32 pExpertOutputMask 
)

This function configures OpenGL Expert Mode global defaults. These settings apply to any OpenGL application which starts up after these values are applied (i.e. these settings *do not* apply to currently running applications).

SUPPORTED OS: Windows XP and higher
Since:
Version: 84.11 (Rel80) / 88.00 (Rel85)
Parameters:
expertDetailLevel Value which specifies the detail level in the feedback stream. This is a mask made up of NVAPI_OGLEXPERT_LEVEL bits.
expertReportMask Mask made up of NVAPI_OGLEXPERT_REPORT bits, this parameter specifies the areas of functional interest.
expertOutputMask Mask made up of NVAPI_OGLEXPERT_OUTPUT bits, this parameter specifies the feedback output location. Note that using OUTPUT_TO_CALLBACK here is meaningless and has no effect, but using it will not cause an error.
Returns:
NVAPI_ERROR or NVAPI_OK

NVAPI_INTERFACE NvAPI_OGL_ExpertModeDefaultsSet ( NvU32  expertDetailLevel,
NvU32  expertReportMask,
NvU32  expertOutputMask 
)

This function configures OpenGL Expert Mode global defaults. These settings apply to any OpenGL application which starts up after these values are applied (i.e. these settings *do not* apply to currently running applications).

SUPPORTED OS: Windows XP and higher
Since:
Version: 84.11 (Rel80) / 88.00 (Rel85)
Parameters:
expertDetailLevel Value which specifies the detail level in the feedback stream. This is a mask made up of NVAPI_OGLEXPERT_LEVEL bits.
expertReportMask Mask made up of NVAPI_OGLEXPERT_REPORT bits, this parameter specifies the areas of functional interest.
expertOutputMask Mask made up of NVAPI_OGLEXPERT_OUTPUT bits, this parameter specifies the feedback output location. Note that using OUTPUT_TO_CALLBACK here is meaningless and has no effect, but using it will not cause an error.
Returns:
NVAPI_ERROR or NVAPI_OK

NVAPI_INTERFACE NvAPI_OGL_ExpertModeGet ( NvU32 pExpertDetailLevel,
NvU32 pExpertReportMask,
NvU32 pExpertOutputMask,
NVAPI_OGLEXPERT_CALLBACK pExpertCallback 
)

This function configures OpenGL Expert Mode, an API usage feedback and advice reporting mechanism. The effects of this call are applied only to the current context, and are reset to the defaults when the context is destroyed.

This feature is valid at runtime only when GLExpert functionality has been built into the OpenGL driver installed on the system. All Windows Vista OpenGL drivers provided by NVIDIA have this instrumentation included by default. Windows XP, however, requires a special display driver available with the NVIDIA PerfSDK found at developer.nvidia.com.

These functions are valid only for the current OpenGL context. Calling these functions prior to creating a context and calling MakeCurrent with it will result in errors and undefined behavior.

SUPPORTED OS: Windows XP and higher
Since:
Version: 84.11 (Rel80) / 88.00 (Rel85)
Parameters:
expertDetailMask Mask made up of NVAPI_OGLEXPERT_DETAIL bits, this parameter specifies the detail level in the feedback stream.
expertReportMask Mask made up of NVAPI_OGLEXPERT_REPORT bits, this parameter specifies the areas of functional interest.
expertOutputMask Mask made up of NVAPI_OGLEXPERT_OUTPUT bits, this parameter specifies the feedback output location.
expertCallback Used in conjunction with OUTPUT_TO_CALLBACK, this is a simple callback function the user may use to obtain the feedback stream. The function will be called once per fully qualified feedback stream extry.
Return values:
NVAPI_API_NOT_INTIALIZED NVAPI not initialized
NVAPI_NVIDIA_DEVICE_NOT_FOUND No NVIDIA GPU found
NVAPI_OPENGL_CONTEXT_NOT_CURRENT No NVIDIA OpenGL context which supports GLExpert has been made current
NVAPI_ERROR OpenGL driver failed to load properly
NVAPI_OK Success

NVAPI_INTERFACE NvAPI_OGL_ExpertModeSet ( NvU32  expertDetailLevel,
NvU32  expertReportMask,
NvU32  expertOutputMask,
NVAPI_OGLEXPERT_CALLBACK  expertCallback 
)

This function configures OpenGL Expert Mode, an API usage feedback and advice reporting mechanism. The effects of this call are applied only to the current context, and are reset to the defaults when the context is destroyed.

This feature is valid at runtime only when GLExpert functionality has been built into the OpenGL driver installed on the system. All Windows Vista OpenGL drivers provided by NVIDIA have this instrumentation included by default. Windows XP, however, requires a special display driver available with the NVIDIA PerfSDK found at developer.nvidia.com.

These functions are valid only for the current OpenGL context. Calling these functions prior to creating a context and calling MakeCurrent with it will result in errors and undefined behavior.

SUPPORTED OS: Windows XP and higher
Since:
Version: 84.11 (Rel80) / 88.00 (Rel85)
Parameters:
expertDetailMask Mask made up of NVAPI_OGLEXPERT_DETAIL bits, this parameter specifies the detail level in the feedback stream.
expertReportMask Mask made up of NVAPI_OGLEXPERT_REPORT bits, this parameter specifies the areas of functional interest.
expertOutputMask Mask made up of NVAPI_OGLEXPERT_OUTPUT bits, this parameter specifies the feedback output location.
expertCallback Used in conjunction with OUTPUT_TO_CALLBACK, this is a simple callback function the user may use to obtain the feedback stream. The function will be called once per fully qualified feedback stream extry.
Return values:
NVAPI_API_NOT_INTIALIZED NVAPI not initialized
NVAPI_NVIDIA_DEVICE_NOT_FOUND No NVIDIA GPU found
NVAPI_OPENGL_CONTEXT_NOT_CURRENT No NVIDIA OpenGL context which supports GLExpert has been made current
NVAPI_ERROR OpenGL driver failed to load properly
NVAPI_OK Success


Copyright (c) 2007, 2008 NVIDIA Corporation. All rights reserved.