File: al_create_sub_bitmap.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (37 lines) | stat: -rw-r--r-- 1,030 bytes parent folder | download
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
.TH al_create_sub_bitmap 3 "" "Allegro reference manual"
.SH NAME
.PP
al_create_sub_bitmap \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

ALLEGRO_BITMAP\ *al_create_sub_bitmap(ALLEGRO_BITMAP\ *parent,
\ \ \ int\ x,\ int\ y,\ int\ w,\ int\ h)
\f[]
.fi
.SH DESCRIPTION
.PP
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.
.PP
The sub\-bitmap may originate off or extend past the parent bitmap.
.PP
See the discussion in al_get_backbuffer(3) about using sub\-bitmaps of
the backbuffer.
.PP
The parent bitmap\[aq]s clipping rectangles are ignored.
.PP
If a sub\-bitmap was not or cannot be created then NULL is returned.
.PP
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.
.SH SEE ALSO
.PP
al_create_bitmap(3)