Files
godot-docs/classes/class_visualshadernodesample3d.rst
2021-10-06 11:19:07 +02:00

72 lines
2.9 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeSample3D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeSample3D:
VisualShaderNodeSample3D
========================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`VisualShaderNodeTexture2DArray<class_VisualShaderNodeTexture2DArray>`, :ref:`VisualShaderNodeTexture3D<class_VisualShaderNodeTexture3D>`
A base node for nodes which samples 3D textures in the visual shader graph.
Description
-----------
A virtual class, use the descendants instead.
Properties
----------
+-----------------------------------------------------+---------------------------------------------------------------+-------+
| :ref:`Source<enum_VisualShaderNodeSample3D_Source>` | :ref:`source<class_VisualShaderNodeSample3D_property_source>` | ``0`` |
+-----------------------------------------------------+---------------------------------------------------------------+-------+
Enumerations
------------
.. _enum_VisualShaderNodeSample3D_Source:
.. _class_VisualShaderNodeSample3D_constant_SOURCE_TEXTURE:
.. _class_VisualShaderNodeSample3D_constant_SOURCE_PORT:
.. _class_VisualShaderNodeSample3D_constant_SOURCE_MAX:
enum **Source**:
- **SOURCE_TEXTURE** = **0** --- Creates internal uniform and provides a way to assign it within node.
- **SOURCE_PORT** = **1** --- Use the uniform texture from sampler port.
- **SOURCE_MAX** = **2** --- Represents the size of the :ref:`Source<enum_VisualShaderNodeSample3D_Source>` enum.
Property Descriptions
---------------------
.. _class_VisualShaderNodeSample3D_property_source:
- :ref:`Source<enum_VisualShaderNodeSample3D_Source>` **source**
+-----------+-------------------+
| *Default* | ``0`` |
+-----------+-------------------+
| *Setter* | set_source(value) |
+-----------+-------------------+
| *Getter* | get_source() |
+-----------+-------------------+
An input source type.
.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`