mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
186 lines
7.4 KiB
ReStructuredText
186 lines
7.4 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/VisualShaderNodeCubemap.xml.
|
|
|
|
.. _class_VisualShaderNodeCubemap:
|
|
|
|
VisualShaderNodeCubemap
|
|
=======================
|
|
|
|
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A :ref:`Cubemap<class_Cubemap>` sampling node to be used within the visual shader graph.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Translated to ``texture(cubemap, vec3)`` in the shader language. Returns a color vector and alpha channel as scalar.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+--------------------------------------------------------------+--------------------------------------------------------------------------+-------+
|
|
| :ref:`TextureLayered<class_TextureLayered>` | :ref:`cube_map<class_VisualShaderNodeCubemap_property_cube_map>` | |
|
|
+--------------------------------------------------------------+--------------------------------------------------------------------------+-------+
|
|
| :ref:`Source<enum_VisualShaderNodeCubemap_Source>` | :ref:`source<class_VisualShaderNodeCubemap_property_source>` | ``0`` |
|
|
+--------------------------------------------------------------+--------------------------------------------------------------------------+-------+
|
|
| :ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` | :ref:`texture_type<class_VisualShaderNodeCubemap_property_texture_type>` | ``0`` |
|
|
+--------------------------------------------------------------+--------------------------------------------------------------------------+-------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualShaderNodeCubemap_Source:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Source**: :ref:`🔗<enum_VisualShaderNodeCubemap_Source>`
|
|
|
|
.. _class_VisualShaderNodeCubemap_constant_SOURCE_TEXTURE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Source<enum_VisualShaderNodeCubemap_Source>` **SOURCE_TEXTURE** = ``0``
|
|
|
|
Use the :ref:`Cubemap<class_Cubemap>` set via :ref:`cube_map<class_VisualShaderNodeCubemap_property_cube_map>`. If this is set to :ref:`source<class_VisualShaderNodeCubemap_property_source>`, the ``samplerCube`` port is ignored.
|
|
|
|
.. _class_VisualShaderNodeCubemap_constant_SOURCE_PORT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Source<enum_VisualShaderNodeCubemap_Source>` **SOURCE_PORT** = ``1``
|
|
|
|
Use the :ref:`Cubemap<class_Cubemap>` sampler reference passed via the ``samplerCube`` port. If this is set to :ref:`source<class_VisualShaderNodeCubemap_property_source>`, the :ref:`cube_map<class_VisualShaderNodeCubemap_property_cube_map>` texture is ignored.
|
|
|
|
.. _class_VisualShaderNodeCubemap_constant_SOURCE_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Source<enum_VisualShaderNodeCubemap_Source>` **SOURCE_MAX** = ``2``
|
|
|
|
Represents the size of the :ref:`Source<enum_VisualShaderNodeCubemap_Source>` enum.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _enum_VisualShaderNodeCubemap_TextureType:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **TextureType**: :ref:`🔗<enum_VisualShaderNodeCubemap_TextureType>`
|
|
|
|
.. _class_VisualShaderNodeCubemap_constant_TYPE_DATA:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` **TYPE_DATA** = ``0``
|
|
|
|
No hints are added to the uniform declaration.
|
|
|
|
.. _class_VisualShaderNodeCubemap_constant_TYPE_COLOR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` **TYPE_COLOR** = ``1``
|
|
|
|
Adds ``source_color`` as hint to the uniform declaration for proper conversion from nonlinear sRGB encoding to linear encoding.
|
|
|
|
.. _class_VisualShaderNodeCubemap_constant_TYPE_NORMAL_MAP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeCubemap_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_VisualShaderNodeCubemap_constant_TYPE_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` **TYPE_MAX** = ``3``
|
|
|
|
Represents the size of the :ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` enum.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeCubemap_property_cube_map:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`TextureLayered<class_TextureLayered>` **cube_map** :ref:`🔗<class_VisualShaderNodeCubemap_property_cube_map>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_cube_map**\ (\ value\: :ref:`TextureLayered<class_TextureLayered>`\ )
|
|
- :ref:`TextureLayered<class_TextureLayered>` **get_cube_map**\ (\ )
|
|
|
|
The :ref:`Cubemap<class_Cubemap>` texture to sample when using :ref:`SOURCE_TEXTURE<class_VisualShaderNodeCubemap_constant_SOURCE_TEXTURE>` as :ref:`source<class_VisualShaderNodeCubemap_property_source>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeCubemap_property_source:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Source<enum_VisualShaderNodeCubemap_Source>` **source** = ``0`` :ref:`🔗<class_VisualShaderNodeCubemap_property_source>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_source**\ (\ value\: :ref:`Source<enum_VisualShaderNodeCubemap_Source>`\ )
|
|
- :ref:`Source<enum_VisualShaderNodeCubemap_Source>` **get_source**\ (\ )
|
|
|
|
Defines which source should be used for the sampling.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeCubemap_property_texture_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` **texture_type** = ``0`` :ref:`🔗<class_VisualShaderNodeCubemap_property_texture_type>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_texture_type**\ (\ value\: :ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>`\ )
|
|
- :ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` **get_texture_type**\ (\ )
|
|
|
|
Defines the type of data provided by the source texture.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |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.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|