Function libCZI_BitmapCopyTo

Function libCZI_BitmapCopyTo#

Function Documentation#

LibCZIApiErrorCode libCZI_BitmapCopyTo(BitmapObjectHandle bitmap_object, std::uint32_t width, std::uint32_t height, std::int32_t pixel_type, std::uint32_t stride, void *ptr)#

Copy the pixel data from the specified bitmap object to the specified memory buffer. The specified destination bitmap must have same width, height and pixel type as the source bitmap.

Parameters:
  • bitmap_object – The bitmap object.

  • width – The width of the destination bitmap.

  • height – The height of the destination bitmap.

  • pixel_type – The pixel type.

  • stride – The stride (given in bytes).

  • ptr[out] Pointer to the memory location where the bitmap is to be copied to.

Returns:

A LibCZIApiErrorCode.