|sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget>/translations/zh_CN/userspace-api/media/v4l/pixfmt-v4l2-mplanemodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/zh_TW/userspace-api/media/v4l/pixfmt-v4l2-mplanemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/it_IT/userspace-api/media/v4l/pixfmt-v4l2-mplanemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/ja_JP/userspace-api/media/v4l/pixfmt-v4l2-mplanemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/ko_KR/userspace-api/media/v4l/pixfmt-v4l2-mplanemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/sp_SP/userspace-api/media/v4l/pixfmt-v4l2-mplanemodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h8SPDX-License-Identifier: GFDL-1.1-no-invariants-or-laterh]h8SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhX/var/lib/git/docbuild/linux/Documentation/userspace-api/media/v4l/pixfmt-v4l2-mplane.rsthKubhsection)}(hhh](htitle)}(hMulti-planar format structuresh]hMulti-planar format structures}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hXgThe struct :c:type:`v4l2_plane_pix_format` structures define size and layout for each of the planes in a multi-planar format. The struct :c:type:`v4l2_pix_format_mplane` structure contains information common to all planes (such as image width and height) and an array of struct :c:type:`v4l2_plane_pix_format` structures, describing all planes of that format.h](h The struct }(hhhhhNhNubh)}(h:c:type:`v4l2_plane_pix_format`h]hliteral)}(hhh]hv4l2_plane_pix_format}(hhhhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1hhhubah}(h]h ]h"]h$]h&]refdoc*userspace-api/media/v4l/pixfmt-v4l2-mplane refdomainhreftypetype refexplicitrefwarn reftargetv4l2_plane_pix_formatuh1hhhhKhhubh_ structures define size and layout for each of the planes in a multi-planar format. The struct }(hhhhhNhNubh)}(h :c:type:`v4l2_pix_format_mplane`h]h)}(hhh]hv4l2_pix_format_mplane}(hjhhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhhubah}(h]h ]h"]h$]h&]refdoch refdomainhreftypetype refexplicitrefwarnhv4l2_pix_format_mplaneuh1hhhhKhhubhm structure contains information common to all planes (such as image width and height) and an array of struct }(hhhhhNhNubh)}(h:c:type:`v4l2_plane_pix_format`h]h)}(hj!h]hv4l2_plane_pix_format}(hj#hhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdoch refdomainhreftypetype refexplicitrefwarnhv4l2_plane_pix_formatuh1hhhhKhhubh2 structures, describing all planes of that format.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubhtabular_col_spec)}(hhh]h}(h]h ]h"]h$]h&]spec|p{1.4cm}|p{4.0cm}|p{11.9cm}|uh1jHhhhKhhhhubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](singlev4l2_plane_pix_format (C type)c.v4l2_plane_pix_formathNtauh1jUhhhhhNhNubhdesc)}(hhh](hdesc_signature)}(hv4l2_plane_pix_formath]hdesc_signature_line)}(htype v4l2_plane_pix_formath](hdesc_sig_keyword)}(htypeh]htype}(hjyhhhNhNubah}(h]h ]kah"]h$]h&]uh1jwhjshhhhhKubhdesc_sig_space)}(h h]h }(hjhhhNhNubah}(h]h ]wah"]h$]h&]uh1jhjshhhhhKubh desc_name)}(hv4l2_plane_pix_formath]h desc_sig_name)}(hjoh]hv4l2_plane_pix_format}(hjhhhNhNubah}(h]h ]nah"]h$]h&]uh1jhjubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1jhjshhhhhKubeh}(h]h ]h"]h$]h&]hh add_permalinkuh1jqsphinx_line_type declaratorhjmhhhhhKubah}(h]jdah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1jkhhhKhjhhhubh desc_content)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhhhhhhKubeh}(h]h ](htypeeh"]h$]h&]domainhobjtypejdesctypejnoindex noindexentrynocontentsentryuh1jfhhhhhNhNubhtable)}(hhh](h)}(hstruct v4l2_plane_pix_formath]hstruct v4l2_plane_pix_format}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubhtgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(h__u32h]h__u32}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj'ubah}(h]h ]h"]h$]h&]uh1j%hj"ubj&)}(hhh]h)}(h ``sizeimage``h]h)}(hjCh]h sizeimage}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAubah}(h]h ]h"]h$]h&]uh1hhhhKhj>ubah}(h]h ]h"]h$]h&]uh1j%hj"ubj&)}(hhh](h)}(hMaximum size in bytes required for image data in this plane, set by the driver. When the image consists of variable length compressed data this is the number of bytes required by the codec to support the worst-case compression scenario.h]hMaximum size in bytes required for image data in this plane, set by the driver. When the image consists of variable length compressed data this is the number of bytes required by the codec to support the worst-case compression scenario.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj^ubh)}(h6The driver will set the value for uncompressed images.h]h6The driver will set the value for uncompressed images.}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hj^ubh)}(hXClients are allowed to set the sizeimage field for variable length compressed data flagged with ``V4L2_FMT_FLAG_COMPRESSED`` at :ref:`VIDIOC_ENUM_FMT`, but the driver may ignore it and set the value itself, or it may modify the provided value based on alignment requirements or minimum/maximum size requirements. If the client wants to leave this to the driver, then it should set sizeimage to 0.h](h`Clients are allowed to set the sizeimage field for variable length compressed data flagged with }(hj}hhhNhNubh)}(h``V4L2_FMT_FLAG_COMPRESSED``h]hV4L2_FMT_FLAG_COMPRESSED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj}ubh at }(hj}hhhNhNubh)}(h:ref:`VIDIOC_ENUM_FMT`h]hinline)}(hjh]hVIDIOC_ENUM_FMT}(hjhhhNhNubah}(h]h ](hstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdoch refdomainjreftyperef refexplicitrefwarnhvidioc_enum_fmtuh1hhhhK"hj}ubh, but the driver may ignore it and set the value itself, or it may modify the provided value based on alignment requirements or minimum/maximum size requirements. If the client wants to leave this to the driver, then it should set sizeimage to 0.}(hj}hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK"hj^ubeh}(h]h ]h"]h$]h&]uh1j%hj"ubeh}(h]h ]h"]h$]h&]uh1j hjubj!)}(hhh](j&)}(hhh]h)}(h__u32h]h__u32}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK)hjubah}(h]h ]h"]h$]h&]uh1j%hjubj&)}(hhh]h)}(h``bytesperline``h]h)}(hjh]h bytesperline}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhK*hjubah}(h]h ]h"]h$]h&]uh1j%hjubj&)}(hhh]h)}(hjDistance in bytes between the leftmost pixels in two adjacent lines. See struct :c:type:`v4l2_pix_format`.h](hPDistance in bytes between the leftmost pixels in two adjacent lines. See struct }(hj hhhNhNubh)}(h:c:type:`v4l2_pix_format`h]h)}(hjh]hv4l2_pix_format}(hjhhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdoch refdomainhreftypetype refexplicitrefwarn c:parent_keysphinx.domains.c LookupKey)}data]sbhv4l2_pix_formatuh1hhhhK+hj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK+hj ubah}(h]h ]h"]h$]h&]uh1j%hjubeh}(h]h ]h"]h$]h&]uh1j hjubj!)}(hhh](j&)}(hhh]h)}(h__u16h]h__u16}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK-hjTubah}(h]h ]h"]h$]h&]uh1j%hjQubj&)}(hhh]h)}(h``reserved[6]``h]h)}(hjph]h reserved[6]}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjnubah}(h]h ]h"]h$]h&]uh1hhhhK.hjkubah}(h]h ]h"]h$]h&]uh1j%hjQubj&)}(hhh]h)}(hMReserved for future extensions. Should be zeroed by drivers and applications.h]hMReserved for future extensions. Should be zeroed by drivers and applications.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK/hjubah}(h]h ]h"]h$]h&]uh1j%hjQubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubeh}(h]id1ah ]h"]h$]h&]uh1jhhhhhNhNubhraw)}(h\smallh]h\small}hjsbah}(h]h ]h"]h$]h&]formatlatexhhuh1jhhhK3hhhhubjI)}(hhh]h}(h]h ]h"]h$]h&]jS|p{4.4cm}|p{5.6cm}|p{7.3cm}|uh1jHhhhK7hhhhubjV)}(hhh]h}(h]h ]h"]h$]h&]entries](jbv4l2_pix_format_mplane (C type)c.v4l2_pix_format_mplanehNtauh1jUhhhhhNhNubjg)}(hhh](jl)}(hv4l2_pix_format_mplaneh]jr)}(htype v4l2_pix_format_mplaneh](jx)}(hj{h]htype}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jwhjhhhhhK9ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhhhK9ubj)}(hv4l2_pix_format_mplaneh]j)}(hjh]hv4l2_pix_format_mplane}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](jjeh"]h$]h&]hhuh1jhjhhhhhK9ubeh}(h]h ]h"]h$]h&]hhjuh1jqjjhjhhhhhK9ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jkhhhK9hjhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhhhhhK9ubeh}(h]h ](htypeeh"]h$]h&]jhjj;jj;jjjuh1jfhhhhhNhNubj)}(hhh](h)}(hstruct v4l2_pix_format_mplaneh]hstruct v4l2_pix_format_mplane}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK;hj?ubj)}(hhh](j)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjPubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjPubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjPubj)}(hhh](j!)}(hhh](j&)}(hhh]h)}(h__u32h]h__u32}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK@hjwubah}(h]h ]h"]h$]h&]uh1j%hjtubj&)}(hhh]h)}(h ``width``h]h)}(hjh]hwidth}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKAhjubah}(h]h ]h"]h$]h&]uh1j%hjtubj&)}(hhh]h)}(h hhhNhNubh)}(h:c:type:`v4l2_quantization`h]h)}(hjH h]hv4l2_quantization}(hjJ hhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhjF ubah}(h]h ]h"]h$]h&]refdoch refdomainhreftypetype refexplicitrefwarnj2j6hv4l2_quantizationuh1hhhhKnhj> ubh . See struct }(hj> hhhNhNubh)}(h:c:type:`v4l2_pix_format`h]h)}(hjk h]hv4l2_pix_format}(hjm hhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhji ubah}(h]h ]h"]h$]h&]refdoch refdomainhreftypetype refexplicitrefwarnj2j6hv4l2_pix_formatuh1hhhhKnhj> ubh.}(hj> hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKnhj; ubah}(h]h ]h"]h$]h&]uh1j%hj ubeh}(h]h ]h"]h$]h&]uh1j hjqubj!)}(hhh](j&)}(hhh]h)}(h__u8h]h__u8}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKphj ubah}(h]h ]h"]h$]h&]uh1j%hj ubj&)}(hhh]h)}(h ``xfer_func``h]h)}(hj h]h xfer_func}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1hhhhKqhj ubah}(h]h ]h"]h$]h&]uh1j%hj ubj&)}(hhh]h)}(h\Transfer function, from enum :c:type:`v4l2_xfer_func`. See struct :c:type:`v4l2_pix_format`.h](hTransfer function, from enum }(hj hhhNhNubh)}(h:c:type:`v4l2_xfer_func`h]h)}(hj h]hv4l2_xfer_func}(hj hhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]refdoch refdomainhreftypetype refexplicitrefwarnj2j6hv4l2_xfer_funcuh1hhhhKrhj ubh . See struct }(hj hhhNhNubh)}(h:c:type:`v4l2_pix_format`h]h)}(hj h]hv4l2_pix_format}(hj hhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]refdoch refdomainhreftypetype refexplicitrefwarnj2j6hv4l2_pix_formatuh1hhhhKrhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKrhj ubah}(h]h ]h"]h$]h&]uh1j%hj ubeh}(h]h ]h"]h$]h&]uh1j hjqubj!)}(hhh](j&)}(hhh]h)}(h__u8h]h__u8}(hjA hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKthj> ubah}(h]h ]h"]h$]h&]uh1j%hj; ubj&)}(hhh]h)}(h``reserved[7]``h]h)}(hjZ h]h reserved[7]}(hj\ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjX ubah}(h]h ]h"]h$]h&]uh1hhhhKuhjU ubah}(h]h ]h"]h$]h&]uh1j%hj; ubj&)}(hhh]h)}(hMReserved for future extensions. Should be zeroed by drivers and applications.h]hMReserved for future extensions. Should be zeroed by drivers and applications.}(hjx hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKvhju ubah}(h]h ]h"]h$]h&]uh1j%hj; ubeh}(h]h ]h"]h$]h&]uh1j hjqubeh}(h]h ]h"]h$]h&]uh1jhjPubeh}(h]h ]h"]h$]h&]colsKuh1jhj?ubeh}(h]id2ah ]h"]h$]h&]uh1jhhhhhNhNubj)}(h \normalsizeh]h \normalsize}hj sbah}(h]h ]h"]h$]h&]formatlatexhhuh1jhhhKyhhhhubeh}(h]multi-planar-format-structuresah ]h"]multi-planar format structuresah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksj%footnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}j j s nametypes}j sh}(j hjdjmjjjjj j?u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}j KsRparse_messages]hsystem_message)}(hhh]h)}(heUnexpected possible title overline or transition. Treating it as ordinary text because it's so short.h]hgUnexpected possible title overline or transition. Treating it as ordinary text because it’s so short.}(hjG hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjD ubah}(h]h ]h"]h$]h&]levelKtypeINFOlineKjsourcehuh1jB hj ubatransform_messages] transformerN include_log] decorationNhhub.