[v2] camera_sensor: Expand on computeTransform() documentation
diff mbox series

Message ID 20250626052441.20305-1-uajain@igalia.com
State New
Headers show
Series
  • [v2] camera_sensor: Expand on computeTransform() documentation
Related show

Commit Message

Umang Jain June 26, 2025, 5:24 a.m. UTC
The description for computeTransform() when the desired orientation
cannot be achieved, can be expanded a further bit, to clearly report
that orientation will be adjusted to native camera sensor mounting
rotation.

Signed-off-by: Umang Jain <uajain@igalia.com>
Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
---
Changes in v2:
- Use rotation instead of orientation for describing sensor mounting
---
 src/libcamera/sensor/camera_sensor.cpp | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Laurent Pinchart June 26, 2025, 10:26 a.m. UTC | #1
On Thu, Jun 26, 2025 at 10:54:41AM +0530, Umang Jain wrote:
> The description for computeTransform() when the desired orientation
> cannot be achieved, can be expanded a further bit, to clearly report
> that orientation will be adjusted to native camera sensor mounting
> rotation.
> 
> Signed-off-by: Umang Jain <uajain@igalia.com>
> Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
> Changes in v2:
> - Use rotation instead of orientation for describing sensor mounting
> ---
>  src/libcamera/sensor/camera_sensor.cpp | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/src/libcamera/sensor/camera_sensor.cpp b/src/libcamera/sensor/camera_sensor.cpp
> index d19b5e2e..4f2fd269 100644
> --- a/src/libcamera/sensor/camera_sensor.cpp
> +++ b/src/libcamera/sensor/camera_sensor.cpp
> @@ -302,8 +302,9 @@ int CameraSensor::setEmbeddedDataEnabled(bool enable)
>   * camera sensor, likely at configure() time.
>   *
>   * If the requested \a orientation cannot be obtained, the \a orientation
> - * parameter is adjusted to report the current image orientation and
> - * Transform::Identity is returned.
> + * parameter is adjusted to report the native image orientation (i.e. resulting
> + * from the physical mounting rotation of the camera sensor, without any
> + * transformation) and Transform::Identity is returned.
>   *
>   * If the requested \a orientation can be obtained, the function computes a
>   * Transform and does not adjust \a orientation.

Patch
diff mbox series

diff --git a/src/libcamera/sensor/camera_sensor.cpp b/src/libcamera/sensor/camera_sensor.cpp
index d19b5e2e..4f2fd269 100644
--- a/src/libcamera/sensor/camera_sensor.cpp
+++ b/src/libcamera/sensor/camera_sensor.cpp
@@ -302,8 +302,9 @@  int CameraSensor::setEmbeddedDataEnabled(bool enable)
  * camera sensor, likely at configure() time.
  *
  * If the requested \a orientation cannot be obtained, the \a orientation
- * parameter is adjusted to report the current image orientation and
- * Transform::Identity is returned.
+ * parameter is adjusted to report the native image orientation (i.e. resulting
+ * from the physical mounting rotation of the camera sensor, without any
+ * transformation) and Transform::Identity is returned.
  *
  * If the requested \a orientation can be obtained, the function computes a
  * Transform and does not adjust \a orientation.