Lines Matching +full:in +full:- +full:application
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
4 Single-planar format structure
13 .. flat-table:: struct v4l2_pix_format
14 :header-rows: 0
15 :stub-columns: 0
18 * - __u32
19 - ``width``
20 - Image width in pixels.
21 * - __u32
22 - ``height``
23 - Image height in pixels. If ``field`` is one of ``V4L2_FIELD_TOP``,
25 refers to the number of lines in the field, otherwise it refers to
26 the number of lines in the frame (which is twice the field height
28 * - :cspan:`2` Applications set these fields to request an image
29 size, drivers return the closest possible values. In case of
45 * - __u32
46 - ``pixelformat``
47 - The pixel format or type of compression, set by the application.
49 :ref:`four character code <v4l2-fourcc>`. V4L2 defines standard
50 RGB formats in :ref:`pixfmt-rgb`, YUV formats in
51 :ref:`yuv-formats`, and reserved codes in
52 :ref:`reserved-formats`
53 * - __u32
54 - ``field``
55 - Field order, from enum :c:type:`v4l2_field`.
58 interlaced or sequentially stored in one buffer or alternating in
60 For more details on fields see :ref:`field-order`.
61 * - __u32
62 - ``bytesperline``
63 - Distance in bytes between the leftmost pixels in two adjacent
65 * - :cspan:`2`
69 the value requested by the application, returning ``width`` times
75 reside in accessible memory. Consider cases where padding bytes
89 Applications and drivers must set this to 0 in that case.
90 * - __u32
91 - ``sizeimage``
92 - Size in bytes of the buffer to hold a complete image, set by the
95 number of bytes required by the codec to support the worst-case
107 * - __u32
108 - ``colorspace``
109 - Image colorspace, from enum :c:type:`v4l2_colorspace`.
111 by the driver for capture streams and by the application for
112 output streams, see :ref:`colorspaces`. If the application sets the
113 flag ``V4L2_PIX_FMT_FLAG_SET_CSC`` then the application can set
118 the flag V4L2_FMT_FLAG_CSC_COLORSPACE in the corresponding struct
119 :c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
120 * - __u32
121 - ``priv``
122 - This field indicates whether the remaining fields of the
146 * - __u32
147 - ``flags``
148 - Flags set by the application or driver, see :ref:`format-flags`.
149 * - union {
150 - (anonymous)
151 * - __u32
152 - ``ycbcr_enc``
153 - Y'CbCr encoding, from enum :c:type:`v4l2_ycbcr_encoding`.
155 the driver for capture streams and by the application for output
156 streams, see :ref:`colorspaces`. If the application sets the
157 flag ``V4L2_PIX_FMT_FLAG_SET_CSC`` then the application can set
163 V4L2_FMT_FLAG_CSC_YCBCR_ENC in the corresponding struct
164 :c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
165 * - __u32
166 - ``hsv_enc``
167 - HSV encoding, from enum :c:type:`v4l2_hsv_encoding`.
169 the driver for capture streams and by the application for output
170 streams, see :ref:`colorspaces`. If the application sets the flag
171 ``V4L2_PIX_FMT_FLAG_SET_CSC`` then the application can set this
175 This field is ignored for non-HSV pixelformats. The driver indicates
177 V4L2_FMT_FLAG_CSC_HSV_ENC in the corresponding struct
178 :c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
179 * - }
180 -
181 * - __u32
182 - ``quantization``
183 - Quantization range, from enum :c:type:`v4l2_quantization`.
185 the driver for capture streams and by the application for output
186 streams, see :ref:`colorspaces`. If the application sets the flag
187 ``V4L2_PIX_FMT_FLAG_SET_CSC`` then the application can set
192 the flag V4L2_FMT_FLAG_CSC_QUANTIZATION in the corresponding struct
193 :c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
194 * - __u32
195 - ``xfer_func``
196 - Transfer function, from enum :c:type:`v4l2_xfer_func`.
198 the driver for capture streams and by the application for output
199 streams, see :ref:`colorspaces`. If the application sets the flag
200 ``V4L2_PIX_FMT_FLAG_SET_CSC`` then the application can set
205 the flag V4L2_FMT_FLAG_CSC_XFER_FUNC in the corresponding struct
206 :c:type:`v4l2_fmtdesc` during enumeration. See :ref:`fmtdesc-flags`.
210 .. _format-flags:
212 .. flat-table:: Format Flags
213 :header-rows: 0
214 :stub-columns: 0
217 * - ``V4L2_PIX_FMT_FLAG_PREMUL_ALPHA``
218 - 0x00000001
219 - The color values are premultiplied by the alpha channel value. For
224 * .. _`v4l2-pix-fmt-flag-set-csc`:
226 - ``V4L2_PIX_FMT_FLAG_SET_CSC``
227 - 0x00000002
228 - Set by the application. It is only used for capture and is
234 So in order to change the quantization, only the ``quantization`` field shall
240 pixel format, see :ref:`fmtdesc-flags`.