NVIDIA DeepStream SDK API Reference

5.0 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvll_osd_struct.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2020, NVIDIA CORPORATION. All rights reserved.
3  *
4  * NVIDIA Corporation and its licensors retain all intellectual property
5  * and proprietary rights in and to this software, related documentation
6  * and any modifications thereto. Any use, reproduction, disclosure or
7  * distribution of this software and related documentation without an express
8  * license agreement from NVIDIA Corporation is strictly prohibited.
9  *
10  */
11 
28 #ifndef __NVLL_OSD_STRUCT_DEFS__
29 #define __NVLL_OSD_STRUCT_DEFS__
30 
31 #include <stdbool.h>
32 
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37 
41 typedef enum {
51 } NvOSD_Mode;
52 
56 typedef enum
57 {
65 
69 typedef struct _NvBbox_Coords {
70  float left;
73  float top;
76  float width;
78  float height;
80 
84 typedef struct _NvOSD_ColorParams {
85  double red;
88  double green;
91  double blue;
94  double alpha;
97 
101 typedef struct _NvOSD_FontParams {
102  char * font_name;
106 // char font_name[64]; /**< Holds a pointer to a string containing
107 // the font name. */
108 
109  unsigned int font_size;
113 
114 
118 typedef struct _NvOSD_TextParams {
119  char * display_text;
121  unsigned int x_offset;
123  unsigned int y_offset;
134 
135 typedef struct _NvOSD_Color_info {
136  int id;
139 
143 typedef struct _NvOSD_RectParams {
144  float left;
147  float top;
150  float width;
152  float height;
154  unsigned int border_width;
159  unsigned int has_bg_color;
162  unsigned int reserved;
167  int color_id;
169 
173 typedef struct _NvOSD_MaskParams {
174  float *data;
175  unsigned int size;
176  float threshold;
177  unsigned int width;
178  unsigned int height;
180 
184 typedef struct _NvOSD_LineParams {
185  unsigned int x1;
188  unsigned int y1;
191  unsigned int x2;
193  unsigned int y2;
195  unsigned int line_width;
199 
203 typedef struct _NvOSD_ArrowParams {
204  unsigned int x1;
206  unsigned int y1;
208  unsigned int x2;
210  unsigned int y2;
212  unsigned int arrow_width;
220  unsigned int reserved;
223 
227 typedef struct _NvOSD_CircleParams {
228  unsigned int xc;
230  unsigned int yc;
232  unsigned int radius;
237  unsigned int has_bg_color; /*< Holds a Boolean value indicating whether
238  the circle has a background color. */
239 
240  NvOSD_ColorParams bg_color; /*< Holds the circle's background color. */
241 
242  unsigned int reserved;
246 
247 #ifdef __cplusplus
248 }
249 #endif
250 
251 #endif
struct _NvOSD_ArrowParams NvOSD_ArrowParams
Holds arrow parameters to be overlaid.
unsigned int width
Threshold for binarization.
unsigned int x2
Holds the box's width in pixels.
NvOSD_ColorParams arrow_color
Holds color parameters of the arrow box.
float height
Holds the box's height in pixels.
struct _NvOSD_Color_info NvOSD_Color_info
unsigned int radius
Holds the radius of circle in pixels.
struct _NvOSD_CircleParams NvOSD_CircleParams
Holds circle parameters to be overlayed.
unsigned int y_offset
Holds the text's vertical offset from the top left pixel of the frame.
unsigned int y2
Holds the box's height in pixels.
unsigned int line_width
Holds the box's border width in pixels.
Holds the font parameters of the text to be overlayed.
unsigned int x2
Holds the end horizontal coordinate in pixels.
float left
Holds the box's left coordinate in pixels.
NvOSD_ColorParams bg_color
Holds unclipped bounding box coordinates of the object.
float width
Holds the box's width in pixels.
Holds the box parameters of the box to be overlayed.
NvOSD_Arrow_Head_Direction arrow_head
Holds the arrowhead position.
unsigned int x1
Holds the box's left coordinate in pixels.
struct _NvOSD_MaskParams NvOSD_MaskParams
Holds the mask parameters of the segment to be overlayed.
struct _NvOSD_FontParams NvOSD_FontParams
Holds the font parameters of the text to be overlayed.
unsigned int size
Mask data.
Holds circle parameters to be overlayed.
unsigned int x1
Holds the start horizontal coordinate in pixels.
unsigned int arrow_width
Holds the arrow shaft width in pixels.
Holds the mask parameters of the segment to be overlayed.
unsigned int y1
Holds the start vertical coordinate in pixels.
Holds arrow parameters to be overlaid.
struct _NvOSD_LineParams NvOSD_LineParams
Holds the box parameters of a line to be overlayed.
NvOSD_ColorParams border_color
Holds the box's border color.
Specifies arrow heads at both start and end = 2.
unsigned int reserved
Holds a field reserved for future use.
NvOSD_Mode
Defines modes used to overlay boxes and text.
Specifies an arrow head only at start = 0.
unsigned int x_offset
Holds the text's horizontal offset from the top left pixel of the frame.
float height
Holds the box's height in pixels.
char * display_text
Holds the text to be overlayed.
struct _NvOSD_ColorParams NvOSD_ColorParams
Holds the color parameters of the box or text to be overlayed.
NvOSD_ColorParams circle_color
Holds the color parameters of the arrow box.
double alpha
Holds the alpha component of color.
float width
Holds the box's width in pixels.
Holds the box parameters of a line to be overlayed.
struct _NvBbox_Coords NvBbox_Coords
Holds unclipped bounding box coordinates of the object.
Specifies the NVIDIA hardware engine for rectangle drawing and masking.
char * font_name
Holds a pointer to the string containing the font name.
NvOSD_ColorParams font_color
Holds the font color.
unsigned int has_bg_color
int set_bg_clr
Holds a Boolean; true if the text has a background color.
NvOSD_ColorParams text_bg_clr
Holds the text's background color, if specified.
Holds parameters of text to be overlayed.
unsigned int y2
Holds the end vertical coordinate in pixels.
unsigned int reserved
Reserved for future use; currently for internal use only.
Specifies using the CPU for OSD processing.
float left
Holds the box's left coordinate in pixels.
NvOSD_Arrow_Head_Direction
Specifies arrow head positions.
unsigned int yc
Holds the start vertical coordinate in pixels.
NvOSD_ColorParams color
Holds the color parameters of the box or text to be overlayed.
struct _NvOSD_RectParams NvOSD_RectParams
Holds the box parameters of the box to be overlayed.
unsigned int has_bg_color
Holds a Boolean; true if the box has a background color.
unsigned int reserved
Reserved for future use; currently for internal use only.
float top
Holds the box's top coordinate in pixels.
float top
Holds the box's top coordinate in pixels.
unsigned int y1
Holds the box's top coordinate in pixels.
struct _NvOSD_TextParams NvOSD_TextParams
Holds parameters of text to be overlayed.
Specifies an arrow head only at end = 1.
unsigned int border_width
Holds the box's border width in pixels.
double blue
Holds the blue component of color.
double red
Holds the red component of color.
unsigned int font_size
Holds the size of the font.
unsigned int height
Mask width.
NvOSD_FontParams font_params
Holds the font parameters of the text to be overlaid.
double green
Holds the green component of color.
Specifies using the GPU for OSD processing.
NvOSD_ColorParams line_color
Holds the box's border color.
float threshold
Mask size.
NvOSD_ColorParams bg_color
Holds the box's background color.
unsigned int xc
Holds the start horizontal coordinate in pixels.