Camera Library Referencecamera_api.h Parent topic: camera_api.h

camera_get_supported_hue()

Retrieve the supported hue values

Synopsis:

#include <camera/camera_api.h>
camera_error_t camera_get_supported_hue(camera_handle_t handle,
                                        uint32_t numasked,
                                        uint32_t *numsupported,
                                        int32_t *values,
                                        bool *maxmin)

Arguments:

handle
The handle returned by a call to the camera_open() function.
numasked
The requested number of hue values to return in the values array. You can set it to 0 to determine the number of hue values supported by the camera.
numsupported
The returned number of hue values supported by the camera.
values
A pointer to a int32_t array. The array is updated with the hue values supported by the camera. Ensure that you allocate an array with the same number of elements as specified in the numasked argument. If the maxmin flag returns true, then the first value returned in the values array is the maximum supported hue value, and the second value returned is the minimum supported hue value.
maxmin
A pointer to a bool value that specifies how to interpret the values argument. This argument is set to true if the values are to be interpreted as a maximum and minimum value; otherwise, it's set to false to indicate that the values describe only the discrete hue values that are supported.

Library:

libcamapi

Description:

Use this function to retrieve the set of supported hue values. You can use the values returned by this function to configure the hue using the function camera_set_hue().

Ensure that the values argument points to an array which has at least numasked elements allocated. To determine an appropriate size for this array, you can invoke this function in presizing mode by setting the numasked argument to 0 or the values argument to NULL. When the function is invoked in presizing mode, the maximum array size that is required is returned in the numsupported argument. You can then allocate an array of the appropriate size and invoke the function again with the numasked argument set to the value returned previously in the numsupported argument.

Returns:

CAMERA_EOK when the function successfully completes, otherwise another camera_error_t value that provides the reason that the call failed.

Parent topic: camera_api.h