[][src]Function k4a_sys_temp::k4a_device_get_color_control

pub unsafe extern "C" fn k4a_device_get_color_control(
    device_handle: k4a_device_t,
    command: k4a_color_control_command_t,
    mode: *mut k4a_color_control_mode_t,
    value: *mut i32
) -> k4a_result_t

Get the Azure Kinect color sensor control value.

\param device_handle Handle obtained by k4a_device_open().

\param command Color sensor control command.

\param mode Location to store the color sensor's control mode. This mode represents whether the command is in automatic or manual mode.

\param value Location to store the color sensor's control value. This value is always written, but is only valid when the \p mode returned is ::K4A_COLOR_CONTROL_MODE_MANUAL for the current \p command.

\returns ::K4A_RESULT_SUCCEEDED if the value was successfully returned, ::K4A_RESULT_FAILED if an error occurred

\remarks Each control command may be set to manual or automatic. See the definition of \ref k4a_color_control_command_t on how to interpret the \p value for each command.

\remarks Some control commands are only supported in manual mode. When a command is in automatic mode, the \p value for that command is not valid.

\remarks Control values set on a device are reset only when the device is power cycled. The device will retain the settings even if the \ref k4a_device_t is closed or the application is restarted.

\relates k4a_device_t

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