On-Screen Display Structure

group ee_nvosd_group

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

Typedefs

typedef struct _NvBbox_Coords NvBbox_Coords

Holds unclipped bounding box coordinates of the object.

typedef struct _NvOSD_ColorParams NvOSD_ColorParams

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

typedef struct _NvOSD_FontParams NvOSD_FontParams

Holds the font parameters of the text to be overlayed.

typedef struct _NvOSD_TextParams NvOSD_TextParams

Holds parameters of text to be overlayed.

typedef struct _NvOSD_Color_info NvOSD_Color_info
typedef struct _NvOSD_RectParams NvOSD_RectParams

Holds the box parameters of the box to be overlayed.

typedef struct _NvOSD_MaskParams NvOSD_MaskParams

Holds the mask parameters of the segment to be overlayed.

typedef struct _NvOSD_LineParams NvOSD_LineParams

Holds the box parameters of a line to be overlayed.

typedef struct _NvOSD_ArrowParams NvOSD_ArrowParams

Holds arrow parameters to be overlaid.

typedef struct _NvOSD_CircleParams NvOSD_CircleParams

Holds circle parameters to be overlayed.

Enums

enum NvOSD_Mode

Defines modes used to overlay boxes and text.

Values:

enumerator MODE_CPU

Specifies using the CPU for OSD processing.

Works with RGBA data only

enumerator MODE_GPU

Specifies using the GPU for OSD processing.

Currently not implemented.

enumerator MODE_HW

Specifies the NVIDIA hardware engine for rectangle drawing and masking.

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

enum NvOSD_Arrow_Head_Direction

Specifies arrow head positions.

Values:

enumerator START_HEAD

Specifies an arrow head only at start = 0.

enumerator END_HEAD

Specifies an arrow head only at end = 1.

enumerator BOTH_HEAD

Specifies arrow heads at both start and end = 2.

struct _NvBbox_Coords
#include <nvll_osd_struct.h>

Holds unclipped bounding box coordinates of the object.

struct _NvOSD_ColorParams
#include <nvll_osd_struct.h>

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

struct _NvOSD_FontParams
#include <nvll_osd_struct.h>

Holds the font parameters of the text to be overlayed.

struct _NvOSD_TextParams
#include <nvll_osd_struct.h>

Holds parameters of text to be overlayed.

struct _NvOSD_Color_info
#include <nvll_osd_struct.h>
struct _NvOSD_RectParams
#include <nvll_osd_struct.h>

Holds the box parameters of the box to be overlayed.

struct _NvOSD_MaskParams
#include <nvll_osd_struct.h>

Holds the mask parameters of the segment to be overlayed.

struct _NvOSD_LineParams
#include <nvll_osd_struct.h>

Holds the box parameters of a line to be overlayed.

struct _NvOSD_ArrowParams
#include <nvll_osd_struct.h>

Holds arrow parameters to be overlaid.

struct _NvOSD_CircleParams
#include <nvll_osd_struct.h>

Holds circle parameters to be overlayed.