get_rle_sprite man page

get_rle_sprite — Creates an RLE sprite using a bitmap as source. Allegro game programming library.

Synopsis

#include <allegro.h>

RLE_SPRITE *get_rle_sprite(BITMAP *bitmap);

Description

Creates an RLE sprite based on the specified bitmap (which must be a  memory bitmap). Remember to free this RLE sprite later to avoid memory leaks. Example:

   RLE_SPRITE *rle;
   BITMAP *bmp;
   ...
   /* Create RLE sprite from an existent bitmap. */
   rle = get_rle_sprite(bmp);
   if (!rle)
      abort_on_error("Couldn't create RLE sprite!");
      
   /* We don't need the bitmap any more.*/
   destroy_bitmap(bmp);
   
   /* Use the RLE sprite. */
   ...
   /* Destroy it when we don't need it any more. */
   destroy_rle_sprite(rle);

Return Value

Returns a pointer to the created RLE sprite, or NULL if the RLE sprite could not be created. Remember to free this RLE sprite later to avoid memory leaks.

See Also

draw_rle_sprite(3), destroy_rle_sprite(3)

Referenced By

destroy_rle_sprite(3), draw_rle_sprite(3), RLE_SPRITE(3).

version 4.4.2 Allegro manual