NVAPI Reference Documentation
NVIDIA
Release 530: March
2023

Typedefs | Functions
NVAPI Handles

Typedefs

typedef void * StereoHandle
 

Functions

 NV_DECLARE_HANDLE (NvLogicalGpuHandle)
 
 NV_DECLARE_HANDLE (NvPhysicalGpuHandle)
 
 NV_DECLARE_HANDLE (NvDisplayHandle)
 
 NV_DECLARE_HANDLE (NvMonitorHandle)
 
 NV_DECLARE_HANDLE (NvUnAttachedDisplayHandle)
 
 NV_DECLARE_HANDLE (NvVisualComputingDeviceHandle)
 
 NV_DECLARE_HANDLE (NvEventHandle)
 
 NV_DECLARE_HANDLE (NvHICHandle)
 
 NV_DECLARE_HANDLE (NvGSyncDeviceHandle)
 
 NV_DECLARE_HANDLE (NvVioHandle)
 
 NV_DECLARE_HANDLE (NvTransitionHandle)
 
 NV_DECLARE_HANDLE (NvAudioHandle)
 
 NV_DECLARE_HANDLE (Nv3DVPContextHandle)
 
 NV_DECLARE_HANDLE (Nv3DVPTransceiverHandle)
 
 NV_DECLARE_HANDLE (Nv3DVPGlassesHandle)
 
 NV_DECLARE_HANDLE (NvPcfClientHandle)
 
 NV_DECLARE_HANDLE (NvSourceHandle)
 
 NV_DECLARE_HANDLE (NvTargetHandle)
 
 NV_DECLARE_HANDLE (NVDX_SwapChainHandle)
 
 NV_DECLARE_HANDLE (NvPresentBarrierClientHandle)
 
#define NVAPI_DEFAULT_HANDLE   0
 
#define NV_BIT(x)   (1 << (x))
 

Detailed Description

NVAPI Handles - These handles are retrieved from various calls and passed in to others in NvAPI These are meant to be opaque types. Do not assume they correspond to indices, HDCs, display indexes or anything else.

Most handles remain valid until a display re-configuration (display mode set) or GPU reconfiguration (going into or out of SLI modes) occurs. If NVAPI_HANDLE_INVALIDATED is received by an app, it should discard all handles, and re-enumerate them.

Macro Definition Documentation

◆ NV_BIT

#define NV_BIT (   x)    (1 << (x))

◆ NVAPI_DEFAULT_HANDLE

#define NVAPI_DEFAULT_HANDLE   0

Typedef Documentation

◆ StereoHandle

typedef void* StereoHandle

A stereo handle, that corresponds to the device interface.

Function Documentation

◆ NV_DECLARE_HANDLE() [1/20]

NV_DECLARE_HANDLE ( Nv3DVPContextHandle  )

A handle for a 3D Vision Pro (3DVP) context.

◆ NV_DECLARE_HANDLE() [2/20]

NV_DECLARE_HANDLE ( Nv3DVPGlassesHandle  )

A handle for a pair of 3DVP RF shutter glasses.

◆ NV_DECLARE_HANDLE() [3/20]

NV_DECLARE_HANDLE ( Nv3DVPTransceiverHandle  )

A handle for a 3DVP RF transceiver.

◆ NV_DECLARE_HANDLE() [4/20]

NV_DECLARE_HANDLE ( NvAudioHandle  )

NVIDIA HD Audio Device.

◆ NV_DECLARE_HANDLE() [5/20]

NV_DECLARE_HANDLE ( NvDisplayHandle  )

Display Device driven by NVIDIA GPU(s) (an attached display)

◆ NV_DECLARE_HANDLE() [6/20]

NV_DECLARE_HANDLE ( NVDX_SwapChainHandle  )

DirectX SwapChain objects.

◆ NV_DECLARE_HANDLE() [7/20]

NV_DECLARE_HANDLE ( NvEventHandle  )

A handle to an event registration instance.

◆ NV_DECLARE_HANDLE() [8/20]

NV_DECLARE_HANDLE ( NvGSyncDeviceHandle  )

A handle to a Sync device.

◆ NV_DECLARE_HANDLE() [9/20]

NV_DECLARE_HANDLE ( NvHICHandle  )

A handle to a Host Interface Card.

◆ NV_DECLARE_HANDLE() [10/20]

NV_DECLARE_HANDLE ( NvLogicalGpuHandle  )

One or more physical GPUs acting in concert (SLI)

◆ NV_DECLARE_HANDLE() [11/20]

NV_DECLARE_HANDLE ( NvMonitorHandle  )

Monitor handle.

◆ NV_DECLARE_HANDLE() [12/20]

NV_DECLARE_HANDLE ( NvPcfClientHandle  )

A handle for NVPCF clients.

◆ NV_DECLARE_HANDLE() [13/20]

NV_DECLARE_HANDLE ( NvPhysicalGpuHandle  )

A single physical GPU.

◆ NV_DECLARE_HANDLE() [14/20]

NV_DECLARE_HANDLE ( NvPresentBarrierClientHandle  )

PresentBarrier client object

◆ NV_DECLARE_HANDLE() [15/20]

NV_DECLARE_HANDLE ( NvSourceHandle  )

Unique source handle on the system.

◆ NV_DECLARE_HANDLE() [16/20]

NV_DECLARE_HANDLE ( NvTargetHandle  )

Unique target handle on the system.

◆ NV_DECLARE_HANDLE() [17/20]

NV_DECLARE_HANDLE ( NvTransitionHandle  )

A handle to address a single transition request.

◆ NV_DECLARE_HANDLE() [18/20]

NV_DECLARE_HANDLE ( NvUnAttachedDisplayHandle  )

Unattached Display Device driven by NVIDIA GPU(s)

◆ NV_DECLARE_HANDLE() [19/20]

NV_DECLARE_HANDLE ( NvVioHandle  )

A handle to an SDI device.

◆ NV_DECLARE_HANDLE() [20/20]

NV_DECLARE_HANDLE ( NvVisualComputingDeviceHandle  )

A handle to a Visual Computing Device.


NVIDIA
Copyright (c) 2007-2023 NVIDIA Corporation. All rights reserved.

NVIDIA