L4T Multimedia API Reference

r32.2 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nvosd.h File Reference

Detailed Description

NVIDIA Multimedia Utilities: On-Screen Display Manager

This file defines the NvOSD library to be used to draw rectangles and text over the frame for given parameters.

Note
The NvOSD API described for the Multimedia API in this document is deprecated. NvOSD support continues in NVIDIA DeepStream. For more information, see the current DeepStream documentation for NvOSD at https://docs.nvidia.com/metropolis/deepstream/4.0/dev-guide/DeepStream_Development_Guide/baggage/group__NvDsOsdApi.html.

Definition in file nvosd.h.

Go to the source code of this file.

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...
 
struct  _NvOSD_ArrowParams
 Holds the arrow parameters to be overlayed. More...
 
struct  _NvOSD_CircleParams
 Holds the circle parameters 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...
 
typedef struct _NvOSD_ArrowParams NvOSD_ArrowParams
 Holds the arrow parameters to be overlayed. More...
 
typedef struct _NvOSD_CircleParams NvOSD_CircleParams
 Holds the circle parameters to be overlayed. More...
 

Enumerations

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

Functions

void * nvosd_create_context (void)
 Creates NvOSD context. More...
 
void nvosd_destroy_context (void *nvosd_ctx)
 Destroys NvOSD context. More...
 
void nvosd_set_clock_params (void *nvosd_ctx, NvOSD_TextParams *clk_params)
 Sets clock parameters for the given context. More...
 
int nvosd_put_text (void *nvosd_ctx, NvOSD_Mode mode, int fd, int num_strings, NvOSD_TextParams *text_params_list)
 Overlays clock and given text at given location on a buffer. More...
 
int nvosd_draw_rectangles (void *nvosd_ctx, NvOSD_Mode mode, int fd, int num_rects, NvOSD_RectParams *rect_params_list)
 Overlays boxes at given location on a buffer. More...
 
int nvosd_init_colors_for_hw_blend (void *nvosd_ctx, NvOSD_Color_info *color_info, int num_classes)
 
int nvosd_draw_arrows (void *nvosd_ctx, NvOSD_Mode mode, int fd, int num_arrows, NvOSD_ArrowParams *arrow_params_list)
 
int nvosd_draw_circles (void *nvosd_ctx, NvOSD_Mode mode, int fd, int num_circles, NvOSD_CircleParams *circle_params_list)