1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
|
.TH "al_get_parent_bitmap" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_get_parent_bitmap \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
ALLEGRO_BITMAP\ *al_get_parent_bitmap(ALLEGRO_BITMAP\ *bitmap)
\f[]
.fi
.SH DESCRIPTION
.PP
Returns the bitmap this bitmap is a sub\-bitmap of.
Returns NULL if this bitmap is not a sub\-bitmap.
This function always returns the real bitmap, and never a sub\-bitmap.
This might NOT match what was passed to al_create_sub_bitmap(3).
Consider this code, for instance:
.IP
.nf
\f[C]
ALLEGRO_BITMAP*\ a\ =\ al_create_bitmap(512,\ 512);
ALLEGRO_BITMAP*\ b\ =\ al_create_sub_bitmap(a,\ 128,\ 128,\ 256,\ 256);
ALLEGRO_BITMAP*\ c\ =\ al_create_sub_bitmap(b,\ 64,\ 64,\ 128,\ 128);
ASSERT(al_get_parent_bitmap(b)\ ==\ a\ &&\ al_get_parent_bitmap(c)\ ==\ a);
\f[]
.fi
.PP
The assertion will pass because only \f[C]a\f[] is a real bitmap, and
both \f[C]b\f[] and \f[C]c\f[] are its sub\-bitmaps.
.SH SINCE
.PP
5.0.6, 5.1.2
.SH SEE ALSO
.PP
al_create_sub_bitmap(3), al_is_sub_bitmap(3)
|