NVIDIA DeepStream SDK API Reference

7.1 Release
NvBufSurfaceCreateParams Struct Reference

Detailed Description

Holds parameters required to allocate an NvBufSurface.

Definition at line 404 of file nvbufsurface.h.

Data Fields

uint32_t gpuId
 Holds the GPU ID. More...
 
uint32_t width
 Holds the width of the buffer. More...
 
uint32_t height
 Holds the height of the buffer. More...
 
uint32_t size
 Holds the amount of memory to be allocated. More...
 
bool isContiguous
 Holds a "contiguous memory" flag. More...
 
NvBufSurfaceColorFormat colorFormat
 Holds the color format of the buffer. More...
 
NvBufSurfaceLayout layout
 Holds the surface layout. More...
 
NvBufSurfaceMemType memType
 Holds the type of memory to be allocated. More...
 

Field Documentation

◆ colorFormat

NvBufSurfaceColorFormat NvBufSurfaceCreateParams::colorFormat

Holds the color format of the buffer.

Definition at line 418 of file nvbufsurface.h.

◆ gpuId

uint32_t NvBufSurfaceCreateParams::gpuId

Holds the GPU ID.

Valid only for a multi-GPU system.

Definition at line 406 of file nvbufsurface.h.

◆ height

uint32_t NvBufSurfaceCreateParams::height

Holds the height of the buffer.

Definition at line 410 of file nvbufsurface.h.

◆ isContiguous

bool NvBufSurfaceCreateParams::isContiguous

Holds a "contiguous memory" flag.

If set, contiguous memory is allocated for the batch. Valid only for CUDA memory types.

Definition at line 416 of file nvbufsurface.h.

◆ layout

NvBufSurfaceLayout NvBufSurfaceCreateParams::layout

Holds the surface layout.

May be Block Linear (BL) or Pitch Linear (PL). For a dGPU, only PL is valid.

Definition at line 421 of file nvbufsurface.h.

◆ memType

NvBufSurfaceMemType NvBufSurfaceCreateParams::memType

Holds the type of memory to be allocated.

Definition at line 423 of file nvbufsurface.h.

◆ size

uint32_t NvBufSurfaceCreateParams::size

Holds the amount of memory to be allocated.

Optional; if set, all other parameters (width, height, etc.) are ignored.

Definition at line 413 of file nvbufsurface.h.

◆ width

uint32_t NvBufSurfaceCreateParams::width

Holds the width of the buffer.

Definition at line 408 of file nvbufsurface.h.


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