NVIDIA DeepStream SDK API Reference

8.0 Release
On-Screen Display Manager

Detailed Description

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

Data Structures

struct  _NvBbox_Coords
 Holds unclipped bounding box coordinates of the object. More...
 
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 parameters of 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_MaskParams
 Holds the mask parameters of the segment to be overlayed. More...
 
struct  _NvOSD_LineParams
 Holds the box parameters of a line to be overlayed. More...
 
struct  _NvOSD_ArrowParams
 Holds arrow parameters to be overlaid. More...
 
struct  _NvOSD_CircleParams
 Holds circle parameters to be overlayed. More...
 

Typedefs

typedef struct _NvBbox_Coords NvBbox_Coords
 Holds unclipped bounding box coordinates of the object. More...
 
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 parameters of 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_MaskParams NvOSD_MaskParams
 Holds the mask parameters of the segment to be overlayed. More...
 
typedef struct _NvOSD_LineParams NvOSD_LineParams
 Holds the box parameters of a line to be overlayed. More...
 
typedef struct _NvOSD_ArrowParams NvOSD_ArrowParams
 Holds arrow parameters to be overlaid. More...
 
typedef struct _NvOSD_CircleParams NvOSD_CircleParams
 Holds circle parameters to be overlayed. More...
 
typedef struct _NvBbox_Coords NvBbox_Coords
 Holds unclipped bounding box coordinates of the object. More...
 
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 parameters of 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_MaskParams NvOSD_MaskParams
 Holds the mask parameters of the segment to be overlayed. More...
 
typedef struct _NvOSD_LineParams NvOSD_LineParams
 Holds the box parameters of a line to be overlayed. More...
 
typedef struct _NvOSD_ArrowParams NvOSD_ArrowParams
 Holds arrow parameters to be overlaid. More...
 
typedef struct _NvOSD_CircleParams NvOSD_CircleParams
 Holds circle parameters to be overlayed. More...
 

Enumerations

enum  NvOSD_Mode {
  MODE_CPU,
  MODE_GPU,
  MODE_NONE,
  MODE_CPU,
  MODE_GPU,
  MODE_NONE
}
 Defines modes used to overlay boxes and text. More...
 
enum  NvOSD_Arrow_Head_Direction {
  START_HEAD,
  END_HEAD,
  BOTH_HEAD,
  START_HEAD,
  END_HEAD,
  BOTH_HEAD
}
 Specifies arrow head positions. More...
 
enum  NvOSD_Mode {
  MODE_CPU,
  MODE_GPU,
  MODE_NONE,
  MODE_CPU,
  MODE_GPU,
  MODE_NONE
}
 Defines modes used to overlay boxes and text. More...
 
enum  NvOSD_Arrow_Head_Direction {
  START_HEAD,
  END_HEAD,
  BOTH_HEAD,
  START_HEAD,
  END_HEAD,
  BOTH_HEAD
}
 Specifies arrow head positions. More...
 

Typedef Documentation

◆ NvBbox_Coords [1/2]

typedef struct _NvBbox_Coords NvBbox_Coords

Holds unclipped bounding box coordinates of the object.

◆ NvBbox_Coords [2/2]

typedef struct _NvBbox_Coords NvBbox_Coords

Holds unclipped bounding box coordinates of the object.

◆ NvOSD_ArrowParams [1/2]

Holds arrow parameters to be overlaid.

◆ NvOSD_ArrowParams [2/2]

Holds arrow parameters to be overlaid.

◆ NvOSD_CircleParams [1/2]

Holds circle parameters to be overlayed.

◆ NvOSD_CircleParams [2/2]

Holds circle parameters to be overlayed.

◆ NvOSD_Color_info [1/2]

◆ NvOSD_Color_info [2/2]

◆ NvOSD_ColorParams [1/2]

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

◆ NvOSD_ColorParams [2/2]

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

◆ NvOSD_FontParams [1/2]

Holds the font parameters of the text to be overlayed.

◆ NvOSD_FontParams [2/2]

Holds the font parameters of the text to be overlayed.

◆ NvOSD_LineParams [1/2]

Holds the box parameters of a line to be overlayed.

◆ NvOSD_LineParams [2/2]

Holds the box parameters of a line to be overlayed.

◆ NvOSD_MaskParams [1/2]

Holds the mask parameters of the segment to be overlayed.

◆ NvOSD_MaskParams [2/2]

Holds the mask parameters of the segment to be overlayed.

◆ NvOSD_RectParams [1/2]

Holds the box parameters of the box to be overlayed.

◆ NvOSD_RectParams [2/2]

Holds the box parameters of the box to be overlayed.

◆ NvOSD_TextParams [1/2]

Holds parameters of text to be overlayed.

◆ NvOSD_TextParams [2/2]

Holds parameters of text to be overlayed.

Enumeration Type Documentation

◆ NvOSD_Arrow_Head_Direction [1/2]

Specifies arrow head positions.

Enumerator
START_HEAD 

Specifies an arrow head only at start = 0.

END_HEAD 

Specifies an arrow head only at end = 1.

BOTH_HEAD 

Specifies arrow heads at both start and end = 2.

START_HEAD 

Specifies an arrow head only at start = 0.

END_HEAD 

Specifies an arrow head only at end = 1.

BOTH_HEAD 

Specifies arrow heads at both start and end = 2.

Definition at line 53 of file sources/includes/nvll_osd_struct.h.

◆ NvOSD_Arrow_Head_Direction [2/2]

Specifies arrow head positions.

Enumerator
START_HEAD 

Specifies an arrow head only at start = 0.

END_HEAD 

Specifies an arrow head only at end = 1.

BOTH_HEAD 

Specifies arrow heads at both start and end = 2.

START_HEAD 

Specifies an arrow head only at start = 0.

END_HEAD 

Specifies an arrow head only at end = 1.

BOTH_HEAD 

Specifies arrow heads at both start and end = 2.

Definition at line 53 of file 9.0/sources/includes/nvll_osd_struct.h.

◆ NvOSD_Mode [1/2]

enum NvOSD_Mode

Defines modes used to overlay boxes and text.

Enumerator
MODE_CPU 

Specifies using the CPU for OSD processing.

Works with RGBA data only

MODE_GPU 

Specifies using the GPU for OSD processing.

Currently not implemented.

MODE_NONE 

Invalid mode.

Instead GPU mode will be used.

MODE_CPU 

Specifies using the CPU for OSD processing.

Works with RGBA data only

MODE_GPU 

Specifies using the GPU for OSD processing.

Currently not implemented.

MODE_NONE 

Invalid mode.

Instead GPU mode will be used.

Definition at line 42 of file 9.0/sources/includes/nvll_osd_struct.h.

◆ NvOSD_Mode [2/2]

enum NvOSD_Mode

Defines modes used to overlay boxes and text.

Enumerator
MODE_CPU 

Specifies using the CPU for OSD processing.

Works with RGBA data only

MODE_GPU 

Specifies using the GPU for OSD processing.

Currently not implemented.

MODE_NONE 

Invalid mode.

Instead GPU mode will be used.

MODE_CPU 

Specifies using the CPU for OSD processing.

Works with RGBA data only

MODE_GPU 

Specifies using the GPU for OSD processing.

Currently not implemented.

MODE_NONE 

Invalid mode.

Instead GPU mode will be used.

Definition at line 42 of file sources/includes/nvll_osd_struct.h.