User Facing Import Kernel API

The Public Import Kernel API. More...

Functions
VX_API_ENTRY vx_status VX_API_CALL	vxQueryMetaFormatAttribute (vx_meta_format meta, vx_enum attribute, void *ptr, vx_size size)
	This function allows a user to query the attributes of a vx_meta_format object in a kernel parameter.
VX_API_ENTRY vx_kernel VX_API_CALL	vxImportKernelFromURL (vx_context context, const vx_char *type, const vx_char *url)
	Import a kernel from binary specified by URL.

Detailed Description

The Public Import Kernel API.

Function Documentation

vxImportKernelFromURL()

VX_API_ENTRY vx_kernel VX_API_CALL vxImportKernelFromURL	(	vx_context	context,
		const vx_char *	type,
		const vx_char *	url )

#include <vx_khr_import_kernel.h>

Import a kernel from binary specified by URL.

The name of kernel parameters can be queried using the vxQueryReference API with vx_parameter as ref and VX_REFERENCE_NAME as attribute.

Parameters

context	[in] The OpenVX context
type	[in] Vendor-specific identifier that indicates to the implementation how to interpret the url. For example, if an implementation can interpret the url as a file, a folder a symbolic label, or a pointer, then a vendor may choose to use "vx_<vendor>_file", "vx_<vendor>_folder", "vx_<vendor>_label", and "vx_<vendor>_pointer", respectively for this field. Container types starting with "vx_khr_" are reserved. Refer to vendor documentation for list of container types supported
url	[in] URL to binary container.

Return values

On	success, a valid vx_kernel object. Calling vxGetStatus with the return value as a parameter will return VX_SUCCESS if the function was successful.

vxQueryMetaFormatAttribute()

VX_API_ENTRY vx_status VX_API_CALL vxQueryMetaFormatAttribute	(	vx_meta_format	meta,
		vx_enum	attribute,
		void *	ptr,
		vx_size	size )

#include <vx_api.h>

This function allows a user to query the attributes of a vx_meta_format object in a kernel parameter.

The vx_meta_format object contains two types of information: data object meta data and some specific information that defines how the valid region of an image changes

The meta data attributes that can be queried are identified by this list:

• vx_image : VX_IMAGE_FORMAT, VX_IMAGE_HEIGHT, VX_IMAGE_WIDTH
• vx_array : VX_ARRAY_CAPACITY, VX_ARRAY_ITEMTYPE
• vx_pyramid : VX_PYRAMID_FORMAT, VX_PYRAMID_HEIGHT, VX_PYRAMID_WIDTH, VX_PYRAMID_LEVELS, VX_PYRAMID_SCALE
• vx_scalar : VX_SCALAR_TYPE
• vx_matrix : VX_MATRIX_TYPE, VX_MATRIX_ROWS, VX_MATRIX_COLUMNS
• vx_distribution : VX_DISTRIBUTION_BINS, VX_DISTRIBUTION_OFFSET, VX_DISTRIBUTION_RANGE
• vx_remap : VX_REMAP_SOURCE_WIDTH, VX_REMAP_SOURCE_HEIGHT, VX_REMAP_DESTINATION_WIDTH, VX_REMAP_DESTINATION_HEIGHT
• vx_lut : VX_LUT_TYPE, VX_LUT_COUNT
• vx_threshold : VX_THRESHOLD_TYPE, VX_THRESHOLD_INPUT_FORMAT, VX_THRESHOLD_INPUT_FORMAT
• vx_object_array : VX_OBJECT_ARRAY_NUMITEMS, VX_OBJECT_ARRAY_ITEMTYPE
• vx_tensor : VX_TENSOR_NUMBER_OF_DIMS, VX_TENSOR_DIMS, VX_TENSOR_DATA_TYPE, VX_TENSOR_FIXED_POINT_POSITION
• VX_VALID_RECT_CALLBACK

  Note

  For vx_image, a specific attribute can be used to query the valid region evolution. This information is not a meta data.

  Parameters

  [in]	meta	The reference to the vx_meta_format struct to query
  [in]	attribute	Use the subset of data object attributes that define the meta data of this object or attributes from vx_meta_format.
  [out]	ptr	The output pointer of the value to query on the meta format object.
  [in]	size	The size in bytes of the object to which ptr points.

  Returns

  A vx_status_e enumeration.

  Return values

  VX_SUCCESS	The attribute was returned; any other value indicates failure.
  VX_ERROR_INVALID_REFERENCE	meta is not a valid vx_meta_format reference.
  VX_ERROR_INVALID_PARAMETERS	size was not correct for the type needed.
  VX_ERROR_NOT_SUPPORTED	the object attribute was not supported on the meta format object.
  VX_ERROR_INVALID_TYPE	attribute type did not match known meta format type.