NVTX C API Reference v3
NVIDIA Tools Extension Library
Loading...
Searching...
No Matches
Data Fields
nvtxMemRegionsResizeBatch_v1 Struct Reference

Register a region of memory inside of a heap. More...

#include <nvToolsExtMem.h>

Data Fields

uint16_t extCompatID
 
uint16_t structSize
 
uint32_t regionType
 
size_t regionDescCount
 
size_t regionDescElementSize
 
void const * regionDescElements
 

Detailed Description

Register a region of memory inside of a heap.

The heap refers the the heap within which the region resides. This can be from nvtxMemHeapRegister, NVTX_MEM_HEAP_HANDLE_PROCESS_WIDE, or one provided from other extension API.

The regionType arg will define which type is used in regionDescArray. The most commonly used type is NVTX_MEM_TYPE_VIRTUAL_ADDRESS.

The regionCount arg is how many element are in regionDescArray and regionHandleArrayOut.

The regionHandleArrayOut arg points to an array where the tool will provide region handles. If a pointer if provided, it is expected to have regionCount elements. This pointer can be NULL if regionType is NVTX_MEM_TYPE_VIRTUAL_ADDRESS. In this case, the user can use the pointer to the virtual memory to reference the region in other related functions which accept nvtxMemRegionRef_t.

Definition at line 390 of file nvToolsExtMem.h.

Field Documentation

◆ extCompatID

uint16_t nvtxMemRegionsResizeBatch_v1::extCompatID

Definition at line 392 of file nvToolsExtMem.h.

◆ regionDescCount

size_t nvtxMemRegionsResizeBatch_v1::regionDescCount

Definition at line 397 of file nvToolsExtMem.h.

◆ regionDescElements

void const* nvtxMemRegionsResizeBatch_v1::regionDescElements

Definition at line 399 of file nvToolsExtMem.h.

◆ regionDescElementSize

size_t nvtxMemRegionsResizeBatch_v1::regionDescElementSize

Definition at line 398 of file nvToolsExtMem.h.

◆ regionType

uint32_t nvtxMemRegionsResizeBatch_v1::regionType

Definition at line 395 of file nvToolsExtMem.h.

◆ structSize

uint16_t nvtxMemRegionsResizeBatch_v1::structSize

Definition at line 393 of file nvToolsExtMem.h.


The documentation for this struct was generated from the following file: