Function libCZI_CompositorDoMultiChannelComposition

Function libCZI_CompositorDoMultiChannelComposition#

Function Documentation#

LibCZIApiErrorCode libCZI_CompositorDoMultiChannelComposition(std::int32_t channelCount, const BitmapObjectHandle *source_bitmaps, const CompositionChannelInfoInterop *channel_info, BitmapObjectHandle *bitmap_object)#

Perform a multi-channel-composition operation. The source bitmaps are provided in the ‘source_bitmaps’ array, and the array of ‘CompositionChannelInfoInterop’ structures provide the information needed for the composition. The resulting bitmap is then put into the ‘bitmap_object’ handle.

Parameters:

  • channelCount – The number of channels - this defines the size of the ‘source_bitmaps’ and ‘channel_info’ arrays.

  • source_bitmaps – The array of source bitmaps.

  • channel_info – The array of channel information.

  • bitmap_object – [out] The resulting bitmap is put here.

Returns:

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

Contents