Files
godot-docs-l10n/classes/fr/class_editorexportplatformweb.rst
Rémi Verschelde c3f2364c10 Sync classref with 4.6 branch
Lots of translations invalidated (fuzzied) as we just synced Weblate.
2025-12-19 16:39:51 +01:00

416 lines
23 KiB
ReStructuredText
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_EditorExportPlatformWeb:
EditorExportPlatformWeb
=======================
**Hérite de:** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Exporteur pour le Web.
.. rst-class:: classref-introduction-group
Description
-----------
The Web exporter customizes how a web build is handled. In the editor's "Export" window, it is created when adding a new "Web" preset.
\ **Note:** Godot on Web is rendered inside a ``<canvas>`` tag. Normally, the canvas cannot be positioned or resized manually, but otherwise acts as the main :ref:`Window<class_Window>` of the application.
.. rst-class:: classref-introduction-group
Tutoriels
------------------
- :doc:`Exportation pour le Web <../tutorials/export/exporting_for_web>`
- :doc:`Index de la documentation Web <../tutorials/platform/web/index>`
.. rst-class:: classref-reftable-group
Propriétés
--------------------
.. table::
:widths: auto
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`custom_template/debug<class_EditorExportPlatformWeb_property_custom_template/debug>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`custom_template/release<class_EditorExportPlatformWeb_property_custom_template/release>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`html/canvas_resize_policy<class_EditorExportPlatformWeb_property_html/canvas_resize_policy>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`html/custom_html_shell<class_EditorExportPlatformWeb_property_html/custom_html_shell>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`html/experimental_virtual_keyboard<class_EditorExportPlatformWeb_property_html/experimental_virtual_keyboard>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`html/export_icon<class_EditorExportPlatformWeb_property_html/export_icon>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`html/focus_canvas_on_start<class_EditorExportPlatformWeb_property_html/focus_canvas_on_start>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`html/head_include<class_EditorExportPlatformWeb_property_html/head_include>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`progressive_web_app/background_color<class_EditorExportPlatformWeb_property_progressive_web_app/background_color>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`progressive_web_app/display<class_EditorExportPlatformWeb_property_progressive_web_app/display>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`progressive_web_app/enabled<class_EditorExportPlatformWeb_property_progressive_web_app/enabled>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`progressive_web_app/ensure_cross_origin_isolation_headers<class_EditorExportPlatformWeb_property_progressive_web_app/ensure_cross_origin_isolation_headers>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`progressive_web_app/icon_144x144<class_EditorExportPlatformWeb_property_progressive_web_app/icon_144x144>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`progressive_web_app/icon_180x180<class_EditorExportPlatformWeb_property_progressive_web_app/icon_180x180>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`progressive_web_app/icon_512x512<class_EditorExportPlatformWeb_property_progressive_web_app/icon_512x512>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`progressive_web_app/offline_page<class_EditorExportPlatformWeb_property_progressive_web_app/offline_page>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`progressive_web_app/orientation<class_EditorExportPlatformWeb_property_progressive_web_app/orientation>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`threads/emscripten_pool_size<class_EditorExportPlatformWeb_property_threads/emscripten_pool_size>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`threads/godot_pool_size<class_EditorExportPlatformWeb_property_threads/godot_pool_size>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`variant/extensions_support<class_EditorExportPlatformWeb_property_variant/extensions_support>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`variant/thread_support<class_EditorExportPlatformWeb_property_variant/thread_support>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`vram_texture_compression/for_desktop<class_EditorExportPlatformWeb_property_vram_texture_compression/for_desktop>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`vram_texture_compression/for_mobile<class_EditorExportPlatformWeb_property_vram_texture_compression/for_mobile>` |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des propriétés
------------------------------------------------------
.. _class_EditorExportPlatformWeb_property_custom_template/debug:
.. rst-class:: classref-property
:ref:`String<class_String>` **custom_template/debug** :ref:`🔗<class_EditorExportPlatformWeb_property_custom_template/debug>`
File path to the custom export template used for debug builds. If left empty, the default template is used.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_custom_template/release:
.. rst-class:: classref-property
:ref:`String<class_String>` **custom_template/release** :ref:`🔗<class_EditorExportPlatformWeb_property_custom_template/release>`
File path to the custom export template used for release builds. If left empty, the default template is used.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_html/canvas_resize_policy:
.. rst-class:: classref-property
:ref:`int<class_int>` **html/canvas_resize_policy** :ref:`🔗<class_EditorExportPlatformWeb_property_html/canvas_resize_policy>`
Determines how the canvas should be resized by Godot.
- **None:** The canvas is not automatically resized.
- **Project:** The size of the canvas is dependent on the :ref:`ProjectSettings<class_ProjectSettings>`.
- **Adaptive:** The canvas is automatically resized to fit as much of the web page as possible.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_html/custom_html_shell:
.. rst-class:: classref-property
:ref:`String<class_String>` **html/custom_html_shell** :ref:`🔗<class_EditorExportPlatformWeb_property_html/custom_html_shell>`
La page HTML personnalisée qui enveloppe la compilation web exportée. Si laissée vide, le shell HTML par défaut est utilisé.
Pour plus d'informations, consultez le tutoriel :doc:`Page HTML custom pour un export Web <../tutorials/platform/web/customizing_html5_shell>`.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_html/experimental_virtual_keyboard:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **html/experimental_virtual_keyboard** :ref:`🔗<class_EditorExportPlatformWeb_property_html/experimental_virtual_keyboard>`
**Expérimental:** Cette propriété peut être changée ou retirée dans de futures versions.
If ``true``, embeds support for a virtual keyboard into the web page, which is shown when necessary on touchscreen devices.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_html/export_icon:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **html/export_icon** :ref:`🔗<class_EditorExportPlatformWeb_property_html/export_icon>`
If ``true``, the project icon will be used as the favicon for this application's web page.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_html/focus_canvas_on_start:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **html/focus_canvas_on_start** :ref:`🔗<class_EditorExportPlatformWeb_property_html/focus_canvas_on_start>`
If ``true``, the canvas will be focused as soon as the application is loaded, if the browser window is already in focus.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_html/head_include:
.. rst-class:: classref-property
:ref:`String<class_String>` **html/head_include** :ref:`🔗<class_EditorExportPlatformWeb_property_html/head_include>`
Additional HTML tags to include inside the ``<head>``, such as ``<meta>`` tags.
\ **Note:** You do not need to add a ``<title>`` tag, as it is automatically included based on the project's name.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/background_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **progressive_web_app/background_color** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/background_color>`
The background color used behind the web application.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/display:
.. rst-class:: classref-property
:ref:`int<class_int>` **progressive_web_app/display** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/display>`
The `display mode <https://developer.mozilla.org/en-US/docs/Web/Manifest/display/>`__ to use for this progressive web application. Different browsers and platforms may not behave the same.
- **Fullscreen:** Displays the app in fullscreen and hides all of the browser's UI elements.
- **Standalone:** Displays the app in a separate window and hides all of the browser's UI elements.
- **Minimal UI:** Displays the app in a separate window and only shows the browser's UI elements for navigation.
- **Browser:** Displays the app as a normal web page.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **progressive_web_app/enabled** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/enabled>`
If ``true``, turns this web build into a `progressive web application <https://en.wikipedia.org/wiki/Progressive_web_app>`__ (PWA).
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/ensure_cross_origin_isolation_headers:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **progressive_web_app/ensure_cross_origin_isolation_headers** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/ensure_cross_origin_isolation_headers>`
When enabled, the progressive web app will make sure that each request has cross-origin isolation headers (COEP/COOP).
This can simplify the setup to serve the exported game.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_144x144:
.. rst-class:: classref-property
:ref:`String<class_String>` **progressive_web_app/icon_144x144** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/icon_144x144>`
File path to the smallest icon for this web application. If not defined, defaults to the project icon.
\ **Note:** If the icon is not 144×144, it will be automatically resized for the final build.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_180x180:
.. rst-class:: classref-property
:ref:`String<class_String>` **progressive_web_app/icon_180x180** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/icon_180x180>`
File path to the small icon for this web application. If not defined, defaults to the project icon.
\ **Note:** If the icon is not 180×180, it will be automatically resized for the final build.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_512x512:
.. rst-class:: classref-property
:ref:`String<class_String>` **progressive_web_app/icon_512x512** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/icon_512x512>`
File path to the largest icon for this web application. If not defined, defaults to the project icon.
\ **Note:** If the icon is not 512×512, it will be automatically resized for the final build.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/offline_page:
.. rst-class:: classref-property
:ref:`String<class_String>` **progressive_web_app/offline_page** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/offline_page>`
The page to display, should the server hosting the page not be available. This page is saved in the client's machine.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_progressive_web_app/orientation:
.. rst-class:: classref-property
:ref:`int<class_int>` **progressive_web_app/orientation** :ref:`🔗<class_EditorExportPlatformWeb_property_progressive_web_app/orientation>`
The orientation to use when the web application is run through a mobile device.
- **Any:** No orientation is forced.
- **Landscape:** Forces a horizontal layout (wider than it is taller).
- **Portrait:** Forces a vertical layout (taller than it is wider).
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_threads/emscripten_pool_size:
.. rst-class:: classref-property
:ref:`int<class_int>` **threads/emscripten_pool_size** :ref:`🔗<class_EditorExportPlatformWeb_property_threads/emscripten_pool_size>`
The number of threads that emscripten will allocate at startup. A smaller value will allocate fewer threads and consume fewer system resources, but you may run the risk of running out of threads in the pool and needing to allocate more threads at run time which may cause a deadlock.
\ **Note:** Some browsers have a hard cap on the number of threads that can be allocated, so it is best to be cautious and keep this number low.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_threads/godot_pool_size:
.. rst-class:: classref-property
:ref:`int<class_int>` **threads/godot_pool_size** :ref:`🔗<class_EditorExportPlatformWeb_property_threads/godot_pool_size>`
Override for the default size of the :ref:`WorkerThreadPool<class_WorkerThreadPool>`. This setting is used when :ref:`ProjectSettings.threading/worker_pool/max_threads<class_ProjectSettings_property_threading/worker_pool/max_threads>` size is set to ``-1`` (which it is by default). This size must be smaller than :ref:`threads/emscripten_pool_size<class_EditorExportPlatformWeb_property_threads/emscripten_pool_size>` otherwise deadlocks may occur.
When using threads, this size needs to be large enough to accommodate features that rely on having a dedicated thread like :ref:`ProjectSettings.physics/2d/run_on_separate_thread<class_ProjectSettings_property_physics/2d/run_on_separate_thread>` or :ref:`ProjectSettings.rendering/driver/threads/thread_model<class_ProjectSettings_property_rendering/driver/threads/thread_model>`. In general, it is best to ensure that this is at least ``4`` and is at least ``2`` or ``3`` less than :ref:`threads/emscripten_pool_size<class_EditorExportPlatformWeb_property_threads/emscripten_pool_size>`.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_variant/extensions_support:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **variant/extensions_support** :ref:`🔗<class_EditorExportPlatformWeb_property_variant/extensions_support>`
If ``true`` enables :ref:`GDExtension<class_GDExtension>` support for this web build.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_variant/thread_support:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **variant/thread_support** :ref:`🔗<class_EditorExportPlatformWeb_property_variant/thread_support>`
If ``true``, the exported game will support threads. It requires `a "cross-origin isolated" website <https://web.dev/articles/coop-coep>`__, which may be difficult to set up and is limited for security reasons (such as not being able to communicate with third-party websites).
If ``false``, the exported game will not support threads. As a result, it is more prone to performance and audio issues, but will only require to be run on an HTTPS website.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_vram_texture_compression/for_desktop:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **vram_texture_compression/for_desktop** :ref:`🔗<class_EditorExportPlatformWeb_property_vram_texture_compression/for_desktop>`
If ``true``, allows textures to be optimized for desktop through the S3TC/BPTC algorithm.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformWeb_property_vram_texture_compression/for_mobile:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **vram_texture_compression/for_mobile** :ref:`🔗<class_EditorExportPlatformWeb_property_vram_texture_compression/for_mobile>`
If ``true`` allows textures to be optimized for mobile through the ETC2/ASTC algorithm.
.. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)`
.. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)`
.. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)`
.. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)`
.. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)`
.. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)`
.. |void| replace:: :abbr:`void (Aucune valeur de retour.)`