create_sub_bitmap man page

create_sub_bitmap — Creates a memory sub bitmap. Allegro game programming library.

Synopsis

#include <allegro.h>

BITMAP *create_sub_bitmap(BITMAP *parent, int x, y, width, height);

Description

Creates a sub-bitmap, ie. a bitmap sharing drawing memory with a pre-existing bitmap, but possibly with a different size and clipping settings. When creating a sub-bitmap of the mode-X screen, the x position must be a multiple of four. The sub-bitmap width and height can extend beyond the right and bottom edges of the parent (they will be clipped), but the origin point must lie within the parent region.

Return Value

Returns a pointer to the created sub bitmap, or NULL if the sub bitmap could not be created. Remember to free the sub bitmap before freeing the parent bitmap to avoid memory leaks and potential crashes accessing memory which has been freed.

See Also

create_bitmap(3), create_bitmap_ex(3), destroy_bitmap(3), is_sub_bitmap(3), clear_bitmap(3), clear_to_color(3), expat(3), exscroll(3), exswitch(3)

Referenced By

create_bitmap(3), create_bitmap_ex(3), create_sub_zbuffer(3), create_system_bitmap(3), create_video_bitmap(3), expat(3), exscroll(3), exswitch(3), is_same_bitmap(3), is_screen_bitmap(3), is_sub_bitmap(3), is_system_bitmap(3), is_video_bitmap(3).

version 4.4.2 Allegro Allegro manual