Kernel Object Extensions

Detailed Description

Adds various extensions to the vx_kernel object.

This section describes different extensions and features to the standard Object: Kernel.

vxLoadKernels

vxLoadKernels function supports relative and absolute paths to libraries, for example:

• "C:\\folder\\my_module.dll" - absolute path on Windows.
• folder/libmy_module.so - relative path on Linux.

Enumerations
enum	nvx_mutability_e {   NVX_MUTABLE_INIT = VX_ENUM_BASE(VX_ID_NVIDIA, NVX_ENUM_MUTABILITY) + 0x0,   NVX_METADATA_IMMUTABLE_INIT = VX_ENUM_BASE(VX_ID_NVIDIA, NVX_ENUM_MUTABILITY) + 0x1,   NVX_IMMUTABLE_INIT = VX_ENUM_BASE(VX_ID_NVIDIA, NVX_ENUM_MUTABILITY) + 0x2 }
	Defines the mutability state of custom kernel parameter. More...

Functions
vx_status	nvxSetKernelParameterMutability (vx_kernel kernel, vx_uint32 index, vx_enum mutability)
	Allows users to set the mutability of the custom kernel. By default, kernel parameters are set to NVX_MUTABLE_INIT. More...

Enumeration Type Documentation

enum nvx_mutability_e

Defines the mutability state of custom kernel parameter.

Enumerator
NVX_MUTABLE_INIT	A Change of the parameter does not imply a node re-initialization.
NVX_METADATA_IMMUTABLE_INIT	A Change of the parameter meta-data implies a node re-initialization.
NVX_IMMUTABLE_INIT	A Change of the parameter meta-data or value implies a node re-initialization.

Definition at line 82 of file nvx.h.

Function Documentation

vx_status nvxSetKernelParameterMutability	(	vx_kernel	kernel,
		vx_uint32	index,
		vx_enum	mutability
	)

Allows users to set the mutability of the custom kernel. By default, kernel parameters are set to NVX_MUTABLE_INIT.

Parameters

[in]	kernel	The reference to the kernel added with vxAddKernel.
[in]	index	The index of the parameter to add.
[in]	mutability	The mutability of the parameter with regard to the kernel initialization function. This must be a value from nvx_mutability_e.

Returns

A vx_status_e enumerated value.

Return values

VX_SUCCESS	Parameter is successfully set on kernel.
VX_ERROR_INVALID_REFERENCE	The value passed as kernel was not a vx_kernel.

Precondition

vxAddKernel