IPC@CHIP® Graphics Library – API Documentation

Header image

Main page


Data Types

This section documents the various data types used thoughout the graphics library. More...

Data Structures

struct  GcImage
 An image object. More...
struct  GcPen
 A pen. More...
struct  GcBrush
 A brush. More...
struct  GcFont
 A font. More...
struct  GcTouchInitParams
 Initialization parameters for the touch panel. More...
struct  GcInitParams
 Initialization parameters (dummy type). More...
struct  GcInitParamsGc01
 Initialization parameters for GC01 controller. More...
struct  GcInitParamsGc02
 Initialisation parameters for GC02 controller. More...
struct  GcInitParamsGc04
 Initialisation parameters for GC04 controller. More...
struct  GcInitParamsGc04V2
 Initialisation parameters for GC04 controller, extended version 2. More...

Typedefs

typedef unsigned long GcHandle
 Internal handle.
typedef unsigned long GcColor
 A color.
typedef void(* GcTouchCallback )(GcTouchEvent event, unsigned short x, unsigned short y)
 Touch callback function prototype.

Enumerations

enum  GcErrorCode {
  GC_ERROR_NO = 0, GC_ERROR_ILLEGAL_ARGUMENT = -1, GC_ERROR_OUT_OF_MEMORY = -2, GC_ERROR_FILE_IO = -3,
  GC_ERROR_FILE_IO_FORMAT = -4, GC_ERROR_OUT_OF_IMAGE_BOUNDS = -5, GC_ERROR_RESOURCE_NOT_FOUND = -6, GC_ERROR_RESOURCE_BUSY = -7,
  GC_ERROR_LIB_OUT_OF_DATE = -8, GC_ERROR_COMM = -9, GC_ERROR_OUT_OF_RESOURCES = -10, GC_ERROR_FIRMWARE_OUT_OF_DATE = -11
}
 

Error code returned by the functions of the graphics library.

More...
enum  GcTransparency { GC_TRANSPARENCY_NONE, GC_TRANSPARENCY_COLOR }
 

Transparency type.

More...
enum  GcPenStyle { GC_PEN_STYLE_SOLID, GC_PEN_STYLE_CLEAR }
 

A pen's style.

More...
enum  GcBrushStyle { GC_BRUSH_STYLE_CLEAR, GC_BRUSH_STYLE_SOLID }
 

A brush's style.

More...
enum  GcImageFileType { GC_IMAGE_FILE_TYPE_BGB, GC_IMAGE_FILE_TYPE_BMP16, GC_IMAGE_FILE_TYPE_BMP24 }
 

Image file type.

More...
enum  GcTouchEvent { GC_TOUCH_EVENT_DOWN, GC_TOUCH_EVENT_UP, GC_TOUCH_EVENT_MOVE }
 

Touch event.

More...
enum  GcTextEncoding { GC_TEXT_ENCODING_ASCII, GC_TEXT_ENCODING_UTF8 }
 

Text encoding.

More...
enum  GcRotation { GC_ROTATE_0, GC_ROTATE_180, GC_ROTATE_CW, GC_ROTATE_CCW }
 

Text rotation types.

More...

Detailed Description

The IPC@CHIP® Graphics Library introduces several data types that are used by the various functions. These data types are documented in this section.

The data types in this section are declared in the header file gclib_types.h, which will be automatically included along with gclib.h.






Top of page | Main page

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