Function libCZI_BitmapLock

Function libCZI_BitmapLock#

Function Documentation#

LibCZIApiErrorCode libCZI_BitmapLock(BitmapObjectHandle bitmap_object, BitmapLockInfoInterop *lockInfo)#

Locks the bitmap object. Once the bitmap is locked, the pixel data can be accessed. Memory access to the pixel data must only occur while the bitmap is locked. The lock must be released by calling ‘libCZI_BitmapUnlock’. It is a fatal error if the bitmap is destroyed while still being locked. Calls to Lock and Unlock are counted, and they must be balanced.

Parameters:

  • bitmap_object – The bitmap object.

  • lockInfo – [out] If successful, information about how to access the pixel data is put here.

Returns:

An error-code indicating success or failure of the operation.

Contents