mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
116 lines
5.0 KiB
ReStructuredText
116 lines
5.0 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeCubeMap.xml.
|
|
|
|
.. _class_VisualShaderNodeCubeMap:
|
|
|
|
VisualShaderNodeCubeMap
|
|
=======================
|
|
|
|
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :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:
|
|
|
|
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.
|
|
|
|
----
|
|
|
|
.. _enum_VisualShaderNodeCubeMap_TextureType:
|
|
|
|
.. _class_VisualShaderNodeCubeMap_constant_TYPE_DATA:
|
|
|
|
.. _class_VisualShaderNodeCubeMap_constant_TYPE_COLOR:
|
|
|
|
.. _class_VisualShaderNodeCubeMap_constant_TYPE_NORMALMAP:
|
|
|
|
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_NORMALMAP** = **2** --- Adds ``hint_normal`` as hint to the uniform declaration, which internally converts the texture for proper usage as normal map.
|
|
|
|
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.)`
|