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

FreeBSD Manual Pages

  
 
  

home | help
al_get_parent_bitmap(3)     Library Functions Manual	 al_get_parent_bitmap(3)

NAME
     al_get_parent_bitmap - Allegro 5 API

SYNOPSIS
	    #include <allegro5/allegro.h>

	    ALLEGRO_BITMAP *al_get_parent_bitmap(ALLEGRO_BITMAP *bitmap)

DESCRIPTION
     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_cre-
     ate_sub_bitmap(3).  Consider this code, for instance:

	    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);

     The assertion will pass because only a is a real bitmap, and both b  and  c
     are its sub-bitmaps.

SINCE
     5.0.6, 5.1.2

SEE ALSO
     al_create_sub_bitmap(3), al_is_sub_bitmap(3)

Allegro reference manual				 al_get_parent_bitmap(3)

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

home | help