NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

libcamera: controls: Drop reference to IPA in controls documentation

Browse source 
The controls relates to the public API, which doesn't expose IPA modules
as they are internal to libcamera. Replace the mention of "IPA" in the
controls documentation.

While at it, fix a small text reflow issue.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Naushir Patuck <naush@raspberrypi.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2023-06-02 08:40:16 +03:00
parent a0271e72a8
commit f65a73f3c8
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/libcamera/control_ids.yaml
View file

@ -275,12 +275,12 @@ controls:
type: int32_t type: int32_t
description: | description: |
Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. Reports a Figure of Merit (FoM) to indicate how in-focus the frame is.
A larger FocusFoM value indicates a more in-focus frame. This control A larger FocusFoM value indicates a more in-focus frame. This singular
depends on the IPA to gather ISP statistics from the defined focus value may be based on a combination of statistics gathered from
region, and combine them in a suitable way to generate a FocusFoM value. multiple focus regions within an image. The number of focus regions and
In this respect, it is not necessarily aimed at providing a way to method of combination is platform dependent. In this respect, it is not
implement a focus algorithm by the application, rather an indication of necessarily aimed at providing a way to implement a focus algorithm by
how in-focus a frame is. the application, rather an indication of how in-focus a frame is.
- ColourCorrectionMatrix: - ColourCorrectionMatrix:
type: float type: float
@ -333,8 +333,8 @@ controls:
- FrameDurationLimits: - FrameDurationLimits:
type: int64_t type: int64_t
description: | description: |
The minimum and maximum (in that order) frame duration, The minimum and maximum (in that order) frame duration, expressed in
expressed in microseconds. microseconds.
When provided by applications, the control specifies the sensor frame When provided by applications, the control specifies the sensor frame
duration interval the pipeline has to use. This limits the largest duration interval the pipeline has to use. This limits the largest
@ -343,7 +343,7 @@ controls:
the sensor will not be able to raise the exposure time above 33ms. the sensor will not be able to raise the exposure time above 33ms.
A fixed frame duration is achieved by setting the minimum and maximum A fixed frame duration is achieved by setting the minimum and maximum
values to be the same. Setting both values to 0 reverts to using the values to be the same. Setting both values to 0 reverts to using the
IPA provided defaults. camera defaults.
The maximum frame duration provides the absolute limit to the shutter The maximum frame duration provides the absolute limit to the shutter
speed computed by the AE algorithm and it overrides any exposure mode speed computed by the AE algorithm and it overrides any exposure mode