NVIDIA DeepStream SDK API Reference

4.0 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
On-Screen Display Structure

Detailed Description

Defines the NvOSD library to be used to draw rectangles and text over the frame.

Data Structures

struct  _NvOSD_ColorParams
 Holds the color parameters of the box or text to be overlayed. More...
 
struct  _NvOSD_FontParams
 Holds the font parameters of the text to be overlayed. More...
 
struct  _NvOSD_TextParams
 Holds the text parameters of the text to be overlayed. More...
 
struct  _NvOSD_Color_info
 
struct  _NvOSD_RectParams
 Holds the box parameters of the box to be overlayed. More...
 
struct  _NvOSD_LineParams
 Holds the box parameters of the line to be overlayed. More...
 

Macros

#define NVOSD_MAX_NUM_RECTS   128
 
#define MAX_BG_CLR   20
 

Typedefs

typedef struct _NvOSD_ColorParams NvOSD_ColorParams
 Holds the color parameters of the box or text to be overlayed. More...
 
typedef struct _NvOSD_FontParams NvOSD_FontParams
 Holds the font parameters of the text to be overlayed. More...
 
typedef struct _NvOSD_TextParams NvOSD_TextParams
 Holds the text parameters of the text to be overlayed. More...
 
typedef struct _NvOSD_Color_info NvOSD_Color_info
 
typedef struct _NvOSD_RectParams NvOSD_RectParams
 Holds the box parameters of the box to be overlayed. More...
 
typedef struct _NvOSD_LineParams NvOSD_LineParams
 Holds the box parameters of the line to be overlayed. More...
 

Enumerations

enum  NvOSD_Mode {
  MODE_CPU,
  MODE_GPU,
  MODE_HW
}
 List modes used to overlay boxes and text. More...
 

Macro Definition Documentation

#define MAX_BG_CLR   20

Definition at line 55 of file nvll_osd_struct.h.

#define NVOSD_MAX_NUM_RECTS   128

Definition at line 54 of file nvll_osd_struct.h.

Typedef Documentation

Holds the color parameters of the box or text to be overlayed.

Holds the font parameters of the text to be overlayed.

Holds the box parameters of the line to be overlayed.

Holds the box parameters of the box to be overlayed.

Holds the text parameters of the text to be overlayed.

Enumeration Type Documentation

enum NvOSD_Mode

List modes used to overlay boxes and text.

Enumerator
MODE_CPU 

Selects CPU for OSD processing.

Works with RGBA data only

MODE_GPU 

Selects GPU for OSD processing.

Yet to be implemented

MODE_HW 

Selects NV HW engine for rectangle draw and mask.

This mode works with both YUV and RGB data. It does not consider alpha parameter. Not applicable for drawing text.

Definition at line 60 of file nvll_osd_struct.h.