Section 3: library functions
set_gfx_mode – Sets a graphic video mode. Allegro game programming library. Synopsis #include <allegro.h> int set_gfx_mode(int card, int w, int h, int v_w, int v_h); Description Switches into graphics mode. The card parameter should usually be one of the Allegro magic drivers (read introduction of chapter "Graphics modes") or see the platform specific documentation for…
set_dissolve_blender – Enables a dissolve blender mode. Allegro game programming library. Synopsis #include <allegro.h> void set_dissolve_blender(int r, int g, int b, int a); Description Enables a dissolve blender mode for combining translucent or lit truecolor pixels. Randomly replaces the colours of some pixels in the destination image with those of the source image. The number…
set_display_switch_mode – Tells Allegro how the program handles background switching. Synopsis #include <allegro.h> int set_display_switch_mode(int mode); Description Sets how the program should handle being switched into the background, if the user tabs away from it. Not all of the possible modes will be supported by every graphics driver on every platform. The available modes are:…
set_display_switch_callback – Installs a switching notification callback. Allegro game programming library. Synopsis #include <allegro.h> int set_display_switch_callback(int dir, void (*cb)()); Description Installs a notification callback for the switching mode that was previously selected by calling set_display_switch_mode(). The direction parameter can either be SWITCH_IN or SWITCH_OUT, depending whether you want to be notified about switches away from…
set_dialog_color – Sets the colors of an array of dialog objects. Allegro game programming library. Synopsis #include <allegro.h> void set_dialog_color(DIALOG *dialog, int fg, int bg); Description Sets the foreground and background colors of an array of dialog objects. See Also gui_fg_color(3), gui_mg_color(3), centre_dialog(3), exgui(3)
set_config_string – Writes a string in the configuration file. Allegro game programming library. Synopsis #include <allegro.h> void set_config_string(const char *section, const char *name, const char *val); Description Writes a string variable to the current config file, replacing any existing value it may have, or removes the variable if `val’ is NULL. The section name may…
set_config_int – Writes an integer in the configuration file. Allegro game programming library. Synopsis #include <allegro.h> void set_config_int(const char *section, const char *name, int val); Description Writes an integer variable to the current config file. See the comments about set_config_string(). See Also set_config_file(3), get_config_int(3), set_config_string(3), set_config_float(3), set_config_hex(3), set_config_id(3)
set_config_id – Writes a driver ID in the configuration file. Allegro game programming library. Synopsis #include <allegro.h> void set_config_id(const char *section, const char *name, int val); Description Writes a 4-letter driver ID variable to the current config file. See the comments about set_config_string(). See Also set_config_file(3), get_config_id(3), set_config_string(3), set_config_float(3), set_config_hex(3), set_config_int(3)
set_config_hex – Writes a hexadecimal integer in the configuration file. Allegro game programming library. Synopsis #include <allegro.h> void set_config_hex(const char *section, const char *name, int val); Description Writes an integer variable to the current config file, in hexadecimal format. See the comments about set_config_string(). See Also set_config_file(3), get_config_hex(3), set_config_string(3), set_config_float(3), set_config_int(3), set_config_id(3)
set_config_float – Writes a float in the configuration file. Allegro game programming library. Synopsis #include <allegro.h> void set_config_float(const char *section, const char *name, float val); Description Writes a floating point variable to the current config file. See the comments about set_config_string(). See Also set_config_file(3), get_config_float(3), set_config_string(3), set_config_hex(3), set_config_int(3), set_config_id(3)
set_config_file – Sets the configuration file. Allegro game programming library. Synopsis #include <allegro.h> void set_config_file(const char *filename); Description Sets the configuration file to be used by all subsequent config functions. If you don’t call this function, Allegro will use the default `allegro.cfg’ file, looking first in the same directory as your program and then in…
set_config_data – Sets a block of configuration data. Allegro game programming library. Synopsis #include <allegro.h> void set_config_data(const char *data, int length); Description Specifies a block of data to be used by all subsequent config functions, which you have already loaded from disk (eg. as part of some more complicated format of your own, or in…
set_color_depth – Sets the global pixel color depth. Allegro game programming library. Synopsis #include <allegro.h> void set_color_depth(int depth); Description Sets the pixel format to be used by subsequent calls to set_gfx_mode() and create_bitmap(). Valid depths are 8 (the default), 15, 16, 24, and 32 bits. Example: set_color_depth(32); if (set_gfx_mode(GFX_AUTODETECT, 640, 480, 0, 0) != 0)…
set_color_conversion – Tells Allegro how to convert images during loading time. Synopsis #include <allegro.h> void set_color_conversion(int mode); Description Specifies how to convert images between the various color depths when reading graphics from external bitmap files or datafiles. The mode is a bitmask specifying which types of conversion are allowed. If the appropriate bit is set,…
set_color – Sets the specified palette entry to the specified RGB triplet. Allegro game programming library. Synopsis #include <allegro.h> void set_color(int index, const RGB *p); Description Sets the specified palette entry to the specified RGB triplet. Unlike the other palette functions this doesn’t do any retrace synchronisation, so you should call vsync() before it to…
set_close_button_callback – Handles the user clicking on the close button of the window. Allegro game programming library. Synopsis #include <allegro.h> int set_close_button_callback(void (*proc)(void)); Description On platforms that have a close button, this routine installs a callback function to handle the close event. In other words, when the user clicks the close button on your program’s…
set_clip_state – Turns on or off the clipping of a bitmap. Allegro game programming library. Synopsis #include <allegro.h> void set_clip_state(BITMAP *bitmap, int state) Description Turns on (if state is non-zero) or off (if state is zero) clipping for the specified bitmap. Turning clipping off may slightly speed up some drawing operations (usually a negligible difference,…
set_clip_rect – Sets the clipping rectangle of a bitmap. Allegro game programming library. Synopsis #include <allegro.h> void set_clip_rect(BITMAP *bitmap, int x1, int y1, int x2, int y2); Description Each bitmap has an associated clipping rectangle, which is the area of the image that it is OK to draw onto. Nothing will be drawn to positions…
set_blender_mode_ex – An even more complex version of set_blender_mode(). Allegro game programming library. Synopsis #include <allegro.h> void set_blender_mode_ex(BLENDER_FUNC b15, b16, b24, b32, b15x, b16x, b24x, int r, g, b, a); Description Like set_blender_mode(), but allows you to specify a more complete set of blender routines. The b15, b16, b24, and b32 routines are used when…
set_blender_mode – Specifies a custom set of truecolor blender routines. Allegro game programming library. Synopsis #include <allegro.h> void set_blender_mode(BLENDER_FUNC b15, b16, b24, int r, g, b, a); Description Specifies a custom set of truecolor blender routines, which can be used to implement whatever special interpolation modes you need. This function shares a single blender between…