Function libCZI_CompositorFillOutCompositionChannelInfoInterop

Function libCZI_CompositorFillOutCompositionChannelInfoInterop#

Function Documentation#

LibCZIApiErrorCode libCZI_CompositorFillOutCompositionChannelInfoInterop(DisplaySettingsHandle display_settings_handle, int channel_index, bool sixteen_or_eight_bits_lut, CompositionChannelInfoInterop *composition_channel_info_interop)#

Given a display-settings object and the channel-number, this function fills out the composition-channel-information which is needed for the multi-channel-composition. Note that in the returned ‘CompositionChannelInfoInterop’ structure, the ‘lut’ field is a pointer to the LUT-data, which must be freed with ‘libCZI_Free’ by the caller.

Parameters:

  • display_settings_handle – The display settings handle.

  • channel_index – The channel-index (referring to the display settings object) we are concerned with.

  • sixteen_or_eight_bits_lut – True for generating a 16-bit LUT; if false, then an 8-bit LUT is generated.

  • composition_channel_info_interop – [out] The composition channel information is put here.

Returns:

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

Contents