trusty (3) al_create_sub_bitmap.3alleg5.gz

Provided by: allegro5-doc_5.0.10-2_all bug

NAME

       al_create_sub_bitmap - Allegro 5 API

SYNOPSIS

              #include <allegro5/allegro.h>

              ALLEGRO_BITMAP *al_create_sub_bitmap(ALLEGRO_BITMAP *parent,
                 int x, int y, int w, int h)

DESCRIPTION

       Creates a sub-bitmap of the parent, at the specified coordinates and of the specified size.  A sub-bitmap
       is a bitmap that shares drawing memory with a pre-existing (parent) bitmap, but possibly with a different
       size and clipping settings.

       The sub-bitmap may originate off or extend past the parent bitmap.

       See the discussion in al_get_backbuffer(3alleg5) about using sub-bitmaps of the backbuffer.

       The parent bitmap's clipping rectangles are ignored.

       If a sub-bitmap was not or cannot be created then NULL is returned.

       Note  that  destroying  parents  of sub-bitmaps will not destroy the sub-bitmaps; instead the sub-bitmaps
       become invalid and should no longer be used.

SEE ALSO

       al_create_bitmap(3alleg5)