control_ids.h File Reference

Camera control identifiers. More...

`#include <stdint.h>`
`#include <libcamera/controls.h>`

Go to the source code of this file.

## Namespaces

| libcamera::controls
| Namespace for libcamera controls.

## Enumerations

enum | { AE_ENABLE = 1 , AE_LOCKED = 2 , AE_METERING_MODE = 3 , AE_CONSTRAINT_MODE = 4 , AE_EXPOSURE_MODE = 5 , EXPOSURE_VALUE = 6 , EXPOSURE_TIME = 7 , ANALOGUE_GAIN = 8 , BRIGHTNESS = 9 , CONTRAST = 10 , LUX = 11 , AWB_ENABLE = 12 , AWB_MODE = 13 , COLOUR_GAINS = 14 , COLOUR_TEMPERATURE = 15 , SATURATION = 16 , SENSOR_BLACK_LEVELS = 17 , SHARPNESS = 18 }
enum | libcamera::controls::AeMeteringModeValues { libcamera::controls::MeteringCentreWeighted = 0 , libcamera::controls::MeteringSpot = 1 , libcamera::controls::MeteringMatrix = 2 , libcamera::controls::MeteringCustom = 3 , libcamera::controls::MeteringModeMax = 3 }
| Supported AeMeteringMode values. More...
enum | libcamera::controls::AeConstraintModeValues { libcamera::controls::ConstraintNormal = 0 , libcamera::controls::ConstraintHighlight = 1 , libcamera::controls::ConstraintShadows = 2 , libcamera::controls::ConstraintCustom = 3 , libcamera::controls::ConstraintModeMax = 3 }
| Supported AeConstraintMode values. More...
enum | libcamera::controls::AeExposureModeValues { libcamera::controls::ExposureNormal = 0 , libcamera::controls::ExposureShort = 1 , libcamera::controls::ExposureLong = 2 , libcamera::controls::ExposureCustom = 3 , libcamera::controls::ExposureModeMax = 3 }
| Supported AeExposureMode values. More...
enum | libcamera::controls::AwbModeValues { libcamera::controls::AwbAuto = 0 , libcamera::controls::AwbIncandescent = 1 , libcamera::controls::AwbTungsten = 2 , libcamera::controls::AwbFluorescent = 3 , libcamera::controls::AwbIndoor = 4 , libcamera::controls::AwbDaylight = 5 , libcamera::controls::AwbCloudy = 6 , libcamera::controls::AwbCustom = 7 , libcamera::controls::AwbModeMax = 7 }
| Supported AwbMode values. More...

## Variables

const Control< bool > | libcamera::controls::AeEnable
| Enable or disable the AE. More...
const Control< bool > | libcamera::controls::AeLocked
| Report the lock status of a running AE algorithm. More...
const Control< int32_t > | libcamera::controls::AeMeteringMode
| Specify a metering mode for the AE algorithm to use. The metering modes determine which parts of the image are used to determine the scene brightness. Metering modes may be platform specific and not all metering modes may be supported.
const Control< int32_t > | libcamera::controls::AeConstraintMode
| Specify a constraint mode for the AE algorithm to use. These determine how the measured scene brightness is adjusted to reach the desired target exposure. Constraint modes may be platform specific, and not all constraint modes may be supported.
const Control< int32_t > | libcamera::controls::AeExposureMode
| Specify an exposure mode for the AE algorithm to use. These specify how the desired total exposure is divided between the shutter time and the sensor's analogue gain. The exposure modes are platform specific, and not all exposure modes may be supported.
const Control< float > | libcamera::controls::ExposureValue
| Specify an Exposure Value (EV) parameter. The EV parameter will only be applied if the AE algorithm is currently enabled. More...
const Control< int32_t > | libcamera::controls::ExposureTime
| Exposure time (shutter speed) for the frame applied in the sensor device. This value is specified in micro-seconds. More...
const Control< float > | libcamera::controls::AnalogueGain
| Analogue gain value applied in the sensor device. The value of the control specifies the gain multiplier applied to all colour channels. This value cannot be lower than 1.0. More...
const Control< float > | libcamera::controls::Brightness
| Specify a fixed brightness parameter. Positive values (up to 1.0) produce brighter images; negative values (up to -1.0) produce darker images and 0.0 leaves pixels unchanged.
const Control< float > | libcamera::controls::Contrast
| Specify a fixed contrast parameter. Normal contrast is given by the value 1.0; larger values produce images with more contrast.
const Control< float > | libcamera::controls::Lux
| Report an estimate of the current illuminance level in lux. The Lux control can only be returned in metadata.
const Control< bool > | libcamera::controls::AwbEnable
| Enable or disable the AWB. More...
const Control< int32_t > | libcamera::controls::AwbMode
| Specify the range of illuminants to use for the AWB algorithm. The modes supported are platform specific, and not all modes may be supported.
const Control< Span< const float > > | libcamera::controls::ColourGains
| Pair of gain values for the Red and Blue colour channels, in that order. ColourGains can only be applied in a Request when the AWB is disabled. More...
const Control< int32_t > | libcamera::controls::ColourTemperature
| Report the current estimate of the colour temperature, in kelvin, for this frame. The ColourTemperature control can only be returned in metadata.
const Control< float > | libcamera::controls::Saturation
| Specify a fixed saturation parameter. Normal saturation is given by the value 1.0; larger values produce more saturated colours; 0.0 produces a greyscale image.
const Control< Span< const int32_t > > | libcamera::controls::SensorBlackLevels
| Reports the sensor black levels used for processing a frame, in the order R, Gr, Gb, B. These values are returned as numbers out of a 16-bit pixel range (as if pixels ranged from 0 to 65535). The SensorBlackLevels control can only be returned in metadata.
const Control< float > | libcamera::controls::Sharpness

A value of 0.0 means no sharpening. The minimum value means minimal sharpening, and shall be 0.0 unless the camera can't disable sharpening completely. The default value shall give a "reasonable" level of sharpening, suitable for most use cases. The maximum value may apply extremely high levels of sharpening, higher than anyone could reasonably want. Negative values are not allowed. Note also that sharpening is not applied to raw streams.

const ControlIdMap | libcamera::controls::controls
| List of all supported libcamera controls. More...

## Detailed Description

Camera control identifiers.