classref: Sync with current master branch (93be33748)

classes/class_visualshadernodetextureparameter.rst

@@ -0,0 +1,216 @@
+:github_url: hide
+
+.. DO NOT EDIT THIS FILE!!!
+.. Generated automatically from Godot engine sources.
+.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
+.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureParameter.xml.
+
+.. _class_VisualShaderNodeTextureParameter:
+
+VisualShaderNodeTextureParameter
+================================
+
+**Inherits:** :ref:`VisualShaderNodeParameter<class_VisualShaderNodeParameter>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
+
+**Inherited By:** :ref:`VisualShaderNodeCubemapParameter<class_VisualShaderNodeCubemapParameter>`, :ref:`VisualShaderNodeTexture2DArrayParameter<class_VisualShaderNodeTexture2DArrayParameter>`, :ref:`VisualShaderNodeTexture2DParameter<class_VisualShaderNodeTexture2DParameter>`, :ref:`VisualShaderNodeTexture3DParameter<class_VisualShaderNodeTexture3DParameter>`, :ref:`VisualShaderNodeTextureParameterTriplanar<class_VisualShaderNodeTextureParameterTriplanar>`
+
+Performs a uniform texture lookup within the visual shader graph.
+
+Description
+-----------
+
+Performs a lookup operation on the texture provided as a uniform for the shader.
+
+Properties
+----------
+
++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+
+| :ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>`   | :ref:`color_default<class_VisualShaderNodeTextureParameter_property_color_default>`   | ``0`` |
++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+
+| :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` | :ref:`texture_filter<class_VisualShaderNodeTextureParameter_property_texture_filter>` | ``0`` |
++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+
+| :ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` | :ref:`texture_repeat<class_VisualShaderNodeTextureParameter_property_texture_repeat>` | ``0`` |
++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+
+| :ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>`     | :ref:`texture_type<class_VisualShaderNodeTextureParameter_property_texture_type>`     | ``0`` |
++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+
+
+Enumerations
+------------
+
+.. _enum_VisualShaderNodeTextureParameter_TextureType:
+
+.. _class_VisualShaderNodeTextureParameter_constant_TYPE_DATA:
+
+.. _class_VisualShaderNodeTextureParameter_constant_TYPE_COLOR:
+
+.. _class_VisualShaderNodeTextureParameter_constant_TYPE_NORMAL_MAP:
+
+.. _class_VisualShaderNodeTextureParameter_constant_TYPE_ANISOTROPY:
+
+.. _class_VisualShaderNodeTextureParameter_constant_TYPE_MAX:
+
+enum **TextureType**:
+
+- **TYPE_DATA** = **0** --- No hints are added to the uniform declaration.
+
+- **TYPE_COLOR** = **1** --- Adds ``source_color`` as hint to the uniform declaration for proper sRGB to linear conversion.
+
+- **TYPE_NORMAL_MAP** = **2** --- Adds ``hint_normal`` as hint to the uniform declaration, which internally converts the texture for proper usage as normal map.
+
+- **TYPE_ANISOTROPY** = **3** --- Adds ``hint_anisotropy`` as hint to the uniform declaration to use for a flowmap.
+
+- **TYPE_MAX** = **4** --- Represents the size of the :ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` enum.
+
+----
+
+.. _enum_VisualShaderNodeTextureParameter_ColorDefault:
+
+.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_WHITE:
+
+.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_BLACK:
+
+.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_TRANSPARENT:
+
+.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_MAX:
+
+enum **ColorDefault**:
+
+- **COLOR_DEFAULT_WHITE** = **0** --- Defaults to fully opaque white color.
+
+- **COLOR_DEFAULT_BLACK** = **1** --- Defaults to fully opaque black color.
+
+- **COLOR_DEFAULT_TRANSPARENT** = **2** --- Defaults to fully transparent black color.
+
+- **COLOR_DEFAULT_MAX** = **3** --- Represents the size of the :ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` enum.
+
+----
+
+.. _enum_VisualShaderNodeTextureParameter_TextureFilter:
+
+.. _class_VisualShaderNodeTextureParameter_constant_FILTER_DEFAULT:
+
+.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST:
+
+.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR:
+
+.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP:
+
+.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP:
+
+.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP_ANISOTROPIC:
+
+.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP_ANISOTROPIC:
+
+.. _class_VisualShaderNodeTextureParameter_constant_FILTER_MAX:
+
+enum **TextureFilter**:
+
+- **FILTER_DEFAULT** = **0**
+
+- **FILTER_NEAREST** = **1**
+
+- **FILTER_LINEAR** = **2**
+
+- **FILTER_NEAREST_MIPMAP** = **3**
+
+- **FILTER_LINEAR_MIPMAP** = **4**
+
+- **FILTER_NEAREST_MIPMAP_ANISOTROPIC** = **5**
+
+- **FILTER_LINEAR_MIPMAP_ANISOTROPIC** = **6**
+
+- **FILTER_MAX** = **7** --- Represents the size of the :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` enum.
+
+----
+
+.. _enum_VisualShaderNodeTextureParameter_TextureRepeat:
+
+.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_DEFAULT:
+
+.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_ENABLED:
+
+.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_DISABLED:
+
+.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_MAX:
+
+enum **TextureRepeat**:
+
+- **REPEAT_DEFAULT** = **0**
+
+- **REPEAT_ENABLED** = **1**
+
+- **REPEAT_DISABLED** = **2**
+
+- **REPEAT_MAX** = **3** --- Represents the size of the :ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` enum.
+
+Property Descriptions
+---------------------
+
+.. _class_VisualShaderNodeTextureParameter_property_color_default:
+
+- :ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` **color_default**
+
++-----------+--------------------------+
+| *Default* | ``0``                    |
++-----------+--------------------------+
+| *Setter*  | set_color_default(value) |
++-----------+--------------------------+
+| *Getter*  | get_color_default()      |
++-----------+--------------------------+
+
+Sets the default color if no texture is assigned to the uniform.
+
+----
+
+.. _class_VisualShaderNodeTextureParameter_property_texture_filter:
+
+- :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **texture_filter**
+
++-----------+---------------------------+
+| *Default* | ``0``                     |
++-----------+---------------------------+
+| *Setter*  | set_texture_filter(value) |
++-----------+---------------------------+
+| *Getter*  | get_texture_filter()      |
++-----------+---------------------------+
+
+Sets the texture filtering mode. See :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` for options.
+
+----
+
+.. _class_VisualShaderNodeTextureParameter_property_texture_repeat:
+
+- :ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` **texture_repeat**
+
++-----------+---------------------------+
+| *Default* | ``0``                     |
++-----------+---------------------------+
+| *Setter*  | set_texture_repeat(value) |
++-----------+---------------------------+
+| *Getter*  | get_texture_repeat()      |
++-----------+---------------------------+
+
+Sets the texture repeating mode. See :ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` for options.
+
+----
+
+.. _class_VisualShaderNodeTextureParameter_property_texture_type:
+
+- :ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` **texture_type**
+
++-----------+-------------------------+
+| *Default* | ``0``                   |
++-----------+-------------------------+
+| *Setter*  | set_texture_type(value) |
++-----------+-------------------------+
+| *Getter*  | get_texture_type()      |
++-----------+-------------------------+
+
+Defines the type of data provided by the source texture. See :ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` for options.
+
+.. |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.)`