Commit 9080d5d3 authored by Sylwester Nawrocki's avatar Sylwester Nawrocki Committed by Mauro Carvalho Chehab

[media] V4L: Improve the selection API documentation

Make the VIDIOC_G/S_SELECTION ioctls documentation more consistent
with the rest of media Docbook, use capital letters where necessary
and correct few minor errors.
Signed-off-by: default avatarSylwester Nawrocki <s.nawrocki@samsung.com>
Signed-off-by: default avatarKyungmin Park <kyungmin.park@samsung.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 1d531601
...@@ -52,6 +52,10 @@ cropping and composing rectangles have the same size.</para> ...@@ -52,6 +52,10 @@ cropping and composing rectangles have the same size.</para>
</textobject> </textobject>
</mediaobject> </mediaobject>
</figure> </figure>
For complete list of the available selection targets see table <xref
linkend="v4l2-sel-target"/>
</section> </section>
<section> <section>
...@@ -186,7 +190,7 @@ V4L2_SEL_TGT_COMPOSE_ACTIVE </constant> target.</para> ...@@ -186,7 +190,7 @@ V4L2_SEL_TGT_COMPOSE_ACTIVE </constant> target.</para>
<section> <section>
<title>Scaling control.</title> <title>Scaling control</title>
<para>An application can detect if scaling is performed by comparing the width <para>An application can detect if scaling is performed by comparing the width
and the height of rectangles obtained using <constant> V4L2_SEL_TGT_CROP_ACTIVE and the height of rectangles obtained using <constant> V4L2_SEL_TGT_CROP_ACTIVE
...@@ -200,7 +204,7 @@ the scaling ratios using these values.</para> ...@@ -200,7 +204,7 @@ the scaling ratios using these values.</para>
<section> <section>
<title>Comparison with old cropping API.</title> <title>Comparison with old cropping API</title>
<para>The selection API was introduced to cope with deficiencies of previous <para>The selection API was introduced to cope with deficiencies of previous
<link linkend="crop"> API </link>, that was designed to control simple capture <link linkend="crop"> API </link>, that was designed to control simple capture
......
...@@ -762,20 +762,20 @@ struct v4l2_crop { ...@@ -762,20 +762,20 @@ struct v4l2_crop {
/* Selection targets */ /* Selection targets */
/* current cropping area */ /* Current cropping area */
#define V4L2_SEL_TGT_CROP_ACTIVE 0 #define V4L2_SEL_TGT_CROP_ACTIVE 0x0000
/* default cropping area */ /* Default cropping area */
#define V4L2_SEL_TGT_CROP_DEFAULT 1 #define V4L2_SEL_TGT_CROP_DEFAULT 0x0001
/* cropping bounds */ /* Cropping bounds */
#define V4L2_SEL_TGT_CROP_BOUNDS 2 #define V4L2_SEL_TGT_CROP_BOUNDS 0x0002
/* current composing area */ /* Current composing area */
#define V4L2_SEL_TGT_COMPOSE_ACTIVE 256 #define V4L2_SEL_TGT_COMPOSE_ACTIVE 0x0100
/* default composing area */ /* Default composing area */
#define V4L2_SEL_TGT_COMPOSE_DEFAULT 257 #define V4L2_SEL_TGT_COMPOSE_DEFAULT 0x0101
/* composing bounds */ /* Composing bounds */
#define V4L2_SEL_TGT_COMPOSE_BOUNDS 258 #define V4L2_SEL_TGT_COMPOSE_BOUNDS 0x0102
/* current composing area plus all padding pixels */ /* Current composing area plus all padding pixels */
#define V4L2_SEL_TGT_COMPOSE_PADDED 259 #define V4L2_SEL_TGT_COMPOSE_PADDED 0x0103
/** /**
* struct v4l2_selection - selection info * struct v4l2_selection - selection info
...@@ -785,7 +785,7 @@ struct v4l2_crop { ...@@ -785,7 +785,7 @@ struct v4l2_crop {
* @r: coordinates of selection window * @r: coordinates of selection window
* @reserved: for future use, rounds structure size to 64 bytes, set to zero * @reserved: for future use, rounds structure size to 64 bytes, set to zero
* *
* Hardware may use multiple helper window to process a video stream. * Hardware may use multiple helper windows to process a video stream.
* The structure is used to exchange this selection areas between * The structure is used to exchange this selection areas between
* an application and a driver. * an application and a driver.
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment