This document provides reference documentation for functions in the Ring library and several Ring addons, including: CURL functions for network requests, ZIP functions for archive manipulation, console color functions, and Allegro functions for graphics and multimedia. It lists functions organized by library/chapter with brief descriptions. The functions cover areas like HTTP requests, file I/O, event handling, fixed point math, and more.

1. Ring Documentation, Release 1.9
• CURLFORM_FILENAME
• CURLFORM_BUFFER
• CURLFORM_BUFFERPTR
• CURLFORM_BUFFERLENGTH
• CURLFORM_STREAM
• CURLFORM_ARRAY
• CURLFORM_CONTENTHEADER
• CURL *curl_easy_init(void)
• void curl_easy_cleanup(CURL * handle )
• CURLcode curl_easy_setopt_1(CURL *handle, CURLoption option, int)
• CURLcode curl_easy_setopt_2(CURL *handle, CURLoption option, const char *)
• CURLcode curl_easy_setopt_3(CURL *handle, CURLoption option, void *)
• CURLcode curl_easy_setopt_4(CURL *handle, CURLoption option, CURLLIST *)
• CURLcode curl_easy_perform(CURL * easy_handle )
• String *curl_easy_perform_silent(CURL * easy_handle )
• CURLcode curl_easy_getinfo_1(CURL *handle, CURLINFO info, char **urlp)
• CURLcode curl_easy_getinfo_2(CURL *handle, CURLINFO info, long *codep)
• CURLcode curl_easy_getinfo_3(CURL *handle, CURLINFO info, double *timep)
• CURLcode curl_easy_getinfo_4(CURL *handle, CURLINFO info, CURLLIST **engine_list)
• CURLcode curl_easy_getinfo_5(CURL *handle, CURLINFO info, struct curl_certinfo *chainp)
• CURLcode curl_easy_getinfo_6(CURL *handle, CURLINFO info, struct curl_tlssessioninfo **session)
• char *curl_version(void)
• time_t curl_getdate(char * datestring , time_t *now )
• CURLFORMcode curl_formadd_1(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor-
moption, const char *, CURLformoption, const char *, CURLformoption)
• CURLFORMcode curl_formadd_2(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor-
moption, const char *, CURLformoption, const char *,CURLformoption, const char *, CURLformoption)
• CURLFORMcode curl_formadd_3(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor-
moption, const char *, CURLformoption, void *, CURLformoption)
• CURLFORMcode curl_formadd_4(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor-
moption, const char *, CURLformoption, void *,CURLformoption, long , CURLformoption)
• CURLFORMcode curl_formadd_5(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor-
moption, const char , CURLformoption, void *,CURLformoption, long , CURLformoption, const char , CURL-
formoption)
• CURLFORMcode curl_formadd_6(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor-
moption, const char *, CURLformoption, const char *,CURLformoption, void * , CURLformoption, long ,
CURLformoption)
• CURLFORMcode curl_formadd_7(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor-
moption, const char *, CURLformoption, struct curl_forms [], CURLformoption)
1219

2. Ring Documentation, Release 1.9
• void curl_formfree(struct curl_httppost * form)
• CURLLIST *curl_slist_append(CURLLIST * list, const char * string )
• void curl_slist_free_all(CURLLIST * list)
• char *curl_easy_escape( CURL * curl , const char * string , int length )
• char *curl_easy_unescape( CURL * curl , const char * url , int inlength , int * outlength )
1220

3. CHAPTER
NINETYTWO
RINGLIBZIP FUNCTIONS REFERENCE
• ZIP_T *zip_openfile(const char *, const char *)
• int zip_entry_open(ZIP_T*, const char *)
• int zip_entry_write(ZIP_T*, const char *,int)
• int zip_entry_fwrite(ZIP_T*, const char *)
• int zip_entry_read(ZIP_T*, void *, size_t *)
• int zip_entry_fread(ZIP_T*, const char *cFile)
• int zip_entry_close(ZIP_T*)
• void zip_extract_file(const char *cZIPFile,const char *cFile)
• void zip_extract_allfiles(const char *cFile, const char *cFolder)
• void zip_close(ZIP_T*)
• int zip_filescount(ZIP_T *)
• const char *zip_getfilenamebyindex(ZIP_T *pZip,int index)
1221

4. CHAPTER
NINETYTHREE
RINGCONSOLECOLORS FUNCTIONS REFERENCE
• CC_FG_NONE
• CC_FG_BLACK
• CC_FG_DARK_RED
• CC_FG_DARK_GREEN
• CC_FG_DARK_YELLOW
• CC_FG_DARK_BLUE
• CC_FG_DARK_MAGENTA
• CC_FG_DARK_CYAN
• CC_FG_GRAY
• CC_FG_DARK_GRAY
• CC_FG_RED
• CC_FG_GREEN
• CC_FG_YELLOW
• CC_FG_BLUE
• CC_FG_MAGENTA
• CC_FG_CYAN
• CC_FG_WHITE
• CC_BG_NONE
• CC_BG_BLACK
• CC_BG_DARK_RED
• CC_BG_DARK_GREEN
• CC_BG_DARK_YELLOW
• CC_BG_DARK_BLUE
• CC_BG_DARK_MAGENTA
• CC_BG_DARK_CYAN
• CC_BG_GRAY
• CC_BG_DARK_GRAY
1222

5. Ring Documentation, Release 1.9
• CC_BG_RED
• CC_BG_GREEN
• CC_BG_YELLOW
• CC_BG_BLUE
• CC_BG_MAGENTA
• CC_BG_CYAN
• CC_BG_WHITE
• void cc_print(int color,const char *string)
1223

6. CHAPTER
NINETYFOUR
RINGALLEGRO FUNCTIONS REFERENCE
• void al_exit(void)
• void al_run_main(void)
• int al_init(void)
• ALLEGRO_CONFIG *al_create_config(void)
• void al_destroy_config(ALLEGRO_CONFIG *config)
• ALLEGRO_CONFIG *al_load_config_file(const char *filename)
• ALLEGRO_CONFIG *al_load_config_file_f(ALLEGRO_FILE *file)
• bool al_save_config_file(const char *filename, const ALLEGRO_CONFIG *config)
• bool al_save_config_file_f(ALLEGRO_FILE *file, const ALLEGRO_CONFIG *config)
• void al_add_config_section(ALLEGRO_CONFIG *config, const char *name)
• void al_add_config_comment(ALLEGRO_CONFIG *config, const char *section, const char *comment)
• const char *al_get_config_value(const ALLEGRO_CONFIG *config,const char *section, const char *key)
• void al_set_config_value(ALLEGRO_CONFIG *config,const char *section, const char *key, const char *value)
• char const *al_get_first_config_section(ALLEGRO_CONFIG const *config,ALLEGRO_CONFIG_SECTION
**iterator)
• char const *al_get_next_config_section(ALLEGRO_CONFIG_SECTION **iterator)
• char const *al_get_first_config_entry(ALLEGRO_CONFIG const *config,char const *section, ALLE-
GRO_CONFIG_ENTRY **iterator)
• char const *al_get_next_config_entry(ALLEGRO_CONFIG_ENTRY **iterator)
• ALLEGRO_CONFIG *al_merge_config(const ALLEGRO_CONFIG *cfg1,const ALLEGRO_CONFIG *cfg2)
• void al_merge_config_into(ALLEGRO_CONFIG *master, const ALLEGRO_CONFIG *add)
• ALLEGRO_DISPLAY *al_create_display(int w, int h)
• void al_destroy_display(ALLEGRO_DISPLAY *display)
• int al_get_new_display_flags(void)
• void al_set_new_display_flags(int flags)
• int al_get_new_display_option(int option, int *importance)
• void al_set_new_display_option(int option, int value, int importance)
• void al_reset_new_display_options(void)
1224

7. Ring Documentation, Release 1.9
• void al_get_new_window_position(int *x, int *y)
• void al_set_new_window_position(int x, int y)
• int al_get_new_display_refresh_rate(void)
• void al_set_new_display_refresh_rate(int refresh_rate)
• ALLEGRO_EVENT_SOURCE *al_get_display_event_source(ALLEGRO_DISPLAY *display)
• ALLEGRO_BITMAP *al_get_backbuffer(ALLEGRO_DISPLAY *display)
• void al_flip_display(void)
• void al_update_display_region(int x, int y, int width, int height)
• bool al_wait_for_vsync(void)
• int al_get_display_width(ALLEGRO_DISPLAY *display)
• int al_get_display_height(ALLEGRO_DISPLAY *display)
• bool al_resize_display(ALLEGRO_DISPLAY *display, int width, int height)
• bool al_acknowledge_resize(ALLEGRO_DISPLAY *display)
• void al_get_window_position(ALLEGRO_DISPLAY *display, int *x, int *y)
• void al_set_window_position(ALLEGRO_DISPLAY *display, int x, int y)
• int al_get_display_flags(ALLEGRO_DISPLAY *display)
• bool al_set_display_flag(ALLEGRO_DISPLAY *display, int flag, bool onoff)
• int al_get_display_option(ALLEGRO_DISPLAY *display, int option)
• int al_get_display_format(ALLEGRO_DISPLAY *display)
• int al_get_display_refresh_rate(ALLEGRO_DISPLAY *display)
• void al_set_window_title(ALLEGRO_DISPLAY *display, const char *title)
• void al_set_display_icon(ALLEGRO_DISPLAY *display, ALLEGRO_BITMAP *icon)
• void al_set_display_icons(ALLEGRO_DISPLAY *display,int num_icons, ALLEGRO_BITMAP *icons[])
• bool al_inhibit_screensaver(bool inhibit)
• void al_acknowledge_drawing_halt(ALLEGRO_DISPLAY *display)
• void al_acknowledge_drawing_resume(ALLEGRO_DISPLAY *display)
• int al_get_display_orientation(ALLEGRO_DISPLAY* display)
• void al_set_display_option(ALLEGRO_DISPLAY *display, int option, int value)
• bool al_get_window_constraints(ALLEGRO_DISPLAY *display,int *min_w, int *min_h, int *max_w, int
*max_h)
• bool al_set_window_constraints(ALLEGRO_DISPLAY *display,int min_w, int min_h, int max_w, int max_h)
• ALLEGRO_EVENT_QUEUE *al_create_event_queue(void)
• void al_destroy_event_queue(ALLEGRO_EVENT_QUEUE *queue)
• void al_register_event_source(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT_SOURCE *source)
• void al_unregister_event_source(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT_SOURCE
*source)
• bool al_is_event_queue_empty(ALLEGRO_EVENT_QUEUE *queue)
1225

8. Ring Documentation, Release 1.9
• bool al_get_next_event(ALLEGRO_EVENT_QUEUE *queue, ALLEGRO_EVENT *ret_event)
• bool al_peek_next_event(ALLEGRO_EVENT_QUEUE *queue, ALLEGRO_EVENT *ret_event)
• bool al_drop_next_event(ALLEGRO_EVENT_QUEUE *queue)
• void al_flush_event_queue(ALLEGRO_EVENT_QUEUE *queue)
• void al_wait_for_event(ALLEGRO_EVENT_QUEUE *queue, ALLEGRO_EVENT *ret_event)
• bool al_wait_for_event_timed(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT *ret_event, float
secs)
• bool al_wait_for_event_until(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT *ret_event, ALLE-
GRO_TIMEOUT *timeout)
• void al_init_user_event_source(ALLEGRO_EVENT_SOURCE *src)
• void al_destroy_user_event_source(ALLEGRO_EVENT_SOURCE *src)
• intptr_t al_get_event_source_data(const ALLEGRO_EVENT_SOURCE *source)
• void al_set_event_source_data(ALLEGRO_EVENT_SOURCE *source, intptr_t data)
• ALLEGRO_FILE *al_fopen(const char *path, const char *mode)
• ALLEGRO_FILE *al_fopen_interface(const ALLEGRO_FILE_INTERFACE *drv,const char *path, const char
*mode)
• ALLEGRO_FILE *al_fopen_slice(ALLEGRO_FILE *fp, size_t initial_size, const char *mode)
• void al_fclose(ALLEGRO_FILE *f)
• size_t al_fread(ALLEGRO_FILE *f, void *ptr, size_t size)
• size_t al_fwrite(ALLEGRO_FILE *f, const void *ptr, size_t size)
• bool al_fflush(ALLEGRO_FILE *f)
• int64_t al_ftell(ALLEGRO_FILE *f)
• bool al_fseek(ALLEGRO_FILE *f, int64_t offset, int whence)
• bool al_feof(ALLEGRO_FILE *f)
• bool al_ferror(ALLEGRO_FILE *f)
• void al_fclearerr(ALLEGRO_FILE *f)
• int al_fungetc(ALLEGRO_FILE *f, int c)
• int64_t al_fsize(ALLEGRO_FILE *f)
• int al_fgetc(ALLEGRO_FILE *f)
• int al_fputc(ALLEGRO_FILE *f, int c)
• int16_t al_fread16le(ALLEGRO_FILE *f)
• int16_t al_fread16be(ALLEGRO_FILE *f)
• size_t al_fwrite16le(ALLEGRO_FILE *f, int16_t w)
• size_t al_fwrite16be(ALLEGRO_FILE *f, int16_t w)
• int32_t al_fread32le(ALLEGRO_FILE *f)
• int32_t al_fread32be(ALLEGRO_FILE *f)
• size_t al_fwrite32le(ALLEGRO_FILE *f, int32_t l)
1226

9. Ring Documentation, Release 1.9
• size_t al_fwrite32be(ALLEGRO_FILE *f, int32_t l)
• char *al_fgets(ALLEGRO_FILE *f, char * const buf, size_t max)
• ALLEGRO_USTR *al_fget_ustr(ALLEGRO_FILE *f)
• int al_fputs(ALLEGRO_FILE *f, char const *p)
• ALLEGRO_FILE *al_fopen_fd(int fd, const char *mode)
• ALLEGRO_FILE *al_make_temp_file(const char *template, ALLEGRO_PATH **ret_path)
• void al_set_new_file_interface(const ALLEGRO_FILE_INTERFACE *file_interface
• void al_set_standard_file_interface(void)
• const ALLEGRO_FILE_INTERFACE *al_get_new_file_interface(void)
• ALLEGRO_FILE *al_create_file_handle(const ALLEGRO_FILE_INTERFACE *drv,void *userdata)
• void *al_get_file_userdata(ALLEGRO_FILE *f)
• ALLEGRO_FS_ENTRY *al_create_fs_entry(const char *path)
• void al_destroy_fs_entry(ALLEGRO_FS_ENTRY *fh)
• const char *al_get_fs_entry_name(ALLEGRO_FS_ENTRY *e)
• bool al_update_fs_entry(ALLEGRO_FS_ENTRY *e)
• uint32_t al_get_fs_entry_mode(ALLEGRO_FS_ENTRY *e)
• time_t al_get_fs_entry_atime(ALLEGRO_FS_ENTRY *e)
• time_t al_get_fs_entry_ctime(ALLEGRO_FS_ENTRY *e)
• time_t al_get_fs_entry_mtime(ALLEGRO_FS_ENTRY *e)
• off_t al_get_fs_entry_size(ALLEGRO_FS_ENTRY *e)
• bool al_fs_entry_exists(ALLEGRO_FS_ENTRY *e)
• bool al_remove_fs_entry(ALLEGRO_FS_ENTRY *e)
• bool al_filename_exists(const char *path)
• bool al_remove_filename(const char *path)
• bool al_open_directory(ALLEGRO_FS_ENTRY *e)
• ALLEGRO_FS_ENTRY *al_read_directory(ALLEGRO_FS_ENTRY *e)
• bool al_close_directory(ALLEGRO_FS_ENTRY *e)
• char *al_get_current_directory(void)
• bool al_change_directory(const char *path)
• bool al_make_directory(const char *path)
• ALLEGRO_FILE *al_open_fs_entry(ALLEGRO_FS_ENTRY *e, const char *mode)
• void al_set_fs_interface(const ALLEGRO_FS_INTERFACE *fs_interface)
• void al_set_standard_fs_interface(void)
• const ALLEGRO_FS_INTERFACE *al_get_fs_interface(void)
• al_fixed al_itofix(int x);
• int al_fixtoi(al_fixed x);
1227

10. Ring Documentation, Release 1.9
• int al_fixfloor(al_fixed x);
• int al_fixceil(al_fixed x);
• al_fixed al_ftofix(double x);
• double al_fixtof(al_fixed x);
• al_fixed al_fixmul(al_fixed x, al_fixed y);
• al_fixed al_fixdiv(al_fixed x, al_fixed y);
• al_fixed al_fixadd(al_fixed x, al_fixed y);
• al_fixed al_fixsub(al_fixed x, al_fixed y);
• al_fixed al_fixsin(al_fixed x);
• al_fixed al_fixcos(al_fixed x);
• al_fixed al_fixtan(al_fixed x);
• al_fixed al_fixasin(al_fixed x);
• al_fixed al_fixacos(al_fixed x);
• al_fixed al_fixatan(al_fixed x)
• al_fixed al_fixatan2(al_fixed y, al_fixed x)
• al_fixed al_fixsqrt(al_fixed x)
• al_fixed al_fixhypot(al_fixed x, al_fixed y)
• ALLEGRO_DISPLAY_MODE *al_get_display_mode(int index, ALLEGRO_DISPLAY_MODE *mode)
• int al_get_num_display_modes(void)
• ALLEGRO_COLOR al_map_rgb(unsigned char r, unsigned char g, unsigned char b)
• ALLEGRO_COLOR al_map_rgb_f(float r, float g, float b)
• ALLEGRO_COLOR al_map_rgba(unsigned char r, unsigned char g, unsigned char b, unsigned char a)
• ALLEGRO_COLOR al_map_rgba_f(float r, float g, float b, float a)
• void al_unmap_rgb(ALLEGRO_COLOR color,unsigned char *r, unsigned char *g, unsigned char *b)
• void al_unmap_rgb_f(ALLEGRO_COLOR color, float *r, float *g, float *b)
• void al_unmap_rgba(ALLEGRO_COLOR color,unsigned char *r, unsigned char *g, unsigned char *b, unsigned
char *a)
• void al_unmap_rgba_f(ALLEGRO_COLOR color,float *r, float *g, float *b, float *a)
• int al_get_pixel_size(int format)
• int al_get_pixel_format_bits(int format)
• ALLEGRO_LOCKED_REGION *al_lock_bitmap(ALLEGRO_BITMAP *bitmap,int format, int flags)
• ALLEGRO_LOCKED_REGION *al_lock_bitmap_region(ALLEGRO_BITMAP *bitmap,int x, int y, int width,
int height, int format, int flags)
• void al_unlock_bitmap(ALLEGRO_BITMAP *bitmap)
• ALLEGRO_BITMAP *al_create_bitmap(int w, int h)
• ALLEGRO_BITMAP *al_create_sub_bitmap(ALLEGRO_BITMAP *parent,int x, int y, int w, int h)
• ALLEGRO_BITMAP *al_clone_bitmap(ALLEGRO_BITMAP *bitmap)
1228