bitmap_mask_color(3alleg)

bitmap_mask_color3alleg

Returns the mask color of the specified bitmap. allegro game programming library.

Usage

#include <allegro.h>

int bitmap_mask_color(BITMAP *bmp);

Overview

Returns the mask color for the specified bitmap (the value which is skipped when drawing sprites). For 256-color bitmaps this is zero, and for truecolor bitmaps it is bright pink (maximum red and blue, zero green). A frequent use of this function is to clear a bitmap with the mask color so you can later use this bitmap with masked_blit() or draw_sprite() after drawing other stuff on it. Example:

   /* Replace mask color with another color. */
   for (y = 0; y h; y++)
      for (x = 0; x w; x++)
         if (getpixel(bmp, x, y) == bitmap_mask_color(bmp))
            putpixel(bmp, x, y, another_color);

Releases

4 releases since Debian 3.1 (Sarge); the text changed 2 times.

  1. 3.1
  2. 4.0
  3. 5.0–6.0

From liballegro-doc 2:4.2.2-2.2 in Debian 6.0 (Squeeze). Parsed by carta from the page's man source.