CoreFlow 1.0.0
A modern orchestration and execution runtime
Loading...
Searching...
No Matches
Internal Macros

Internal Macros, and define's. More...

Macros

#define dimof(x)
 Get the dimensionality of the array.
 
#define VX_TYPE_IS_IMAGE(type)
 Used to determine is a type is an image.
 
#define VX_TYPE_IS_SCALAR(type)
 Used to determine if a type is a scalar.
 
#define VX_TYPE_IS_SCALAR_WITH_SIZE(type)
 Used to determine scalar with size.
 
#define VX_TYPE_IS_STRUCT(type)
 Used to determine if a type is a struct.
 
#define VX_TYPE_IS_DATA_OBJECT(type)
 Used to determine if a type is a data object.
 
#define VX_TYPE_IS_OBJECT(type)
 Used to determine if a type is an object.
 
#define VX_CHECK_PARAM(ptr, size, type, align)
 A parameter checker for size and alignment.
 
#define VX_CALLOC(type)
 Convenience wrapper around calloc to cast it correctly.
 
#define VX_STRINGERIZE(x)
 Helper to convert any data type to string.
 
#define VX_MIN(a, b)
 Min & Max helper macros.
 
#define VX_BOOL_TO_STATUS(b)
 Helper to extract vx_status from vx_bool.
 

Detailed Description

Internal Macros, and define's.

Macro Definition Documentation

◆ dimof

#define dimof ( x)

#include <vx_internal.h>

Value:
(sizeof(x)/sizeof(x[0]))

Get the dimensionality of the array.

If not defined by the platform, this allows client to retrieve the dimensionality of an array of fixed sized units.

◆ VX_BOOL_TO_STATUS

#define VX_BOOL_TO_STATUS ( b)

#include <vx_internal.h>

Value:
@ vx_true_e
The "true" value.
Definition vx_types.h:406
@ VX_SUCCESS
No error.
Definition vx_types.h:543
@ VX_FAILURE
Indicates a generic error code, used when no other describes the error.
Definition vx_types.h:542

Helper to extract vx_status from vx_bool.

◆ VX_CALLOC

#define VX_CALLOC ( type)

#include <vx_internal.h>

Value:
(type *)new type()

Convenience wrapper around calloc to cast it correctly.

◆ VX_CHECK_PARAM

#define VX_CHECK_PARAM ( ptr,
size,
type,
align )

#include <vx_internal.h>

Value:
(size == sizeof(type) && ((vx_size)ptr & align) == 0)
size_t vx_size
A wrapper of size_t to keep the naming convention uniform.
Definition vx_types.h:186

A parameter checker for size and alignment.

◆ VX_MIN

#define VX_MIN ( a,
b )

#include <vx_internal.h>

Value:
((a) < (b) ? (a) : (b))

Min & Max helper macros.

◆ VX_STRINGERIZE

#define VX_STRINGERIZE ( x)

#include <vx_internal.h>

Value:
x, #x

Helper to convert any data type to string.

◆ VX_TYPE_IS_DATA_OBJECT

#define VX_TYPE_IS_DATA_OBJECT ( type)

#include <vx_internal.h>

Value:
( (((type) >= VX_TYPE_LUT) && ((type) <= VX_TYPE_REMAP)) || \
(((type) >= VX_TYPE_OBJECT_ARRAY) && ((type) <= VX_TYPE_TENSOR)) )
@ VX_TYPE_LUT
A vx_lut.
Definition vx_types.h:492
@ VX_TYPE_REMAP
A vx_remap.
Definition vx_types.h:501
@ VX_TYPE_TENSOR
A vx_tensor.
Definition vx_types.h:507
@ VX_TYPE_OBJECT_ARRAY
A vx_object_array.
Definition vx_types.h:504

Used to determine if a type is a data object.

◆ VX_TYPE_IS_IMAGE

#define VX_TYPE_IS_IMAGE ( type)

#include <vx_internal.h>

Value:
static vx_bool isSupportedFourcc(vx_df_image code)
Determines which VX_DF_IMAGE are supported in the sample implementation.

Used to determine is a type is an image.

◆ VX_TYPE_IS_OBJECT

#define VX_TYPE_IS_OBJECT ( type)

#include <vx_internal.h>

Value:
@ VX_TYPE_VENDOR_OBJECT_END
A value used for bound checking of vendor objects.
Definition vx_types.h:482
@ VX_TYPE_REFERENCE
A vx_reference.
Definition vx_types.h:485

Used to determine if a type is an object.

◆ VX_TYPE_IS_SCALAR

#define VX_TYPE_IS_SCALAR ( type)

#include <vx_internal.h>

Value:
(VX_TYPE_INVALID < (type) && (type) < VX_TYPE_SCALAR_MAX)
@ VX_TYPE_INVALID
An invalid type value. When passed an error must be returned.
Definition vx_types.h:434
#define VX_TYPE_SCALAR_MAX
Definition vx_compatibility.h:20

Used to determine if a type is a scalar.

◆ VX_TYPE_IS_SCALAR_WITH_SIZE

#define VX_TYPE_IS_SCALAR_WITH_SIZE ( type)

#include <vx_internal.h>

Value:
@ VX_TYPE_VENDOR_STRUCT_END
A value for comparison between vendor structs and Khronos defined objects.
Definition vx_types.h:480

Used to determine scalar with size.

◆ VX_TYPE_IS_STRUCT

#define VX_TYPE_IS_STRUCT ( type)

#include <vx_internal.h>

Value:
@ VX_TYPE_RECTANGLE
A vx_rectangle_t.
Definition vx_types.h:452

Used to determine if a type is a struct.