mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
336 lines
12 KiB
ReStructuredText
336 lines
12 KiB
ReStructuredText
: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.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Performs a lookup operation on the texture provided as a uniform for the shader.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+
|
|
| :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`` |
|
|
+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualShaderNodeTextureParameter_TextureType:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **TextureType**:
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_TYPE_DATA:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` **TYPE_DATA** = ``0``
|
|
|
|
No hints are added to the uniform declaration.
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_TYPE_COLOR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` **TYPE_COLOR** = ``1``
|
|
|
|
Adds ``source_color`` as hint to the uniform declaration for proper sRGB to linear conversion.
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_TYPE_NORMAL_MAP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` **TYPE_NORMAL_MAP** = ``2``
|
|
|
|
Adds ``hint_normal`` as hint to the uniform declaration, which internally converts the texture for proper usage as normal map.
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_TYPE_ANISOTROPY:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` **TYPE_ANISOTROPY** = ``3``
|
|
|
|
Adds ``hint_anisotropy`` as hint to the uniform declaration to use for a flowmap.
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_TYPE_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` **TYPE_MAX** = ``4``
|
|
|
|
Represents the size of the :ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` enum.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _enum_VisualShaderNodeTextureParameter_ColorDefault:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **ColorDefault**:
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_WHITE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` **COLOR_DEFAULT_WHITE** = ``0``
|
|
|
|
Defaults to fully opaque white color.
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_BLACK:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` **COLOR_DEFAULT_BLACK** = ``1``
|
|
|
|
Defaults to fully opaque black color.
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_TRANSPARENT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` **COLOR_DEFAULT_TRANSPARENT** = ``2``
|
|
|
|
Defaults to fully transparent black color.
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` **COLOR_DEFAULT_MAX** = ``3``
|
|
|
|
Represents the size of the :ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` enum.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _enum_VisualShaderNodeTextureParameter_TextureFilter:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **TextureFilter**:
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_FILTER_DEFAULT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_DEFAULT** = ``0``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_NEAREST** = ``1``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_LINEAR** = ``2``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_NEAREST_MIPMAP** = ``3``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_LINEAR_MIPMAP** = ``4``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP_ANISOTROPIC:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_NEAREST_MIPMAP_ANISOTROPIC** = ``5``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP_ANISOTROPIC:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_LINEAR_MIPMAP_ANISOTROPIC** = ``6``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_FILTER_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_MAX** = ``7``
|
|
|
|
Represents the size of the :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` enum.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _enum_VisualShaderNodeTextureParameter_TextureRepeat:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **TextureRepeat**:
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_DEFAULT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` **REPEAT_DEFAULT** = ``0``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_ENABLED:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` **REPEAT_ENABLED** = ``1``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_DISABLED:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` **REPEAT_DISABLED** = ``2``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` **REPEAT_MAX** = ``3``
|
|
|
|
Represents the size of the :ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` enum.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_property_color_default:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` **color_default** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_color_default** **(** :ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` value **)**
|
|
- :ref:`ColorDefault<enum_VisualShaderNodeTextureParameter_ColorDefault>` **get_color_default** **(** **)**
|
|
|
|
Sets the default color if no texture is assigned to the uniform.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_property_texture_filter:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **texture_filter** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_texture_filter** **(** :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` value **)**
|
|
- :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **get_texture_filter** **(** **)**
|
|
|
|
Sets the texture filtering mode. See :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` for options.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_property_texture_repeat:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` **texture_repeat** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_texture_repeat** **(** :ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` value **)**
|
|
- :ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` **get_texture_repeat** **(** **)**
|
|
|
|
Sets the texture repeating mode. See :ref:`TextureRepeat<enum_VisualShaderNodeTextureParameter_TextureRepeat>` for options.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeTextureParameter_property_texture_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` **texture_type** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_texture_type** **(** :ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` value **)**
|
|
- :ref:`TextureType<enum_VisualShaderNodeTextureParameter_TextureType>` **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.)`
|