INDEX
-----

 - 1. General terms and compiling
      Overview

 - 2. Initializing and ending functions
   * window
     + open_window()          # open graphic mode
     + close_window()         # close graphic mode
   * sound
     + init_sound()           # start sound server
     + end_sound()            # exit sound server
   * network
     + start_nettcp()         # start network server
     + connect_nettcp()       # connect player to network server
     + close_nettcp()         # disconnect player from network server

 - 3. Window functions
   + reopen_window()          # resize a window in X window, else no effect
   + flush_window()           # flush all graphic data to window

 - 4. Graphic box functions
   * graphic box
     + create_grafik()        # create an empty graphic box
     + load_grafik()          # create a graphic box from a graphic file
     + text_to_grafik()       # create a graphic box with a text in it
     + GRAFIK_WIDTH()         # macro: get width of a graphic box
     + GRAFIK_HEIGHT()        # macro: get height of a graphic box
     + copy_grafik()          # copy a graphic to another graphic or backbuffer
     + save_grafik_as_ppm()   # save graphic as "raw" ppm file (P6)
     + save_grafik_as_ppm3()  # save graphic as "plain" ppm file (P3)
     + free_grafik()          # destroy a graphic box and free memory
   * drawing
     + draw_pixel()           # draw a pixel into a graphic box
     + draw_line()            # draw a line into a graphic box
     + draw_circle()          # draw a circle into a graphic box
     + draw_fillbox()         # draw a filled rectangle into a graphic box
     + draw_text()            # draw text into a graphic box
     + set_font()             # set font used by draw_text()
     + get_pixel()            # get color index of one pixel of a graphic box
     + CLEAR_BOX()            # macro: clear graphic box
   * manipulating
     + rotate_grafik()        # rotate a graphic at certain degrees
     + zoom_grafik()          # zoom a graphic greater or smaller

 - 5. Sprite functions
   + create_sprite()        # create an empty sprite (animated graphic)
   + load_sprite()          # create a sprite from a sprite file
   + rotate_sprite()        # create a new rotated sprite
   + zoom_sprite()          # create a new zoomed sprite
   + add_grafik_to_sprite() # add a graphic to a sprite
   + SPRITE_WIDTH()         # macro: get width of a sprite
   + SPRITE_HEIGHT()        # macro: get height of a sprite
   + next_sprite()          # get actual graphic of a sprite
   + last_sprite()          # get graphic of next_sprite() again
   + reset_sprite()         # reset a sprite to the beginning
   + free_sprite()          # destroy a sprite and free memory

 - 6. Color functions
   + load_colormap()          # load another colormap
   + brightness()             # reduce or increase brightness of loaded colormap
   + color_index()            # get best color index of a given color name

 - 7. Film functions (moving graphics with sound)
   + create_film()            # create a new film
   + free_film()              # destroy a film and free memory
   + add_bild_to_film()       # add a picture to a certain film sequence
   + reset_film()             # reset (rewind) a film
   + copy_film()              # give out next step of a film
   + SET_FILM()               # macro: set global film values
   + SET_FILM_BILD()          # macro: set values of a picture of a film

 - 8. Key and mouse functions
   + CLEAR_KEYS               # macro: set the key field empty
   + ADD_KEYS()               # macro: add a key into the key field
   + SAVE_KEYS()              # macro: save a key field
   + RESTORE_KEYS()           # macro: restore a saved key field
   + IS_KEYS()                # macro: check whether a key is pressed or not
   + MOUSE_FOUND              # macro: test whether a mouse was found or not
   + MOUSE_X                  # macro: get the x position of the mouse pointer
   + MOUSE_Y                  # macro: get the y position of the mouse pointer
   + IS_MOUSELEFT             # macro: check left mouse button pressed
   + IS_MOUSERIGHT            # macro: check right mouse button pressed
   + IS_MOUSEMIDDLE           # macro: check middle mouse button pressed
   + mouse_speed()            # set the mouse pointer speed, if possible
   + get_keys()               # update function for getting key/mouse input
   + clear_state()            # clear all key/mouse events

 - 9. Sound functions
   + (for init_sound() see 2. )
   + load_wave()              # load wave/midi/mp3 connecting it to a wave no.
   + play_wave()              # play a wave/midi/mp3 assigned to a wave number
   + stop_wave()              # stop playing wave/midi/mp3 at certain channels
   + pause_wave()             # pause playing wave/midi/mp3 at certain channels
   + continue_wave()          # continue playing wave/midi/mp3 at certain chan.
   + volume_wave()            # change volume percent at certain channels
   + accel_wave()             # save cpu time for playing at cost of quality
   + set_vol()                # set main or pcm volume for all channels
   + (for end_sound() see 2. )

 - 10. Network functions
   + (for start_nettcp() see 2. )
   + (for connect_nettcp() see 2. )
   + talk_nettcp()            # send and receive players network data
   + (for close_nettcp() see 2.)

 - 11. Other functions and programs
   + wait_time()              # sleep up to a certain time in milliseconds
   + program: vgag-bitmap     # convert windows bitmaps or ppm graphic files
                              # into vgagames graphic files
                              # and show colormap of file

 - 12. Examples - see directory "example"