![]() |
VisionWorks Toolkit ReferenceDecember 18, 2015 | 1.2 Release |
The API definition for OpenVX.
Definition in file vx_api.h.
Go to the source code of this file.
Macros | |
#define | vxArrayItem(type, ptr, index, stride) (*(type *)(vxFormatArrayPointer((ptr), (index), (stride)))) |
Allows access to an array item as a typecast pointer deference. More... | |
#define | vxFormatArrayPointer(ptr, index, stride) (&(((vx_uint8*)(ptr))[(index) * (stride)])) |
Accesses a specific indexed element in an array. More... | |
Functions | |
vx_status VX_API_CALL | vxAccessArrayRange (vx_array arr, vx_size start, vx_size end, vx_size *stride, void **ptr, vx_enum usage) |
Grants access to a sub-range of an Array. The number of elements in the sub-range is given by (end - start). More... | |
vx_status VX_API_CALL | vxAccessDistribution (vx_distribution distribution, void **ptr, vx_enum usage) |
Grants access to a distribution object and increments the object reference count in case of success. More... | |
vx_status VX_API_CALL | vxAccessImagePatch (vx_image image, const vx_rectangle_t *rect, vx_uint32 plane_index, vx_imagepatch_addressing_t *addr, void **ptr, vx_enum usage) |
Allows the User to extract a rectangular patch (subset) of an image from a single plane. More... | |
vx_status VX_API_CALL | vxAccessLUT (vx_lut lut, void **ptr, vx_enum usage) |
Grants access to a LUT table and increments the object reference count in case of success. More... | |
vx_status VX_API_CALL | vxAddArrayItems (vx_array arr, vx_size count, const void *ptr, vx_size stride) |
Adds items to the Array. More... | |
vx_kernel VX_API_CALL | vxAddKernel (vx_context context, const vx_char name[VX_MAX_KERNEL_NAME], vx_enum enumeration, vx_kernel_f func_ptr, vx_uint32 numParams, vx_kernel_input_validate_f input, vx_kernel_output_validate_f output, vx_kernel_initialize_f init, vx_kernel_deinitialize_f deinit) |
Allows users to add custom kernels to the known kernel database in OpenVX at run-time. This would primarily be used by the module function vxPublishKernels . More... | |
void VX_API_CALL | vxAddLogEntry (vx_reference ref, vx_status status, const char *message,...) |
Adds a line to the log. More... | |
vx_status VX_API_CALL | vxAddParameterToGraph (vx_graph graph, vx_parameter parameter) |
Adds the given parameter extracted from a vx_node to the graph. More... | |
vx_status VX_API_CALL | vxAddParameterToKernel (vx_kernel kernel, vx_uint32 index, vx_enum dir, vx_enum data_type, vx_enum state) |
Allows users to set the signatures of the custom kernel. More... | |
vx_status VX_API_CALL | vxAgeDelay (vx_delay delay) |
Ages the internal delay ring by one. This means that once this API is called the reference from index 0 will go to index -1 and so forth until \( -count+1 \) is reached. This last object will become 0. Once the delay has been aged, it updates the reference in any associated nodes. More... | |
vx_status VX_API_CALL | vxAssignNodeCallback (vx_node node, vx_nodecomplete_f callback) |
Assigns a callback to a node. If a callback already exists in this node, this function must return an error and the user may clear the callback by passing a NULL pointer as the callback. More... | |
vx_status VX_API_CALL | vxCommitArrayRange (vx_array arr, vx_size start, vx_size end, const void *ptr) |
Commits data back to the Array object. More... | |
vx_status VX_API_CALL | vxCommitDistribution (vx_distribution distribution, const void *ptr) |
Commits the distribution objec> and decrements the object reference count in case of success. The memory must be a vx_uint32 array of a value at least as big as the value returned via VX_DISTRIBUTION_ATTRIBUTE_BINS . More... | |
vx_status VX_API_CALL | vxCommitImagePatch (vx_image image, vx_rectangle_t *rect, vx_uint32 plane_index, vx_imagepatch_addressing_t *addr, const void *ptr) |
This allows the User to commit a rectangular patch (subset) of an image from a single plane. More... | |
vx_status VX_API_CALL | vxCommitLUT (vx_lut lut, const void *ptr) |
Commits the Lookup Table and decrements the object reference count in case of success. More... | |
vx_size VX_API_CALL | vxComputeImagePatchSize (vx_image image, const vx_rectangle_t *rect, vx_uint32 plane_index) |
This computes the size needed to retrieve an image patch from an image. More... | |
vx_array VX_API_CALL | vxCreateArray (vx_context context, vx_enum item_type, vx_size capacity) |
Creates a reference to an Array object. More... | |
vx_context VX_API_CALL | vxCreateContext () |
Creates a vx_context . More... | |
vx_convolution VX_API_CALL | vxCreateConvolution (vx_context context, vx_size columns, vx_size rows) |
Creates a reference to a convolution matrix object. More... | |
vx_delay VX_API_CALL | vxCreateDelay (vx_context context, vx_reference exemplar, vx_size slots) |
Creates a Delay object. More... | |
vx_distribution VX_API_CALL | vxCreateDistribution (vx_context context, vx_size numBins, vx_int32 offset, vx_uint32 range) |
Creates a reference to a 1D Distribution of a consecutive interval [offset, offset + range - 1] defined by a start offset and valid range, divided equally into numBins parts. More... | |
vx_node VX_API_CALL | vxCreateGenericNode (vx_graph graph, vx_kernel kernel) |
Creates a reference to a node object for a given kernel. More... | |
vx_graph VX_API_CALL | vxCreateGraph (vx_context context) |
Creates an empty graph. More... | |
vx_image VX_API_CALL | vxCreateImage (vx_context context, vx_uint32 width, vx_uint32 height, vx_df_image color) |
Creates an opaque reference to an image buffer. More... | |
vx_image VX_API_CALL | vxCreateImageFromHandle (vx_context context, vx_df_image color, vx_imagepatch_addressing_t addrs[], void *ptrs[], vx_enum import_type) |
Creates a reference to an image object that was externally allocated. More... | |
vx_image VX_API_CALL | vxCreateImageFromROI (vx_image img, const vx_rectangle_t *rect) |
Creates an image from another image given a rectangle. This second reference refers to the data in the original image. Updates to this image updates the parent image. The rectangle must be defined within the pixel space of the parent image. More... | |
vx_lut VX_API_CALL | vxCreateLUT (vx_context context, vx_enum data_type, vx_size count) |
Creates LUT object of a given type. More... | |
vx_matrix VX_API_CALL | vxCreateMatrix (vx_context c, vx_enum data_type, vx_size columns, vx_size rows) |
Creates a reference to a matrix object. More... | |
vx_pyramid VX_API_CALL | vxCreatePyramid (vx_context context, vx_size levels, vx_float32 scale, vx_uint32 width, vx_uint32 height, vx_df_image format) |
Creates a reference to a pyramid object of the supplied number of levels. More... | |
vx_remap VX_API_CALL | vxCreateRemap (vx_context context, vx_uint32 src_width, vx_uint32 src_height, vx_uint32 dst_width, vx_uint32 dst_height) |
Creates a remap table object. More... | |
vx_scalar VX_API_CALL | vxCreateScalar (vx_context context, vx_enum data_type, const void *ptr) |
Creates a reference to a scalar object. Also see Node Parameters. More... | |
vx_threshold VX_API_CALL | vxCreateThreshold (vx_context c, vx_enum thresh_type, vx_enum data_type) |
Creates a reference to a threshold object of a given type. More... | |
vx_image VX_API_CALL | vxCreateUniformImage (vx_context context, vx_uint32 width, vx_uint32 height, vx_df_image color, const void *value) |
Creates a reference to an image object that has a singular, uniform value in all pixels. More... | |
vx_array VX_API_CALL | vxCreateVirtualArray (vx_graph graph, vx_enum item_type, vx_size capacity) |
Creates an opaque reference to a virtual Array with no direct user access. More... | |
vx_image VX_API_CALL | vxCreateVirtualImage (vx_graph graph, vx_uint32 width, vx_uint32 height, vx_df_image color) |
Creates an opaque reference to an image buffer with no direct user access. This function allows setting the image width, height, or format. More... | |
vx_pyramid VX_API_CALL | vxCreateVirtualPyramid (vx_graph graph, vx_size levels, vx_float32 scale, vx_uint32 width, vx_uint32 height, vx_df_image format) |
Creates a reference to a virtual pyramid object of the supplied number of levels. More... | |
vx_status VX_API_CALL | vxDirective (vx_reference reference, vx_enum directive) |
Provides a generic API to give platform-specific directives to the implementations. More... | |
vx_status VX_API_CALL | vxFinalizeKernel (vx_kernel kernel) |
This API is called after all parameters have been added to the kernel and the kernel is ready to be used. Notice that the reference to the kernel created by vxAddKernel is still valid after the call to vxFinalizeKernel. More... | |
void *VX_API_CALL | vxFormatImagePatchAddress1d (void *ptr, vx_uint32 index, const vx_imagepatch_addressing_t *addr) |
Accesses a specific indexed pixel in an image patch. More... | |
void *VX_API_CALL | vxFormatImagePatchAddress2d (void *ptr, vx_uint32 x, vx_uint32 y, const vx_imagepatch_addressing_t *addr) |
Accesses a specific pixel at a 2d coordinate in an image patch. More... | |
vx_context VX_API_CALL | vxGetContext (vx_reference reference) |
Retrieves the context from any reference from within a context. More... | |
vx_parameter VX_API_CALL | vxGetGraphParameterByIndex (vx_graph graph, vx_uint32 index) |
Retrieves a vx_parameter from a vx_graph . More... | |
vx_kernel VX_API_CALL | vxGetKernelByEnum (vx_context context, vx_enum kernel) |
Obtains a reference to the kernel using the vx_kernel_e enumeration. More... | |
vx_kernel VX_API_CALL | vxGetKernelByName (vx_context context, const vx_char *name) |
Obtains a reference to a kernel using a string to specify the name. More... | |
vx_parameter VX_API_CALL | vxGetKernelParameterByIndex (vx_kernel kernel, vx_uint32 index) |
Retrieves a vx_parameter from a vx_kernel . More... | |
vx_parameter VX_API_CALL | vxGetParameterByIndex (vx_node node, vx_uint32 index) |
Retrieves a vx_parameter from a vx_node . More... | |
vx_image VX_API_CALL | vxGetPyramidLevel (vx_pyramid pyr, vx_uint32 index) |
Retrieves a level of the pyramid as a vx_image , which can be used elsewhere in OpenVX. A call to vxReleaseImage is necessary to release an image for each call of vxGetPyramidLevel. More... | |
vx_reference VX_API_CALL | vxGetReferenceFromDelay (vx_delay delay, vx_int32 index) |
Retrieves a reference from a delay object. More... | |
vx_status VX_API_CALL | vxGetRemapPoint (vx_remap table, vx_uint32 dst_x, vx_uint32 dst_y, vx_float32 *src_x, vx_float32 *src_y) |
Retrieves the source pixel point from a destination pixel. More... | |
vx_status VX_API_CALL | vxGetStatus (vx_reference reference) |
Provides a generic API to return status values from Object constructors if they fail. More... | |
vx_status VX_API_CALL | vxGetValidRegionImage (vx_image image, vx_rectangle_t *rect) |
Retrieves the valid region of the image as a rectangle. More... | |
vx_status VX_API_CALL | vxHint (vx_reference reference, vx_enum hint) |
Provides a generic API to give platform-specific hints to the implementation. More... | |
vx_bool VX_API_CALL | vxIsGraphVerified (vx_graph graph) |
Returns a Boolean to indicate the state of graph verification. More... | |
vx_status VX_API_CALL | vxLoadKernels (vx_context context, const vx_char *module) |
Loads one or more kernels into the OpenVX context. This is the interface by which OpenVX is extensible. Once the set of kernels is loaded new kernels and their parameters can be queried. More... | |
vx_status VX_API_CALL | vxProcessGraph (vx_graph graph) |
This function causes the synchronous processing of a graph. If the graph has not been verified, then the implementation verifies the graph immediately. If verification fails this function returns a status identical to what vxVerifyGraph would return. After the graph verfies successfully then processing occurs. If the graph was previously verified via vxVerifyGraph or vxProcessGraph then the graph is processed. This function blocks until the graph is completed. More... | |
vx_status VX_API_CALL | vxQueryArray (vx_array arr, vx_enum attribute, void *ptr, vx_size size) |
Queries the Array for some specific information. More... | |
vx_status VX_API_CALL | vxQueryContext (vx_context context, vx_enum attribute, void *ptr, vx_size size) |
Queries the context for some specific information. More... | |
vx_status VX_API_CALL | vxQueryConvolution (vx_convolution conv, vx_enum attribute, void *ptr, vx_size size) |
Queries an attribute on the convolution matrix object. More... | |
vx_status VX_API_CALL | vxQueryDelay (vx_delay delay, vx_enum attribute, void *ptr, vx_size size) |
Queries a vx_delay object attribute. More... | |
vx_status VX_API_CALL | vxQueryDistribution (vx_distribution distribution, vx_enum attribute, void *ptr, vx_size size) |
Queries a Distribution object. More... | |
vx_status VX_API_CALL | vxQueryGraph (vx_graph graph, vx_enum attribute, void *ptr, vx_size size) |
Allows the user to query attributes of the Graph. More... | |
vx_status VX_API_CALL | vxQueryImage (vx_image image, vx_enum attribute, void *ptr, vx_size size) |
Retrieves various attributes of an image. More... | |
vx_status VX_API_CALL | vxQueryKernel (vx_kernel kernel, vx_enum attribute, void *ptr, vx_size size) |
This allows the client to query the kernel to get information about the number of parameters, enum values, etc. More... | |
vx_status VX_API_CALL | vxQueryLUT (vx_lut lut, vx_enum attribute, void *ptr, vx_size size) |
Queries attributes from a LUT. More... | |
vx_status VX_API_CALL | vxQueryMatrix (vx_matrix mat, vx_enum attribute, void *ptr, vx_size size) |
Queries an attribute on the matrix object. More... | |
vx_status VX_API_CALL | vxQueryNode (vx_node node, vx_enum attribute, void *ptr, vx_size size) |
Allows a user to query information out of a node. More... | |
vx_status VX_API_CALL | vxQueryParameter (vx_parameter param, vx_enum attribute, void *ptr, vx_size size) |
Allows the client to query a parameter to determine its meta-information. More... | |
vx_status VX_API_CALL | vxQueryPyramid (vx_pyramid pyr, vx_enum attribute, void *ptr, vx_size size) |
Queries an attribute from an image pyramid. More... | |
vx_status VX_API_CALL | vxQueryReference (vx_reference ref, vx_enum attribute, void *ptr, vx_size size) |
Queries any reference type for some basic information (count, type). More... | |
vx_status VX_API_CALL | vxQueryRemap (vx_remap r, vx_enum attribute, void *ptr, vx_size size) |
Queries attributes from a Remap table. More... | |
vx_status VX_API_CALL | vxQueryScalar (vx_scalar scalar, vx_enum attribute, void *ptr, vx_size size) |
Queries attributes from a scalar. More... | |
vx_status VX_API_CALL | vxQueryThreshold (vx_threshold thresh, vx_enum attribute, void *ptr, vx_size size) |
Queries an attribute on the threshold object. More... | |
vx_status VX_API_CALL | vxReadConvolutionCoefficients (vx_convolution conv, vx_int16 *array) |
Gets the convolution data (copy). More... | |
vx_status VX_API_CALL | vxReadMatrix (vx_matrix mat, void *array) |
Gets the matrix data (copy). More... | |
vx_status VX_API_CALL | vxReadScalarValue (vx_scalar ref, void *ptr) |
Gets the scalar value out of a reference. More... | |
void VX_API_CALL | vxRegisterLogCallback (vx_context context, vx_log_callback_f callback, vx_bool reentrant) |
Registers a callback facility to the OpenVX implementation to receive error logs. More... | |
vx_enum VX_API_CALL | vxRegisterUserStruct (vx_context context, vx_size size) |
Registers user-defined structures to the context. More... | |
vx_status VX_API_CALL | vxReleaseArray (vx_array *arr) |
Releases a reference of an Array object. The object may not be garbage collected until its total reference count is zero. After returning from this function the reference is zeroed. More... | |
vx_status VX_API_CALL | vxReleaseContext (vx_context *context) |
Releases the OpenVX object context. More... | |
vx_status VX_API_CALL | vxReleaseConvolution (vx_convolution *conv) |
Releases the reference to a convolution matrix. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseDelay (vx_delay *delay) |
Releases a reference to a delay object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseDistribution (vx_distribution *distribution) |
Releases a reference to a distribution object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseGraph (vx_graph *graph) |
Releases a reference to a graph. The object may not be garbage collected until its total reference count is zero. Once the reference count is zero, all node references in the graph are automatically released as well. Data referenced by those nodes may not be released as the user may have external references to the data. More... | |
vx_status VX_API_CALL | vxReleaseImage (vx_image *image) |
Releases a reference to an image object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseKernel (vx_kernel *kernel) |
Release the reference to the kernel. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseLUT (vx_lut *lut) |
Releases a reference to a LUT object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseMatrix (vx_matrix *mat) |
Releases a reference to a matrix object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseNode (vx_node *node) |
Releases a reference to a Node object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseParameter (vx_parameter *param) |
Releases a reference to a parameter object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleasePyramid (vx_pyramid *pyr) |
Releases a reference to a pyramid object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseRemap (vx_remap *table) |
Releases a reference to a remap table object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseScalar (vx_scalar *scalar) |
Releases a reference to a scalar object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxReleaseThreshold (vx_threshold *thresh) |
Releases a reference to a threshold object. The object may not be garbage collected until its total reference count is zero. More... | |
vx_status VX_API_CALL | vxRemoveKernel (vx_kernel kernel) |
Removes a non-finalized vx_kernel from the vx_context and releases it. Once a vx_kernel has been finalized it cannot be removed. More... | |
vx_status VX_API_CALL | vxRemoveNode (vx_node *node) |
Removes a Node from its parent Graph and releases it. More... | |
vx_nodecomplete_f VX_API_CALL | vxRetrieveNodeCallback (vx_node node) |
Retrieves the current node callback function pointer set on the node. More... | |
vx_status VX_API_CALL | vxScheduleGraph (vx_graph graph) |
Schedules a graph for future execution. More... | |
vx_status VX_API_CALL | vxSetContextAttribute (vx_context context, vx_enum attribute, const void *ptr, vx_size size) |
Sets an attribute on the context. More... | |
vx_status VX_API_CALL | vxSetConvolutionAttribute (vx_convolution conv, vx_enum attribute, const void *ptr, vx_size size) |
Sets attributes on the convolution object. More... | |
vx_status VX_API_CALL | vxSetGraphAttribute (vx_graph graph, vx_enum attribute, const void *ptr, vx_size size) |
Allows the set to attributes on the Graph. More... | |
vx_status VX_API_CALL | vxSetGraphParameterByIndex (vx_graph graph, vx_uint32 index, vx_reference value) |
Sets a reference to the parameter on the graph. The implementation must set this parameter on the originating node as well. More... | |
vx_status VX_API_CALL | vxSetImageAttribute (vx_image image, vx_enum attribute, const void *ptr, vx_size size) |
Allows setting attributes on the image. More... | |
vx_status VX_API_CALL | vxSetKernelAttribute (vx_kernel kernel, vx_enum attribute, const void *ptr, vx_size size) |
Sets kernel attributes. More... | |
vx_status VX_API_CALL | vxSetMetaFormatAttribute (vx_meta_format meta, vx_enum attribute, const void *ptr, vx_size size) |
This function allows a user to set the attributes of a vx_meta_format object in a kernel output validator. More... | |
vx_status VX_API_CALL | vxSetNodeAttribute (vx_node node, vx_enum attribute, const void *ptr, vx_size size) |
Allows a user to set attribute of a node before Graph Validation. More... | |
vx_status VX_API_CALL | vxSetParameterByIndex (vx_node node, vx_uint32 index, vx_reference value) |
Sets the specified parameter data for a kernel on the node. More... | |
vx_status VX_API_CALL | vxSetParameterByReference (vx_parameter parameter, vx_reference value) |
Associates a parameter reference and a data reference with a kernel on a node. More... | |
vx_status VX_API_CALL | vxSetRemapPoint (vx_remap table, vx_uint32 dst_x, vx_uint32 dst_y, vx_float32 src_x, vx_float32 src_y) |
Assigns a destination pixel mapping to the source pixel. More... | |
vx_status VX_API_CALL | vxSetThresholdAttribute (vx_threshold thresh, vx_enum attribute, const void *ptr, vx_size size) |
Sets attributes on the threshold object. More... | |
vx_status VX_API_CALL | vxTruncateArray (vx_array arr, vx_size new_num_items) |
Truncates an Array (remove items from the end). More... | |
vx_status VX_API_CALL | vxVerifyGraph (vx_graph graph) |
Verifies the state of the graph before it is executed. This is useful to catch programmer errors and contract errors. If not verified, the graph verifies before being processed. More... | |
vx_status VX_API_CALL | vxWaitGraph (vx_graph graph) |
Waits for a specific graph to complete. If the graph has been scheduled multiple times since the last call to vxWaitGraph, then vxWaitGraph returns only when the last scheduled execution completes. More... | |
vx_status VX_API_CALL | vxWriteConvolutionCoefficients (vx_convolution conv, const vx_int16 *array) |
Sets the convolution data (copy) More... | |
vx_status VX_API_CALL | vxWriteMatrix (vx_matrix mat, const void *array) |
Sets the matrix data (copy) More... | |
vx_status VX_API_CALL | vxWriteScalarValue (vx_scalar ref, const void *ptr) |
Sets the scalar value in a reference. More... | |