---
name: "al_lock_bitmap_blocked"
section: "3alleg5"
platform: "linux"
package: "allegro5-doc"
version: "2:5.2.10.1+dfsg-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/al_lock_bitmap_blocked/3alleg5"
---

# al\_lock\_bitmap\_blocked(3alleg5)

Allegro 5 API

## NAME

al\_lock\_bitmap\_blocked - Allegro 5 API

## SYNOPSIS

-

  ```
  #include <allegro5/allegro.h>
  ALLEGRO_LOCKED_REGION *al_lock_bitmap_blocked(ALLEGRO_BITMAP *bitmap,
     int flags)
  ```

## DESCRIPTION

Like al\_lock\_bitmap(3alleg5), but allows locking bitmaps with a blocked pixel format (i.e. a format for which al\_get\_pixel\_block\_width(3alleg5) or al\_get\_pixel\_block\_height(3alleg5) 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 `al_lock_bitmap(bmp, al_get_bitmap_format(bmp), flags)`.

*Note:* Currently there are no drawing functions that work when the bitmap is locked with a compressed format. al\_get\_pixel(3alleg5) will also not work.

## SINCE

5\.1.9

## SEE ALSO

al\_lock\_bitmap(3alleg5), al\_lock\_bitmap\_region\_blocked(3alleg5)