godotengine/godot-docs-l10n
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs-l10n.git synced 2026-01-04 10:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.x
godot-docs-l10n/classes/fr/class_canvaslayer.rst
Rémi Verschelde 369fd84a4f Sync classref with 4.5 branch
2025-12-19 14:34:07 +01:00

329 lines
15 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.

:github_url: hide
.. _class_CanvasLayer:
CanvasLayer
===========
**Hérite de :** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Hérité par :** :ref:`ParallaxBackground<class_ParallaxBackground>`
Un nœud utilisé pour le rendu indépendant d'objets dans une scène 2D.
.. rst-class:: classref-introduction-group
Description
-----------
:ref:`CanvasItem<class_CanvasItem>`-derived nodes that are direct or indirect children of a **CanvasLayer** will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index ``0``, so a **CanvasLayer** with index ``-1`` will be drawn below, and a **CanvasLayer** with index ``1`` will be drawn above. This order will hold regardless of the :ref:`CanvasItem.z_index<class_CanvasItem_property_z_index>` of the nodes within each layer.
\ **CanvasLayer**\ s can be hidden and they can also optionally follow the viewport. This makes them useful for HUDs like health bar overlays (on layers ``1`` and higher) or backgrounds (on layers ``-1`` and lower).
\ **Note:** Embedded :ref:`Window<class_Window>`\ s are placed on layer ``1024``. :ref:`CanvasItem<class_CanvasItem>`\ s on layers ``1025`` and higher appear in front of embedded windows.
\ **Note:** Each **CanvasLayer** is drawn on one specific :ref:`Viewport<class_Viewport>` and cannot be shared between multiple :ref:`Viewport<class_Viewport>`\ s, see :ref:`custom_viewport<class_CanvasLayer_property_custom_viewport>`. When using multiple :ref:`Viewport<class_Viewport>`\ s, for example in a split-screen game, you need to create an individual **CanvasLayer** for each :ref:`Viewport<class_Viewport>` you want it to be drawn on.
.. rst-class:: classref-introduction-group
Tutoriels
------------------
- :doc:`Transformations du canevas et de la fenêtre d'affichage <../tutorials/2d/2d_transforms>`
- :doc:`Calques du canevas <../tutorials/2d/canvas_layers>`
- `Démo 2D « Dodge The Creeps » <https://godotengine.org/asset-library/asset/2712>`__
.. rst-class:: classref-reftable-group
Propriétés
--------------------
.. table::
:widths: auto
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_CanvasLayer_property_custom_viewport>` | |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`bool<class_bool>` | :ref:`follow_viewport_enabled<class_CanvasLayer_property_follow_viewport_enabled>` | ``false`` |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`float<class_float>` | :ref:`follow_viewport_scale<class_CanvasLayer_property_follow_viewport_scale>` | ``1.0`` |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`layer<class_CanvasLayer_property_layer>` | ``1`` |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CanvasLayer_property_offset>` | ``Vector2(0, 0)`` |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`float<class_float>` | :ref:`rotation<class_CanvasLayer_property_rotation>` | ``0.0`` |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`scale<class_CanvasLayer_property_scale>` | ``Vector2(1, 1)`` |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_CanvasLayer_property_transform>` | ``Transform2D(1, 0, 0, 1, 0, 0)`` |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`bool<class_bool>` | :ref:`visible<class_CanvasLayer_property_visible>` | ``true`` |
+---------------------------------------+------------------------------------------------------------------------------------+-----------------------------------+
.. rst-class:: classref-reftable-group
Méthodes
----------------
.. table::
:widths: auto
+---------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_canvas<class_CanvasLayer_method_get_canvas>`\ (\ ) |const| |
+---------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_final_transform<class_CanvasLayer_method_get_final_transform>`\ (\ ) |const| |
+---------------------------------------+----------------------------------------------------------------------------------------+
| |void| | :ref:`hide<class_CanvasLayer_method_hide>`\ (\ ) |
+---------------------------------------+----------------------------------------------------------------------------------------+
| |void| | :ref:`show<class_CanvasLayer_method_show>`\ (\ ) |
+---------------------------------------+----------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signaux
--------------
.. _class_CanvasLayer_signal_visibility_changed:
.. rst-class:: classref-signal
**visibility_changed**\ (\ ) :ref:`🔗<class_CanvasLayer_signal_visibility_changed>`
Émis lorsque la visibilité de la couche est changée. Voir :ref:`visible<class_CanvasLayer_property_visible>`.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des propriétés
------------------------------------------------------
.. _class_CanvasLayer_property_custom_viewport:
.. rst-class:: classref-property
:ref:`Node<class_Node>` **custom_viewport** :ref:`🔗<class_CanvasLayer_property_custom_viewport>`
.. rst-class:: classref-property-setget
- |void| **set_custom_viewport**\ (\ value\: :ref:`Node<class_Node>`\ )
- :ref:`Node<class_Node>` **get_custom_viewport**\ (\ )
Le nœud :ref:`Viewport<class_Viewport>` personnalisé assigné au **CanvasLayer**. Si ``null``, ça utilise la fenêtre d'affichage par défaut à la place.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_property_follow_viewport_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **follow_viewport_enabled** = ``false`` :ref:`🔗<class_CanvasLayer_property_follow_viewport_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_follow_viewport**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_following_viewport**\ (\ )
Si activé, le **CanvasLayer** garde sa position dans l'espace global. Si désactivé, le **CanvasLayer** reste à une position fixe sur l'écran.
Avec :ref:`follow_viewport_scale<class_CanvasLayer_property_follow_viewport_scale>`, cela peut être utilisé pour un effet de pseudo-3D.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_property_follow_viewport_scale:
.. rst-class:: classref-property
:ref:`float<class_float>` **follow_viewport_scale** = ``1.0`` :ref:`🔗<class_CanvasLayer_property_follow_viewport_scale>`
.. rst-class:: classref-property-setget
- |void| **set_follow_viewport_scale**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_follow_viewport_scale**\ (\ )
Redimensionne la couche en utilisant :ref:`follow_viewport_enabled<class_CanvasLayer_property_follow_viewport_enabled>`. Les couches se déplaçant au premier plan devraient avoir des échelles croissantes, tandis que les couches se déplaçant dans le fond devraient avoir des couches décroissantes.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_property_layer:
.. rst-class:: classref-property
:ref:`int<class_int>` **layer** = ``1`` :ref:`🔗<class_CanvasLayer_property_layer>`
.. rst-class:: classref-property-setget
- |void| **set_layer**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_layer**\ (\ )
Index de couche pour l'ordre du dessin. Les valeurs inférieures sont dessinées derrière les valeurs supérieures.
\ **Note :** Si plusieurs CanvasLayers ont le même index de couche, les enfants :ref:`CanvasItem<class_CanvasItem>` d'un CanvasLayer sont dessinés derrière les enfants :ref:`CanvasItem<class_CanvasItem>` de l'autre CanvasLayer. Quel CanvasLayer est dessiné devant est non-déterministe.
\ **Note :** L'index de couche devrait être entre :ref:`RenderingServer.CANVAS_LAYER_MIN<class_RenderingServer_constant_CANVAS_LAYER_MIN>` et :ref:`RenderingServer.CANVAS_LAYER_MAX<class_RenderingServer_constant_CANVAS_LAYER_MAX>` (inclusifs). Toute autre valeur rebouclera.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_property_offset:
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **offset** = ``Vector2(0, 0)`` :ref:`🔗<class_CanvasLayer_property_offset>`
.. rst-class:: classref-property-setget
- |void| **set_offset**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
- :ref:`Vector2<class_Vector2>` **get_offset**\ (\ )
Le décalage de base du calque.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_property_rotation:
.. rst-class:: classref-property
:ref:`float<class_float>` **rotation** = ``0.0`` :ref:`🔗<class_CanvasLayer_property_rotation>`
.. rst-class:: classref-property-setget
- |void| **set_rotation**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_rotation**\ (\ )
La rotation du calque en radians.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_property_scale:
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **scale** = ``Vector2(1, 1)`` :ref:`🔗<class_CanvasLayer_property_scale>`
.. rst-class:: classref-property-setget
- |void| **set_scale**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
- :ref:`Vector2<class_Vector2>` **get_scale**\ (\ )
L'échelle du calque.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_property_transform:
.. rst-class:: classref-property
:ref:`Transform2D<class_Transform2D>` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` :ref:`🔗<class_CanvasLayer_property_transform>`
.. rst-class:: classref-property-setget
- |void| **set_transform**\ (\ value\: :ref:`Transform2D<class_Transform2D>`\ )
- :ref:`Transform2D<class_Transform2D>` **get_transform**\ (\ )
Le transform du calque.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_property_visible:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **visible** = ``true`` :ref:`🔗<class_CanvasLayer_property_visible>`
.. rst-class:: classref-property-setget
- |void| **set_visible**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_visible**\ (\ )
Si ``false``, tous les :ref:`CanvasItem<class_CanvasItem>` dans ce **CanvasLayer** sont cachés.
Contrairement à :ref:`CanvasItem.visible<class_CanvasItem_property_visible>`, la visibilité d'un **CanvasLayer** n'est pas propagée aux calques enfants.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des méthodes
--------------------------------------------------
.. _class_CanvasLayer_method_get_canvas:
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_canvas**\ (\ ) |const| :ref:`🔗<class_CanvasLayer_method_get_canvas>`
Renvoie le RID du canevas utilisé par ce calque.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_method_get_final_transform:
.. rst-class:: classref-method
:ref:`Transform2D<class_Transform2D>` **get_final_transform**\ (\ ) |const| :ref:`🔗<class_CanvasLayer_method_get_final_transform>`
Renvoie la transformation du système de coordonnées du **CanvasLayer** vers le système de coordonnées du :ref:`Viewport<class_Viewport>`.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_method_hide:
.. rst-class:: classref-method
|void| **hide**\ (\ ) :ref:`🔗<class_CanvasLayer_method_hide>`
Masque tous les :ref:`CanvasItem<class_CanvasItem>` dans ce **CanvasLayer**. Ceci est équivalent à définir :ref:`visible<class_CanvasLayer_property_visible>` à ``false``.
.. rst-class:: classref-item-separator
----
.. _class_CanvasLayer_method_show:
.. rst-class:: classref-method
|void| **show**\ (\ ) :ref:`🔗<class_CanvasLayer_method_show>`
Affiche tous les :ref:`CanvasItem<class_CanvasItem>` dans ce **CanvasLayer**. Ceci est équivalent à définir :ref:`visible<class_CanvasLayer_property_visible>` à ``true``.
.. |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.)`
Reference in New Issue View Git Blame Copy Permalink