Bitmap::Metode LockBits (gdiplusheaders.h)

Artikel
03/14/2023

Metode Bitmap::LockBits mengunci bagian persegi dari bitmap ini dan menyediakan buffer sementara yang dapat Anda gunakan untuk membaca atau menulis data piksel dalam format tertentu. Data piksel apa pun yang Anda tulis ke buffer disalin ke objek Bitmap saat Anda memanggil Bitmap::UnlockBits.

Sintaks

Status LockBits(
  [in]      const Rect  *rect,
  [in]      UINT        flags,
  [in]      PixelFormat format,
  [in, out] BitmapData  *lockedBitmapData
);

Parameter

[in] rect

Jenis: const Rect*

Penunjuk ke persegi panjang yang menentukan bagian bitmap yang akan dikunci.

[in] flags

Jenis: UINT

Set bendera yang menentukan apakah bagian terkunci dari bitmap tersedia untuk dibaca atau ditulis dan apakah pemanggil telah mengalokasikan buffer. Bendera individual didefinisikan dalam enumerasi ImageLockMode .

[in] format

Jenis: PixelFormat

Bilangan bulat yang menentukan format data piksel dalam buffer sementara. Format piksel buffer sementara tidak harus sama dengan format piksel objek Bitmap ini. Jenis data PixelFormat dan konstanta yang mewakili berbagai format piksel ditentukan dalam Gdipluspixelformats.h. Untuk informasi selengkapnya tentang konstanta format piksel, lihat Konstanta Format Piksel Gambar. GDI+ versi 1.0 tidak mendukung pemrosesan gambar 16-bits-per-saluran, jadi Anda tidak boleh mengatur parameter ini sama dengan PixelFormat48bppRGB, PixelFormat64bppARGB, atau PixelFormat64bppPARGB.

[in, out] lockedBitmapData

Jenis: BitmapData*

Penunjuk ke objek BitmapData . Jika bendera ImageLockModeUserInputBuf dari parameter bendera dibersihkan , maka lockedBitmapData hanya berfungsi sebagai parameter output. Dalam hal ini, anggota data Scan0 objek BitmapData menerima penunjuk ke buffer sementara, yang diisi dengan nilai piksel yang diminta. Anggota data lain dari objek BitmapData menerima atribut (lebar, tinggi, format, dan langkah) data piksel dalam buffer sementara. Jika data piksel disimpan di bawah ke atas, anggota data Stride negatif. Jika data piksel disimpan di atas bawah, anggota data Stride positif. Jika bendera ImageLockModeUserInputBuf dari parameter bendera diatur, maka lockedBitmapData berfungsi sebagai parameter input (dan mungkin sebagai parameter output). Dalam hal ini, pemanggil harus mengalokasikan buffer untuk data piksel yang akan dibaca atau ditulis. Pemanggil juga harus membuat objek BitmapData , mengatur anggota data Scan0 objek BitmapData tersebut ke alamat buffer, dan mengatur anggota data lain dari objek BitmapData untuk menentukan atribut (lebar, tinggi, format, dan langkah) buffer.

Mengembalikan nilai

Jenis: Status

Jika metode berhasil, metode mengembalikan Ok, yang merupakan elemen dari enumerasi Status .

Jika metode gagal, metode mengembalikan salah satu elemen lain dari enumerasi Status .

Persyaratan


Klien minimum yang didukung	Windows XP, Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	gdiplusheaders.h (termasuk Gdiplus.h)
Pustaka	Gdiplus.lib
DLL	Gdiplus.dll