godot-docs/classes/class_visualshadernodecubemap.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubemap.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _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.

Description
-----------

Translated to ``texture(cubemap, vec3)`` in the shader language. Returns a color vector and alpha channel as scalar.

Properties
----------

+--------------------------------------------------------------+--------------------------------------------------------------------------+-------+
| :ref:`Cubemap<class_Cubemap>`                                | :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`` |
+--------------------------------------------------------------+--------------------------------------------------------------------------+-------+

Enumerations
------------

.. _enum_VisualShaderNodeCubemap_Source:

.. _class_VisualShaderNodeCubemap_constant_SOURCE_TEXTURE:

.. _class_VisualShaderNodeCubemap_constant_SOURCE_PORT:

.. _class_VisualShaderNodeCubemap_constant_SOURCE_MAX:

enum **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.

- **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.

- **SOURCE_MAX** = **2** --- Represents the size of the :ref:`Source<enum_VisualShaderNodeCubemap_Source>` enum.

----

.. _enum_VisualShaderNodeCubemap_TextureType:

.. _class_VisualShaderNodeCubemap_constant_TYPE_DATA:

.. _class_VisualShaderNodeCubemap_constant_TYPE_COLOR:

.. _class_VisualShaderNodeCubemap_constant_TYPE_NORMAL_MAP:

.. _class_VisualShaderNodeCubemap_constant_TYPE_MAX:

enum **TextureType**:

- **TYPE_DATA** = **0** --- No hints are added to the uniform declaration.

- **TYPE_COLOR** = **1** --- Adds ``hint_albedo`` 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_MAX** = **3** --- Represents the size of the :ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` enum.

Property Descriptions
---------------------

.. _class_VisualShaderNodeCubemap_property_cube_map:

- :ref:`Cubemap<class_Cubemap>` **cube_map**

+----------+---------------------+
| *Setter* | set_cube_map(value) |
+----------+---------------------+
| *Getter* | 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>`.

----

.. _class_VisualShaderNodeCubemap_property_source:

- :ref:`Source<enum_VisualShaderNodeCubemap_Source>` **source**

+-----------+-------------------+
| *Default* | ``0``             |
+-----------+-------------------+
| *Setter*  | set_source(value) |
+-----------+-------------------+
| *Getter*  | get_source()      |
+-----------+-------------------+

Defines which source should be used for the sampling. See :ref:`Source<enum_VisualShaderNodeCubemap_Source>` for options.

----

.. _class_VisualShaderNodeCubemap_property_texture_type:

- :ref:`TextureType<enum_VisualShaderNodeCubemap_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_VisualShaderNodeCubemap_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.)`