Files
godot-docs-l10n/classes/fr/class_visualshadernodegroupbase.rst
2025-12-19 14:34:07 +01:00

339 lines
20 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_VisualShaderNodeGroupBase:
VisualShaderNodeGroupBase
=========================
**Hérite de:** :ref:`VisualShaderNodeResizableBase<class_VisualShaderNodeResizableBase>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Hérité par :** :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>`
Classe de base pour une famille de nœuds avec un nombre variable de ports d'entrée et de sortie dans le graphe de shader visuel.
.. rst-class:: classref-introduction-group
Description
-----------
Actuellement, ça n'a aucune utilisation, utilisez plutôt les classes dérivées.
.. rst-class:: classref-reftable-group
Méthodes
----------------
.. table::
:widths: auto
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`\ (\ id\: :ref:`int<class_int>`, type\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`\ (\ id\: :ref:`int<class_int>`, type\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_input_ports<class_VisualShaderNodeGroupBase_method_clear_input_ports>`\ (\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_output_ports<class_VisualShaderNodeGroupBase_method_clear_output_ports>`\ (\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>`\ (\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>`\ (\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_input_port_count<class_VisualShaderNodeGroupBase_method_get_input_port_count>`\ (\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_inputs<class_VisualShaderNodeGroupBase_method_get_inputs>`\ (\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_output_port_count<class_VisualShaderNodeGroupBase_method_get_output_port_count>`\ (\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_outputs<class_VisualShaderNodeGroupBase_method_get_outputs>`\ (\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_input_port<class_VisualShaderNodeGroupBase_method_has_input_port>`\ (\ id\: :ref:`int<class_int>`\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_output_port<class_VisualShaderNodeGroupBase_method_has_output_port>`\ (\ id\: :ref:`int<class_int>`\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_valid_port_name<class_VisualShaderNodeGroupBase_method_is_valid_port_name>`\ (\ name\: :ref:`String<class_String>`\ ) |const| |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_input_port<class_VisualShaderNodeGroupBase_method_remove_input_port>`\ (\ id\: :ref:`int<class_int>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_output_port<class_VisualShaderNodeGroupBase_method_remove_output_port>`\ (\ id\: :ref:`int<class_int>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_input_port_name<class_VisualShaderNodeGroupBase_method_set_input_port_name>`\ (\ id\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_input_port_type<class_VisualShaderNodeGroupBase_method_set_input_port_type>`\ (\ id\: :ref:`int<class_int>`, type\: :ref:`int<class_int>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_inputs<class_VisualShaderNodeGroupBase_method_set_inputs>`\ (\ inputs\: :ref:`String<class_String>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_output_port_name<class_VisualShaderNodeGroupBase_method_set_output_port_name>`\ (\ id\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_output_port_type<class_VisualShaderNodeGroupBase_method_set_output_port_type>`\ (\ id\: :ref:`int<class_int>`, type\: :ref:`int<class_int>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_outputs<class_VisualShaderNodeGroupBase_method_set_outputs>`\ (\ outputs\: :ref:`String<class_String>`\ ) |
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des méthodes
--------------------------------------------------
.. _class_VisualShaderNodeGroupBase_method_add_input_port:
.. rst-class:: classref-method
|void| **add_input_port**\ (\ id\: :ref:`int<class_int>`, type\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_add_input_port>`
Adds an input port with the specified ``type`` (see :ref:`PortType<enum_VisualShaderNode_PortType>`) and ``name``.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_add_output_port:
.. rst-class:: classref-method
|void| **add_output_port**\ (\ id\: :ref:`int<class_int>`, type\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_add_output_port>`
Adds an output port with the specified ``type`` (see :ref:`PortType<enum_VisualShaderNode_PortType>`) and ``name``.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_clear_input_ports:
.. rst-class:: classref-method
|void| **clear_input_ports**\ (\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_clear_input_ports>`
Retire tous les ports d'entrées précédemment spécifiés.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_clear_output_ports:
.. rst-class:: classref-method
|void| **clear_output_ports**\ (\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_clear_output_ports>`
Retire tous les ports de sortie précédemment spécifiés.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_free_input_port_id**\ (\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>`
Renvoie un identifiant d'un port d'entrée libre qui peut être utilisé pour :ref:`add_input_port()<class_VisualShaderNodeGroupBase_method_add_input_port>`.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_free_output_port_id**\ (\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>`
Renvoie un identifiant d'un port de sortie libre qui peut être utilisé pour :ref:`add_input_port()<class_VisualShaderNodeGroupBase_method_add_input_port>`.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_get_input_port_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_input_port_count**\ (\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_get_input_port_count>`
Renvoie le nombre de ports d'entrée utilisés. C'est une alternative à :ref:`get_free_input_port_id()<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>`.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_get_inputs:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_inputs**\ (\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_get_inputs>`
Returns a :ref:`String<class_String>` description of the input ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_input_port()<class_VisualShaderNodeGroupBase_method_add_input_port>`).
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_get_output_port_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_output_port_count**\ (\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_get_output_port_count>`
Renvoie le nombre de ports de sortie utilisés. C'est une alternative à :ref:`get_free_output_port_id()<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>`.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_get_outputs:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_outputs**\ (\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_get_outputs>`
Renvoie une :ref:`String<class_String>` de description des ports sortants sous forme de liste séparée par une virgule avec le format ``identifiant,type,nom;`` (voir :ref:`add_output_port()<class_VisualShaderNodeGroupBase_method_add_output_port>`).
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_has_input_port:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_input_port**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_has_input_port>`
Renvoie ``true`` si le port d'entrée spécifié existe.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_has_output_port:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_output_port**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_has_output_port>`
Renvoie ``true`` si le port de sortie spécifié existe.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_valid_port_name**\ (\ name\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_VisualShaderNodeGroupBase_method_is_valid_port_name>`
Returns ``true`` if the specified port name does not override an existed port name and is valid within the shader.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_remove_input_port:
.. rst-class:: classref-method
|void| **remove_input_port**\ (\ id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_remove_input_port>`
Supprime le port d'entrée spécifié.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_remove_output_port:
.. rst-class:: classref-method
|void| **remove_output_port**\ (\ id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_remove_output_port>`
Supprime le port de sortie spécifié.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_set_input_port_name:
.. rst-class:: classref-method
|void| **set_input_port_name**\ (\ id\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_set_input_port_name>`
Renomme le port dentrée spécifié.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_set_input_port_type:
.. rst-class:: classref-method
|void| **set_input_port_type**\ (\ id\: :ref:`int<class_int>`, type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_set_input_port_type>`
Définit le type du port d'entrée spécifié (voir :ref:`PortType<enum_VisualShaderNode_PortType>`).
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_set_inputs:
.. rst-class:: classref-method
|void| **set_inputs**\ (\ inputs\: :ref:`String<class_String>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_set_inputs>`
Définit tous les ports entrants avec une :ref:`String<class_String>` composée de valeurs séparées par un point-virgule : ``identifiant,type,nom;`` (voir :ref:`add_input_port()<class_VisualShaderNodeGroupBase_method_add_input_port>`).
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_set_output_port_name:
.. rst-class:: classref-method
|void| **set_output_port_name**\ (\ id\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_set_output_port_name>`
Renomme le port de sortie spécifié.
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_set_output_port_type:
.. rst-class:: classref-method
|void| **set_output_port_type**\ (\ id\: :ref:`int<class_int>`, type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_set_output_port_type>`
Définit le type du port de sortie spécifié (voir :ref:`PortType<enum_VisualShaderNode_PortType>`).
.. rst-class:: classref-item-separator
----
.. _class_VisualShaderNodeGroupBase_method_set_outputs:
.. rst-class:: classref-method
|void| **set_outputs**\ (\ outputs\: :ref:`String<class_String>`\ ) :ref:`🔗<class_VisualShaderNodeGroupBase_method_set_outputs>`
Définit tous les ports sortants avec une :ref:`String<class_String>` composée de valeurs séparées par un point-virgule : ``identifiant,type,nom;`` (voir :ref:`add_input_port()<class_VisualShaderNodeGroupBase_method_add_input_port>`).
.. |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.)`