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...

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

Typedef Documentation

typedef struct _NvBbox_Coords NvBbox_Coords

Holds unclipped bounding box coordinates of the object.

typedef struct _NvOSD_ArrowParams NvOSD_ArrowParams

Holds arrow parameters to be overlaid.

typedef struct _NvOSD_CircleParams NvOSD_CircleParams

Holds circle parameters to be overlayed.

typedef struct _NvOSD_Color_info NvOSD_Color_info

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_LineParams NvOSD_LineParams

Holds the box parameters of a line to be overlayed.

typedef struct _NvOSD_MaskParams NvOSD_MaskParams

Holds the mask parameters of the segment to be overlayed.

typedef struct _NvOSD_RectParams NvOSD_RectParams

Holds the box parameters of the box to be overlayed.

typedef struct _NvOSD_TextParams NvOSD_TextParams

Holds parameters of text to be overlayed.

Enumeration Type Documentation

enum NvOSD_Arrow_Head_Direction

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.

Definition at line 56 of file nvll_osd_struct.h.

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_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.

Definition at line 41 of file nvll_osd_struct.h.