![]() |
Multimedia API ReferenceNovember 16, 2016 | 24.2.1 Release |
This file defines the NvOSD library to be used to draw rectangles and text over the frame for given parameters.
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_RectParams |
Holds the box parameters of the box to be overlayed. More... | |
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_RectParams | NvOSD_RectParams |
Holds the box parameters of the box 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... | |
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_RectParams NvOSD_RectParams |
Holds the box parameters of the box to be overlayed.
typedef struct _NvOSD_TextParams NvOSD_TextParams |
Holds the text parameters of the text to be overlayed.
enum NvOSD_Mode |
List modes used to overlay boxes and text.
void* nvosd_create_context | ( | void | ) |
Creates NvOSD context.
void nvosd_destroy_context | ( | void * | nvosd_ctx | ) |
Destroys NvOSD context.
[in] | nvosd_ctx | A pointer to NvOSD context. |
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.
Boxes can be configured with: a. Only border To draw boxes with only border, you must set border_width and set has_bg_color to 0 for the given box. b. Border and background color To draw boxes with border and background color, you must set border_width and set has_bg_color to 1, and specify background color parameters for the given box. c. Solid fill acting as mask region To draw boxes with solid fill acting as mask region, you must set border_width to 0 and has_bg_color to 1 for the given box.
You must ensure that the length of rect_params_list is at least num_rects.
[in] | nvosd_ctx | A pointer to NvOSD context. |
[in] | mode | Specifies the mode selection to draw the boxes. |
[in] | fd | Specifies the DMABUF FD of buffer on which boxes are to be overlayed. |
[in] | num_rects | Specifies the number of boxes to be overlayed. |
[in] | rect_params_list | A pointer to an array of NvOSD_TextParams structure for the clock and text to be overlayed. |
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.
To overlay the clock, you must set clock params using nvosd_set_clock_params(). You must ensure that the length of text_params_list is at least num_strings.
[in] | nvosd_ctx | A pointer to NvOSD context. |
[in] | mode | Specifies the mode selection to draw the text. |
[in] | fd | Specifies the DMABUF FD of buffer on which text is to be overlayed. |
[in] | num_strings | Specifies the number of strings to be overlayed. |
[in] | text_params_list | A pointer to an array of NvOSD_TextParams structure for the clock and text to be overlayed. |
void nvosd_set_clock_params | ( | void * | nvosd_ctx, |
NvOSD_TextParams * | clk_params | ||
) |
Sets clock parameters for the given context.
The clock is overlayed when nvosd_put_text() is called. If no other text is to be overlayed, nvosd_put_text must be called with num_strings as 0 and text_params_list as NULL.
[in] | nvosd_ctx | A pointer to NvOSD context. |
[in] | clk_params | A pointer to NvOSD_TextParams structure for the clock to be overlayed; NULL to disable the clock. |