[][src]Function k4a_sys_temp::k4a_capture_set_ir_image

pub unsafe extern "C" fn k4a_capture_set_ir_image(
    capture_handle: k4a_capture_t,
    image_handle: k4a_image_t
)

Set or add an IR image to the associated capture.

\param capture_handle Capture handle to hold the image.

\param image_handle Image handle containing the image.

\relates k4a_capture_t

\remarks When a \ref k4a_image_t is added to a \ref k4a_capture_t, the \ref k4a_capture_t will automatically add a reference to the \ref k4a_image_t.

\remarks If there is already an IR image contained in the capture, the existing image will be dereferenced and replaced with the new image.

\remarks To remove a IR image to the capture without adding a new image, this function can be called with a NULL image_handle.

\remarks Any \ref k4a_image_t contained in this \ref k4a_capture_t will automatically be dereferenced when all references to the \ref k4a_capture_t are released with k4a_capture_release().

\xmlonly k4a.h (include k4a/k4a.h) k4a.lib k4a.dll \endxmlonly