media/v4l/vidioc-enum-framesizes.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
13 VIDIOC_ENUM_FRAMESIZES - Enumerate frame sizes
30     that contains an index and pixel format and receives a frame width
37 and height in pixels) that the device supports for the given pixel
38 format.
40 The supported pixel formats can be obtained by using the
47 -  **Discrete:** The function returns success if the given index value
48    (zero-based) is valid. The application should increase the index by
54 -  **Step-wise:** The function returns success if the given index value
60 -  **Continuous:** This is a special case of the step-wise type above.
76    format sizes.
92 .. flat-table:: struct v4l2_frmsize_discrete
93     :header-rows:  0
94     :stub-columns: 0
97     * - __u32
98       - ``width``
99       - Width of the frame [pixel].
100     * - __u32
101       - ``height``
102       - Height of the frame [pixel].
107 .. flat-table:: struct v4l2_frmsize_stepwise
108     :header-rows:  0
109     :stub-columns: 0
112     * - __u32
113       - ``min_width``
114       - Minimum frame width [pixel].
115     * - __u32
116       - ``max_width``
117       - Maximum frame width [pixel].
118     * - __u32
119       - ``step_width``
120       - Frame width step size [pixel].
121     * - __u32
122       - ``min_height``
123       - Minimum frame height [pixel].
124     * - __u32
125       - ``max_height``
126       - Maximum frame height [pixel].
127     * - __u32
128       - ``step_height``
129       - Frame height step size [pixel].
136 .. flat-table:: struct v4l2_frmsizeenum
137     :header-rows:  0
138     :stub-columns: 0
140     * - __u32
141       - ``index``
142       - IN: Index of the given frame size in the enumeration.
143     * - __u32
144       - ``pixel_format``
145       - IN: Pixel format for which the frame sizes are enumerated.
146     * - __u32
147       - ``type``
148       - OUT: Frame size type the device supports.
149     * - union {
150       - (anonymous)
151       - OUT: Frame size with the given index.
152     * - struct :c:type:`v4l2_frmsize_discrete`
153       - ``discrete``
154       -
155     * - struct :c:type:`v4l2_frmsize_stepwise`
156       - ``stepwise``
157       -
158     * - }
159       -
160       -
161     * - __u32
162       - ``reserved[2]``
163       - Reserved space for future use. Must be zeroed by drivers and
174 .. flat-table:: enum v4l2_frmsizetypes
175     :header-rows:  0
176     :stub-columns: 0
179     * - ``V4L2_FRMSIZE_TYPE_DISCRETE``
180       - 1
181       - Discrete frame size.
182     * - ``V4L2_FRMSIZE_TYPE_CONTINUOUS``
183       - 2
184       - Continuous frame size.
185     * - ``V4L2_FRMSIZE_TYPE_STEPWISE``
186       - 3
187       - Step-wise defined frame size.
192 On success 0 is returned, on error -1 and the ``errno`` variable is set
194 :ref:`Generic Error Codes <gen-errors>` chapter.