mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
67 lines
2.9 KiB
ReStructuredText
67 lines
2.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeBooleanUniform.xml.
|
|
|
|
.. _class_VisualShaderNodeBooleanUniform:
|
|
|
|
VisualShaderNodeBooleanUniform
|
|
==============================
|
|
|
|
**Inherits:** :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
A boolean uniform to be used within the visual shader graph.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Translated to ``uniform bool`` in the shader language.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------+---------------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`default_value<class_VisualShaderNodeBooleanUniform_property_default_value>` | ``false`` |
|
|
+-------------------------+---------------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`default_value_enabled<class_VisualShaderNodeBooleanUniform_property_default_value_enabled>` | ``false`` |
|
|
+-------------------------+---------------------------------------------------------------------------------------------------+-----------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeBooleanUniform_property_default_value:
|
|
|
|
- :ref:`bool<class_bool>` **default_value**
|
|
|
|
+-----------+--------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------------+
|
|
| *Setter* | set_default_value(value) |
|
|
+-----------+--------------------------+
|
|
| *Getter* | get_default_value() |
|
|
+-----------+--------------------------+
|
|
|
|
A default value to be assigned within the shader.
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeBooleanUniform_property_default_value_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **default_value_enabled**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+----------------------------------+
|
|
| *Setter* | set_default_value_enabled(value) |
|
|
+-----------+----------------------------------+
|
|
| *Getter* | is_default_value_enabled() |
|
|
+-----------+----------------------------------+
|
|
|
|
Enables usage of the :ref:`default_value<class_VisualShaderNodeBooleanUniform_property_default_value>`.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|