Commit 1073f441 authored by Paul Kocialkowski's avatar Paul Kocialkowski Committed by Mauro Carvalho Chehab

media: doc: codec: Rename "Return fields" to "Returned fields" for consistency

The parts about fields that are returned typically comes after
"Required fields" so it feels more consistent to name them
"Returned fields".
Signed-off-by: default avatarPaul Kocialkowski <paul.kocialkowski@bootlin.com>
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
parent 1526ae0f
...@@ -277,7 +277,7 @@ Initialization ...@@ -277,7 +277,7 @@ Initialization
other fields other fields
follow standard semantics. follow standard semantics.
* **Return fields:** * **Returned fields:**
``sizeimage`` ``sizeimage``
adjusted size of ``OUTPUT`` buffers. adjusted size of ``OUTPUT`` buffers.
...@@ -311,7 +311,7 @@ Initialization ...@@ -311,7 +311,7 @@ Initialization
``memory`` ``memory``
follows standard semantics. follows standard semantics.
* **Return fields:** * **Returned fields:**
``count`` ``count``
the actual number of buffers allocated. the actual number of buffers allocated.
...@@ -339,7 +339,7 @@ Initialization ...@@ -339,7 +339,7 @@ Initialization
``format`` ``format``
follows standard semantics. follows standard semantics.
* **Return fields:** * **Returned fields:**
``count`` ``count``
adjusted to the number of allocated buffers. adjusted to the number of allocated buffers.
...@@ -410,7 +410,7 @@ Capture Setup ...@@ -410,7 +410,7 @@ Capture Setup
``type`` ``type``
a ``V4L2_BUF_TYPE_*`` enum appropriate for ``CAPTURE``. a ``V4L2_BUF_TYPE_*`` enum appropriate for ``CAPTURE``.
* **Return fields:** * **Returned fields:**
``width``, ``height`` ``width``, ``height``
frame buffer resolution for the decoded frames. frame buffer resolution for the decoded frames.
...@@ -443,7 +443,7 @@ Capture Setup ...@@ -443,7 +443,7 @@ Capture Setup
``target`` ``target``
set to ``V4L2_SEL_TGT_COMPOSE``. set to ``V4L2_SEL_TGT_COMPOSE``.
* **Return fields:** * **Returned fields:**
``r.left``, ``r.top``, ``r.width``, ``r.height`` ``r.left``, ``r.top``, ``r.width``, ``r.height``
the visible rectangle; it must fit within the frame buffer resolution the visible rectangle; it must fit within the frame buffer resolution
...@@ -552,7 +552,7 @@ Capture Setup ...@@ -552,7 +552,7 @@ Capture Setup
frame is written; defaults to ``V4L2_SEL_TGT_COMPOSE_DEFAULT``; frame is written; defaults to ``V4L2_SEL_TGT_COMPOSE_DEFAULT``;
read-only on hardware without additional compose/scaling capabilities. read-only on hardware without additional compose/scaling capabilities.
* **Return fields:** * **Returned fields:**
``r.left``, ``r.top``, ``r.width``, ``r.height`` ``r.left``, ``r.top``, ``r.width``, ``r.height``
the visible rectangle; it must fit within the frame buffer resolution the visible rectangle; it must fit within the frame buffer resolution
...@@ -629,7 +629,7 @@ Capture Setup ...@@ -629,7 +629,7 @@ Capture Setup
``memory`` ``memory``
follows standard semantics. follows standard semantics.
* **Return fields:** * **Returned fields:**
``count`` ``count``
actual number of buffers allocated. actual number of buffers allocated.
...@@ -668,7 +668,7 @@ Capture Setup ...@@ -668,7 +668,7 @@ Capture Setup
a format representing the maximum framebuffer resolution to be a format representing the maximum framebuffer resolution to be
accommodated by newly allocated buffers. accommodated by newly allocated buffers.
* **Return fields:** * **Returned fields:**
``count`` ``count``
adjusted to the number of allocated buffers. adjusted to the number of allocated buffers.
......
...@@ -163,7 +163,7 @@ Initialization ...@@ -163,7 +163,7 @@ Initialization
other fields other fields
follow standard semantics. follow standard semantics.
* **Return fields:** * **Returned fields:**
``sizeimage`` ``sizeimage``
adjusted size of ``CAPTURE`` buffers. adjusted size of ``CAPTURE`` buffers.
...@@ -189,7 +189,7 @@ Initialization ...@@ -189,7 +189,7 @@ Initialization
other fields other fields
follow standard semantics. follow standard semantics.
* **Return fields:** * **Returned fields:**
``pixelformat`` ``pixelformat``
raw format supported for the coded format currently selected on raw format supported for the coded format currently selected on
...@@ -215,7 +215,7 @@ Initialization ...@@ -215,7 +215,7 @@ Initialization
other fields other fields
follow standard semantics. follow standard semantics.
* **Return fields:** * **Returned fields:**
``width``, ``height`` ``width``, ``height``
may be adjusted to match encoder minimums, maximums and alignment may be adjusted to match encoder minimums, maximums and alignment
...@@ -245,7 +245,7 @@ Initialization ...@@ -245,7 +245,7 @@ Initialization
the desired frame interval; the encoder may adjust it to the desired frame interval; the encoder may adjust it to
match hardware requirements. match hardware requirements.
* **Return fields:** * **Returned fields:**
``parm.output.timeperframe`` ``parm.output.timeperframe``
the adjusted frame interval. the adjusted frame interval.
...@@ -296,7 +296,7 @@ Initialization ...@@ -296,7 +296,7 @@ Initialization
the desired coded frame interval; the encoder may adjust it to the desired coded frame interval; the encoder may adjust it to
match hardware requirements. match hardware requirements.
* **Return fields:** * **Returned fields:**
``parm.capture.timeperframe`` ``parm.capture.timeperframe``
the adjusted frame interval. the adjusted frame interval.
...@@ -339,7 +339,7 @@ Initialization ...@@ -339,7 +339,7 @@ Initialization
rectangle and may be subject to adjustment to match codec and rectangle and may be subject to adjustment to match codec and
hardware constraints. hardware constraints.
* **Return fields:** * **Returned fields:**
``r.left``, ``r.top``, ``r.width``, ``r.height`` ``r.left``, ``r.top``, ``r.width``, ``r.height``
visible rectangle adjusted by the encoder. visible rectangle adjusted by the encoder.
...@@ -387,7 +387,7 @@ Initialization ...@@ -387,7 +387,7 @@ Initialization
other fields other fields
follow standard semantics. follow standard semantics.
* **Return fields:** * **Returned fields:**
``count`` ``count``
actual number of buffers allocated. actual number of buffers allocated.
...@@ -420,7 +420,7 @@ Initialization ...@@ -420,7 +420,7 @@ Initialization
other fields other fields
follow standard semantics. follow standard semantics.
* **Return fields:** * **Returned fields:**
``count`` ``count``
adjusted to the number of allocated buffers. adjusted to the number of allocated buffers.
......
...@@ -180,7 +180,7 @@ Initialization ...@@ -180,7 +180,7 @@ Initialization
``memory`` ``memory``
follows standard semantics. follows standard semantics.
* **Return fields:** * **Returned fields:**
``count`` ``count``
actual number of buffers allocated. actual number of buffers allocated.
...@@ -208,7 +208,7 @@ Initialization ...@@ -208,7 +208,7 @@ Initialization
follows standard semantics. ``V4L2_MEMORY_USERPTR`` is not supported follows standard semantics. ``V4L2_MEMORY_USERPTR`` is not supported
for ``CAPTURE`` buffers. for ``CAPTURE`` buffers.
* **Return fields:** * **Returned fields:**
``count`` ``count``
adjusted to allocated number of buffers, in case the codec requires adjusted to allocated number of buffers, in case the codec requires
......
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