|
CoreFlow 1.0.0
A modern orchestration and execution runtime
|
The API definition for OpenVX. More...
Macros | |
| #define | vxFormatArrayPointer(ptr, index, stride) |
| Accesses a specific indexed element in an array. | |
| #define | vxArrayItem(type, ptr, index, stride) |
| Allows access to an array item as a typecast pointer deference. | |
Functions | |
| VX_API_ENTRY vx_context VX_API_CALL | vxCreateContext (void) |
Creates a vx_context. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxReleaseContext (vx_context *context) |
| Releases the OpenVX object context. | |
| VX_API_ENTRY vx_context VX_API_CALL | vxGetContext (vx_reference reference) |
| Retrieves the context from any reference from within a context. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryContext (vx_context context, vx_enum attribute, void *ptr, vx_size size) |
| Queries the context for some specific information. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetContextAttribute (vx_context context, vx_enum attribute, const void *ptr, vx_size size) |
| Sets an attribute on the context. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxHint (vx_reference reference, vx_enum hint, const void *data, vx_size data_size) |
| Provides a generic API to give platform-specific hints to the implementation. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxDirective (vx_reference reference, vx_enum directive) |
| Provides a generic API to give platform-specific directives to the implementations. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxGetStatus (vx_reference reference) |
| Provides a generic API to return status values from Object constructors if they fail. | |
| VX_API_ENTRY vx_enum VX_API_CALL | vxRegisterUserStruct (vx_context context, vx_size size) |
| Registers user-defined structures to the context. | |
| VX_API_ENTRY vx_enum VX_API_CALL | vxRegisterUserStructWithName (vx_context context, vx_size size, const vx_char *type_name) |
| Registers user-defined structures to the context, and associates a name to it. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxGetUserStructNameByEnum (vx_context context, vx_enum user_struct_type, vx_char *type_name, vx_size name_size) |
| Returns the name of the user-defined structure associated with the enumeration given. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxGetUserStructEnumByName (vx_context context, const vx_char *type_name, vx_enum *user_struct_type) |
| Returns the enum of the user-defined structure associated with the name given. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxAllocateUserKernelId (vx_context context, vx_enum *pKernelEnumId) |
| Allocates and registers user-defined kernel enumeration to a context. The allocated enumeration is from available pool of 4096 enumerations reserved for dynamic allocation from VX_KERNEL_BASE(VX_ID_USER,0). | |
| VX_API_ENTRY vx_status VX_API_CALL | vxAllocateUserKernelLibraryId (vx_context context, vx_enum *pLibraryId) |
| Allocates and registers user-defined kernel library ID to a context. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetImmediateModeTarget (vx_context context, vx_enum target_enum, const char *target_string) |
| Sets the default target of the immediate mode. Upon successful execution of this function any future execution of immediate mode function is attempted on the new default target of the context. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_image VX_API_CALL | vxCreateUniformImage (vx_context context, vx_uint32 width, vx_uint32 height, vx_df_image color, const vx_pixel_value_t *value) |
| Creates a reference to an image object that has a singular, uniform value in all pixels. The uniform image created is read-only. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_image VX_API_CALL | vxCreateImageFromHandle (vx_context context, vx_df_image color, const vx_imagepatch_addressing_t addrs[], void *const ptrs[], vx_enum memory_type) |
| Creates a reference to an image object that was externally allocated. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSwapImageHandle (vx_image image, void *const new_ptrs[], void *prev_ptrs[], vx_size num_planes) |
| Swaps the image handle of an image previously created from handle. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryImage (vx_image image, vx_enum attribute, void *ptr, vx_size size) |
| Retrieves various attributes of an image. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetImageAttribute (vx_image image, vx_enum attribute, const void *ptr, vx_size size) |
| Allows setting attributes on the image. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetImagePixelValues (vx_image image, const vx_pixel_value_t *pixel_value) |
| Initialize an image with the given pixel value. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxGetValidRegionImage (vx_image image, vx_rectangle_t *rect) |
| Retrieves the valid region of the image as a rectangle. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyImagePatch (vx_image image, const vx_rectangle_t *image_rect, vx_uint32 image_plane_index, const vx_imagepatch_addressing_t *user_addr, void *user_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy a rectangular patch from/into an image object plane. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxMapImagePatch (vx_image image, const vx_rectangle_t *rect, vx_uint32 plane_index, vx_map_id *map_id, vx_imagepatch_addressing_t *addr, void **ptr, vx_enum usage, vx_enum mem_type, vx_uint32 flags) |
| Allows the application to get direct access to a rectangular patch of an image object plane. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxUnmapImagePatch (vx_image image, vx_map_id map_id) |
| Unmap and commit potential changes to a image object patch that were previously mapped. Unmapping an image patch invalidates the memory location from which the patch could be accessed by the application. Accessing this memory location after the unmap function completes has an undefined behavior. | |
| VX_API_ENTRY vx_image VX_API_CALL | vxCreateImageFromChannel (vx_image img, vx_enum channel) |
| Create a sub-image from a single plane channel of another image. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetImageValidRectangle (vx_image image, const vx_rectangle_t *rect) |
| Sets the valid rectangle for an image according to a supplied rectangle. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxRegisterKernelLibrary (vx_context context, const vx_char *module, vx_publish_kernels_f publish, vx_unpublish_kernels_f unpublish) |
| Registers a module with kernels in a context. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxLoadKernels (vx_context context, const vx_char *module) |
| Loads a library of kernels, called module, into a context. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxUnloadKernels (vx_context context, const vx_char *module) |
| Unloads all kernels from the OpenVX context that had been loaded from the module using the vxLoadKernels function. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_kernel VX_API_CALL | vxGetKernelByEnum (vx_context context, vx_enum kernel) |
Obtains a reference to the kernel using the vx_kernel_e enumeration. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_kernel VX_API_CALL | vxAddUserKernel (vx_context context, const vx_char name[VX_MAX_KERNEL_NAME], vx_enum enumeration, vx_kernel_f func_ptr, vx_uint32 numParams, vx_kernel_validate_f validate, vx_kernel_initialize_f init, vx_kernel_deinitialize_f deinit) |
| Allows users to add custom kernels to a context at run-time. | |
| VX_API_ENTRY 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 vxAddUserKernel is still valid after the call to vxFinalizeKernel. If an error occurs, the kernel is not available for usage by the clients of OpenVX. Typically this is due to a mismatch between the number of parameters requested and given. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxRemoveKernel (vx_kernel kernel) |
| Removes a custom kernel from its context and releases it. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetKernelAttribute (vx_kernel kernel, vx_enum attribute, const void *ptr, vx_size size) |
| Sets kernel attributes. | |
| VX_API_ENTRY vx_parameter VX_API_CALL | vxGetKernelParameterByIndex (vx_kernel kernel, vx_uint32 index) |
Retrieves a vx_parameter from a vx_kernel. | |
| VX_API_ENTRY vx_graph VX_API_CALL | vxCreateGraph (vx_context context) |
| Creates an empty graph. | |
| VX_API_ENTRY 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. Releasing the graph will only release the nodes if the nodes were not previously released by the application. Data referenced by those nodes may not be released as the user may still have references to the data. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxScheduleGraph (vx_graph graph) |
Schedules a graph for future execution. 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetGraphAttribute (vx_graph graph, vx_enum attribute, const void *ptr, vx_size size) |
| Allows the attributes of the Graph to be set to the provided value. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxAddParameterToGraph (vx_graph graph, vx_parameter parameter) |
Adds the given parameter extracted from a vx_node to the graph. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_parameter VX_API_CALL | vxGetGraphParameterByIndex (vx_graph graph, vx_uint32 index) |
Retrieves a vx_parameter from a vx_graph. | |
| VX_API_ENTRY vx_bool VX_API_CALL | vxIsGraphVerified (vx_graph graph) |
| Returns a Boolean to indicate the state of graph verification. | |
| VX_API_ENTRY vx_node VX_API_CALL | vxCreateGenericNode (vx_graph graph, vx_kernel kernel) |
| Creates a reference to a node object for a given kernel. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxRemoveNode (vx_node *node) |
| Removes a Node from its parent Graph and releases it. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_nodecomplete_f VX_API_CALL | vxRetrieveNodeCallback (vx_node node) |
| Retrieves the current node callback function pointer set on the node. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetNodeTarget (vx_node node, vx_enum target_enum, const char *target_string) |
Sets the node target to the provided value. A success invalidates the graph that the node belongs to (vxVerifyGraph must be called before the next execution) | |
| VX_API_ENTRY vx_status VX_API_CALL | vxReplicateNode (vx_graph graph, vx_node first_node, vx_bool replicate[], vx_uint32 number_of_parameters) |
Creates replicas of the same node first_node to process a set of objects stored in vx_pyramid or vx_object_array. first_node needs to have as parameter levels 0 of a vx_pyramid or the index 0 of a vx_object_array. Replica nodes are not accessible by the application through any means. An application request for removal of first_node from the graph will result in removal of all replicas. Any change of parameter or attribute of first_node will be propagated to the replicas. vxVerifyGraph shall enforce consistency of parameters and attributes in the replicas. | |
| VX_API_ENTRY vx_parameter VX_API_CALL | vxGetParameterByIndex (vx_node node, vx_uint32 index) |
Retrieves a vx_parameter from a vx_node. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryParameter (vx_parameter parameter, vx_enum attribute, void *ptr, vx_size size) |
| Allows the client to query a parameter to determine its meta-information. | |
| VX_API_ENTRY 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 ref sub_node_parameters. | |
| VX_API_ENTRY vx_scalar VX_API_CALL | vxCreateScalarWithSize (vx_context context, vx_enum data_type, const void *ptr, vx_size size) |
| Creates a reference to a scalar object. Also see ref sub_node_parameters. | |
| VX_API_ENTRY vx_scalar VX_API_CALL | vxCreateVirtualScalar (vx_graph graph, vx_enum data_type) |
| Creates an opaque reference to a scalar object with no direct user access. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryScalar (vx_scalar scalar, vx_enum attribute, void *ptr, vx_size size) |
| Queries attributes from a scalar. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyScalar (vx_scalar scalar, void *user_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy from/into a scalar object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyScalarWithSize (vx_scalar scalar, vx_size size, void *user_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy from/into a scalar object with size. | |
| VX_API_ENTRY 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 like count or type. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxReleaseReference (vx_reference *ref_ptr) |
| Releases a reference. The reference may potentially refer to multiple OpenVX objects of different types. This function can be used instead of calling a specific release function for each individual object type (e.g. vxRelease<object>). The object will not be destroyed until its total reference count is zero. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxRetainReference (vx_reference ref) |
| Increments the reference counter of an object This function is used to express the fact that the OpenVX object is referenced multiple times by an application. Each time this function is called for an object, the application will need to release the object one additional time before it can be destructed. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetReferenceName (vx_reference ref, const vx_char *name) |
| Name a reference. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryDelay (vx_delay delay, vx_enum attribute, void *ptr, vx_size size) |
Queries a vx_delay object attribute. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_delay VX_API_CALL | vxCreateDelay (vx_context context, vx_reference exemplar, vx_size num_slots) |
| Creates a Delay object. | |
| VX_API_ENTRY vx_reference VX_API_CALL | vxGetReferenceFromDelay (vx_delay delay, vx_int32 index) |
| Retrieves a reference to a delay slot object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxAgeDelay (vx_delay delay) |
| Shifts the internal delay ring by one. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxRegisterAutoAging (vx_graph graph, vx_delay delay) |
| Register a delay for auto-aging. | |
| VX_API_ENTRY void VX_API_CALL | vxAddLogEntry (vx_reference ref, vx_status status, const char *message,...) |
| Adds a line to the log. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_lut VX_API_CALL | vxCreateLUT (vx_context context, vx_enum data_type, vx_size count) |
Creates LUT object of a given type. The value of VX_LUT_OFFSET is equal to 0 for data_type = VX_TYPE_UINT8, and (vx_uint32)(count/2) for VX_TYPE_INT16. | |
| VX_API_ENTRY vx_lut VX_API_CALL | vxCreateVirtualLUT (vx_graph graph, vx_enum data_type, vx_size count) |
| Creates an opaque reference to a LUT object with no direct user access. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryLUT (vx_lut lut, vx_enum attribute, void *ptr, vx_size size) |
| Queries attributes from a LUT. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyLUT (vx_lut lut, void *user_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy from/into a LUT object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxMapLUT (vx_lut lut, vx_map_id *map_id, void **ptr, vx_enum usage, vx_enum mem_type, vx_bitfield flags) |
| Allows the application to get direct access to LUT object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxUnmapLUT (vx_lut lut, vx_map_id map_id) |
| Unmap and commit potential changes to LUT object that was previously mapped. Unmapping a LUT invalidates the memory location from which the LUT data could be accessed by the application. Accessing this memory location after the unmap function completes has an undefined behavior. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_distribution VX_API_CALL | vxCreateVirtualDistribution (vx_graph graph, vx_size numBins, vx_int32 offset, vx_uint32 range) |
| Creates an opaque reference to a 1D Distribution object without direct user access. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryDistribution (vx_distribution distribution, vx_enum attribute, void *ptr, vx_size size) |
| Queries a Distribution object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyDistribution (vx_distribution distribution, void *user_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy from/into a distribution object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxMapDistribution (vx_distribution distribution, vx_map_id *map_id, void **ptr, vx_enum usage, vx_enum mem_type, vx_bitfield flags) |
| Allows the application to get direct access to distribution object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxUnmapDistribution (vx_distribution distribution, vx_map_id map_id) |
| Unmap and commit potential changes to distribution object that was previously mapped. Unmapping a distribution invalidates the memory location from which the distribution data could be accessed by the application. Accessing this memory location after the unmap function completes has an undefined behavior. | |
| VX_API_ENTRY vx_threshold VX_API_CALL | vxCreateThresholdForImage (vx_context context, vx_enum thresh_type, vx_df_image input_format, vx_df_image output_format) |
| Creates a threshold object and returns a reference to it. | |
| VX_API_ENTRY vx_threshold VX_API_CALL | vxCreateVirtualThresholdForImage (vx_graph graph, vx_enum thresh_type, vx_df_image input_format, vx_df_image output_format) |
| Creates an opaque reference to a threshold object without direct user access. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyThresholdValue (vx_threshold thresh, vx_pixel_value_t *value_ptr, vx_enum usage, vx_enum user_mem_type) |
Allows the application to copy the thresholding value from/into a threshold object with type VX_THRESHOLD_TYPE_BINARY. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyThresholdRange (vx_threshold thresh, vx_pixel_value_t *lower_value_ptr, vx_pixel_value_t *upper_value_ptr, vx_enum usage, vx_enum user_mem_type) |
Allows the application to copy thresholding values from/into a threshold object with type VX_THRESHOLD_TYPE_RANGE. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyThresholdOutput (vx_threshold thresh, vx_pixel_value_t *true_value_ptr, vx_pixel_value_t *false_value_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy the true and false output values from/into a threshold object. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetThresholdAttribute (vx_threshold thresh, vx_enum attribute, const void *ptr, vx_size size) |
| Sets attributes on the threshold object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryThreshold (vx_threshold thresh, vx_enum attribute, void *ptr, vx_size size) |
| Queries an attribute on the threshold object. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_matrix VX_API_CALL | vxCreateVirtualMatrix (vx_graph graph, vx_enum data_type, vx_size columns, vx_size rows) |
| Creates an opaque reference to a matrix object without direct user access. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryMatrix (vx_matrix mat, vx_enum attribute, void *ptr, vx_size size) |
| Queries an attribute on the matrix object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyMatrix (vx_matrix matrix, void *user_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy from/into a matrix object. | |
| VX_API_ENTRY vx_matrix VX_API_CALL | vxCreateMatrixFromPattern (vx_context context, vx_enum pattern, vx_size columns, vx_size rows) |
| Creates a reference to a matrix object from a boolean pattern. | |
| VX_API_ENTRY vx_matrix VX_API_CALL | vxCreateMatrixFromPatternAndOrigin (vx_context context, vx_enum pattern, vx_size columns, vx_size rows, vx_size origin_col, vx_size origin_row) |
| Creates a reference to a matrix object from a boolean pattern, with a user-specified origin. | |
| VX_API_ENTRY vx_convolution VX_API_CALL | vxCreateConvolution (vx_context context, vx_size columns, vx_size rows) |
| Creates a reference to a convolution matrix object. | |
| VX_API_ENTRY vx_convolution VX_API_CALL | vxCreateVirtualConvolution (vx_graph graph, vx_size columns, vx_size rows) |
| Creates an opaque reference to a convolution matrix object without direct user access. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetConvolutionAttribute (vx_convolution conv, vx_enum attribute, const void *ptr, vx_size size) |
| Sets attributes on the convolution object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyConvolutionCoefficients (vx_convolution conv, void *user_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy coefficients from/into a convolution object. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryPyramid (vx_pyramid pyr, vx_enum attribute, void *ptr, vx_size size) |
| Queries an attribute from an image pyramid. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_remap VX_API_CALL | vxCreateVirtualRemap (vx_graph graph, vx_uint32 src_width, vx_uint32 src_height, vx_uint32 dst_width, vx_uint32 dst_height) |
| Creates an opaque reference to a remap table object without direct user access. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxMapRemapPatch (vx_remap remap, const vx_rectangle_t *rect, vx_map_id *map_id, vx_size *stride_y, void **ptr, vx_enum coordinate_type, vx_enum usage, vx_enum mem_type) |
| Allows the application to get direct access to a rectangular patch of a remap object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxUnmapRemapPatch (vx_remap remap, vx_map_id map_id) |
| Unmap and commit potential changes to a remap object patch that was previously mapped. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyRemapPatch (vx_remap remap, const vx_rectangle_t *rect, vx_size user_stride_y, void *user_ptr, vx_enum user_coordinate_type, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy a rectangular patch from/into a remap object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryRemap (vx_remap table, vx_enum attribute, void *ptr, vx_size size) |
| Queries attributes from a Remap table. | |
| VX_API_ENTRY vx_array VX_API_CALL | vxCreateArray (vx_context context, vx_enum item_type, vx_size capacity) |
| Creates a reference to an Array object. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryArray (vx_array arr, vx_enum attribute, void *ptr, vx_size size) |
| Queries the Array for some specific information. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxAddArrayItems (vx_array arr, vx_size count, const void *ptr, vx_size stride) |
| Adds items to the Array. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxTruncateArray (vx_array arr, vx_size new_num_items) |
| Truncates an Array (remove items from the end). | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyArrayRange (vx_array array, vx_size range_start, vx_size range_end, vx_size user_stride, void *user_ptr, vx_enum usage, vx_enum user_mem_type) |
| Allows the application to copy a range from/into an array object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxMapArrayRange (vx_array array, vx_size range_start, vx_size range_end, vx_map_id *map_id, vx_size *stride, void **ptr, vx_enum usage, vx_enum mem_type, vx_uint32 flags) |
| Allows the application to get direct access to a range of an array object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxUnmapArrayRange (vx_array array, vx_map_id map_id) |
| Unmap and commit potential changes to an array object range that was previously mapped. Unmapping an array range invalidates the memory location from which the range could be accessed by the application. Accessing this memory location after the unmap function completes has an undefined behavior. | |
| VX_API_ENTRY vx_object_array VX_API_CALL | vxCreateObjectArray (vx_context context, vx_reference exemplar, vx_size count) |
| Creates a reference to an ObjectArray of count objects. | |
| VX_API_ENTRY vx_object_array VX_API_CALL | vxCreateVirtualObjectArray (vx_graph graph, vx_reference exemplar, vx_size count) |
| Creates an opaque reference to a virtual ObjectArray with no direct user access. | |
| VX_API_ENTRY vx_reference VX_API_CALL | vxGetObjectArrayItem (vx_object_array arr, vx_uint32 index) |
| Retrieves the reference to the OpenVX Object in location index of the ObjectArray. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxReleaseObjectArray (vx_object_array *arr) |
| Releases a reference of an ObjectArray object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryObjectArray (vx_object_array arr, vx_enum attribute, void *ptr, vx_size size) |
| Queries an atribute from the ObjectArray. | |
| VX_API_ENTRY 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. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSetMetaFormatFromReference (vx_meta_format meta, vx_reference exemplar) |
| Set a meta format object from an exemplar data object reference. | |
| 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_tensor VX_API_CALL | vxCreateTensor (vx_context context, vx_size number_of_dims, const vx_size *dims, vx_enum data_type, vx_int8 fixed_point_position) |
| Creates an opaque reference to a tensor data buffer. | |
| VX_API_ENTRY vx_object_array VX_API_CALL | vxCreateImageObjectArrayFromTensor (vx_tensor tensor, const vx_rectangle_t *rect, vx_size array_size, vx_size jump, vx_df_image image_format) |
| Creates an array of images into the multi-dimension data, this can be adjacent 2D images or not depending on the stride value. The stride value is representing bytes in the third dimension. The OpenVX image object that points to a three dimension data and access it as an array of images. This has to be portion of the third lowest dimension, and the stride correspond to that third dimension. The returned Object array is an array of images. Where the image data is pointing to a specific memory in the input tensor. | |
| VX_API_ENTRY vx_tensor VX_API_CALL | vxCreateTensorFromView (vx_tensor tensor, vx_size number_of_dims, const vx_size *view_start, const vx_size *view_end) |
| Creates a tensor data from another tensor data given a view. This second reference refers to the data in the original tensor data. Updates to this tensor data updates the parent tensor data. The view must be defined within the dimensions of the parent tensor data. | |
| VX_API_ENTRY vx_tensor VX_API_CALL | vxCreateVirtualTensor (vx_graph graph, vx_size number_of_dims, const vx_size *dims, vx_enum data_type, vx_int8 fixed_point_position) |
| Creates an opaque reference to a tensor data buffer with no direct user access. This function allows setting the tensor data dimensions or data format. | |
| VX_API_ENTRY vx_tensor VX_API_CALL | vxCreateTensorFromHandle (vx_context context, vx_size number_of_dims, const vx_size *dims, vx_enum data_type, vx_int8 fixed_point_position, const vx_size *stride, void *ptr, vx_enum memory_type) |
| Creates a reference to an tensor object that was externally allocated. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxSwapTensorHandle (vx_tensor tensor, void *new_ptr, void **prev_ptr) |
| Swaps the tensor handle of an tensor previously created from handle. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxCopyTensorPatch (vx_tensor tensor, vx_size number_of_dims, const vx_size *view_start, const vx_size *view_end, const vx_size *user_stride, void *user_ptr, vx_enum usage, vx_enum user_memory_type) |
| Allows the application to copy a view patch from/into an tensor object . | |
| VX_API_ENTRY vx_status VX_API_CALL | vxMapTensorPatch (vx_tensor tensor, vx_size number_of_dims, const vx_size *view_start, const vx_size *view_end, vx_map_id *map_id, vx_size *stride, void **ptr, vx_enum usage, vx_enum mem_type) |
| Allows the application to get direct access to a patch of tensor object. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxUnmapTensorPatch (vx_tensor tensor, const vx_map_id map_id) |
| Unmap and commit potential changes to a tensor object patch that was previously mapped. Unmapping a tensor patch invalidates the memory location from which the patch could be accessed by the application. Accessing this memory location after the unmap function completes has an undefined behavior. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxQueryTensor (vx_tensor tensor, vx_enum attribute, void *ptr, vx_size size) |
| Retrieves various attributes of a tensor data. | |
| VX_API_ENTRY vx_status VX_API_CALL | vxReleaseTensor (vx_tensor *tensor) |
| Releases a reference to a tensor data object. The object may not be garbage collected until its total reference count is zero. | |
The API definition for OpenVX.