~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]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/pt_BR/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 c:parent_keysphinx.domains.c LookupKey)}data]j  ASTIdentifier)} identifierV4LsbNasb 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)}(hj!h]hv4l2_pix_format_mplane}(hj#hhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdocj refdomainhreftypetype refexplicitrefwarnj jjv4l2_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)}(hjDh]hv4l2_plane_pix_format}(hjFhhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhjBubah}(h]h ]h"]h$]h&]refdocj refdomainhreftypetype refexplicitrefwarnj jjv4l2_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}|uh1jkhhhKhhhhubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](single"V4L.v4l2_plane_pix_format (C type)c.V4L.v4l2_plane_pix_formathNtauh1jxhhhhhNhNubhdesc)}(hhh](hdesc_signature)}(hv4l2_plane_pix_formath]hdesc_signature_line)}(htype v4l2_plane_pix_formath](hdesc_sig_keyword)}(htypeh]htype}(hjhhhNhNubah}(h]h ]kah"]h$]h&]uh1jhjhhhhhKubhdesc_sig_space)}(h h]h }(hjhhhNhNubah}(h]h ]wah"]h$]h&]uh1jhjhhhhhKubh desc_name)}(hv4l2_plane_pix_formath]h desc_sig_name)}(hjh]hv4l2_plane_pix_format}(hjhhhNhNubah}(h]h ]nah"]h$]h&]uh1jhjubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1jhjhhhhhKubeh}(h]h ]h"]h$]h&]hhƌ add_permalinkuh1jsphinx_line_type declaratorhjhhhhhKubah}(h]jah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1jhhhKhjhhubh desc_content)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhhhhhKubeh}(h]h ](htypeeh"]h$]h&]domainhobjtypejdesctypejnoindex noindexentrynocontentsentryuh1jhhhhhNhNubhtable)}(hhh](h)}(hstruct v4l2_plane_pix_formath]hstruct v4l2_plane_pix_format}(hj hhhNhNubah}(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}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjJubah}(h]h ]h"]h$]h&]uh1jHhjEubjI)}(hhh]h)}(h ``sizeimage``h]h)}(hjfh]h sizeimage}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjdubah}(h]h ]h"]h$]h&]uh1hhhhKhjaubah}(h]h ]h"]h$]h&]uh1jHhjEubjI)}(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.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h6The driver will set the value for uncompressed images.h]h6The driver will set the value for uncompressed images.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK!hjubh)}(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 }(hjhhhNhNubh)}(h``V4L2_FMT_FLAG_COMPRESSED``h]hV4L2_FMT_FLAG_COMPRESSED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh at }(hjhhhNhNubh)}(h:ref:`VIDIOC_ENUM_FMT`h]hinline)}(hjh]hVIDIOC_ENUM_FMT}(hjhhhNhNubah}(h]h ](hstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjvidioc_enum_fmtuh1hhhhK#hjubh, 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.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK#hjubeh}(h]h ]h"]h$]h&]uh1jHhjEubeh}(h]h ]h"]h$]h&]uh1jChj@ubjD)}(hhh](jI)}(hhh]h)}(h__u32h]h__u32}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK*hjubah}(h]h ]h"]h$]h&]uh1jHhjubjI)}(hhh]h)}(h``bytesperline``h]h)}(hjh]h bytesperline}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhK+hj ubah}(h]h ]h"]h$]h&]uh1jHhjubjI)}(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)}(hj9h]hv4l2_pix_format}(hj;hhhNhNubah}(h]h ](hhc-typeeh"]h$]h&]uh1hhj7ubah}(h]h ]h"]h$]h&]refdocj refdomainhreftypetype refexplicitrefwarnj jjv4l2_pix_formatuh1hhhhK,hj/ubh.}(hj/hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK,hj,ubah}(h]h ]h"]h$]h&]uh1jHhjubeh}(h]h ]h"]h$]h&]uh1jChj@ubjD)}(hhh](jI)}(hhh]h)}(h__u16h]h__u16}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK.hjoubah}(h]h ]h"]h$]h&]uh1jHhjlubjI)}(hhh]h)}(h``reserved[6]``h]h)}(hjh]h reserved[6]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhK/hjubah}(h]h ]h"]h$]h&]uh1jHhjlubjI)}(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&]uh1hhhhK0hjubah}(h]h ]h"]h$]h&]uh1jHhjlubeh}(h]h ]h"]h$]h&]uh1jChj@ubeh}(h]h ]h"]h$]h&]uh1j>hjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubeh}(h]id1ah ]h"]h$]h&]uh1jhhhhhNhNubhraw)}(h\smallh]h\small}hjsbah}(h]h ]h"]h$]h&]formatlatexhhuh1jhhhK4hhhhubjl)}(hhh]h}(h]h ]h"]h$]h&]jv|p{4.4cm}|p{5.6cm}|p{7.3cm}|uh1jkhhhK8hhhhubjy)}(hhh]h}(h]h ]h"]h$]h&]entries](j#V4L.v4l2_pix_format_mplane (C type)c.V4L.v4l2_pix_format_mplanehNtauh1jxhhhhhNhNubj)}(hhh](j)}(hv4l2_pix_format_mplaneh]j)}(htype v4l2_pix_format_mplaneh](j)}(hjh]htype}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhhhK:ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhhhK:ubj)}(hv4l2_pix_format_mplaneh]j)}(hjh]hv4l2_pix_format_mplane}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubah}(h]h ](jjeh"]h$]h&]hhuh1jhjhhhhhK:ubeh}(h]h ]h"]h$]h&]hhjuh1jjjhjhhhhhK:ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jhhhK:hjhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhhhhhK:ubeh}(h]h ](htypeeh"]h$]h&]jhjjVjjVjjjuh1jhhhhhNhNubj)}(hhh](h)}(hstruct v4l2_pix_format_mplaneh]hstruct v4l2_pix_format_mplane}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjkubeh}(h]h ]h"]h$]h&]colsKuh1jhjZubeh}(h]id2ah ]h"]h$]h&]uh1jhhhhhNhNubj)}(h \normalsizeh]h \normalsize}hj sbah}(h]h ]h"]h$]h&]formatlatexhhuh1jhhhKzhhhhubeh}(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_backlinksjHfootnote_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_sourcehnj _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 hjjjjjjj jZu 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.}(hjb hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_ ubah}(h]h ]h"]h$]h&]levelKtypeINFOlineKksourcehuh1j] hj ubatransform_messages] transformerN include_log] decorationNhhub.