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  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in
11  * the documentation and/or other materials provided with the
12  * distribution.
13  * 3. The names of its contributors may not be used to endorse or promote
14  * products derived from this software without specific prior written
15  * permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
23  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
46 #ifndef __NVLL_OSD_STRUCT_DEFS__
47 #define __NVLL_OSD_STRUCT_DEFS__
48 
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 
57 typedef enum {
67 } NvOSD_Mode;
68 
72 typedef enum
73 {
81 
85 typedef struct _NvOSD_ColorParams {
86  double red;
89  double green;
92  double blue;
95  double alpha;
98 
102 typedef struct _NvOSD_FontParams {
103  char * font_name;
107 // char font_name[64]; /**< Holds a pointer to a string containing
108 // the font name. */
109 
110  unsigned int font_size;
114 
115 
119 typedef struct _NvOSD_TextParams {
120  char * display_text;
122  unsigned int x_offset;
124  unsigned int y_offset;
135 
136 typedef struct _NvOSD_Color_info {
137  int id;
140 
144 typedef struct _NvOSD_RectParams {
145  float left;
148  float top;
151  float width;
153  float height;
155  unsigned int border_width;
160  unsigned int has_bg_color;
163  unsigned int reserved;
168  int color_id;
170 
174 typedef struct _NvOSD_LineParams {
175  unsigned int x1;
178  unsigned int y1;
181  unsigned int x2;
183  unsigned int y2;
185  unsigned int line_width;
189 
193 typedef struct _NvOSD_ArrowParams {
194  unsigned int x1;
196  unsigned int y1;
198  unsigned int x2;
200  unsigned int y2;
202  unsigned int arrow_width;
210  unsigned int reserved;
213 
217 typedef struct _NvOSD_CircleParams {
218  unsigned int xc;
220  unsigned int yc;
222  unsigned int radius;
227  unsigned int has_bg_color; /*< Holds a Boolean value indicating whether
228  the circle has a background color. */
229 
230  NvOSD_ColorParams bg_color; /*< Holds the circle's background color. */
231 
232  unsigned int reserved;
236 
237 #ifdef __cplusplus
238 }
239 #endif
240 
241 #endif
struct _NvOSD_ArrowParams NvOSD_ArrowParams
Holds arrow parameters to be overlaid.
unsigned int x2
Holds the box's width in pixels.
NvOSD_ColorParams arrow_color
Holds color parameters of the arrow box.
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.
NvOSD_ColorParams bg_color
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_FontParams NvOSD_FontParams
Holds the font parameters of the text to be overlayed.
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.
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.
Holds the box parameters of a line to be overlayed.
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.
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.
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.
NvOSD_ColorParams bg_color
Holds the box's background color.
unsigned int xc
Holds the start horizontal coordinate in pixels.