<Start> <Intro> <Install> <Legal> <Screen> <Buffer> <Sprite> <Input> <Misc> <Debug> <Utes> <Author>
Function Categories

Functions in the library are split into several logical groupings. Every function within each group is explained in detail later in this document. The following is an overview of the function groups:

screen functions

Screen function names are preceded by screen_. They operate on the screen of the target to allow palette functions like setting a palette and fading in and out. They also include blitting functions which allow all or parts of buffers to be copied on to the screen. This group also includes mode setting functions to enter and leave a graphical state, and functions to clear the screen or fill it with a colour.

palette functions

These functions are palette operations that are not immediately visible on screen, such as re-mapping image palettes, loading palettes and creating new palettes. Functions of this type are preceded by pal_.

buffer functions

Buffer function names are preceded by buff_. This group consists of all the operations that can be performed on buffers, such as blitting functions that copy graphical data from one buffer to another, as well as graphics primitives that allow for drawing shapes and pictures into buffers.

sprite functions

All sprite functions are prefixed by sprite_. This category includes functions for describing, moving and manipulating sprites and sprite images, as well as loading sprites from files for use in your programs.

input functions

Input function provide a portable way for your application to respond to a users actions. Available are functions for reading the mouse, prefixed by mouse_, the keyboard, kb_, and joysticks, joystick_.

image functions

Image functions, prefixed by image_, deal with loading and saving images to and from files. An image is essentially a buffer containing a picture which has its own palette.

miscellaneous functions

Anything not covered by the above categories belongs to this category, including error handling and version information.

Next Section: Library Conventions

<Start> <Intro> <Install> <Legal> <Screen> <Buffer> <Sprite> <Input> <Misc> <Debug> <Utes> <Author>