IPC@CHIP® Graphics Library – API Documentation

Header image

Main page


Most functions of the IPC@CHIP® Graphics Library have (if any) the same result type: GcErrorCode. This simplifies the evaluation of a function's result.

Since:
1.00
Enumerator:
GC_ERROR_NO 

The function has finished successfully.

GC_ERROR_ILLEGAL_ARGUMENT 

An illegal argument has been passed to the function.

GC_ERROR_OUT_OF_MEMORY 

Memory allocation failed. This can be related either to CPU memory or to video memory.

GC_ERROR_FILE_IO 

A file operation (read, write, open, create, etc.) failed.

GC_ERROR_FILE_IO_FORMAT 

The format of a file was unuseable. Note that this can also be the case for the special *.bg? files used by the IPC@CHIP® Graphics Library. These files are optimized for one special IPC@CHIP® Graphics Controller and may be unusable with another IPC@CHIP® Graphics Controller.

GC_ERROR_OUT_OF_IMAGE_BOUNDS 

This code is returned when you tried to access an image out of its bounds. If the image for example has a width of 240 pixels, the last accessable x coordinate is 239. If you try to access the x coordinate 240, this error code will be returned.

GC_ERROR_RESOURCE_NOT_FOUND 

This error code is returned, if any kind of internal resource could not be located (e.g. if you try to set a font face that has not been loaded).

GC_ERROR_RESOURCE_BUSY 

This error code is returned if any kind of internal resource exists, but could not be accessed.

GC_ERROR_LIB_OUT_OF_DATE 

This error code is returned, if a function suspects that your application software was designed for a newer version of the IPC@CHIP® Graphics Library. This can for example be the case, if you set the structVer field of any of the structure data types to a value higher than the one expected by the library.

GC_ERROR_COMM 

This error code is returned when the communication between the IPC@CHIP® and the graphics controller failed. When this error code is returned also the system error record is set (error code GC_SYSTEM_ERROR_COMM).

Note:
This code is not used on GC01's parallel interface.
Since:
1.07
GC_ERROR_OUT_OF_RESOURCES 

This error code is returned, if an internally managed resources such as a task or semaphore could not be allocated.

Since:
1.07
GC_ERROR_FIRMWARE_OUT_OF_DATE 

This error code is returned by gcInit(), if the firmware version of your graphics controller is too old for this version of the IPC@CHIP® Graphics Library to run on.

Since:
1.07





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Tue Jun 27 14:21:34 2017 by Doxygen 1.6.1