Common parameters and error values
This chapter provides an overview of the common parameter types and the enumeration used for error reporting.
Common parameter types
The VGLite graphics API uses a naming convention scheme wherein definitions are preceded by vg_lite.
Below is the list of types and structures in the driver implementation.
Name |
Typedef |
Value |
---|---|---|
vg_lite_bool_t |
int |
A signed 32-bit integer 0: FALSE; 1: TRUE. |
vg_lite_int8_t |
char |
A signed 8-bit integer |
vg_lite_uint8_t |
unsigned char |
An unsigned 8-bit integer |
vg_lite_int16_t |
short |
A signed 16-bit integer |
vg_lite_uint16_t |
unsigned short |
An unsigned 16-bit integer |
vg_lite_int32_t |
int |
A signed 32-bit integer |
vg_lite_uint32_t |
unsigned int |
An unsigned 32-bit integer |
vg_lite_uint64_t |
unsigned long long |
An unsigned 64-bit integer |
vg_lite_float_t |
float |
A 32-bit single precision floating point number |
vg_lite_double_t |
double |
A 64-bit double precision floating point number |
vg_lite_char_t |
char |
A signed 8-bit integer |
vg_lite_string |
char* |
A pointer to a character string |
vg_lite_pointer |
void* |
A generic address pointer (void *). On 32-bit OS, it is a 32-bit address pointer. On 64-bit OS, it is a 64-bit address pointer. |
vg_lite_void |
void |
The void type |
vg_lite_color_t |
vg_lite_uint32_t |
A 32-bit color value |
VG_LITE_S8 |
enum vg_lite_format_t |
A signed 8-bit integer coordinate |
VG_LITE_S16 |
enum vg_lite_format_t |
A signed 16 bit integer coordinate |
VG_LITE_S32 |
enum vg_lite_format_t |
A signed 32-bit integer coordinate |
VG_LITE_FP32 |
enum vg_lite_format_t |
A 32-bit floating point coordinate |
Parent topic:Common parameters and error values
Enumerations for error reporting
This section describes enumerations used for error reporting.
vg_lite_error_t
enumeration
Most functions in the API include an error status via the vg_lite_error_t
enumeration. API functions return the status of the command and will report VG_LITE_SUCCESS
if successful with no errors. Possible error values include the values in the table below. vg_lite_error_t
enumeration is used in many functions, including initialization, flush, blit, draw, gradient, and pattern functions.
|
Description |
---|---|
|
Cannot communicate with the kernel driver |
|
An invalid argument was specified |
|
Multi-thread/tasks fail (available from June 2020) |
|
No context specified |
|
Function call is not supported. Hardware support is not available. |
|
Out of memory (driver heap) |
|
Out of resources (OS heap) |
|
Successful with no errors |
|
Timeout |
|
Object exists (available from August 2021) |
|
Data alignment error (available from August 2021) |
Parent topic:Enumerations for error reporting
Parent topic:Common parameters and error values