File: al_lock_bitmap_blocked.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (36 lines) | stat: -rw-r--r-- 962 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
.TH "al_lock_bitmap_blocked" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_lock_bitmap_blocked \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

ALLEGRO_LOCKED_REGION\ *al_lock_bitmap_blocked(ALLEGRO_BITMAP\ *bitmap,
\ \ \ int\ flags)
\f[]
.fi
.SH DESCRIPTION
.PP
Like al_lock_bitmap(3), but allows locking bitmaps with a blocked pixel
format (i.e.
a format for which al_get_pixel_block_width(3) or
al_get_pixel_block_height(3) do not return 1) in that format.
To that end, this function also does not allow format conversion.
For bitmap formats with a block size of 1, this function is identical to
calling
\f[C]al_lock_bitmap(bmp,\ al_get_bitmap_format(bmp),\ flags)\f[].
.RS
.PP
\f[I]Note:\f[] Currently there are no drawing functions that work when
the bitmap is locked with a compressed format.
al_get_pixel(3) will also not work.
.RE
.SH SINCE
.PP
5.1.9
.SH SEE ALSO
.PP
al_lock_bitmap(3), al_lock_bitmap_region_blocked(3)