[][src]Function azure_kinect::bindings::k4a_playback_set_color_conversion

pub unsafe extern "C" fn k4a_playback_set_color_conversion(
    playback_handle: k4a_playback_t,
    target_format: k4a_image_format_t
) -> k4a_result_t

Set the image format that color captures will be converted to. By default the conversion format will be the same as the image format stored in the recording file, and no conversion will occur.

\param playback_handle Handle obtained by k4a_playback_open().

\param target_format The target image format to be returned in captures.

\returns ::K4A_RESULT_SUCCEEDED if the format conversion is supported. ::K4A_RESULT_FAILED otherwise.

\remarks After the color conversion format is set, all \ref k4a_capture_t objects returned from the playback handle will have their color images converted to the \p target_format.

\remarks Color format conversion occurs in the user-thread, so setting \p target_format to anything other than the format stored in the file may significantly increase the latency of \p k4a_playback_get_next_capture() and \p k4a_playback_get_previous_capture().

\relates k4a_playback_t

\xmlonly playback.h (include k4arecord/playback.h) k4arecord.lib k4arecord.dll \endxmlonly