DirectX Interface

Data Structures
struct	NV_D3D11_META_COMMAND_RESOURCE
struct	_NV_MULTIGPU_CAPS_V1
struct	_NV_QUERY_SINGLE_PASS_STEREO_SUPPORT_PARAMS_V1
struct	_NV_QUERY_MULTIVIEW_SUPPORT_PARAMS_V1
struct	_NV_MULTIVIEW_PARAMS_V1
struct	_NV_QUERY_MODIFIED_W_SUPPORT_PARAMS
struct	_NV_QUERY_LATELATCH_SUPPORT_PARAMS
struct	_NV_D3D1x_GRAPHICS_CAPS_V1
struct	_NV_D3D11_EXCLUSIVE_SCISSOR_RECT_DESC_V1
struct	_NV_PIXEL_SRSO_1x2
struct	_NV_QUERY_SMP_ASSIST_SUPPORT_PARAMS_V1
struct	_NV_GET_SLEEP_STATUS_PARAMS
struct	_NV_SET_SLEEP_MODE_PARAMS
struct	_NV_LATENCY_RESULT_PARAMS
struct	_NV_LATENCY_MARKER_PARAMS
struct	NV_GET_CURRENT_SLI_STATE_V1

Macros
#define	NVAPI_COPY_ASYNCHRONOUSLY   1
#define	NV_MAX_PIXEL_SHADING_RATES   16
#define	NV_GET_CURRENT_SLI_STATE_VER1   MAKE_NVAPI_VERSION(NV_GET_CURRENT_SLI_STATE_V1,1)

Typedefs
typedef enum _NVAPI_D3D11_INSERTWFI_FLAG	NVAPI_D3D11_INSERTWFI_FLAG
typedef enum _NVAPI_ANSEL_FEATURE	NVAPI_ANSEL_FEATURE
typedef enum _NV_RESOLVE_MODE	NV_RESOLVE_MODE
typedef struct _NV_MULTIGPU_CAPS_V1	NV_MULTIGPU_CAPS_V1
typedef struct _NV_MULTIGPU_CAPS_V1 *	PNV_MULTIGPU_CAPS_V1
typedef struct _NV_QUERY_SINGLE_PASS_STEREO_SUPPORT_PARAMS_V1	NV_QUERY_SINGLE_PASS_STEREO_SUPPORT_PARAMS_V1
typedef struct _NV_QUERY_MULTIVIEW_SUPPORT_PARAMS_V1	NV_QUERY_MULTIVIEW_SUPPORT_PARAMS_V1
typedef struct _NV_MULTIVIEW_PARAMS_V1	NV_MULTIVIEW_PARAMS_V1
typedef struct _NV_QUERY_MODIFIED_W_SUPPORT_PARAMS	NV_QUERY_MODIFIED_W_SUPPORT_PARAMS_V1
typedef ID3DLateLatchObject_V1	ID3DLateLatchObject
typedef struct _NV_QUERY_LATELATCH_SUPPORT_PARAMS	NV_QUERY_LATELATCH_SUPPORT_PARAMS_V1
typedef enum _IMPLICIT_SLI_CONTROL	IMPLICIT_SLI_CONTROL
typedef struct _NV_D3D1x_GRAPHICS_CAPS_V1	NV_D3D1x_GRAPHICS_CAPS_V1
typedef struct _NV_D3D11_EXCLUSIVE_SCISSOR_RECT_DESC_V1	NV_D3D11_EXCLUSIVE_SCISSOR_RECT_DESC_V1
typedef struct _NV_PIXEL_SRSO_1x2	NV_PIXEL_SRSO_1x2
typedef enum NV_SMP_ASSIST_TYPE	NV_SMP_ASSIST_TYPE
typedef struct _NV_QUERY_SMP_ASSIST_SUPPORT_PARAMS_V1	NV_QUERY_SMP_ASSIST_SUPPORT_PARAMS_V1
typedef struct _NV_GET_SLEEP_STATUS_PARAMS	NV_GET_SLEEP_STATUS_PARAMS_V1
typedef struct _NV_SET_SLEEP_MODE_PARAMS	NV_SET_SLEEP_MODE_PARAMS_V1
typedef struct _NV_LATENCY_RESULT_PARAMS	NV_LATENCY_RESULT_PARAMS_V1
typedef struct _NV_LATENCY_MARKER_PARAMS	NV_LATENCY_MARKER_PARAMS_V1
typedef NV_LATENCY_MARKER_PARAMS_V1	NV_ASYNC_FRAME_MARKER_PARAMS_V1
typedef enum _NVAPI_D3D_SETRESOURCEHINT_CATEGORY	NVAPI_D3D_SETRESOURCEHINT_CATEGORY
typedef enum _NVAPI_D3D_SETRESOURCEHINT_SLI	NVAPI_D3D_SETRESOURCEHINT_SLI
typedef enum _NVAPI_D3D_RESOURCERENDERING_FLAG	NVAPI_D3D_RESOURCERENDERING_FLAG

Enumerations
enum	NVAPI_ALIAS_SURFACE_FLAG { NVAPI_ALIAS_SURFACE_FLAG_NONE = 0x00000000 , NVAPI_ALIAS_SURFACE_FLAG_USE_SUPER = 0x00000001 , NVAPI_ALIAS_SURFACE_FLAG_MASK = 0x00000001 }
enum	_NVAPI_D3D11_INSERTWFI_FLAG { NVAPI_D3D_BEGIN_UAV_OVERLAP_NO_WFI = 0x00000000 , NVAPI_D3D_BEGIN_UAV_OVERLAP_GFX_WFI = 0x00000001 , NVAPI_D3D_BEGIN_UAV_OVERLAP_COMP_WFI = 0x00000002 }
enum	_NVAPI_ANSEL_FEATURE { NVAPI_ANSEL_FEATURE_UNKNOWN = 0 , NVAPI_ANSEL_FEATURE_BLACK_AND_WHITE = 1 , NVAPI_ANSEL_FEATURE_HUDLESS = 2 }
enum	_NV_RESOLVE_MODE { NV_RESOLVE_MODE_SAMPLE_0 }
enum	_IMPLICIT_SLI_CONTROL { DISABLE_IMPLICIT_SLI = 0 , ENABLE_IMPLICIT_SLI = 1 }
enum	NV_SMP_ASSIST_TYPE { NV_SMP_ASSIST_NONE = 0 , NV_SMP_ASSIST_MRS = 1 , NV_SMP_ASSIST_LMS = 2 , NV_SMP_ASSIST_NUM_TYPES }
enum	NV_LATENCY_MARKER_TYPE {   SIMULATION_START = 0 , SIMULATION_END = 1 , RENDERSUBMIT_START = 2 , RENDERSUBMIT_END = 3 ,   PRESENT_START = 4 , PRESENT_END = 5 , INPUT_SAMPLE = 6 , TRIGGER_FLASH = 7 ,   PC_LATENCY_PING = 8 , OUT_OF_BAND_RENDERSUBMIT_START = 9 , OUT_OF_BAND_RENDERSUBMIT_END = 10 , OUT_OF_BAND_PRESENT_START = 11 ,   OUT_OF_BAND_PRESENT_END = 12 }
enum	NV_OUT_OF_BAND_CQ_TYPE { OUT_OF_BAND_RENDER = 0 , OUT_OF_BAND_PRESENT = 1 }
enum	NVAPI_DEVICE_FEATURE_LEVEL {   NVAPI_DEVICE_FEATURE_LEVEL_NULL = -1 , NVAPI_DEVICE_FEATURE_LEVEL_10_0 = 0 , NVAPI_DEVICE_FEATURE_LEVEL_10_0_PLUS = 1 , NVAPI_DEVICE_FEATURE_LEVEL_10_1 = 2 ,   NVAPI_DEVICE_FEATURE_LEVEL_11_0 = 3 }
enum	_NVAPI_D3D_SETRESOURCEHINT_CATEGORY { NVAPI_D3D_SRH_CATEGORY_SLI = 1 }
enum	_NVAPI_D3D_SETRESOURCEHINT_SLI { NVAPI_D3D_SRH_SLI_APP_CONTROLLED_INTERFRAME_CONTENT_SYNC = 1 , NVAPI_D3D_SRH_SLI_ASK_FOR_BROADCAST_USAGE = 2 , NVAPI_D3D_SRH_SLI_RESPECT_DRIVER_INTERFRAME_CONTENT_SYNC = 3 }
enum	_NVAPI_D3D_RESOURCERENDERING_FLAG { NVAPI_D3D_RR_FLAG_DEFAULTS = 0x00000000 , NVAPI_D3D_RR_FLAG_FORCE_DISCARD_CONTENT = 0x00000001 , NVAPI_D3D_RR_FLAG_FORCE_KEEP_CONTENT = 0x00000002 , NVAPI_D3D_RR_FLAG_MULTI_FRAME = 0x00000004 }

Functions
NVAPI_INTERFACE	NvAPI_D3D9_RegisterResource (IDirect3DResource9 *pResource)
NVAPI_INTERFACE	NvAPI_D3D9_UnregisterResource (IDirect3DResource9 *pResource)
NVAPI_INTERFACE	NvAPI_D3D9_AliasSurfaceAsTexture (IDirect3DDevice9 *pDev, IDirect3DSurface9 *pSurface, IDirect3DTexture9 **ppTexture, DWORD dwFlag)
NVAPI_INTERFACE	NvAPI_D3D9_StretchRectEx (IDirect3DDevice9 *pDevice, IDirect3DResource9 *pSourceResource, CONST RECT *pSourceRect, IDirect3DResource9 *pDestResource, CONST RECT *pDestRect, D3DTEXTUREFILTERTYPE Filter)
NVAPI_INTERFACE	NvAPI_D3D9_ClearRT (IDirect3DDevice9 *pDevice, NvU32 dwNumRects, CONST RECT *pRects, float r, float g, float b, float a)
NVAPI_INTERFACE	NvAPI_D3D9_GetSurfaceHandle (IDirect3DSurface9 *pSurface, NVDX_ObjectHandle *pHandle)
NVAPI_INTERFACE	NvAPI_D3D10_SetDepthBoundsTest (ID3D10Device *pDev, NvU32 bEnable, float fMinDepth, float fMaxDepth)
NVAPI_INTERFACE	NvAPI_D3D11_IsNvShaderExtnOpCodeSupported (__in IUnknown *pDev, __in NvU32 opCode, __out bool *pSupported)
NVAPI_INTERFACE	NvAPI_D3D11_SetNvShaderExtnSlot (__in IUnknown *pDev, __in NvU32 uavSlot)
NVAPI_INTERFACE	NvAPI_D3D11_SetNvShaderExtnSlotLocalThread (__in IUnknown *pDev, __in NvU32 uavSlot)
NVAPI_INTERFACE	NvAPI_D3D11_BeginUAVOverlap (__in IUnknown *pDeviceOrContext)
NVAPI_INTERFACE	NvAPI_D3D11_EndUAVOverlap (__in IUnknown *pDeviceOrContext)
NVAPI_INTERFACE	NvAPI_D3D_SetFPSIndicatorState (IUnknown *pDev, NvU8 doEnable)
NVAPI_INTERFACE	NvAPI_D3D9_Present (IDirect3DDevice9 *pDevice, IDirect3DSwapChain9 *pSwapChain, const RECT *pSourceRect, const RECT *pDestRect, HWND hDestWindowOverride, const RGNDATA *pDirtyRegion)
NVAPI_INTERFACE	NvAPI_D3D9_QueryFrameCount (IDirect3DDevice9 *pDevice, NvU32 *pFrameCount)
NVAPI_INTERFACE	NvAPI_D3D9_ResetFrameCount (IDirect3DDevice9 *pDevice)
NVAPI_INTERFACE	NvAPI_D3D9_QueryMaxSwapGroup (IDirect3DDevice9 *pDevice, NvU32 *pMaxGroups, NvU32 *pMaxBarriers)
NVAPI_INTERFACE	NvAPI_D3D9_QuerySwapGroup (IDirect3DDevice9 *pDevice, IDirect3DSwapChain9 *pSwapChain, NvU32 *pSwapGroup, NvU32 *pSwapBarrier)
NVAPI_INTERFACE	NvAPI_D3D9_JoinSwapGroup (IDirect3DDevice9 *pDevice, IDirect3DSwapChain9 *pSwapChain, NvU32 group, BOOL blocking)
NVAPI_INTERFACE	NvAPI_D3D9_BindSwapBarrier (IDirect3DDevice9 *pDevice, NvU32 group, NvU32 barrier)
NVAPI_INTERFACE	NvAPI_D3D1x_Present (IUnknown *pDevice, IDXGISwapChain *pSwapChain, UINT SyncInterval, UINT Flags)
NVAPI_INTERFACE	NvAPI_D3D1x_QueryFrameCount (IUnknown *pDevice, NvU32 *pFrameCount)
NVAPI_INTERFACE	NvAPI_D3D1x_ResetFrameCount (IUnknown *pDevice)
NVAPI_INTERFACE	NvAPI_D3D1x_QueryMaxSwapGroup (IUnknown *pDevice, NvU32 *pMaxGroups, NvU32 *pMaxBarriers)
NVAPI_INTERFACE	NvAPI_D3D1x_QuerySwapGroup (IUnknown *pDevice, IDXGISwapChain *pSwapChain, NvU32 *pSwapGroup, NvU32 *pSwapBarrier)
NVAPI_INTERFACE	NvAPI_D3D1x_JoinSwapGroup (IUnknown *pDevice, IDXGISwapChain *pSwapChain, NvU32 group, BOOL blocking)
NVAPI_INTERFACE	NvAPI_D3D1x_BindSwapBarrier (IUnknown *pDevice, NvU32 group, NvU32 barrier)
NVAPI_INTERFACE	NvAPI_D3D11_CreateRasterizerState (__in ID3D11Device *pDevice, __in const NvAPI_D3D11_RASTERIZER_DESC_EX *pRasterizerDesc, __out ID3D11RasterizerState **ppRasterizerState)
NVAPI_INTERFACE	NvAPI_D3D11_CheckFeatureSupport (__in ID3D11Device *pDevice, __in NV_D3D11_FEATURE Feature, __out void *pFeatureSupportData, __in UINT FeatureSupportDataSize)
NVAPI_INTERFACE	NvAPI_D3D11_CreateImplicitMSAATexture2D (__in ID3D11Device *pDevice, __in const D3D11_TEXTURE2D_DESC *pDesc, __out ID3D11Texture2D **ppTexture2D)
NVAPI_INTERFACE	NvAPI_D3D11_ResolveSubresourceRegion (__in ID3D11Device *pDevice, __in ID3D11Texture2D *pDstResource, __in UINT DstSubresource, __in UINT DstX, __in UINT DstY, __in ID3D11Texture2D *pSrcResource, __in UINT SrcSubresource, __in_opt const RECT *pSrcRect, __in DXGI_FORMAT Format, __in NV_RESOLVE_MODE ResolveMode)
NVAPI_INTERFACE	NvAPI_D3D11_AliasMSAATexture2DAsNonMSAA (__in ID3D11Device *pDevice, __in ID3D11Texture2D *pInputTex, __out ID3D11Texture2D **ppOutTex)
NVAPI_INTERFACE	NvAPI_D3D11_DecompressView (__in ID3D11Device *pDevice, __in ID3D11DeviceContext *pDeviceContext, __in ID3D11View *pView)
NVAPI_INTERFACE	NvAPI_D3D11_EnumerateMetaCommands (__in ID3D11Device *pDevice, __inout NvU32 *pNumMetaCommands, __out_ecount_opt(*pNumMetaCommands) NVAPI_META_COMMAND_DESC *pDescs)
NVAPI_INTERFACE	NvAPI_D3D11_InitializeMetaCommand (__in ID3D11DeviceContext *pDeviceContext, __in ID3D11NvMetaCommand *pMetaCommand, __in_bcount(InitializationParametersDataSize) const void *pInitializationParametersData, __in NvU32 InitializationParametersDataSize)
NVAPI_INTERFACE	NvAPI_D3D11_ExecuteMetaCommand (__in ID3D11DeviceContext *pDeviceContext, __in ID3D11NvMetaCommand *pMetaCommand, __in_bcount(ExecutionParametersDataSize) const void *pExecutionParametersData, __in NvU32 ExecutionParametersDataSize)
NVAPI_INTERFACE	NvAPI_D3D_IsGSyncCapable (__in IUnknown *pDeviceOrContext, __in NVDX_ObjectHandle primarySurface, __out BOOL *pIsGsyncCapable)
NVAPI_INTERFACE	NvAPI_D3D_IsGSyncActive (__in IUnknown *pDeviceOrContext, __in NVDX_ObjectHandle primarySurface, __out BOOL *pIsGsyncActive)
NVAPI_INTERFACE	NvAPI_D3D1x_DisableShaderDiskCache (IUnknown *pDevice)
NVAPI_INTERFACE	NvAPI_D3D11_MultiGPU_GetCaps (__inout PNV_MULTIGPU_CAPS pMultiGPUCaps)
NVAPI_INTERFACE	NvAPI_D3D11_MultiGPU_Init (__in bool bEnable)
NVAPI_INTERFACE	NvAPI_D3D11_CreateMultiGPUDevice (__in ID3D11Device *pDevice, __in ULONG version, __out ULONG *currentVersion, __out ID3D11MultiGPUDevice **ppD3D11MultiGPUDevice, __in UINT maxGpus=ALL_GPUS)
NVAPI_INTERFACE	NvAPI_D3D_QuerySinglePassStereoSupport (__in IUnknown *pDevice, __inout NV_QUERY_SINGLE_PASS_STEREO_SUPPORT_PARAMS *pQuerySinglePassStereoSupportedParams)
NVAPI_INTERFACE	NvAPI_D3D_SetSinglePassStereoMode (__in IUnknown *pDevOrContext, __in NvU32 numViews, __in NvU32 renderTargetIndexOffset, __in NvU8 independentViewportMaskEnable)
NVAPI_INTERFACE	NvAPI_D3D_QueryMultiViewSupport (__in IUnknown *pDevice, __inout NV_QUERY_MULTIVIEW_SUPPORT_PARAMS *pQueryMultiViewSupportedParams)
NVAPI_INTERFACE	NvAPI_D3D_SetMultiViewMode (__in IUnknown *pDevOrContext, __in NV_MULTIVIEW_PARAMS *pMultiViewParams)
NVAPI_INTERFACE	NvAPI_D3D_QueryModifiedWSupport (__in IUnknown *pDev, __inout NV_QUERY_MODIFIED_W_SUPPORT_PARAMS *pQueryModifiedWSupportedParams)
NVAPI_INTERFACE	NvAPI_D3D_SetModifiedWMode (__in IUnknown *pDevOrContext, __in NV_MODIFIED_W_PARAMS *psModifiedWParams)
	DECLARE_INTERFACE (ID3DLateLatchObject_V1)
NVAPI_INTERFACE	NvAPI_D3D_CreateLateLatchObject (__in IUnknown *pDevice, __inout NV_D3D_LATELATCH_OBJECT_DESC *pLateLatchObjectDesc)
NVAPI_INTERFACE	NvAPI_D3D_QueryLateLatchSupport (__in IUnknown *pDevice, __inout NV_QUERY_LATELATCH_SUPPORT_PARAMS *pQueryLateLatchSupportParams)
NVAPI_INTERFACE	NvAPI_D3D_RegisterDevice (__in IUnknown *pDev)
NVAPI_INTERFACE	NvAPI_D3D11_MultiDrawInstancedIndirect (__in ID3D11DeviceContext *pDevContext11, __in NvU32 drawCount, __in ID3D11Buffer *pBuffer, __in NvU32 alignedByteOffsetForArgs, __in NvU32 alignedByteStrideForArgs)
NVAPI_INTERFACE	NvAPI_D3D11_MultiDrawIndexedInstancedIndirect (__in ID3D11DeviceContext *pDevContext11, __in NvU32 drawCount, __in ID3D11Buffer *pBuffer, __in NvU32 alignedByteOffsetForArgs, __in NvU32 alignedByteStrideForArgs)
NVAPI_INTERFACE	NvAPI_D3D_ImplicitSLIControl (__in IMPLICIT_SLI_CONTROL implicitSLIControl)
NVAPI_INTERFACE	NvAPI_D3D1x_GetGraphicsCapabilities (__in IUnknown *pDevice, __in NvU32 structVersion, __inout NV_D3D1x_GRAPHICS_CAPS *pGraphicsCaps)
NVAPI_INTERFACE	NvAPI_D3D11_RSSetExclusiveScissorRects (__in IUnknown *pContext, __in NV_D3D11_EXCLUSIVE_SCISSOR_RECTS_DESC *pExclusiveScissorRectsDesc)
NVAPI_INTERFACE	NvAPI_D3D11_RSSetViewportsPixelShadingRates (__in IUnknown *pContext, __in NV_D3D11_VIEWPORTS_SHADING_RATE_DESC *pShadingRateDesc)
NVAPI_INTERFACE	NvAPI_D3D11_CreateShadingRateResourceView (__in ID3D11Device *pDevice, __in ID3D11Resource *pShadingRateResource, __in NV_D3D11_SHADING_RATE_RESOURCE_VIEW_DESC *pShadingRateResourceViewDesc, __out ID3D11NvShadingRateResourceView **ppShadingRateResourceView)
NVAPI_INTERFACE	NvAPI_D3D11_RSSetShadingRateResourceView (__in IUnknown *pContext, __in ID3D11NvShadingRateResourceView *pShadingRateResourceView)
NVAPI_INTERFACE	NvAPI_D3D11_RSGetPixelShadingRateSampleOrder (__in IUnknown *pContext, __out NV_PIXEL_SHADING_RATE_SAMPLE_ORDER_TABLE *pSampleOrderTable)
NVAPI_INTERFACE	NvAPI_D3D11_RSSetPixelShadingRateSampleOrder (__in IUnknown *pContext, __in NV_PIXEL_SHADING_RATE_SAMPLE_ORDER_TABLE *pSampleOrderTable)
NVAPI_INTERFACE	NvAPI_D3D_InitializeVRSHelper (__in IUnknown *pDevice, __inout NV_VRS_HELPER_INIT_PARAMS *pInitializeVRSHelperParams)
NVAPI_INTERFACE	NvAPI_D3D_InitializeNvGazeHandler (__in IUnknown *pDevice, __inout NV_GAZE_HANDLER_INIT_PARAMS *pInitializeNvGazeHandlerParams)
NVAPI_INTERFACE	NvAPI_D3D_InitializeSMPAssist (__in IUnknown *pDevice, __inout NV_SMP_ASSIST_INITIALIZE_PARAMS *pSMPAssistInitParams)
NVAPI_INTERFACE	NvAPI_D3D_QuerySMPAssistSupport (__in IUnknown *pDev, __inout NV_QUERY_SMP_ASSIST_SUPPORT_PARAMS *pQuerySMPAssistSupportParams)
NVAPI_INTERFACE	NvAPI_D3D_GetSleepStatus (__in IUnknown *pDev, __in NV_GET_SLEEP_STATUS_PARAMS *pGetSleepStatusParams)
NVAPI_INTERFACE	NvAPI_D3D_SetSleepMode (__in IUnknown *pDev, __in NV_SET_SLEEP_MODE_PARAMS *pSetSleepModeParams)
NVAPI_INTERFACE	NvAPI_D3D_Sleep (__in IUnknown *pDev)
NVAPI_INTERFACE	NvAPI_D3D_GetLatency (__in IUnknown *pDev, __out NV_LATENCY_RESULT_PARAMS *pGetLatencyParams)
NVAPI_INTERFACE	NvAPI_D3D_SetLatencyMarker (__in IUnknown *pDev, __in NV_LATENCY_MARKER_PARAMS *pSetLatencyMarkerParams)
NVAPI_INTERFACE	NvAPI_D3D_GetObjectHandleForResource (IUnknown *pDevice, IUnknown *pResource, NVDX_ObjectHandle *pHandle)
NVAPI_INTERFACE	NvAPI_D3D11_CreateDevice (IDXGIAdapter *pAdapter, D3D_DRIVER_TYPE DriverType, HMODULE Software, UINT Flags, CONST D3D_FEATURE_LEVEL *pFeatureLevels, UINT FeatureLevels, UINT SDKVersion, ID3D11Device **ppDevice, D3D_FEATURE_LEVEL *pFeatureLevel, ID3D11DeviceContext **ppImmediateContext, NVAPI_DEVICE_FEATURE_LEVEL *pSupportedLevel)
NVAPI_INTERFACE	NvAPI_D3D11_CreateDeviceAndSwapChain (IDXGIAdapter *pAdapter, D3D_DRIVER_TYPE DriverType, HMODULE Software, UINT Flags, CONST D3D_FEATURE_LEVEL *pFeatureLevels, UINT FeatureLevels, UINT SDKVersion, CONST DXGI_SWAP_CHAIN_DESC *pSwapChainDesc, IDXGISwapChain **ppSwapChain, ID3D11Device **ppDevice, D3D_FEATURE_LEVEL *pFeatureLevel, ID3D11DeviceContext **ppImmediateContext, NVAPI_DEVICE_FEATURE_LEVEL *pSupportedLevel)
NVAPI_INTERFACE	NvAPI_D3D11_SetDepthBoundsTest (IUnknown *pDeviceOrContext, NvU32 bEnable, float fMinDepth, float fMaxDepth)
NVAPI_INTERFACE	NvAPI_D3D_GetCurrentSLIState (IUnknown *pDevice, NV_GET_CURRENT_SLI_STATE *pSliState)
NVAPI_INTERFACE	NvAPI_D3D_SetResourceHint (IUnknown *pDev, NVDX_ObjectHandle obj, NVAPI_D3D_SETRESOURCEHINT_CATEGORY dwHintCategory, NvU32 dwHintName, NvU32 *pdwHintValue)
NVAPI_INTERFACE	NvAPI_D3D_BeginResourceRendering (IUnknown *pDeviceOrContext, NVDX_ObjectHandle obj, NvU32 Flags)
NVAPI_INTERFACE	NvAPI_D3D_EndResourceRendering (IUnknown *pDeviceOrContext, NVDX_ObjectHandle obj, NvU32 Flags)

Detailed Description

Macro Definition Documentation

NV_GET_CURRENT_SLI_STATE_VER1

#define NV_GET_CURRENT_SLI_STATE_VER1   MAKE_NVAPI_VERSION(NV_GET_CURRENT_SLI_STATE_V1,1)

NV_MAX_PIXEL_SHADING_RATES

#define NV_MAX_PIXEL_SHADING_RATES   16

See NvAPI_D3D11_RSSetViewportsPixelShadingRates

NVAPI_COPY_ASYNCHRONOUSLY

#define NVAPI_COPY_ASYNCHRONOUSLY   1

SUPPORTED OS: Windows 7 and higher

  DESCRIPTION: This function returns ID3D11MultiGPUDevice used for multi GPU VR support
 
        \param [in]        pDevice                  current d3d device
        \param [in]        version                  version of requested ID3D11MultiGPUDevice. 
        \param [out]       currentVersion           pointer to returned current version of ID3D11MultiGPUDevice. 
        \param [out]       ppD3D11MultiGPUDevice    pointer to returned ID3D11MultiGPUDevice. 
        \param [in]        maxGpus                  max number of gpus this ID3D11MultiGPUDevice is allowed to use
 
 
\return ::NVAPI_OK                          if the call succeeds.
          NVAPI_INVALID_ARGUMENT            if NvAPI_D3D11_MultiGPU_Init() was not enabled prior to the creation of the D3D11 device, 
                                            or if maxGpus is greater than the number of GPUs in the SLI group.
          NVAPI_NO_ACTIVE_SLI_TOPOLOGY      on single-GPU systems, or 
                                            if SLI has not been enabled in the NVIDIA control panel.
          NVAPI_INVALID_CALL                if there is already an ID3D11MultiGPUDevice created for the specified ID3D11Device.
          NVAPI_INCOMPATIBLE_STRUCT_VERSION if requested interface version is greater than the one that is supported by installed.
                                            driver. In this case currentVersion will contain version supported by installed driver. 

Typedef Documentation

ID3DLateLatchObject

typedef ID3DLateLatchObject_V1 ID3DLateLatchObject

See NvAPI_D3D_CreateLateLatchObject

IMPLICIT_SLI_CONTROL

typedef enum _IMPLICIT_SLI_CONTROL IMPLICIT_SLI_CONTROL

SUPPORTED OS: Windows 7 and higher This function enables/disables the SLI rendering mode. It has to be called prior to D3D device creation. Once this function is called with DISABLE_IMPLICIT_SLI parameter all subsequently created devices will be forced to run in a single gpu mode until the same function is called with ENABLE_IMPLICIT_SLI parameter. The enable call will force all subsequently created devices to run in default implicit SLI mode being determined by an application profile or a global control panel SLI setting. This NvAPI call is supported in all DX10+ versions of the driver. It is supported on all Windows versions.

Return values

NVAPI_OK	Completed request
NVAPI_ERROR	Error occurred

NV_ASYNC_FRAME_MARKER_PARAMS_V1

typedef NV_LATENCY_MARKER_PARAMS_V1 NV_ASYNC_FRAME_MARKER_PARAMS_V1

Used in NvAPI_D3D12_SetAsyncFrameMarker

NV_D3D11_EXCLUSIVE_SCISSOR_RECT_DESC_V1

typedef struct _NV_D3D11_EXCLUSIVE_SCISSOR_RECT_DESC_V1 NV_D3D11_EXCLUSIVE_SCISSOR_RECT_DESC_V1

See NvAPI_D3D11_RSSetExclusiveScissorRects

NV_D3D1x_GRAPHICS_CAPS_V1

typedef struct _NV_D3D1x_GRAPHICS_CAPS_V1 NV_D3D1x_GRAPHICS_CAPS_V1

SUPPORTED OS: Windows 10 SUPPORTED OS: Windows 10 and higher SUPPORTED OS: Windows 10 and higher

See NvAPI_D3D1x_GetGraphicsCapabilities

NV_GET_SLEEP_STATUS_PARAMS_V1

typedef struct _NV_GET_SLEEP_STATUS_PARAMS NV_GET_SLEEP_STATUS_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

Used to get sleep status

NV_LATENCY_MARKER_PARAMS_V1

typedef struct _NV_LATENCY_MARKER_PARAMS NV_LATENCY_MARKER_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

Used set latency markers

NV_LATENCY_RESULT_PARAMS_V1

typedef struct _NV_LATENCY_RESULT_PARAMS NV_LATENCY_RESULT_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

Used to get latency report.

NV_MULTIGPU_CAPS_V1

typedef struct _NV_MULTIGPU_CAPS_V1 NV_MULTIGPU_CAPS_V1

SUPPORTED OS: Windows 7 and higher DESCRIPTION: Request to get multi GPU extension caps.

Parameters

[in/out]

pMultiGPUCaps Pointer to a structure returning multi GPU caps

Return values

NVAPI_OK	Call succeeded.
NVAPI_ERROR	Call failed.

NV_MULTIVIEW_PARAMS_V1

typedef struct _NV_MULTIVIEW_PARAMS_V1 NV_MULTIVIEW_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

Used for setting the Mode for MultiView HW Feature. <>

NV_PIXEL_SRSO_1x2

typedef struct _NV_PIXEL_SRSO_1x2 NV_PIXEL_SRSO_1x2

See NvAPI_D3D11_RSGetPixelShadingRateSampleOrder See NvAPI_D3D11_RSSetPixelShadingRateSampleOrder

NV_QUERY_LATELATCH_SUPPORT_PARAMS_V1

typedef struct _NV_QUERY_LATELATCH_SUPPORT_PARAMS NV_QUERY_LATELATCH_SUPPORT_PARAMS_V1

See NvAPI_D3D_QueryLateLatchSupport

NV_QUERY_MODIFIED_W_SUPPORT_PARAMS_V1

typedef struct _NV_QUERY_MODIFIED_W_SUPPORT_PARAMS NV_QUERY_MODIFIED_W_SUPPORT_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

Used to query the support of Lens Matched Shading HW feature <>

NV_QUERY_MULTIVIEW_SUPPORT_PARAMS_V1

typedef struct _NV_QUERY_MULTIVIEW_SUPPORT_PARAMS_V1 NV_QUERY_MULTIVIEW_SUPPORT_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

Used to query the support of MultiView HW feature <>

NV_QUERY_SINGLE_PASS_STEREO_SUPPORT_PARAMS_V1

typedef struct _NV_QUERY_SINGLE_PASS_STEREO_SUPPORT_PARAMS_V1 NV_QUERY_SINGLE_PASS_STEREO_SUPPORT_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

Used to query the support of Single Pass Stereo HW feature <>

NV_QUERY_SMP_ASSIST_SUPPORT_PARAMS_V1

typedef struct _NV_QUERY_SMP_ASSIST_SUPPORT_PARAMS_V1 NV_QUERY_SMP_ASSIST_SUPPORT_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

NV_RESOLVE_MODE

typedef enum _NV_RESOLVE_MODE NV_RESOLVE_MODE

SUPPORTED OS: Windows 10 and higher SUPPORTED OS: Windows 10 and higher

Valid modes for NvAPI_D3D11_ResolveSubresourceRegion() and NvAPI_D3D12_ResolveSubresourceRegion

NV_SET_SLEEP_MODE_PARAMS_V1

typedef struct _NV_SET_SLEEP_MODE_PARAMS NV_SET_SLEEP_MODE_PARAMS_V1

SUPPORTED OS: Windows 7 and higher

Used to set sleep mode

NV_SMP_ASSIST_TYPE

typedef enum NV_SMP_ASSIST_TYPE NV_SMP_ASSIST_TYPE

SUPPORTED OS: Windows 7 and higher

NVAPI_ANSEL_FEATURE

typedef enum _NVAPI_ANSEL_FEATURE NVAPI_ANSEL_FEATURE

SUPPORTED OS: Windows 7 and higher

  DESCRIPTION: This function configure the setting of AnselShim, including hotkey.
 
        \param [in]        pDevice             current d3d device (should be ID3D11Device, ID3D10Device, or ID3D12Device)
        \param [in]        pAnselConfig        configuration of Ansel to be set, including hotkey setting
 
 
\return ::NVAPI_OK     if the call succeeds.

NVAPI_D3D11_INSERTWFI_FLAG

typedef enum _NVAPI_D3D11_INSERTWFI_FLAG NVAPI_D3D11_INSERTWFI_FLAG

DESCRIPTION: Causes the driver to skip synchronization that is normally needed when accessing UAVs. Applications must use this with caution otherwise this might cause data hazards when multiple draw calls/compute shader launches are accessing same memory locations

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	*pDeviceOrContext	pointer to D3D11 device, or D3D11 device context
[in]	insertWFIFlags	bit fields to indicate which WFI would be inserted (gfx / compute / both).

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NVAPI_D3D_RESOURCERENDERING_FLAG

typedef enum _NVAPI_D3D_RESOURCERENDERING_FLAG NVAPI_D3D_RESOURCERENDERING_FLAG

Used in NvAPI_D3D_BeginResourceRendering().

NVAPI_D3D_SETRESOURCEHINT_CATEGORY

typedef enum _NVAPI_D3D_SETRESOURCEHINT_CATEGORY NVAPI_D3D_SETRESOURCEHINT_CATEGORY

Valid categories for NvAPI_D3D_SetResourceHint()

NVAPI_D3D_SETRESOURCEHINT_SLI

typedef enum _NVAPI_D3D_SETRESOURCEHINT_SLI NVAPI_D3D_SETRESOURCEHINT_SLI

Types of SLI hints;
NVAPI_D3D_SRH_SLI_APP_CONTROLLED_INTERFRAME_CONTENT_SYNC: Valid values : 0 or 1
Default value: 0
Explanation: If the value is 1, the driver will not track any rendering operations that would mark this resource as dirty, avoiding any form of synchronization across frames rendered in parallel in multiple GPUs in AFR mode.

NVAPI_D3D_SRH_SLI_ASK_FOR_BROADCAST_USAGE: Valid values : 0 or 1
Default value: 0
Explanation: If the value is 1, the driver will try to perform operations which involved target resource in broadcast, where it's possible. Hint is static and must be set before resource starts using.

NVAPI_D3D_SRH_SLI_RESPECT_DRIVER_INTERFRAME_CONTENT_SYNC: Valid values : 0 or 1
Default value: 0
Explanation: If the value is 1, the driver will do dirty resource resolve regardless of discard flags in the application profile or AFR-FriendlyD3DHints.exe name using.

PNV_MULTIGPU_CAPS_V1

typedef struct _NV_MULTIGPU_CAPS_V1 * PNV_MULTIGPU_CAPS_V1

Enumeration Type Documentation

_IMPLICIT_SLI_CONTROL

enum _IMPLICIT_SLI_CONTROL

SUPPORTED OS: Windows 7 and higher This function enables/disables the SLI rendering mode. It has to be called prior to D3D device creation. Once this function is called with DISABLE_IMPLICIT_SLI parameter all subsequently created devices will be forced to run in a single gpu mode until the same function is called with ENABLE_IMPLICIT_SLI parameter. The enable call will force all subsequently created devices to run in default implicit SLI mode being determined by an application profile or a global control panel SLI setting. This NvAPI call is supported in all DX10+ versions of the driver. It is supported on all Windows versions.

Return values

NVAPI_OK	Completed request
NVAPI_ERROR	Error occurred

Enumerator
DISABLE_IMPLICIT_SLI
ENABLE_IMPLICIT_SLI

_NV_RESOLVE_MODE

enum _NV_RESOLVE_MODE

SUPPORTED OS: Windows 10 and higher SUPPORTED OS: Windows 10 and higher

Valid modes for NvAPI_D3D11_ResolveSubresourceRegion() and NvAPI_D3D12_ResolveSubresourceRegion

Enumerator
NV_RESOLVE_MODE_SAMPLE_0

_NVAPI_ANSEL_FEATURE

enum _NVAPI_ANSEL_FEATURE

SUPPORTED OS: Windows 7 and higher

  DESCRIPTION: This function configure the setting of AnselShim, including hotkey.
 
        \param [in]        pDevice             current d3d device (should be ID3D11Device, ID3D10Device, or ID3D12Device)
        \param [in]        pAnselConfig        configuration of Ansel to be set, including hotkey setting
 
 
\return ::NVAPI_OK     if the call succeeds.

Enumerator
NVAPI_ANSEL_FEATURE_UNKNOWN
NVAPI_ANSEL_FEATURE_BLACK_AND_WHITE
NVAPI_ANSEL_FEATURE_HUDLESS

_NVAPI_D3D11_INSERTWFI_FLAG

enum _NVAPI_D3D11_INSERTWFI_FLAG

DESCRIPTION: Causes the driver to skip synchronization that is normally needed when accessing UAVs. Applications must use this with caution otherwise this might cause data hazards when multiple draw calls/compute shader launches are accessing same memory locations

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	*pDeviceOrContext	pointer to D3D11 device, or D3D11 device context
[in]	insertWFIFlags	bit fields to indicate which WFI would be inserted (gfx / compute / both).

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Enumerator
NVAPI_D3D_BEGIN_UAV_OVERLAP_NO_WFI	no WFI
NVAPI_D3D_BEGIN_UAV_OVERLAP_GFX_WFI	(bit 0) force graphics WFI
NVAPI_D3D_BEGIN_UAV_OVERLAP_COMP_WFI	(bit 1) force compute WFI

_NVAPI_D3D_RESOURCERENDERING_FLAG

enum _NVAPI_D3D_RESOURCERENDERING_FLAG

Used in NvAPI_D3D_BeginResourceRendering().

Enumerator
NVAPI_D3D_RR_FLAG_DEFAULTS	All bits set to 0 are defaults.
NVAPI_D3D_RR_FLAG_FORCE_DISCARD_CONTENT	(bit 0) The flag forces to discard previous content of the resource regardless of the NvApiHints_Sli_Disable_InterframeSync hint
NVAPI_D3D_RR_FLAG_FORCE_KEEP_CONTENT	(bit 1) The flag forces to respect previous content of the resource regardless of the NvApiHints_Sli_Disable_InterframeSync hint
NVAPI_D3D_RR_FLAG_MULTI_FRAME	(bit 2) The flag hints the driver that content will be used for many frames. If not specified then the driver assumes that content is used only on the next frame

_NVAPI_D3D_SETRESOURCEHINT_CATEGORY

enum _NVAPI_D3D_SETRESOURCEHINT_CATEGORY

Valid categories for NvAPI_D3D_SetResourceHint()

Enumerator
NVAPI_D3D_SRH_CATEGORY_SLI

_NVAPI_D3D_SETRESOURCEHINT_SLI

enum _NVAPI_D3D_SETRESOURCEHINT_SLI

Types of SLI hints;
NVAPI_D3D_SRH_SLI_APP_CONTROLLED_INTERFRAME_CONTENT_SYNC: Valid values : 0 or 1
Default value: 0
Explanation: If the value is 1, the driver will not track any rendering operations that would mark this resource as dirty, avoiding any form of synchronization across frames rendered in parallel in multiple GPUs in AFR mode.

NVAPI_D3D_SRH_SLI_ASK_FOR_BROADCAST_USAGE: Valid values : 0 or 1
Default value: 0
Explanation: If the value is 1, the driver will try to perform operations which involved target resource in broadcast, where it's possible. Hint is static and must be set before resource starts using.

NVAPI_D3D_SRH_SLI_RESPECT_DRIVER_INTERFRAME_CONTENT_SYNC: Valid values : 0 or 1
Default value: 0
Explanation: If the value is 1, the driver will do dirty resource resolve regardless of discard flags in the application profile or AFR-FriendlyD3DHints.exe name using.

Enumerator
NVAPI_D3D_SRH_SLI_APP_CONTROLLED_INTERFRAME_CONTENT_SYNC
NVAPI_D3D_SRH_SLI_ASK_FOR_BROADCAST_USAGE
NVAPI_D3D_SRH_SLI_RESPECT_DRIVER_INTERFRAME_CONTENT_SYNC

NV_LATENCY_MARKER_TYPE

enum NV_LATENCY_MARKER_TYPE

SUPPORTED OS: Windows 7 and higher

Used define latency marker type

Enumerator
SIMULATION_START
SIMULATION_END
RENDERSUBMIT_START
RENDERSUBMIT_END
PRESENT_START
PRESENT_END
INPUT_SAMPLE
TRIGGER_FLASH
PC_LATENCY_PING
OUT_OF_BAND_RENDERSUBMIT_START
OUT_OF_BAND_RENDERSUBMIT_END
OUT_OF_BAND_PRESENT_START
OUT_OF_BAND_PRESENT_END

NV_OUT_OF_BAND_CQ_TYPE

enum NV_OUT_OF_BAND_CQ_TYPE

SUPPORTED OS: Windows 10 and higher

Used in NvAPI_D3D12_NotifyOutOfBandCommandQueue

Enumerator
OUT_OF_BAND_RENDER
OUT_OF_BAND_PRESENT

NV_SMP_ASSIST_TYPE

enum NV_SMP_ASSIST_TYPE

SUPPORTED OS: Windows 7 and higher

Enumerator
NV_SMP_ASSIST_NONE
NV_SMP_ASSIST_MRS
NV_SMP_ASSIST_LMS
NV_SMP_ASSIST_NUM_TYPES

NVAPI_ALIAS_SURFACE_FLAG

enum NVAPI_ALIAS_SURFACE_FLAG

See NvAPI_D3D9_AliasSurfaceAsTexture().

Enumerator
NVAPI_ALIAS_SURFACE_FLAG_NONE
NVAPI_ALIAS_SURFACE_FLAG_USE_SUPER	Use the surface's msaa buffer directly as a texture, rather than resolving. (This is much slower, but potentially has higher quality.)
NVAPI_ALIAS_SURFACE_FLAG_MASK

NVAPI_DEVICE_FEATURE_LEVEL

enum NVAPI_DEVICE_FEATURE_LEVEL

D3D_FEATURE_LEVEL supported - used in NvAPI_D3D11_CreateDevice() and NvAPI_D3D11_CreateDeviceAndSwapChain()

Enumerator
NVAPI_DEVICE_FEATURE_LEVEL_NULL
NVAPI_DEVICE_FEATURE_LEVEL_10_0
NVAPI_DEVICE_FEATURE_LEVEL_10_0_PLUS
NVAPI_DEVICE_FEATURE_LEVEL_10_1
NVAPI_DEVICE_FEATURE_LEVEL_11_0

Function Documentation

DECLARE_INTERFACE()

DECLARE_INTERFACE

(

ID3DLateLatchObject_V1

)

See NvAPI_D3D_CreateLateLatchObject

Release the created LateLatch object and associated buffers.

Request to queue the latch operation to the GPU.

Get ID3D11Buffer* available at the given 'index'

Returns the number of late latch buffers created for this LateLatchObject.

Fully update all LateLatch buffers with new data.

Partially update one of the LateLatch buffers with new data.

References __in.

NvAPI_D3D10_SetDepthBoundsTest()

NVAPI_INTERFACE NvAPI_D3D10_SetDepthBoundsTest	(	ID3D10Device *	pDev,
		NvU32	bEnable,
		float	fMinDepth,
		float	fMaxDepth
	)

DESCRIPTION: This function enables/disables the depth bounds test.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDev	The device to set the depth bounds test
[in]	bEnable	Enable(non-zero)/disable(zero) the depth bounds test
[in]	fMinDepth	The minimum depth for the depth bounds test
[in]	fMaxDepth	The maximum depth for the depth bounds test The valid values for fMinDepth and fMaxDepth are such that 0 <= fMinDepth <= fMaxDepth <= 1

Returns

NVAPI_OK if the depth bounds test was correctly enabled or disabled

NvAPI_D3D11_AliasMSAATexture2DAsNonMSAA()

NVAPI_INTERFACE NvAPI_D3D11_AliasMSAATexture2DAsNonMSAA	(	__in ID3D11Device *	pDevice,
		__in ID3D11Texture2D *	pInputTex,
		__out ID3D11Texture2D **	ppOutTex
	)

SUPPORTED OS: Windows 10 and higher SUPPORTED OS: Windows 8 and higher SUPPORTED OS: Windows 8 and higher SUPPORTED OS: Windows 8 and higher SUPPORTED OS: Windows 8 and higher SUPPORTED OS: Windows 7 and higher

  DESCRIPTION: This function allows creating (aliasing) a non-MSAA Texture2D object using the same memory as the given multi-sampled
               texture (pInputTex). The surface created would be bloated in width and height but it will have SampleCount = 1
               For 2X MSAA: OutTex.Width = InputTex.Width * 2, outTex.Height = InputTex.Height
               For 4X MSAA: OutTex.Width = InputTex.Width * 2, outTex.Height = InputTex.Height * 2
               For 8X MSAA: OutTex.Width = InputTex.Width * 4, outTex.Height = InputTex.Height * 2
               Only textures SampleQuality = 0 can be aliased as Non MSAA
               The app should ensure that original texture is released only after the aliased copy is released.
 
               This function is  free-threaded create compatible i.e. it can be called from a different thread 
               than the one calling immediate device setstate functions.   
 
        \param [in]        pDevice             current d3d device
        \param [in]        pInputTex           The MultiSampled Texture2D resource that is being aliased
        \param [out]       ppOutTex            The aliased non AA copy MultiSampled Texture2D resource
 
 
\return :: NVAPI_OK                   if the call succeeds.

NvAPI_D3D11_BeginUAVOverlap()

NVAPI_INTERFACE NvAPI_D3D11_BeginUAVOverlap

(

__in IUnknown *

pDeviceOrContext

)

DESCRIPTION: Causes the driver to skip synchronization that is normally needed when accessing UAVs. Applications must use this with caution otherwise this might cause data hazards when multiple draw calls/compute shader launches are accessing same memory locations

SUPPORTED OS: Windows 7 and higher

Parameters

[in]

*pDeviceOrContext

pointer to D3D11 device, or D3D11 device context

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D11_CheckFeatureSupport()

NVAPI_INTERFACE NvAPI_D3D11_CheckFeatureSupport	(	__in ID3D11Device *	pDevice,
		__in NV_D3D11_FEATURE	Feature,
		__out void *	pFeatureSupportData,
		__in UINT	FeatureSupportDataSize
	)

DESCRIPTION: This function gets information about the features that are supported by the current graphics driver.

Parameters

[in]	pDevice	The device on which to query for support.
[in]	Feature	A member of the NvAPI_D3D11_FEATURE enumerated type that describes which feature to query for suppor.
[in]	pFeatureSupportData	Upon completion of the method, the passed structure is filled with data that describes the feature support.
[out]	FeatureSupportDataSize	The size of the structure passed to the pFeatureSupportData parameter.

Since

Release: 410

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status.

Return values

:	Returns NVAPI_OK if successful; returns NVAPI_INVALID_ARGUMENT if an unsupported data type is passed to the pFeatureSupportData parameter or a size mismatch is detected for the FeatureSupportDataSize parameter;

NvAPI_D3D11_CreateDevice()

NVAPI_INTERFACE NvAPI_D3D11_CreateDevice	(	IDXGIAdapter *	pAdapter,
		D3D_DRIVER_TYPE	DriverType,
		HMODULE	Software,
		UINT	Flags,
		CONST D3D_FEATURE_LEVEL *	pFeatureLevels,
		UINT	FeatureLevels,
		UINT	SDKVersion,
		ID3D11Device **	ppDevice,
		D3D_FEATURE_LEVEL *	pFeatureLevel,
		ID3D11DeviceContext **	ppImmediateContext,
		NVAPI_DEVICE_FEATURE_LEVEL *	pSupportedLevel
	)

DESCRIPTION: This function tries to create a DirectX 11 device. If the call fails (if we are running on pre-DirectX 11 hardware), depending on the type of hardware it will try to create a DirectX 10.1 OR DirectX 10.0+ OR DirectX 10.0 device. The function call is the same as D3D11CreateDevice(), but with an extra argument (D3D_FEATURE_LEVEL supported by the device) that the function fills in. This argument can contain -1 (NVAPI_DEVICE_FEATURE_LEVEL_NULL), if the requested featureLevel is less than DirecX 10.0.

NOTE: When NvAPI_D3D11_CreateDevice is called with 10+ feature level we have an issue on few set of tesla hardware (G80/G84/G86/G92/G94/G96) which does not support all feature level 10+ functionality e.g. calling driver with mismatch between RenderTarget and Depth Buffer. App developers should take into consideration such limitation when using NVAPI on such tesla hardwares. SUPPORTED OS: Windows 7 and higher

Since

Release: 185

Parameters

[in]	pAdapter
[in]	DriverType
[in]	Software
[in]	Flags
[in]	*pFeatureLevels
[in]	FeatureLevels
[in]	SDKVersion
[in]	**ppDevice
[in]	*pFeatureLevel
[in]	**ppImmediateContext
[in]	*pSupportedLevel	D3D_FEATURE_LEVEL supported

Returns

NVAPI_OK if the createDevice call succeeded.

NvAPI_D3D11_CreateDeviceAndSwapChain()

NVAPI_INTERFACE NvAPI_D3D11_CreateDeviceAndSwapChain	(	IDXGIAdapter *	pAdapter,
		D3D_DRIVER_TYPE	DriverType,
		HMODULE	Software,
		UINT	Flags,
		CONST D3D_FEATURE_LEVEL *	pFeatureLevels,
		UINT	FeatureLevels,
		UINT	SDKVersion,
		CONST DXGI_SWAP_CHAIN_DESC *	pSwapChainDesc,
		IDXGISwapChain **	ppSwapChain,
		ID3D11Device **	ppDevice,
		D3D_FEATURE_LEVEL *	pFeatureLevel,
		ID3D11DeviceContext **	ppImmediateContext,
		NVAPI_DEVICE_FEATURE_LEVEL *	pSupportedLevel
	)

DESCRIPTION: This function tries to create a DirectX 11 device and swap chain. If the call fails (if we are running on pre=DirectX 11 hardware), depending on the type of hardware it will try to create a DirectX 10.1 OR DirectX 10.0+ OR DirectX 10.0 device. The function call is the same as D3D11CreateDeviceAndSwapChain,
but with an extra argument (D3D_FEATURE_LEVEL supported by the device) that the function fills in. This argument can contain -1 (NVAPI_DEVICE_FEATURE_LEVEL_NULL), if the requested featureLevel is less than DirectX 10.0.

SUPPORTED OS: Windows 7 and higher

Since

Release: 185

Parameters

[in]	pAdapter
[in]	DriverType
[in]	Software
[in]	Flags
[in]	*pFeatureLevels
[in]	FeatureLevels
[in]	SDKVersion
[in]	*pSwapChainDesc
[in]	**ppSwapChain
[in]	**ppDevice
[in]	*pFeatureLevel
[in]	**ppImmediateContext
[in]	*pSupportedLevel	D3D_FEATURE_LEVEL supported

return NVAPI_OK if the createDevice with swap chain call succeeded.

NvAPI_D3D11_CreateImplicitMSAATexture2D()

NVAPI_INTERFACE NvAPI_D3D11_CreateImplicitMSAATexture2D	(	__in ID3D11Device *	pDevice,
		__in const D3D11_TEXTURE2D_DESC *	pDesc,
		__out ID3D11Texture2D **	ppTexture2D
	)

SUPPORTED OS: Windows 10 and higher

Since

Release: 410

  DESCRIPTION: NvAPI_D3D11_CreateImplicitMSAATexture2D is a simple wrapper of ID3D11Device::CreateTexture2D 
               which allows to create multisampled 2D texture that is exposed to DX runtime as non-multisampled texture.
 
        \param [in]       pDevice      Current d3d device
        \param [in]       pDesc        A pointer to a D3D11_TEXTURE2D_DESC structure that describes a 2D texture resource.
                                       To create a typeless resource that can be interpreted at runtime into different,
                                       compatible formats, specify a typeless format in the texture description.
                                       To generatemipmap levels automatically, set the number of mipmap levels to 0.
                                       SampleDesc.SampleCount specifies actual resource sample count, while D3D runtime object
                                       sees resource as non-multisampled.
 
        \param [out]      ppTexture2D  A pointer to a buffer that receives a pointer to a ID3D11Texture2D interface for the
                                       created texture.
 
\return  This API can return any of the error codes enumerated in
         #NvAPI_Status.  See MSDN for the API specific error codes.

NvAPI_D3D11_CreateMultiGPUDevice()

NVAPI_INTERFACE NvAPI_D3D11_CreateMultiGPUDevice	(	__in ID3D11Device *	pDevice,
		__in ULONG	version,
		__out ULONG *	currentVersion,
		__out ID3D11MultiGPUDevice **	ppD3D11MultiGPUDevice,
		__in UINT	maxGpus = ALL_GPUS
	)

NvAPI_D3D11_CreateRasterizerState()

NVAPI_INTERFACE NvAPI_D3D11_CreateRasterizerState	(	__in ID3D11Device *	pDevice,
		__in const NvAPI_D3D11_RASTERIZER_DESC_EX *	pRasterizerDesc,
		__out ID3D11RasterizerState **	ppRasterizerState
	)

  DESCRIPTION: This function is an extension of ID3D11Device::CreateRasterizerState with additional raster states
 
               If programmable sample positions is used, to decompress the surface using the currently bound
               programmable sample positions, use function NvAPI_D3D11_DecompressView.
 
               This function is  free-threaded create compatible i.e. it can be called from a different thread 
               than the one calling immediate device setstate functions.   
 
        \param [in]        pDevice             current d3d device
        \param [in]        pRasterizerDesc     Rasterizer state description of type NVAPI_D3D11_RASTERIZER_DESC_EX
        \param [out]       ppRasterizerState   ID3D11RasterizerState 
 
 
\return ::NVAPI_OK     if the call succeeds.

NvAPI_D3D11_CreateShadingRateResourceView()

NVAPI_INTERFACE NvAPI_D3D11_CreateShadingRateResourceView	(	__in ID3D11Device *	pDevice,
		__in ID3D11Resource *	pShadingRateResource,
		__in NV_D3D11_SHADING_RATE_RESOURCE_VIEW_DESC *	pShadingRateResourceViewDesc,
		__out ID3D11NvShadingRateResourceView **	ppShadingRateResourceView
	)

DESCRIPTION: Creates Shading Rate Resource View by taking ID3D11Resource as an input Shading Rate Surface.

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pDevice	The device to be used for creating the Shading Rate Resource View
[in]	pShadingRateResource	Shading Rate Resource on which the view is to be created.

Note

This should be of format DXGI_FORMAT_R8_UINT or DXGI_FORMAT_R8_TYPELESS

This should be confined to size calculated using render target dimensions, NV_VARIABLE_PIXEL_SHADING_TILE_WIDTH and NV_VARIABLE_PIXEL_SHADING_TILE_HEIGHT

Parameters

[in]	pShadingRateDesc	Shading Rate Resource View descriptor
[out]	ppShadingRateResourceView	Address of a pointer to ID3D11NvShadingRateResourceView for returning the newly created Shading Rate Resource View

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D11_DecompressView()

NVAPI_INTERFACE NvAPI_D3D11_DecompressView	(	__in ID3D11Device *	pDevice,
		__in ID3D11DeviceContext *	pDeviceContext,
		__in ID3D11View *	pView
	)

SUPPORTED OS: Windows 7 and higher

  DESCRIPTION: This function is used to decompress a surface using the currently bound programmable sample positions.
 
               This is needed:
                 - When writing to a surface in a region previously rendered by different sample positions and no clear was done.
                 - When reading a surface in a shader that was rendered using non-standard sample positions.
                 - When copying from a surface that was rendered using non-standard sample positions.
 
        \param [in]        pDevice             Current d3d11 device
        \param [in]        pDeviceContext      Current d3d11 device context
        \param [in]        pView               Current view to decompress
 
 
\return ::NVAPI_OK     if the call succeeds.

NvAPI_D3D11_EndUAVOverlap()

NVAPI_INTERFACE NvAPI_D3D11_EndUAVOverlap

(

__in IUnknown *

pDeviceOrContext

)

DESCRIPTION: Re-enables driver synchronization between calls that access same UAVs See NvAPI_D3D_BeginUAVOverlap for more details.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]

*pDeviceOrContext

pointer to D3D11 device, or D3D11 device context

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D11_EnumerateMetaCommands()

NVAPI_INTERFACE NvAPI_D3D11_EnumerateMetaCommands	(	__in ID3D11Device *	pDevice,
		__inout NvU32 *	pNumMetaCommands,
		__out_ecount_opt *pNumMetaCommands NVAPI_META_COMMAND_DESC *	pDescs
	)

Since

Release: 400

  DESCRIPTION: Enumerates MetaCommands supported on the system
 
        \param [in]        pDevice                A pointer to D3D11 device.
        \param [in/out]    pNumMetaCommands       Should be non-null. When the value pointed by pNumMetaCommands is 0 (or when pDescs is NULL), the function returns number of metacommands supported.
                                                  When the value pointed is non-zero, the value indicates number of Metacommand descriptions to be populated in pDescs array.
        \param [out]       pDescs                 Pointer to array where Metacommand descriptions will be returned. Can be null to indicate that the app is querying the number of supported metacommands. 
                                                  Otherwise should have enough space to hold *pNumMetaCommands descriptors
SUPPORTED OS:  Windows 10
 
\return  This API can return any of the error codes enumerated in
         #NvAPI_Status.  If there are return error codes with specific
         meaning for this API, they are listed below.

NvAPI_D3D11_ExecuteMetaCommand()

NVAPI_INTERFACE NvAPI_D3D11_ExecuteMetaCommand	(	__in ID3D11DeviceContext *	pDeviceContext,
		__in ID3D11NvMetaCommand *	pMetaCommand,
		__in_bcount(ExecutionParametersDataSize) const void *	pExecutionParametersData,
		__in NvU32	ExecutionParametersDataSize
	)

Since

Release: 400

  DESCRIPTION: Executes the given MetaCommand with the parameters passed in
 
        \param [in]        pDeviceContext                   A pointer to the d3d11 device context
        \param [in]        pMetaCommand                     the MetaCommand to execute
        \param [in]        pExecutionParametersData         Structure containing parameters
        \param [in]        ExecutionParametersDataSize      Size of the parameter structure in bytes 
SUPPORTED OS:  Windows 10
 
\return  This API can return any of the error codes enumerated in
         #NvAPI_Status.  If there are return error codes with specific
         meaning for this API, they are listed below.

NvAPI_D3D11_InitializeMetaCommand()

NVAPI_INTERFACE NvAPI_D3D11_InitializeMetaCommand	(	__in ID3D11DeviceContext *	pDeviceContext,
		__in ID3D11NvMetaCommand *	pMetaCommand,
		__in_bcount(InitializationParametersDataSize) const void *	pInitializationParametersData,
		__in NvU32	InitializationParametersDataSize
	)

Since

Release: 400

  DESCRIPTION: Initializes the given MetaCommand with the parameters passed in
 
        \param [in]        pDeviceContext                   A pointer to the d3d11 device context
        \param [in]        pMetaCommand                     the MetaCommand to initialize
        \param [in]        pInitializationParametersData    Structure containing parameters
        \param [in]        InitializationParametersDataSize Size of the parameter structure in bytes 
SUPPORTED OS:  Windows 10
 
\return  This API can return any of the error codes enumerated in
         #NvAPI_Status.  If there are return error codes with specific
         meaning for this API, they are listed below.

NvAPI_D3D11_IsNvShaderExtnOpCodeSupported()

NVAPI_INTERFACE NvAPI_D3D11_IsNvShaderExtnOpCodeSupported	(	__in IUnknown *	pDev,
		__in NvU32	opCode,
		__out bool *	pSupported
	)

DESCRIPTION: This function checks if a nv HLSL shader extension opcode is supported on current hardware. List of opcodes is in nvShaderExtnEnums.h To use Nvidia HLSL extensions the application must include nvHLSLExtns.h in the hlsl shader code. See nvHLSLExtns.h for more details on supported opcodes.

This function can be called from a different thread than the one calling immediate device setstate functions.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDev	The device on which to query for support, should be a ID3D11Device+ device
[in]	opCode	the opcode to check
[out]	pSupported	true if supported, false otherwise

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

:	NVAPI_OK if the call succeeded

NvAPI_D3D11_MultiDrawIndexedInstancedIndirect()

NVAPI_INTERFACE NvAPI_D3D11_MultiDrawIndexedInstancedIndirect	(	__in ID3D11DeviceContext *	pDevContext11,
		__in NvU32	drawCount,
		__in ID3D11Buffer *	pBuffer,
		__in NvU32	alignedByteOffsetForArgs,
		__in NvU32	alignedByteStrideForArgs
	)

DESCRIPTION: Extension of DrawIndexedInstancedIndirect that takes a draw count in. The effect of this function is to loop over that draw count and perform the DrawIndexedInstancedIndirect operation each time, incrementing the buffer offset by the supplied stride each time.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	*pDevContext11	Pointer to D3D11 device context (IC or DC)
[in]	drawCount	Do DrawIndexedInstancedIndirect operation this many times
[in]	*pBuffer	ID3D11Buffer that contains the command parameters
[in]	alignedByteOffsetForArgs	Start in pBuffer of the command parameters
[in]	alignedByteStrideForArgs	Stride of the command parameters - must be >= 5 * sizeof(NvU32)

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

NVAPI_D3D_DEVICE_NOT_REGISTERED

When MultiDraw is called on a deferred context, and the device has not yet been registered (NvAPI_D3D_RegisterDevice), this error is returned.

NvAPI_D3D11_MultiDrawInstancedIndirect()

NVAPI_INTERFACE NvAPI_D3D11_MultiDrawInstancedIndirect	(	__in ID3D11DeviceContext *	pDevContext11,
		__in NvU32	drawCount,
		__in ID3D11Buffer *	pBuffer,
		__in NvU32	alignedByteOffsetForArgs,
		__in NvU32	alignedByteStrideForArgs
	)

DESCRIPTION: Extension of DrawInstancedIndirect that takes a draw count in. The effect of this function is to loop over that draw count and perform the DrawInstancedIndirect operation each time, incrementing the buffer offset by the supplied stride each time.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	*pDevContext11	Pointer to D3D11 device context (IC or DC)
[in]	drawCount	Do DrawInstancedIndirect operation this many times
[in]	*pBuffer	ID3D11Buffer that contains the command parameters
[in]	alignedByteOffsetForArgs	Start in pBuffer of the command parameters
[in]	alignedByteStrideForArgs	Stride of the command parameters - must be >= 4 * sizeof(NvU32)

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

NVAPI_D3D_DEVICE_NOT_REGISTERED

When MultiDraw is called on a deferred context, and the device has not yet been registered (NvAPI_D3D_RegisterDevice), this error is returned.

NvAPI_D3D11_MultiGPU_GetCaps()

NVAPI_INTERFACE NvAPI_D3D11_MultiGPU_GetCaps

(

__inout PNV_MULTIGPU_CAPS

pMultiGPUCaps

)

SUPPORTED OS: Windows 7 and higher

NvAPI_D3D11_MultiGPU_Init()

NVAPI_INTERFACE NvAPI_D3D11_MultiGPU_Init

(

__in bool

bEnable

)

SUPPORTED OS: Windows 7 and higher DESCRIPTION: Request to enable/disable multi GPU extension. Also if enabled automatically disables auto stereo.

Parameters

[in]

bEnable

if true enables the extension for all subsequently created devices. Otherwise disables it

Return values

NVAPI_OK	Call succeeded.
NVAPI_ERROR	Call failed.

NvAPI_D3D11_ResolveSubresourceRegion()

NVAPI_INTERFACE NvAPI_D3D11_ResolveSubresourceRegion	(	__in ID3D11Device *	pDevice,
		__in ID3D11Texture2D *	pDstResource,
		__in UINT	DstSubresource,
		__in UINT	DstX,
		__in UINT	DstY,
		__in ID3D11Texture2D *	pSrcResource,
		__in UINT	SrcSubresource,
		__in_opt const RECT *	pSrcRect,
		__in DXGI_FORMAT	Format,
		__in NV_RESOLVE_MODE	ResolveMode
	)

Since

Release: 410

  DESCRIPTION: NvAPI_D3D11_ResolveSubresourceRegion is D3D11 an analog of D3D12 ResolveSubresourceRegion.
 
        \param [in]       pDstResource    Destination resource. Must be a created with the D3D11_USAGE_DEFAULT flag and be single-sampled.
        \param [in]       DstSubresource  A zero-based index, that identifies the destination subresource. Use D3D11CalcSubresource to calculate the index.
        \param [in]       DstX            The X coordinate of the left-most edge of the destination region.
                                          The width of the destination region is the same as the width of the source rect.
 
        \param [in]       DstY            The Y coordinate of the top-most edge of the destination region.
                                          The height of the destination region is the same as the height of the source rect.
 
        \param [in]       pSrcResource    Source resource. Must be multisampled.
        \param [in]       SrcSubresource  The source subresource of the source resource.
        \param [in]       pSrcRect        Specifies the rectangular region of the source resource to be resolved.
                                          Passing NULL for pSrcRect specifies that the entire subresource is to be resolved.
 
        \param [in]       Format          A DXGI_FORMAT that indicates how the multisampled resource will be resolved to a single-sampled resource.
        \param [in]       ResolveMode     Specifies the operation used to resolve the source samples. NV_RESOLVE_MODE_SAMPLE_0 is the only supported mode.
                                          NV_RESOLVE_MODE_SAMPLE_0 outputs sample 0 and discards all other samples.
 
\return  This API can return any of the error codes enumerated in
         #NvAPI_Status.  See MSDN for the API specific error codes.

NvAPI_D3D11_RSGetPixelShadingRateSampleOrder()

NVAPI_INTERFACE NvAPI_D3D11_RSGetPixelShadingRateSampleOrder	(	__in IUnknown *	pContext,
		__out NV_PIXEL_SHADING_RATE_SAMPLE_ORDER_TABLE *	pSampleOrderTable
	)

DESCRIPTION: Get the Sample Order for Variable Shading Rate

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pContext	The device context (ID3D11DeviceContext) used for getting the Shading Rate Sample Order
[out]	pSampleOrderTable	A pointer to NV_PIXEL_SHADING_RATE_SAMPLE_ORDER_TABLE where the current Sample Order for Variable Pixel Rate Shading that is returned

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D11_RSSetExclusiveScissorRects()

NVAPI_INTERFACE NvAPI_D3D11_RSSetExclusiveScissorRects	(	__in IUnknown *	pContext,
		__in NV_D3D11_EXCLUSIVE_SCISSOR_RECTS_DESC *	pExclusiveScissorRectsDesc
	)

DESCRIPTION: Sets Exclusive Scissor Rects. The content bounded within the Scissor Rects will be excluded from rendering unlike regular Scissor Rects. These are orthogonal with Regular Scissor Rects.

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pContext	The device context (ID3D11DeviceContext) to be used for setting the Exclusive Scissor Rects.
[in]	pExclusiveScissorRectsDesc	Description of the Exclusive Scissor Rects duly filled with their dimensions and control over enablement of individual ScissorRect

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D11_RSSetPixelShadingRateSampleOrder()

NVAPI_INTERFACE NvAPI_D3D11_RSSetPixelShadingRateSampleOrder	(	__in IUnknown *	pContext,
		__in NV_PIXEL_SHADING_RATE_SAMPLE_ORDER_TABLE *	pSampleOrderTable
	)

DESCRIPTION: Set the Sample Order for Variable Shading Rate

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pContext	The device context (ID3D11DeviceContext) used for setting the Shading Rate Sample Order
[out]	pSampleOrderTable	Sample Order for Variable Shading Rate to be set

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D11_RSSetShadingRateResourceView()

NVAPI_INTERFACE NvAPI_D3D11_RSSetShadingRateResourceView	(	__in IUnknown *	pContext,
		__in ID3D11NvShadingRateResourceView *	pShadingRateResourceView
	)

DESCRIPTION: Sets Shading Rate Resource View

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pContext	The device context (ID3D11DeviceContext) used for setting the Shading Rate Resource View
[out]	pShadingRateResourceView	Shading Rate Resource View to be set

Note

See NvAPI_D3D11_CreateShadingRateResourceView

Passing this as null will reset Shading Rate Resource View to defaults

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D11_RSSetViewportsPixelShadingRates()

NVAPI_INTERFACE NvAPI_D3D11_RSSetViewportsPixelShadingRates	(	__in IUnknown *	pContext,
		__in NV_D3D11_VIEWPORTS_SHADING_RATE_DESC *	pShadingRateDesc
	)

DESCRIPTION: Sets Pixel Shading Rates and Enables/Disables per-viewport Variable Pixel Shading Rate feature

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pContext	The device context (ID3D11DeviceContext) to be used for setting the Viewports Shading Rates
[in]	pShadingRateDesc	Shading rate descriptor

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D11_SetDepthBoundsTest()

NVAPI_INTERFACE NvAPI_D3D11_SetDepthBoundsTest	(	IUnknown *	pDeviceOrContext,
		NvU32	bEnable,
		float	fMinDepth,
		float	fMaxDepth
	)

DESCRIPTION: This function enables/disables the depth bounds test

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDeviceOrContext	The device or device context to set depth bounds test
[in]	bEnable	Enable(non-zero)/disable(zero) the depth bounds test
[in]	fMinDepth	The minimum depth for depth bounds test
[in]	fMaxDepth	The maximum depth for depth bounds test The valid values for fMinDepth and fMaxDepth are such that 0 <= fMinDepth <= fMaxDepth <= 1

Returns

NVAPI_OK if the depth bounds test was correcly enabled or disabled

NvAPI_D3D11_SetNvShaderExtnSlot()

NVAPI_INTERFACE NvAPI_D3D11_SetNvShaderExtnSlot	(	__in IUnknown *	pDev,
		__in NvU32	uavSlot
	)

DESCRIPTION: This function sets the fake UAV slot that is used by Nvidia HLSL shader extensions globally. All createShader calls made to the driver after setting this slot would treat writes/reads to this UAV in a different way. Applications are expected to bind null UAV to this slot. The same slot is used for all shader stages. To disable shader extensions the app need to set this uav slot to 0xFFFFFFFF. To use Nvidia HLSL extensions the application must include nvHLSLExtns.h in the hlsl shader code. See nvHLSLExtns.h for more details.

This function can be called from a different thread than the one calling immediate device setstate functions.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDev	The device for which to set the extension slot should be a ID3D11Device+ device
[in]	uavSlot	the uav slot to use

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

:	NVAPI_OK : success, the uavSlot was set sucessfully

NvAPI_D3D11_SetNvShaderExtnSlotLocalThread()

NVAPI_INTERFACE NvAPI_D3D11_SetNvShaderExtnSlotLocalThread	(	__in IUnknown *	pDev,
		__in NvU32	uavSlot
	)

DESCRIPTION: This function sets the fake UAV slot that is used by Nvidia HLSL shader extensions on local thread. All createShader calls on the same thread that calls this function after setting this slot would treat writes/reads to this UAV in a different way. Applications are expected to bind null UAV to this slot. The same slot is used for all shader stages. To disable shader extensions the app may set this uav slot to 0xFFFFFFFF. To use Nvidia HLSL extensions the application must include nvHLSLExtns.h in the hlsl shader code. See nvHLSLExtns.h for more details.

This function can be called from a different thread than the one calling immediate device setstate functions.

SUPPORTED OS: Windows 7 and higher

Since

Release: 387

Parameters

[in]	pDev	The device for which to set the extension slot should be a ID3D11Device+ device
[in]	uavSlot	the uav slot to use

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

:	NVAPI_OK : success, the uavSlot was set sucessfully

NvAPI_D3D1x_BindSwapBarrier()

NVAPI_INTERFACE NvAPI_D3D1x_BindSwapBarrier	(	IUnknown *	pDevice,
		NvU32	group,
		NvU32	barrier
	)

DESCRIPTION: This API causes a SwapGroup to be bound to or released from the specified SwapBarrier.

Parameters

[in]	pDevice	The caller provides the D3D device that owns the SwapChain used as a SwapGroup client. pDevice can be either ID3D10Device or ID3D10Device1 or ID3D11Device or ID3D12Device.
[in]	group	The caller specifies the SwapGroup to be bound to the SwapBarrier.
[in]	barrier	The caller specifies the SwapBarrier that the SwapGroup should be bound to. If the value of barrier is zero, the SwapGroup releases the SwapBarrier. The SwapGroup will be bound to the SwapBarrier if the value of barrier is a positive integer less than or equal to the maximum number of SwapBarriers queried by NvAPI_D3D1x_QueryMaxSwapGroup. SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	the SwapGroup is bound to the specified SwapBarrier
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D1x_DisableShaderDiskCache()

NVAPI_INTERFACE NvAPI_D3D1x_DisableShaderDiskCache

(

IUnknown *

pDevice

)

SUPPORTED OS: Windows 7 and higher DESCRIPTION: Disables driver managed caching of shader compilations to disk

Parameters

[in]

pDevice

Device to disabled the shader disk cache on

Return values

NVAPI_OK	Shader disk cache was disabled
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	Argument passed in is invalid.

NvAPI_D3D1x_GetGraphicsCapabilities()

NVAPI_INTERFACE NvAPI_D3D1x_GetGraphicsCapabilities	(	__in IUnknown *	pDevice,
		__in NvU32	structVersion,
		__inout NV_D3D1x_GRAPHICS_CAPS *	pGraphicsCaps
	)

DESCRIPTION: Get the graphics capabilities for current hardware/software setup

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pDevice	The ID3D11Device device to be used for getting the graphics capabilities.
[in]	structVersion	Version of the caps struct. Should be set to NV_D3D1x_GRAPHICS_CAPS_VER.
[in,out]	pGraphicsCaps	Pointer to a NV_D3D1x_GRAPHICS_CAPS_CAPS struct created by app. Graphics capabilities will be filled in this struct by the driver.

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D1x_JoinSwapGroup()

NVAPI_INTERFACE NvAPI_D3D1x_JoinSwapGroup	(	IUnknown *	pDevice,
		IDXGISwapChain *	pSwapChain,
		NvU32	group,
		BOOL	blocking
	)

DESCRIPTION: This API causes the SwapChain of a SwapGroup client to join or leave the specified SwapGroup.

Parameters

[in]	pDevice	The caller provides the D3D device that owns the SwapChain used as a SwapGroup client. pDevice can be either ID3D10Device or ID3D10Device1 or ID3D11Device or ID3D12Device.
[in]	pSwapChain	The IDXGISwapChain interface that is used as the SwapGroup client.
[in]	group	The caller specifies the SwapGroup which the SwapChain should join. If the value of group is zero, the SwapChain leaves the SwapGroup. The SwapChain joins a SwapGroup if the SwapGroup number is a positive integer less than or equal to the maximum number of SwapGroups queried by NvAPI_SwapGroup_QueryMaxSwapGroup.
[in]	blocking	The caller specifies that a presentation of this SwapChain should return immediately or block until all members of the SwapGroup are ready and the presentation was actually executed. A boolean value of false means the Present operation returns immediately and a value of true means the Present operation is blocking.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	the SwapChain joined/left the SwapGroup accordingly
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D1x_Present()

NVAPI_INTERFACE NvAPI_D3D1x_Present	(	IUnknown *	pDevice,
		IDXGISwapChain *	pSwapChain,
		UINT	SyncInterval,
		UINT	Flags
	)

DESCRIPTION: Presents the contents of the next buffer in the sequence of back buffers owned by a D3D device. This Present operation supports using a SwapGroup and SwapBarrier on the SwapChain that owns the back buffer to be presented.

NOTE: NvAPI_D3D1x_Present is a wrapper of the method IDXGISwapChain::Present which additionally notifies the D3D driver of the SwapChain used by the runtime for presentation, thus allowing the D3D driver to apply SwapGroup and SwapBarrier functionality to that SwapChain.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDevice	The D3D device interface that is used to issue the Present operation, using the following IDirect3DDevice9::Present input parameters. pDevice can be either ID3D10Device or ID3D10Device1 or ID3D11Device or ID3D12Device.
[in]	pSwapChain	The IDXGISwapChain interface that is intended to present
[in]	SyncInterval	An integer that specifies the how to synchronize presentation of a frame with the vertical blank. Values are: 0: The presentation occurs immediately, there is no synchronization. 1,2,3,4 : Synchronize presentation after the n'th vertical blank.
[in]	Flags	An integer value that contains swap-chain presentation options as defined in DXGI_PRESENT.

Return values

NVAPI_OK	the Present operation was successfully executed
NVAPI_DEVICE_BUSY	the Present operation failed with an error DXGI_ERROR_DEVICE_RESET or DXGI_ERROR_DEVICE_REMOVED,
NVAPI_ERROR	the communication with the D3D driver failed, SwapGroup/SwapBarrier may not be possible.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D1x_QueryFrameCount()

NVAPI_INTERFACE NvAPI_D3D1x_QueryFrameCount	(	IUnknown *	pDevice,
		NvU32 *	pFrameCount
	)

DESCRIPTION: This API queries the universal framecounter of the Quadro-Sync master device.

Parameters

[in]	pDevice	The caller provides the D3D device that has access to the Quadro-Sync device, pDevice can be either ID3D10Device or ID3D10Device1 or ID3D11Device or ID3D12Device.
[out]	pFrameCount	The caller provides the storage space where the framecount is stored.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	*pFrameCount populated with framecount value.
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D1x_QueryMaxSwapGroup()

NVAPI_INTERFACE NvAPI_D3D1x_QueryMaxSwapGroup	(	IUnknown *	pDevice,
		NvU32 *	pMaxGroups,
		NvU32 *	pMaxBarriers
	)

DESCRIPTION: This API queries the number of supported SwapGroups and SwapBarriers in the graphics system.

Parameters

[in]	pDevice	The caller provides the D3D device that is intended to use SwapGroup functionality. pDevice can be either ID3D10Device or ID3D10Device1 or ID3D11Device or ID3D12Device.
[out]	pMaxGroups	The caller provides the storage space where the number of available SwapGroups is stored.
[out]	pMaxBarriers	The caller provides the storage space where the number of available SwapBarriers is stored.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	the number of SwapGroups and SwapBarriers has been stored
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D1x_QuerySwapGroup()

NVAPI_INTERFACE NvAPI_D3D1x_QuerySwapGroup	(	IUnknown *	pDevice,
		IDXGISwapChain *	pSwapChain,
		NvU32 *	pSwapGroup,
		NvU32 *	pSwapBarrier
	)

DESCRIPTION: This API queries the current SwapGroup and SwapBarrier that a SwapChain of a specific client device is bound to.

Parameters

[in]	pDevice	The caller provides the D3D device that owns the SwapChain used as a SwapGroup client. pDevice can be either ID3D10Device or ID3D10Device1 or ID3D11Device or ID3D12Device.
[in]	pSwapChain	The IDXGISwapChain interface that is used as the SwapGroup client.
[out]	pSwapGroup	The caller provides the storage space where the current SwapGroup is stored.
[out]	pSwapBarrier	The caller provides the storage space where the current SwapBarrier is stored.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	the current SwapGroup and SwapBarrier has been stored
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D1x_ResetFrameCount()

NVAPI_INTERFACE NvAPI_D3D1x_ResetFrameCount

(

IUnknown *

pDevice

)

DESCRIPTION: This API resets the universal framecounter on the Quadro-Sync master device.

Parameters

[in]

pDevice

The caller provides the D3D device that has access to the Quadro-Sync device, pDevice can be either ID3D10Device or ID3D10Device1 or ID3D11Device or ID3D12Device.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	framecounter has been reset
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	pDevice arg passed in is invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D9_AliasSurfaceAsTexture()

NvAPI_D3D9_AliasSurfaceAsTexture	(	IDirect3DDevice9 *	pDev,
		IDirect3DSurface9 *	pSurface,
		IDirect3DTexture9 **	ppTexture,
		DWORD	dwFlag
	)

DESCRIPTION: Create a texture that is an alias of a surface registered with NvAPI. The new texture can be bound with IDirect3DDevice9::SetTexture(). Note that the texture must be unbound before drawing to the surface again. Unless the USE_SUPER flag is passed, MSAA surfaces will be resolved before being used as a texture. MSAA depth buffers are resolved with a point filter, and non-depth MSAA surfaces are resolved with a linear filter.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDev	The D3D device that owns the objects
[in]	pSurface	Pointer to a surface that has been registered with NvAPI to which a texture alias is to be provided
[out]	ppTexture	Fill with the texture created
[in]	dwFlag	NVAPI_ALIAS_SURFACE_FLAG to describe how to handle the texture

Return values

NVAPI_OK	completed request
NVAPI_INVALID_POINTER	A null pointer was passed as an argument
NVAPI_INVALID_ARGUMENT	One of the arguments was invalid, probably dwFlag.
NVAPI_UNREGISTERED_RESOURCE	pSurface has not been registered with NvAPI
NVAPI_ERROR	error occurred

NvAPI_D3D9_BindSwapBarrier()

NVAPI_INTERFACE NvAPI_D3D9_BindSwapBarrier	(	IDirect3DDevice9 *	pDevice,
		NvU32	group,
		NvU32	barrier
	)

DESCRIPTION: This API causes a SwapGroup to be bound to or released from the specified SwapBarrier.

Parameters

[in]	pDevice	The caller provides the DirectX 9 device that is used as a swapgroup client
[in]	group	The caller specifies the SwapGroup to be bound to the SwapBarrier.
[in]	barrier	The caller specifies the SwapBarrier that the SwapGroup should be bound to. If the value of barrier is zero, the SwapGroup will be released from the SwapBarrier. The SwapGroup will be bound to the SwapBarrier if the value of barrier is a positive integer less than or equal to the maximum number of SwapBarriers queried by NvAPI_SwapGroup_QueryMaxSwapGroup.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	the SwapGroup is bound to or released from the specified SwapBarrier
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D9_ClearRT()

NVAPI_INTERFACE NvAPI_D3D9_ClearRT	(	IDirect3DDevice9 *	pDevice,
		NvU32	dwNumRects,
		CONST RECT *	pRects,
		float	r,
		float	g,
		float	b,
		float	a
	)

DESCRIPTION: This API Clears the currently bound render target(s) with the given color

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDevice	The D3D device that owns the objects.
[in]	dwNumRects	The no of rectangles to clear. If 0, clear the entire surface (clipped to viewport)
[in]	pRects	Defines the rectangles to clear. Should be NULL if dwNumRects == 0
[in]	r	red component of the clear color
[in]	g	green component of the clear color
[in]	b	blue component of the clear color
[in]	a	alpha component of the clear color

Returns

This API can return any of the error codes enumerated in NvAPI_Status.

NvAPI_D3D9_GetSurfaceHandle()

NVAPI_INTERFACE NvAPI_D3D9_GetSurfaceHandle	(	IDirect3DSurface9 *	pSurface,
		NVDX_ObjectHandle *	pHandle
	)

SUPPORTED OS: Windows 7 and higher This function gets the handle of a given surface. This handle uniquely identifies the surface through all NvAPI entries.

Since

Release: 313

Parameters

[in]	pSurface	Surface to be identified
[out]	pHandle	Will be filled by the return handle

Returns

An int which could be an NvAPI status or DX HRESULT code

NvAPI_D3D9_JoinSwapGroup()

NVAPI_INTERFACE NvAPI_D3D9_JoinSwapGroup	(	IDirect3DDevice9 *	pDevice,
		IDirect3DSwapChain9 *	pSwapChain,
		NvU32	group,
		BOOL	blocking
	)

DESCRIPTION: This API causes the SwapChain of a SwapGroup client to join or leave the specified SwapGroup.

Parameters

[in]	pDevice	The caller provides the DirectX 9 device that is used as a swapgroup client
[in]	pSwapChain	The caller provides the IDirect3DSwapChain9 interface as a handle to the SwapChain that belongs to the swapgroup client device
[in]	group	The caller specifies the SwapGroup which the SwapChain should join. If the value of group is zero, the SwapChain leaves the SwapGroup. The SwapChain joins a SwapGroup if the SwapGroup number is a positive integer less than or equal to the maximum number of SwapGroups queried by NvAPI_SwapGroup_QueryMaxSwapGroup.
[in]	blocking	The caller specifies that a presentation of this SwapChain should return immediately or block until all members of the SwapGroup are ready and the presentation was actually executed. A boolean value of false means the Present operation returns immediately and a value of true means the Present operation is blocking.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	the SwapChain joined/left the SwapGroup accordingly
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D9_Present()

NVAPI_INTERFACE NvAPI_D3D9_Present	(	IDirect3DDevice9 *	pDevice,
		IDirect3DSwapChain9 *	pSwapChain,
		const RECT *	pSourceRect,
		const RECT *	pDestRect,
		HWND	hDestWindowOverride,
		const RGNDATA *	pDirtyRegion
	)

DESCRIPTION: This API presents the contents of the next buffer in the sequence of back buffers owned by a IDirect3DDevice9 device. This Present operation supports using a SwapGroup and SwapBarrier on the SwapChain that owns the back buffer to be presented.

NOTE: NvAPI_D3D9_Present is a wrapper of the method IDirect3DDevice9::Present which additionally notifies the D3D driver of the SwapChain used by the runtime for presentation, thus allowing the D3D driver to apply SwapGroup and SwapBarrier functionality to that SwapChain.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDevice	The IDirect3DDevice9 interface that is used to issue the Present, using the following IDirect3DDevice9::Present input parameters
[in]	pSwapChain	Optional pointer to a IDirect3DSwapChain9 interface. If provided, the presentation is executed using this interface (i.e. pSwapChain->Present()) for the given swapchain only. If NULL, the presentation is executed on the device for all swapchains as in pDevice->Present()
[in]	pSourceRect	A pointer to a RECT structure containing the source rectangle. If NULL, the entire source surface is presented.
[in]	pDestRect	A pointer to a RECT structure containing the destination rectangle, in window client coordinates. If NULL, the entire client area is filled.
[in]	hDestWindowOverride	A pointer to a destination window whose client area is taken as the target for this presentation. If this value is NULL, then the hWndDeviceWindow member of D3DPRESENT_PARAMTERS is taken.
[in]	pDirtyRegion	(IN) A pointer to a region to be presented. It must be NULL unless the swap chain was reated with D3DSWAPEFFECT_COPY. If this value is non-NULL, the contained region is expressed in back buffer coordinates.

Return values

NVAPI_OK	the Present operation was successfully executed
NVAPI_D3D_DEVICE_LOST	D3D device status is D3DERR_DEVICELOST or D3DERR_DEVICENOTRESET, the caller has to reset device
NVAPI_DEVICE_BUSY	the Present operation failed with an error other than D3DERR_DEVICELOST or D3DERR_DEVICENOTRESET
NVAPI_ERROR	the communication with the D3D driver failed, SwapGroup/SwapBarrier may not be possible.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D9_QueryFrameCount()

NVAPI_INTERFACE NvAPI_D3D9_QueryFrameCount	(	IDirect3DDevice9 *	pDevice,
		NvU32 *	pFrameCount
	)

DESCRIPTION: This API queries the universal framecounter of the Quadro-Sync master device.

Parameters

[in]	pDevice	The caller provides the DX9 device that has access to the Quadro-Sync device
[out]	pFrameCount	The caller provides the storage space where the framecount is stored.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	*pFrameCount populated with framecount value.
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D9_QueryMaxSwapGroup()

NVAPI_INTERFACE NvAPI_D3D9_QueryMaxSwapGroup	(	IDirect3DDevice9 *	pDevice,
		NvU32 *	pMaxGroups,
		NvU32 *	pMaxBarriers
	)

DESCRIPTION: This API queries the number of supported SwapGroups and SwapBarriers in the graphics system.

Parameters

[in]	pDevice	The caller provides the DirectX 9 device that is used as a swapgroup client
[out]	pMaxGroups	The caller provides the storage space where the number of available SwapGroups is stored.
[out]	pMaxBarriers	The caller provides the storage space where the number of available SwapBarriers is stored.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	the number of SwapGroups and SwapBarriers has been stored
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D9_QuerySwapGroup()

NVAPI_INTERFACE NvAPI_D3D9_QuerySwapGroup	(	IDirect3DDevice9 *	pDevice,
		IDirect3DSwapChain9 *	pSwapChain,
		NvU32 *	pSwapGroup,
		NvU32 *	pSwapBarrier
	)

DESCRIPTION: This API queries the current SwapGroup and SwapBarrier that a SwapChain of a specific client device is bound to.

Parameters

[in]	pDevice	The caller provides the DirectX 9 device that is used as a swapgroup client
[in]	pSwapChain	The caller provides the IDirect3DSwapChain9 interface as a handle to the SwapChain that belongs to the swapgroup client device
[out]	pSwapGroup	The caller provides the storage space where the current SwapGroup is stored.
[out]	pSwapBarrier	The caller provides the storage space where the current SwapBarrier is stored.

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	the current SwapGroup and SwapBarrier has been stored
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D9_RegisterResource()

NVAPI_INTERFACE NvAPI_D3D9_RegisterResource

(

IDirect3DResource9 *

pResource

)

DESCRIPTION: This API binds a resource (surface/texture) so that it can be retrieved internally by NVAPI.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]

pResource

surface/texture

Returns

NVAPI_OK, NVAPI_ERROR

NvAPI_D3D9_ResetFrameCount()

NVAPI_INTERFACE NvAPI_D3D9_ResetFrameCount

(

IDirect3DDevice9 *

pDevice

)

DESCRIPTION: This API resets the universal framecounter on the Quadro-Sync master device.

Parameters

[in]

pDevice

The caller provides the DX9 device that has access to the Quadro-Sync device

SUPPORTED OS: Windows 7 and higher

Return values

NVAPI_OK	framecounter has been reset
NVAPI_ERROR	The operation failed.
NVAPI_INVALID_ARGUMENT	One or more args passed in are invalid.
NVAPI_API_NOT_INITIALIZED	NvAPI was not yet initialized.

NvAPI_D3D9_StretchRectEx()

NVAPI_INTERFACE NvAPI_D3D9_StretchRectEx	(	IDirect3DDevice9 *	pDevice,
		IDirect3DResource9 *	pSourceResource,
		CONST RECT *	pSourceRect,
		IDirect3DResource9 *	pDestResource,
		CONST RECT *	pDestRect,
		D3DTEXTUREFILTERTYPE	Filter
	)

DESCRIPTION: This API copies the contents of the source resource to the destination resource. This function can convert between a wider range of surfaces than IDirect3DDevice9::StretchRect. For example, it can copy from a depth/stencil surface to a texture.

The source and destination resources must be registered with NvAPI before being used with NvAPI_D3D9_StretchRectEx().

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDevice	The D3D device that owns the objects.
[in]	pSourceResource	Pointer to the source resource.
[in]	pSrcRect	Defines the rectangle on the source to copy from. If NULL, copy from the entire resource.
[in]	pDestResource	Pointer to the destination resource.
[in]	pDstRect	Defines the rectangle on the destination to copy to. If NULL, copy to the entire resource.
[in]	Filter	Choose a filtering method: D3DTEXF_NONE, D3DTEXF_POINT, D3DTEXF_LINEAR.

Return values

NVAPI_OK	completed request
NVAPI_INVALID_POINTER	An invalid pointer was passed as an argument (probably NULL)
NVAPI_INVALID_ARGUMENT	One of the arguments was invalid
NVAPI_UNREGISTERED_RESOURCE	a resource was passed in without being registered
NVAPI_ERROR	error occurred

NvAPI_D3D9_UnregisterResource()

NVAPI_INTERFACE NvAPI_D3D9_UnregisterResource

(

IDirect3DResource9 *

pResource

)

DESCRIPTION: This API unbinds a resource (surface/texture) after use.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]

pResource

surface/texture

Returns

NVAPI_OK, NVAPI_ERROR

NvAPI_D3D_BeginResourceRendering()

NvAPI_D3D_BeginResourceRendering	(	IUnknown *	pDeviceOrContext,
		NVDX_ObjectHandle	obj,
		NvU32	Flags
	)

DESCRIPTION: This function tells the driver that the resource will begin to receive updates. It must be used in combination with NvAPI_D3D_EndResourceRendering(). The primary use of this function is allow the driver to initiate early inter-frame synchronization of resources while running in AFR SLI mode.

SUPPORTED OS: Windows 7 and higher

Since

Release: 185

Parameters

[in]	pDev	IDirect3DDevice9, ID3D10Device, ID3D11Device or ID3D11DeviceContext that is using the resource
[in]	obj	Previously obtained HV resource handle
[in]	Flags	The flags for functionality applied to resource while being used.

Return values

NVAPI_OK	Function succeeded, if used properly and driver can initiate proper sync'ing of the resources.
NVAPI_INVALID_ARGUMENT	Bad argument(s) or invalid flag values
NVAPI_INVALID_CALL	Mismatched begin/end calls

NvAPI_D3D_CreateLateLatchObject()

NVAPI_INTERFACE NvAPI_D3D_CreateLateLatchObject	(	__in IUnknown *	pDevice,
		__inout NV_D3D_LATELATCH_OBJECT_DESC *	pLateLatchObjectDesc
	)

DESCRIPTION: Creates a Late Latch Object interface

SUPPORTED OS: Windows 7 and higher

Since

Release: 384

Parameters

[in]	pDevice	Current ID3D11Device.
[in,out]	pLateLatchObjectDesc	Pointer to in/out structure for late latch object creation

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D_EndResourceRendering()

NVAPI_INTERFACE NvAPI_D3D_EndResourceRendering	(	IUnknown *	pDeviceOrContext,
		NVDX_ObjectHandle	obj,
		NvU32	Flags
	)

DESCRIPTION: This function tells the driver that the resource is done receiving updates. It must be used in combination with NvAPI_D3D_BeginResourceRendering(). The primary use of this function is allow the driver to initiate early inter-frame syncs of resources while running in AFR SLI mode.

SUPPORTED OS: Windows 7 and higher

Since

Release: 185

Parameters

[in]	pDev	IDirect3DDevice9, ID3D10Device, ID3D11Device or ID3D11DeviceContext that is using the resource
[in]	obj	Previously obtained HV resource handle
[in]	Flags	Reserved, must be zero

Return values

NVAPI_OK	Function succeeded, if used properly and driver can initiate proper sync'ing of the resources.
NVAPI_INVALID_ARGUMENT	Bad argument(s) or invalid flag values
NVAPI_INVALID_CALL	Mismatched begin/end calls

NvAPI_D3D_GetCurrentSLIState()

NVAPI_INTERFACE NvAPI_D3D_GetCurrentSLIState	(	IUnknown *	pDevice,
		NV_GET_CURRENT_SLI_STATE *	pSliState
	)

DESCRIPTION: This function returns the current SLI state for the specified device. The structure contains the number of AFR groups, the current AFR group index, and what the AFR group index will be for the next frame. pDevice can be either a IDirect3DDevice9 or ID3D10Device pointer.

SUPPORTED OS: Windows 7 and higher

Since

Release: 173

Return values

NVAPI_OK	Completed request
NVAPI_ERROR	Error occurred

NvAPI_D3D_GetLatency()

NVAPI_INTERFACE NvAPI_D3D_GetLatency	(	__in IUnknown *	pDev,
		__out NV_LATENCY_RESULT_PARAMS *	pGetLatencyParams
	)

DESCRIPTION: Get a latency report including the timestamps of the application latency markers set with NvAPI_D3D_SetLatencyMarker as well as driver, OS queue and graphics hardware times. Requires calling NvAPI_D3D_SetLatencyMarker with incrementing frameID for valid results. Rendering for at least 90 frames is recommended to properly fill out the structure. The newest completed frame is at the end (element 63) and is preceeded by older frames. If not enough frames are valid then all frames are returned with all zeroes.

Since

Release: 455

Parameters

[in]	pDev	The target device
[in]	pGetLatencyParams	The latency result structure. SUPPORTED OS: Windows 7 and higher

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D_GetObjectHandleForResource()

NVAPI_INTERFACE NvAPI_D3D_GetObjectHandleForResource	(	IUnknown *	pDevice,
		IUnknown *	pResource,
		NVDX_ObjectHandle *	pHandle
	)

DESCRIPTION: This API gets a handle to a resource.

Parameters

[in]	pDev	The ID3D11Device, ID3D10Device or IDirect3DDevice9 or ID3D11DeviceContext to use
[in]	pResource	The ID3D11Resource, ID3D10Resource or IDirect3DResource9 from which we want the NvAPI handle
[out]	pHandle	A handle to the resource

SUPPORTED OS: Windows 7 and higher

Since

Release: 185

Returns

NVAPI_OK if the handle was populated.

NvAPI_D3D_GetSleepStatus()

NVAPI_INTERFACE NvAPI_D3D_GetSleepStatus	(	__in IUnknown *	pDev,
		__in NV_GET_SLEEP_STATUS_PARAMS *	pGetSleepStatusParams
	)

DESCRIPTION: This function can be used to get the latest sleep status. bLowLatencyMode indicates whether low latency mode is currently enabled in the driver. Note that it may not always reflect the previously requested sleep mode, as the feature may not be available on the platform, or the setting has been overridden by the control panel, for example.

Since

Release: 455

Parameters

[in]	pDev	The target device.
[in]	pGetSleepStatusParams	Sleep status params. SUPPORTED OS: Windows 7 and higher

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D_ImplicitSLIControl()

NVAPI_INTERFACE NvAPI_D3D_ImplicitSLIControl

(

__in IMPLICIT_SLI_CONTROL

implicitSLIControl

)

NvAPI_D3D_InitializeNvGazeHandler()

NVAPI_INTERFACE NvAPI_D3D_InitializeNvGazeHandler	(	__in IUnknown *	pDevice,
		__inout NV_GAZE_HANDLER_INIT_PARAMS *	pInitializeNvGazeHandlerParams
	)

SUPPORTED OS: Windows 7 and higher DESCRIPTION: Creates an interface for updating and managing gaze data

SUPPORTED OS: Windows 7 and higher

Since

Release: 430

Parameters

[in]

pDevice

The device to be used for creating the Gaze Handler interface

Note

This should be same as the device used with VRS Handler. See also: NvAPI_D3D_InitializeVRSHelper.

Parameters

[in]

pInitializeNvGazeHandlerParams

Descriptor for Gaze Data Handler initialization

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D_InitializeSMPAssist()

NVAPI_INTERFACE NvAPI_D3D_InitializeSMPAssist	(	__in IUnknown *	pDevice,
		__inout NV_SMP_ASSIST_INITIALIZE_PARAMS *	pSMPAssistInitParams
	)

DESCRIPTION: Initialize SMP Assist extension. Take the SMPAssist(MRS/LMS) params from the application. Provide the application with a interface pointer for future use.

Since

Release: 396

Parameters

[in]	pDevice	Pointer to IUnknown (Currently supports ID3D11Device)
[in,out]	pSMPAssistInitParams	SMP Assist initialization params

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

NVAPI_OK	Call succeeded.
NVAPI_ERROR	Call failed.
NVAPI_INVALID_ARGUMENT	One of the required input arguments was NULL

NvAPI_D3D_InitializeVRSHelper()

NVAPI_INTERFACE NvAPI_D3D_InitializeVRSHelper	(	__in IUnknown *	pDevice,
		__inout NV_VRS_HELPER_INIT_PARAMS *	pInitializeVRSHelperParams
	)

SUPPORTED OS: Windows 7 and higher DESCRIPTION: Creates an interface for updating, enabling and disabling internally tracked shading rate pattern for Variable Rate Shading

SUPPORTED OS: Windows 7 and higher

Since

Release: 430

Parameters

[in]

pDevice

The device to be used for creating the VRS Handler interface

Note

This should be same the device used for Gaze Handler. See also: NvAPI_D3D_InitializeNvGazeHandler.

Parameters

[in]

pInitializeVRSHelperParams

Descriptor for VRS Helper initialization

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

NvAPI_D3D_IsGSyncActive()

NVAPI_INTERFACE NvAPI_D3D_IsGSyncActive	(	__in IUnknown *	pDeviceOrContext,
		__in NVDX_ObjectHandle	primarySurface,
		__out BOOL *	pIsGsyncActive
	)

FUNCTION NAME: NvAPI_D3D_IsGSyncActive DESCRIPTION: This API get the G-Sync state for the given device context. This is only reliable after the first present call has completed. As it is a bit time consuming, It should not be called per frame.

Parameters

[in]	pDeviceOrContext	The D3D9, D3D10, D3D11 device, or D3D11 device context
[in]	NVDX_ObjectHandle	The handle of primary surface
[out]	pIsGsyncActive	if G-Sync is active, *pisGsyncActive is true.

SUPPORTED OS: Windows 7 and higher

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D_IsGSyncCapable()

NVAPI_INTERFACE NvAPI_D3D_IsGSyncCapable	(	__in IUnknown *	pDeviceOrContext,
		__in NVDX_ObjectHandle	primarySurface,
		__out BOOL *	pIsGsyncCapable
	)

FUNCTION NAME: NvAPI_D3D_IsGSyncCapable DESCRIPTION: This API gets G-Sync capability for the given device context. This is only reliable after the first present call has completed.

Parameters

[in]	pDeviceOrContext	The D3D9, D3D10, D3D11 device, or D3D11 device context
[in]	NVDX_ObjectHandle	The handle of primary surface
[out]	pIsGsyncCapable	if G-Sync can be enabled, *pIsGsyncCapable is true.

SUPPORTED OS: Windows 7 and higher

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D_QueryLateLatchSupport()

NVAPI_INTERFACE NvAPI_D3D_QueryLateLatchSupport	(	__in IUnknown *	pDevice,
		__inout NV_QUERY_LATELATCH_SUPPORT_PARAMS *	pQueryLateLatchSupportParams
	)

DESCRIPTION: Queries the support of DX11 Late Latch feature on current setup.

SUPPORTED OS: Windows 7 and higher

Since

Release: 384

Parameters

[in]	pDevice	Current ID3D11Device.
[in,out]	pQueryLateLatchSupportParams	Stores value of whether Late Latch is supported on current setup or not.

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

<>

NvAPI_D3D_QueryModifiedWSupport()

NVAPI_INTERFACE NvAPI_D3D_QueryModifiedWSupport	(	__in IUnknown *	pDev,
		__inout NV_QUERY_MODIFIED_W_SUPPORT_PARAMS *	pQueryModifiedWSupportedParams
	)

DESCRIPTION: Queries the support of Modified W feature on current setup and returns appropriate boolean value.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDevice	The ID3D11Device to use.
[in,out]	pQueryModifiedWSupportedParams	Stores value of whether Modified W is supported on current setup or not.

Return values

NVAPI_OK	Call succeeded.
NVAPI_ERROR	Call failed.
NVAPI_INVALID_ARGUMENT	One or more arguments are invalid.

<>

NvAPI_D3D_QueryMultiViewSupport()

NVAPI_INTERFACE NvAPI_D3D_QueryMultiViewSupport	(	__in IUnknown *	pDevice,
		__inout NV_QUERY_MULTIVIEW_SUPPORT_PARAMS *	pQueryMultiViewSupportedParams
	)

DESCRIPTION: Queries the support of MultiView feature on current setup and returns appropriate boolean value.

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pDevice	The ID3D11Device to use.
[in,out]	pMultiViewSupportedParams	Stores value of whether MultiView is supported on current setup or not.

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

<>

NvAPI_D3D_QuerySinglePassStereoSupport()

NVAPI_INTERFACE NvAPI_D3D_QuerySinglePassStereoSupport	(	__in IUnknown *	pDevice,
		__inout NV_QUERY_SINGLE_PASS_STEREO_SUPPORT_PARAMS *	pQuerySinglePassStereoSupportedParams
	)

DESCRIPTION: Queries the support of Single Pass Stereo feature on current setup and returns appropriate boolean value.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDevice	The ID3D11Device to use.
[in,out]	pSinglePassStereoSupportedParams	Stores value of whether Single Pass Stereo is supported on current setup or not.

Return values

NVAPI_OK	Call succeeded.
NVAPI_ERROR	Call failed.
NVAPI_INVALID_ARGUMENT	One or more arguments are invalid.

<>

NvAPI_D3D_QuerySMPAssistSupport()

NVAPI_INTERFACE NvAPI_D3D_QuerySMPAssistSupport	(	__in IUnknown *	pDev,
		__inout NV_QUERY_SMP_ASSIST_SUPPORT_PARAMS *	pQuerySMPAssistSupportParams
	)

SUPPORTED OS: Windows 7 and higher DESCRIPTION: Query SMP assist extension support.

Since

Release: 396

Parameters

[in]	pDev	Pointer to IUnknown (Currently supports ID3D11Device)
[out]	pQuerySMPAssistSupportParams	Pointer to a structure returning requested SMP assist support

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

NVAPI_NOT_SUPPORTED	Requested SMP assist is not supported.
NVAPI_OK	Call succeeded. Check value of pQuerySMPAssistSupportParams->bSMPAssistSupported
NVAPI_INVALID_POINTER	pDev or pQuerySMPAssistSupportParams was a NULL pointer

NvAPI_D3D_RegisterDevice()

NVAPI_INTERFACE NvAPI_D3D_RegisterDevice

(

__in IUnknown *

pDev

)

DESCRIPTION: Tells NvAPI about a D3D device. This must be called prior to using any DX1x deferred-context calls.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]

pDev

The ID3D10Device or ID3D11Device to use.

RETURN STATUS: This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

<>

NvAPI_D3D_SetFPSIndicatorState()

NVAPI_INTERFACE NvAPI_D3D_SetFPSIndicatorState	(	IUnknown *	pDev,
		NvU8	doEnable
	)

DESCRIPTION: Display an overlay that tracks the number of times the app presents per second, or,
the number of frames-per-second (FPS)

SUPPORTED OS: Windows 7 and higher

Parameters

[in]

bool

Whether or not to enable the fps indicator.

Returns

NVAPI_OK, NVAPI_ERROR

<>

NvAPI_D3D_SetLatencyMarker()

NVAPI_INTERFACE NvAPI_D3D_SetLatencyMarker	(	__in IUnknown *	pDev,
		__in NV_LATENCY_MARKER_PARAMS *	pSetLatencyMarkerParams
	)

DESCRIPTION: Set a latency marker to be tracked by the NvAPI_D3D_GetLatency function. SIMULATION_START must be the first marker sent in a frame, after the previous frame's Sleep call (if used). INPUT_SAMPLE may be sent to record the moment user input was sampled and should come between SIMULATION_START and SIMULATION_END. RENDERSUBMIT_START should come before any Direct3D calls are made for the given frame and RENDERSUBMIT_END should come before calling Present. PRESENT_START and END should wrap the Present call to inform the driver of a present block done by the OS before the driver receives the Present. TRIGGER_FLASH tells the driver to render its flash indicator for latency testing, typically driven by a mouse click. The frameID can start at an abitrary moment in the application lifetime but must strictly increment from that point forward for consistent results.

Since

Release: 455

Parameters

[in]	pDev	The target device
[in]	pSetLatencyMarkerParams	The latency marker structure SUPPORTED OS: Windows 7 and higher

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D_SetModifiedWMode()

NVAPI_INTERFACE NvAPI_D3D_SetModifiedWMode	(	__in IUnknown *	pDevOrContext,
		__in NV_MODIFIED_W_PARAMS *	psModifiedWParams
	)

DESCRIPTION: Set the Modified W state and A,B coefficients for HW support

Note

Note that this is an asynchronous function and returns NVAPI_OK if all arguments are valid. Returned value NVAPI_OK does not reflect that Modified-W is supported or is set in hardware. One must call NvAPI_D3D_QueryModifiedWSupport() to confirm that the current setup supports Modified-W before calling this set-function.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDevOrContext	The ID3D11Device or ID3D11DeviceContext to use.
[in]	psModifiedWParams	Modified W parameters.

Return values

NVAPI_OK	Call succeeded.
NVAPI_ERROR	Call failed.
NVAPI_INVALID_ARGUMENT	One or more arguments are invalid.

<>

NvAPI_D3D_SetMultiViewMode()

NVAPI_INTERFACE NvAPI_D3D_SetMultiViewMode	(	__in IUnknown *	pDevOrContext,
		__in NV_MULTIVIEW_PARAMS *	pMultiViewParams
	)

DESCRIPTION: Set the MultiView state

Note

Note that this is an asynchronous function and returns NVAPI_OK if all arguments are valid. Returned value NVAPI_OK does not reflect that MultiView is supported or is set in hardware. One must call NvAPI_D3D_QueryMultiViewSupport() to confirm that the current setup supports MultiView before calling this set-function.

SUPPORTED OS: Windows 7 and higher

Since

Release: 410

Parameters

[in]	pDevOrContext	The ID3D11Device or ID3D11DeviceContext to use.
[in]	pMultiViewParams	MultiView Params

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below. (none)

<>

NvAPI_D3D_SetResourceHint()

NvAPI_D3D_SetResourceHint	(	IUnknown *	pDev,
		NVDX_ObjectHandle	obj,
		NVAPI_D3D_SETRESOURCEHINT_CATEGORY	dwHintCategory,
		NvU32	dwHintName,
		NvU32 *	pdwHintValue
	)

DESCRIPTION: This is a general purpose function for passing down various resource related hints to the driver. Hints are divided into categories and types within each category. For DX11 devices this function is free-threaded. An application is responsible to complete this call before making use of the resource in a rendering context (therefore applying inter-thread synchronization as appropriate). As a debug help to an application the driver enforces that a resource in this call was never bound.

SUPPORTED OS: Windows 7 and higher

Since

Release: 185

Parameters

[in]	pDev	The ID3D10Device or IDirect3DDevice9 that is a using the resource
[in]	obj	Previously obtained HV resource handle
[in]	dwHintCategory	Category of the hints
[in]	dwHintName	A hint within this category
	[in/out]	*pdwHintValue Pointer to location containing hint value, function returns previous hint value in this slot

Returns

an int which could be an NvAPI status or DX HRESULT code

Return values

NVAPI_OK
NVAPI_INVALID_ARGUMENT
NVAPI_INVALID_CALL	It is illegal to change a hint dynamically when the resource is already bound.

NvAPI_D3D_SetSinglePassStereoMode()

NVAPI_INTERFACE NvAPI_D3D_SetSinglePassStereoMode	(	__in IUnknown *	pDevOrContext,
		__in NvU32	numViews,
		__in NvU32	renderTargetIndexOffset,
		__in NvU8	independentViewportMaskEnable
	)

DESCRIPTION: Set the Single Pass Stereo state

Note

Note that this is an asynchronous function and returns NVAPI_OK if all arguments are valid. Returned value NVAPI_OK does not reflect that Single Pass Stereo is supported or is set in hardware. One must call NvAPI_D3D_QuerySinglePassStereoSupport() to confirm that the current setup supports Single Pass Stereo before calling this set-function.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	pDevOrContext	The ID3D11Device or ID3D11DeviceContext to use.
[in]	numViews	Number of views to render.
[in]	renderTargetIndexOffset	Offset between render targets of the different views.
[in]	independentViewportMaskEnable	Is the independent viewport mask enabled.

Return values

NVAPI_OK	Call succeeded.
NVAPI_ERROR	Call failed.
NVAPI_INVALID_ARGUMENT	One or more arguments are invalid.

<>

NvAPI_D3D_SetSleepMode()

NVAPI_INTERFACE NvAPI_D3D_SetSleepMode	(	__in IUnknown *	pDev,
		__in NV_SET_SLEEP_MODE_PARAMS *	pSetSleepModeParams
	)

DESCRIPTION: This function can be used to update sleep mode dynamically. The settings are not dependent to each other, meaning low latency mode can be enabled/disabled regardless of whether minimum interval is set or not. The former is to intelligently lower latency without impacting frame rate. The later is to limit frame rate (e.g. minimumIntervalUs = 10000 limits frame rate to 100 FPS). They work well separately and/or together. Note that minimumIntervalUs usage is not limited to lowering latency, so feel free to use it to limit frame rate for menu, cut scenes, etc. Note that low latency mode can be enabled, and/or minimum interval can be set, even without using NvAPI_D3D_Sleep(). However, without it, the sleep to achieve these features would happen at a less optimal point, resulting in higher overall latency. The bLowLatencyBoost will request the GPU run at max clocks even in scenarios where it is idle most of the frame and would normally try to save power. This can decrease latency in CPU-limited scenarios. While this function can be called as often as needed, it is not necessary nor recommended to call this too frequently (e.g. every frame), as the settings persist for the target device.

Since

Release: 455

Parameters

[in]	pDev	The target device.
[in]	pSetSleepModeParams	Sleep mode params. SUPPORTED OS: Windows 7 and higher

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

NvAPI_D3D_Sleep()

NVAPI_INTERFACE NvAPI_D3D_Sleep

(

__in IUnknown *

pDev

)

DESCRIPTION: It is recommended to call this function at the very start of each frame (e.g. before input sampling). If there is a need to sleep, due to frame rate limit and/or low latency features, for example, this call provides an entry point for the driver to sleep at the most optimal spot to achieve the lowest latency. It is recommended to call this function even when low latency mode is disabled and minimum interval is 0. Other features, such as Maximum Frame Rate setting, could be enabled in the control panel to benefit from this. It is OK to start (or stop) using this function at any time. However, when using this function, it must be called exactly once on each frame. If this function is not called, after several frames, the driver would fallback to sleep at its less optimal spot.

Since

Release: 455

Parameters

[in]

pDev

The target device. SUPPORTED OS: Windows 7 and higher

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.