TI Display Kernel APIs

Detailed Description

Display (Sink Node) Kernels.

Data Structures
struct	tivx_display_crop_params_t
	The configuration data structure for setting crop parameters. More...
struct	tivx_display_params_t
	The configuration data structure used by the TIVX_KERNEL_DISPLAY kernel. More...
struct	tivx_display_select_channel_params_t
	Channels parameters for selecting channel to be displayed. Passed as an argument to TIVX_DISPLAY_SELECT_CHANNEL control command. More...

Defines
#define	TIVX_KERNEL_DISPLAY_NAME   "com.ti.display"
	Display Kernel Name.
#define	TIVX_DISPLAY_SELECT_CHANNEL   (0x30000000u)
	Control Command to select the channel to be displayed. More...
#define	TIVX_DISPLAY_SET_CROP_PARAMS   (0x30000001u)
	Control Command to set the Crop parameters. More...

Functions
void	tivxRegisterVideoIOTargetDisplayKernels (void)
	Function to register Video IO Kernels on the display Target.
void	tivxUnRegisterVideoIOTargetDisplayKernels (void)
	Function to un-register Video IO Kernels on the display Target.
VX_API_ENTRY vx_node VX_API_CALL	tivxDisplayNode (vx_graph graph, vx_user_data_object configuration, vx_image image)
	[Graph] Creates a DSS Display Node. More...

Macro Definition Documentation

TIVX_DISPLAY_SELECT_CHANNEL

#define TIVX_DISPLAY_SELECT_CHANNEL   (0x30000000u)

Control Command to select the channel to be displayed.

The display node can only display one of the input channels. In case, input is obeject array, there could be frames from multiple channels. In this case, this control command is used to select the channels to be displayed. This cmd can be called at runtime, provided all channels are exactly same in format, size, storage format etc..

This control command uses pointer to structure tivx_display_select_channel_params_t as an input argument.

Definition at line 104 of file video_io_display.h.

TIVX_DISPLAY_SET_CROP_PARAMS

#define TIVX_DISPLAY_SET_CROP_PARAMS   (0x30000001u)

Control Command to set the Crop parameters.

The display node supports cropping the input image and then using scalar, zoom out/in effect could be achieved. Typically for zoom effect, output resolution ie scalar output resolution remains constant. Only input crop parameters are changed.

This control command uses pointer to structure tivx_display_crop_params_t as an input argument.

Definition at line 119 of file video_io_display.h.

Function Documentation

tivxDisplayNode()

VX_API_ENTRY vx_node VX_API_CALL tivxDisplayNode	(	vx_graph	graph,
		vx_user_data_object	configuration,
		vx_image	image
	)

[Graph] Creates a DSS Display Node.

Parameters

[in]	graph	The reference to the graph.
[in]	configuration	The input user data object of a single display params structure of type tivx_display_params_t.
[in]	image	The input image in one of the below formats: VX_DF_IMAGE_RGB, VX_DF_IMAGE_RGBX, VX_DF_IMAGE_BGRX, VX_DF_IMAGE_UYVY, VX_DF_IMAGE_NV12, VX_DF_IMAGE_U16, VX_DF_IMAGE_U8 or TIVX_DF_IMAGE_RGB565.

See also

TIVX_KERNEL_DISPLAY_NAME

Returns

vx_node.

Return values

vx_node

A node reference. Any possible errors preventing a successful creation should be checked using vxGetStatus