aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorSylwester Nawrocki <s.nawrocki@samsung.com>2011-11-14 06:48:18 -0500
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-12-30 11:05:08 -0500
commitcc1d327232759647ea56725eab1c6b16c92d52fa (patch)
treec929516390d3aade90f4a87f29ceaa05be47aa6a /Documentation/DocBook
parentb4d48c942c17ce3d3a330ad91e109e522bc97378 (diff)
[media] v4l: Add new alpha component control
The V4L2_CID_ALPHA_COMPONENT control is intended for the video capture or memory-to-memory devices that are capable of setting up the per-pixel alpha component to some arbitrary value. It allows to set the alpha component for all pixels to an arbitrary value. Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/v4l/compat.xml11
-rw-r--r--Documentation/DocBook/media/v4l/controls.xml25
-rw-r--r--Documentation/DocBook/media/v4l/pixfmt-packed-rgb.xml7
3 files changed, 35 insertions, 8 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml
index 8b44a43f4542..12ba26262d32 100644
--- a/Documentation/DocBook/media/v4l/compat.xml
+++ b/Documentation/DocBook/media/v4l/compat.xml
@@ -2379,6 +2379,17 @@ that used it. It was originally scheduled for removal in 2.6.35.
2379 </orderedlist> 2379 </orderedlist>
2380 </section> 2380 </section>
2381 2381
2382 <section>
2383 <title>V4L2 in Linux 3.3</title>
2384 <orderedlist>
2385 <listitem>
2386 <para>Added <constant>V4L2_CID_ALPHA_COMPONENT</constant> control
2387 to the <link linkend="control">User controls class</link>.
2388 </para>
2389 </listitem>
2390 </orderedlist>
2391 </section>
2392
2382 <section id="other"> 2393 <section id="other">
2383 <title>Relation of V4L2 to other Linux multimedia APIs</title> 2394 <title>Relation of V4L2 to other Linux multimedia APIs</title>
2384 2395
diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml
index c0422c622337..a1be37897ad7 100644
--- a/Documentation/DocBook/media/v4l/controls.xml
+++ b/Documentation/DocBook/media/v4l/controls.xml
@@ -324,12 +324,6 @@ minimum value disables backlight compensation.</entry>
324 (usually a microscope).</entry> 324 (usually a microscope).</entry>
325 </row> 325 </row>
326 <row> 326 <row>
327 <entry><constant>V4L2_CID_LASTP1</constant></entry>
328 <entry></entry>
329 <entry>End of the predefined control IDs (currently
330<constant>V4L2_CID_ILLUMINATORS_2</constant> + 1).</entry>
331 </row>
332 <row>
333 <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_CAPTURE</constant></entry> 327 <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_CAPTURE</constant></entry>
334 <entry>integer</entry> 328 <entry>integer</entry>
335 <entry>This is a read-only control that can be read by the application 329 <entry>This is a read-only control that can be read by the application
@@ -345,6 +339,25 @@ and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS.
345The value is the minimum number of OUTPUT buffers that is necessary for hardware 339The value is the minimum number of OUTPUT buffers that is necessary for hardware
346to work.</entry> 340to work.</entry>
347 </row> 341 </row>
342 <row id="v4l2-alpha-component">
343 <entry><constant>V4L2_CID_ALPHA_COMPONENT</constant></entry>
344 <entry>integer</entry>
345 <entry> Sets the alpha color component on the capture device or on
346 the capture buffer queue of a mem-to-mem device. When a mem-to-mem
347 device produces frame format that includes an alpha component
348 (e.g. <link linkend="rgb-formats">packed RGB image formats</link>)
349 and the alpha value is not defined by the mem-to-mem input data
350 this control lets you select the alpha component value of all
351 pixels. It is applicable to any pixel format that contains an alpha
352 component.
353 </entry>
354 </row>
355 <row>
356 <entry><constant>V4L2_CID_LASTP1</constant></entry>
357 <entry></entry>
358 <entry>End of the predefined control IDs (currently
359 <constant>V4L2_CID_ALPHA_COMPONENT</constant> + 1).</entry>
360 </row>
348 <row> 361 <row>
349 <entry><constant>V4L2_CID_PRIVATE_BASE</constant></entry> 362 <entry><constant>V4L2_CID_PRIVATE_BASE</constant></entry>
350 <entry></entry> 363 <entry></entry>
diff --git a/Documentation/DocBook/media/v4l/pixfmt-packed-rgb.xml b/Documentation/DocBook/media/v4l/pixfmt-packed-rgb.xml
index ba56536622f2..166c8d65e4f7 100644
--- a/Documentation/DocBook/media/v4l/pixfmt-packed-rgb.xml
+++ b/Documentation/DocBook/media/v4l/pixfmt-packed-rgb.xml
@@ -428,8 +428,11 @@ colorspace <constant>V4L2_COLORSPACE_SRGB</constant>.</para>
428 <para>Bit 7 is the most significant bit. The value of a = alpha 428 <para>Bit 7 is the most significant bit. The value of a = alpha
429bits is undefined when reading from the driver, ignored when writing 429bits is undefined when reading from the driver, ignored when writing
430to the driver, except when alpha blending has been negotiated for a 430to the driver, except when alpha blending has been negotiated for a
431<link linkend="overlay">Video Overlay</link> or <link 431<link linkend="overlay">Video Overlay</link> or <link linkend="osd">
432linkend="osd">Video Output Overlay</link>.</para> 432Video Output Overlay</link> or when alpha component has been configured
433for a <link linkend="capture">Video Capture</link> by means of <link
434linkend="v4l2-alpha-component"> <constant>V4L2_CID_ALPHA_COMPONENT
435</constant> </link> control.</para>
433 436
434 <example> 437 <example>
435 <title><constant>V4L2_PIX_FMT_BGR24</constant> 4 &times; 4 pixel 438 <title><constant>V4L2_PIX_FMT_BGR24</constant> 4 &times; 4 pixel