Camera Library Referencecamera_3a.h Parent topic: camera_3a.h

camera_get_supported_ev_offsets()

Updated: April 19, 2023

Retrieve the supported EV offset values

Synopsis:

#include <camera/camera_3a.h>
camera_error_t camera_get_supported_ev_offsets(camera_handle_t handle,
                                               unsigned numasked,
                                               unsigned *numsupported,
                                               double *offsets,
                                               bool *maxmin)

Arguments:

handle
The handle returned by a call to the camera_open() function.
numasked
The requested number of EV offset values to return in the offsets array. You can specify a value of 0 to determine the number of supported EV offsets values.
numsupported
A pointer to an integer that will be updated with the number of supported EV offset values.
offsets
A pointer to a double array that will be updated with the EV offset values supported by the camera. Ensure that you allocate an array with numasked elements. For details about the meaning of the values returned in this array, see the maxmin description.
maxmin
A pointer to a bool that will specify how to interpret the offsets array. This argument will be true if the first of two values returned in the array is to be interpreted as the maximum supported EV offset and the second as the minimum supported EV offset. It will be false if the values are to be interpreted as the discrete EV offset values that are supported.

Library:

libcamapi

Description:

Use this function to retrieve the EV offset values that are available on the camera.

Ensure that the offsets 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 offsets argument to NULL. The function then returns, in the numsupported argument, the maximum array size required. You can then allocate an array of this size and invoke the function again with numasked set to that previous numsupported value.

The values that you retrieve using this function can be set using the camera_set_ev_offset() function.

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_3a.h