NVAPI Reference Documentation
NVIDIA
Release 550
Wed Apr 17 2024

Data Structures | Macros | Typedefs
General NVAPI Defines, Structs, and Enums

Data Structures

struct  NvSBox
 
struct  NvGUID
 

Macros

#define NVAPI_GENERIC_STRING_MAX   4096
 
#define NVAPI_LONG_STRING_MAX   256
 
#define NVAPI_SHORT_STRING_MAX   64
 
#define NvGUID_Defined
 
#define NVAPI_MAX_PHYSICAL_GPUS   64
 
#define NVAPI_MAX_PHYSICAL_BRIDGES   100
 
#define NVAPI_PHYSICAL_GPUS   32
 
#define NVAPI_MAX_LOGICAL_GPUS   64
 
#define NVAPI_MAX_AVAILABLE_GPU_TOPOLOGIES   256
 
#define NVAPI_MAX_AVAILABLE_SLI_GROUPS   256
 
#define NVAPI_MAX_GPU_TOPOLOGIES   NVAPI_MAX_PHYSICAL_GPUS
 
#define NVAPI_MAX_GPU_PER_TOPOLOGY   8
 
#define NVAPI_MAX_DISPLAY_HEADS   2
 
#define NVAPI_ADVANCED_DISPLAY_HEADS   4
 
#define NVAPI_MAX_DISPLAYS   NVAPI_PHYSICAL_GPUS * NVAPI_ADVANCED_DISPLAY_HEADS
 
#define NVAPI_MAX_ACPI_IDS   16
 
#define NVAPI_MAX_VIEW_MODES   8
 
#define NVAPI_SYSTEM_MAX_HWBCS   128
 
#define NVAPI_SYSTEM_HWBC_INVALID_ID   0xffffffff
 
#define NVAPI_SYSTEM_MAX_DISPLAYS   NVAPI_MAX_PHYSICAL_GPUS * NV_MAX_HEADS
 
#define NV_MAX_HEADS   4
 
#define NVAPI_MAX_HEADS_PER_GPU   32
 
#define NV_MAX_VID_STREAMS   4
 
#define NV_MAX_VID_STREAMS_EX   20
 
#define NV_MAX_VID_PROFILES   4
 
#define NVAPI_MAX_AUDIO_DEVICES   16
 
#define MAKE_NVAPI_VERSION(typeName, ver)   (NvU32)(sizeof(typeName) | ((ver)<<16))
 
#define GET_NVAPI_VERSION(ver)   (NvU32)((ver)>>16)
 
#define GET_NVAPI_SIZE(ver)   (NvU32)((ver) & 0xffff)
 

Typedefs

typedef struct NvGUID NvLUID
 
typedef char NvAPI_String[NVAPI_GENERIC_STRING_MAX]
 
typedef char NvAPI_LongString[NVAPI_LONG_STRING_MAX]
 
typedef char NvAPI_ShortString[NVAPI_SHORT_STRING_MAX]
 
typedef NvU16 NvAPI_UnicodeShortString[NVAPI_SHORT_STRING_MAX]
 

Detailed Description

<>

Macro Definition Documentation

◆ GET_NVAPI_SIZE

#define GET_NVAPI_SIZE (   ver)    (NvU32)((ver) & 0xffff)

◆ GET_NVAPI_VERSION

#define GET_NVAPI_VERSION (   ver)    (NvU32)((ver)>>16)

◆ MAKE_NVAPI_VERSION

#define MAKE_NVAPI_VERSION (   typeName,
  ver 
)    (NvU32)(sizeof(typeName) | ((ver)<<16))

NvAPI Version Definition
Maintain per structure specific version define using the MAKE_NVAPI_VERSION macro.
Usage: #define NV_GENLOCK_STATUS_VER MAKE_NVAPI_VERSION(NV_GENLOCK_STATUS, 1)

◆ NV_MAX_HEADS

#define NV_MAX_HEADS   4

Maximum heads, each with NVAPI_DESKTOP_RES resolution.

◆ NV_MAX_VID_PROFILES

#define NV_MAX_VID_PROFILES   4

Maximum number of output video profiles supported.

◆ NV_MAX_VID_STREAMS

#define NV_MAX_VID_STREAMS   4

Maximum number of input video streams, each with a #NVAPI_VIDEO_SRC_INFO.

◆ NV_MAX_VID_STREAMS_EX

#define NV_MAX_VID_STREAMS_EX   20

Increasing MAX no. of input video streams, each with a #NVAPI_VIDEO_SRC_INFO.

◆ NVAPI_ADVANCED_DISPLAY_HEADS

#define NVAPI_ADVANCED_DISPLAY_HEADS   4

◆ NVAPI_GENERIC_STRING_MAX

#define NVAPI_GENERIC_STRING_MAX   4096

◆ NVAPI_LONG_STRING_MAX

#define NVAPI_LONG_STRING_MAX   256

◆ NVAPI_MAX_ACPI_IDS

#define NVAPI_MAX_ACPI_IDS   16

◆ NVAPI_MAX_AUDIO_DEVICES

#define NVAPI_MAX_AUDIO_DEVICES   16

◆ NVAPI_MAX_AVAILABLE_GPU_TOPOLOGIES

#define NVAPI_MAX_AVAILABLE_GPU_TOPOLOGIES   256

◆ NVAPI_MAX_AVAILABLE_SLI_GROUPS

#define NVAPI_MAX_AVAILABLE_SLI_GROUPS   256

◆ NVAPI_MAX_DISPLAY_HEADS

#define NVAPI_MAX_DISPLAY_HEADS   2

◆ NVAPI_MAX_DISPLAYS

#define NVAPI_MAX_DISPLAYS   NVAPI_PHYSICAL_GPUS * NVAPI_ADVANCED_DISPLAY_HEADS

◆ NVAPI_MAX_GPU_PER_TOPOLOGY

#define NVAPI_MAX_GPU_PER_TOPOLOGY   8

◆ NVAPI_MAX_GPU_TOPOLOGIES

#define NVAPI_MAX_GPU_TOPOLOGIES   NVAPI_MAX_PHYSICAL_GPUS

◆ NVAPI_MAX_HEADS_PER_GPU

#define NVAPI_MAX_HEADS_PER_GPU   32

◆ NVAPI_MAX_LOGICAL_GPUS

#define NVAPI_MAX_LOGICAL_GPUS   64

◆ NVAPI_MAX_PHYSICAL_BRIDGES

#define NVAPI_MAX_PHYSICAL_BRIDGES   100

◆ NVAPI_MAX_PHYSICAL_GPUS

#define NVAPI_MAX_PHYSICAL_GPUS   64

◆ NVAPI_MAX_VIEW_MODES

#define NVAPI_MAX_VIEW_MODES   8

◆ NVAPI_PHYSICAL_GPUS

#define NVAPI_PHYSICAL_GPUS   32

◆ NVAPI_SHORT_STRING_MAX

#define NVAPI_SHORT_STRING_MAX   64

◆ NVAPI_SYSTEM_HWBC_INVALID_ID

#define NVAPI_SYSTEM_HWBC_INVALID_ID   0xffffffff

◆ NVAPI_SYSTEM_MAX_DISPLAYS

#define NVAPI_SYSTEM_MAX_DISPLAYS   NVAPI_MAX_PHYSICAL_GPUS * NV_MAX_HEADS

◆ NVAPI_SYSTEM_MAX_HWBCS

#define NVAPI_SYSTEM_MAX_HWBCS   128

◆ NvGUID_Defined

#define NvGUID_Defined

Typedef Documentation

◆ NvAPI_LongString

typedef char NvAPI_LongString[NVAPI_LONG_STRING_MAX]

◆ NvAPI_ShortString

typedef char NvAPI_ShortString[NVAPI_SHORT_STRING_MAX]

◆ NvAPI_String

typedef char NvAPI_String[NVAPI_GENERIC_STRING_MAX]

◆ NvAPI_UnicodeShortString

typedef NvU16 NvAPI_UnicodeShortString[NVAPI_SHORT_STRING_MAX]

◆ NvLUID

typedef struct NvGUID NvLUID