Function libCZI_SubBlockCreateBitmap

Function libCZI_SubBlockCreateBitmap#

Function Documentation#

LibCZIApiErrorCode libCZI_SubBlockCreateBitmap(SubBlockObjectHandle sub_block_object, BitmapObjectHandle *bitmap_object)#

Create a bitmap object from the specified sub-block object. The bitmap object can be used to access the pixel data contained in the sub-block. If the subblock contains compressed data, then decompression will be performed in this call.

Parameters:
  • sub_block_object – The sub-block object.

  • bitmap_object[out] If successful, the handle to the newly created bitmap object is put here.

Returns:

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