nvll_osd_api.h File Reference

Detailed Description

NVIDIA Multimedia Utilities: On-Screen Display API

This file defines the NvOSD library, used to draw rectangles and text over the frame.

Definition in file nvll_osd_api.h.

Go to the source code of this file.

Data Structures
struct	_NvOSD_FrameTextParams
	Holds information about the text in a frame. More...
struct	_NvOSD_FrameRectParams
	Holds information about the rectangles in a frame. More...
struct	_NvOSD_FrameSegmentMaskParams
	Holds information about the rectangles in a frame. More...
struct	_NvOSD_FrameLineParams
	Holds information about the lines in a frame. More...
struct	_NvOSD_FrameArrowParams
	Holds information about the arrows in a frame. More...
struct	_NvOSD_FrameCircleParams
	Holds information about the circles in a frame. More...

Macros
#define	NVOSD_PRINT_E(f_,...)   printf("libnvosd (%d):(ERROR) : " f_, __LINE__, ##__VA_ARGS__)
#define	MAX_IN_BUF   16
#define	MAX_BORDER_WIDTH   32

Typedefs
typedef void *	NvOSDCtxHandle
typedef struct _NvOSD_FrameTextParams	NvOSD_FrameTextParams
	Holds information about the text in a frame. More...
typedef struct _NvOSD_FrameRectParams	NvOSD_FrameRectParams
	Holds information about the rectangles in a frame. More...
typedef struct _NvOSD_FrameSegmentMaskParams	NvOSD_FrameSegmentMaskParams
	Holds information about the rectangles in a frame. More...
typedef struct _NvOSD_FrameLineParams	NvOSD_FrameLineParams
	Holds information about the lines in a frame. More...
typedef struct _NvOSD_FrameArrowParams	NvOSD_FrameArrowParams
	Holds information about the arrows in a frame. More...
typedef struct _NvOSD_FrameCircleParams	NvOSD_FrameCircleParams
	Holds information about the circles in a frame. More...

Functions
NvOSDCtxHandle	nvll_osd_create_context (void)
	Creates an NvOSD context. More...
void	nvll_osd_destroy_context (NvOSDCtxHandle nvosd_ctx)
	Destroys an NvOSD context. More...
void	nvll_osd_set_clock_params (NvOSDCtxHandle nvosd_ctx, NvOSD_TextParams *clk_params)
	Sets clock parameters for a given context. More...
int	nvll_osd_put_text (NvOSDCtxHandle nvosd_ctx, NvOSD_FrameTextParams *frame_text_params)
	/brief Overlays clock and given text at a given location in a buffer. More...
int	nvll_osd_draw_segment_masks (NvOSDCtxHandle nvosd_ctx, NvOSD_FrameSegmentMaskParams *frame_mask_params)
	Overlays segment masks at a given location in a buffer. More...
int	nvll_osd_draw_rectangles (NvOSDCtxHandle nvosd_ctx, NvOSD_FrameRectParams *frame_rect_params)
	Overlays boxes at a given location in a buffer. More...
int	nvll_osd_draw_lines (NvOSDCtxHandle nvosd_ctx, NvOSD_FrameLineParams *frame_line_params)
	Overlays lines on the buffer. More...
int	nvll_osd_draw_arrows (NvOSDCtxHandle nvosd_ctx, NvOSD_FrameArrowParams *frame_arrow_params)
	Overlays arrows on the buffer. More...
int	nvll_osd_draw_circles (NvOSDCtxHandle nvosd_ctx, NvOSD_FrameCircleParams *frame_circle_params)
	Overlays circles on the buffer. More...
void *	nvll_osd_set_params (NvOSDCtxHandle nvosd_ctx, int width, int height)
	Sets the resolution of the frames on which the NvOSDContext is to operate. More...
int	nvll_osd_init_colors_for_hw_blend (void *nvosd_ctx, NvOSD_Color_info *color_info, int num_classes)
	Initializes colors for HW based blending. More...