Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
load_bitmap(3)			 Allegro manual 		  load_bitmap(3)

NAME
     load_bitmap - Loads any supported bitmap from a file. Allegro game program-
     ming library.

SYNOPSIS
     #include <allegro.h>

     BITMAP *load_bitmap(const char *filename, RGB *pal);

DESCRIPTION
     Loads  a  bitmap from a file. The palette data will be stored in the second
     parameter, which should be an array of 256 RGB structures. At present  this
     function  supports  BMP, LBM, PCX, and TGA files, determining the type from
     the file extension.

     If the file contains a truecolor image, you must set the video mode or call
     set_color_conversion() before loading it. In this case, if the  destination
     color depth is 8-bit, the palette will be generated by calling generate_op-
     timized_palette()	on  the  bitmap; otherwise, the returned palette will be
     generated by calling generate_332_palette().

     The pal argument may be NULL. In this case, the palette data are simply not
     returned. Additionally, if the file is a truecolor image and  the	destina-
     tion  color  depth is 8-bit, the color conversion process will use the cur-
     rent palette instead of generating an optimized one.

     Example:

	BITMAP *bmp;
	PALETTE palette;
	...
	bmp = load_bitmap("image.pcx", palette);
	if (!bmp)
	   abort_on_error("Couldn't load image.pcx!");
	...
	destroy_bitmap(bmp);

RETURN VALUE
     Returns a pointer to the bitmap or NULL on error. Remember that you are re-
     sponsible for destroying the bitmap when you are finished with it to  avoid
     memory leaks.

SEE ALSO
     load_bmp(3),   load_lbm(3),  load_pcx(3),	load_tga(3),  destroy_bitmap(3),
     save_bitmap(3),	  register_bitmap_file_type(3),      set_color_depth(3),
     set_color_conversion(3),	     generate_optimized_palette(3),	  gener-
     ate_332_palette(3)

Allegro 			  version 4.4.3 		  load_bitmap(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=load_bitmap&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help