summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-29 17:37:59 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-09-09 09:34:01 -0300
commite8be7e97e639af6f968473e5a598afbebc737b9c (patch)
treea33c38e32956ad127634eabb978f824ecbbb6c65 /Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
parent2257e180101c910c2d93dd226ab1e500e4a6813c (diff)
downloadop-kernel-dev-e8be7e97e639af6f968473e5a598afbebc737b9c.zip
op-kernel-dev-e8be7e97e639af6f968473e5a598afbebc737b9c.tar.gz
[media] docs-rst: convert uAPI structs to C domain
instead of declaring the uAPI structs using usual refs, e. g.: .. _foo-struct: Use the C domain way: .. c:type:: foo_struct This way, the kAPI documentation can use cross-references to point to the uAPI symbols. That solves about ~100 undefined warnings like: WARNING: c:type reference target not found: foo_struct Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-g-fbuf.rst')
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-fbuf.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst b/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
index 00f7836..7ade2f7 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
@@ -49,13 +49,13 @@ VGA signal or graphics into a video signal. *Video Output Overlays* are
always non-destructive.
To get the current parameters applications call the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`
-ioctl with a pointer to a :ref:`struct v4l2_framebuffer <v4l2-framebuffer>`
+ioctl with a pointer to a :c:type:`struct v4l2_framebuffer <v4l2_framebuffer>`
structure. The driver fills all fields of the structure or returns an
EINVAL error code when overlays are not supported.
To set the parameters for a *Video Output Overlay*, applications must
initialize the ``flags`` field of a struct
-:ref:`struct v4l2_framebuffer <v4l2-framebuffer>`. Since the framebuffer is
+:c:type:`struct v4l2_framebuffer <v4l2_framebuffer>`. Since the framebuffer is
implemented on the TV card all other parameters are determined by the
driver. When an application calls :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` with a pointer to
this structure, the driver prepares for the overlay and returns the
@@ -77,7 +77,7 @@ destructive video overlay.
.. tabularcolumns:: |p{3.5cm}|p{3.5cm}|p{3.5cm}|p{7.0cm}|
-.. _v4l2-framebuffer:
+.. c:type:: v4l2_framebuffer
.. cssclass:: longtable
@@ -172,7 +172,7 @@ destructive video overlay.
-
-
- For *non-destructive Video Overlays* this field only defines a
- format for the struct :ref:`v4l2_window <v4l2-window>`
+ format for the struct :c:type:`v4l2_window`
``chromakey`` field.
- .. row 10
@@ -207,7 +207,7 @@ destructive video overlay.
- Drivers and applications shall ignore this field. If applicable,
the field order is selected with the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, using the ``field``
- field of struct :ref:`v4l2_window <v4l2-window>`.
+ field of struct :c:type:`v4l2_window`.
- .. row 13
@@ -422,7 +422,7 @@ destructive video overlay.
- 0x0004
- Use chroma-keying. The chroma-key color is determined by the
- ``chromakey`` field of struct :ref:`v4l2_window <v4l2-window>`
+ ``chromakey`` field of struct :c:type:`v4l2_window`
and negotiated with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl, see :ref:`overlay` and :ref:`osd`.
@@ -454,7 +454,7 @@ destructive video overlay.
images. The blend function is: output = (framebuffer pixel * alpha
+ video pixel * (255 - alpha)) / 255. The alpha value is
determined by the ``global_alpha`` field of struct
- :ref:`v4l2_window <v4l2-window>` and negotiated with the
+ :c:type:`v4l2_window` and negotiated with the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`.
@@ -478,11 +478,11 @@ destructive video overlay.
- Use source chroma-keying. The source chroma-key color is
determined by the ``chromakey`` field of struct
- :ref:`v4l2_window <v4l2-window>` and negotiated with the
+ :c:type:`v4l2_window` and negotiated with the
:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`. Both chroma-keying are mutual exclusive to each
other, so same ``chromakey`` field of struct
- :ref:`v4l2_window <v4l2-window>` is being used.
+ :c:type:`v4l2_window` is being used.
Return Value
OpenPOWER on IntegriCloud