.. 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/docs/gdscript/doc/classes/Decal.xml. .. _class_Decal: Decal ===== **Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`albedo_mix` | ``1.0`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`cull_mask` | ``1048575`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_begin` | ``40.0`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`distance_fade_enabled` | ``false`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_length` | ``10.0`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`emission_energy` | ``1.0`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`lower_fade` | ``0.3`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`modulate` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`normal_fade` | ``0.0`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`Vector3` | :ref:`size` | ``Vector3(2, 2, 2)`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`texture_albedo` | | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`texture_emission` | | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`texture_normal` | | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`texture_orm` | | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`upper_fade` | ``0.3`` | +-----------------------------------+--------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_texture` **(** :ref:`DecalTexture` type **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Decal_DecalTexture: .. rst-class:: classref-enumeration enum **DecalTexture**: .. _class_Decal_constant_TEXTURE_ALBEDO: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **TEXTURE_ALBEDO** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Decal_constant_TEXTURE_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **TEXTURE_NORMAL** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Decal_constant_TEXTURE_ORM: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **TEXTURE_ORM** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Decal_constant_TEXTURE_EMISSION: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **TEXTURE_EMISSION** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Decal_constant_TEXTURE_MAX: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **TEXTURE_MAX** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Decal_property_albedo_mix: .. rst-class:: classref-property :ref:`float` **albedo_mix** = ``1.0`` .. rst-class:: classref-property-setget - void **set_albedo_mix** **(** :ref:`float` value **)** - :ref:`float` **get_albedo_mix** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_cull_mask: .. rst-class:: classref-property :ref:`int` **cull_mask** = ``1048575`` .. rst-class:: classref-property-setget - void **set_cull_mask** **(** :ref:`int` value **)** - :ref:`int` **get_cull_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_distance_fade_begin: .. rst-class:: classref-property :ref:`float` **distance_fade_begin** = ``40.0`` .. rst-class:: classref-property-setget - void **set_distance_fade_begin** **(** :ref:`float` value **)** - :ref:`float` **get_distance_fade_begin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_distance_fade_enabled: .. rst-class:: classref-property :ref:`bool` **distance_fade_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_enable_distance_fade** **(** :ref:`bool` value **)** - :ref:`bool` **is_distance_fade_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_distance_fade_length: .. rst-class:: classref-property :ref:`float` **distance_fade_length** = ``10.0`` .. rst-class:: classref-property-setget - void **set_distance_fade_length** **(** :ref:`float` value **)** - :ref:`float` **get_distance_fade_length** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_emission_energy: .. rst-class:: classref-property :ref:`float` **emission_energy** = ``1.0`` .. rst-class:: classref-property-setget - void **set_emission_energy** **(** :ref:`float` value **)** - :ref:`float` **get_emission_energy** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_lower_fade: .. rst-class:: classref-property :ref:`float` **lower_fade** = ``0.3`` .. rst-class:: classref-property-setget - void **set_lower_fade** **(** :ref:`float` value **)** - :ref:`float` **get_lower_fade** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_modulate: .. rst-class:: classref-property :ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` .. rst-class:: classref-property-setget - void **set_modulate** **(** :ref:`Color` value **)** - :ref:`Color` **get_modulate** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_normal_fade: .. rst-class:: classref-property :ref:`float` **normal_fade** = ``0.0`` .. rst-class:: classref-property-setget - void **set_normal_fade** **(** :ref:`float` value **)** - :ref:`float` **get_normal_fade** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_size: .. rst-class:: classref-property :ref:`Vector3` **size** = ``Vector3(2, 2, 2)`` .. rst-class:: classref-property-setget - void **set_size** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_texture_albedo: .. rst-class:: classref-property :ref:`Texture2D` **texture_albedo** .. rst-class:: classref-property-setget - void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** - :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_texture_emission: .. rst-class:: classref-property :ref:`Texture2D` **texture_emission** .. rst-class:: classref-property-setget - void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** - :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_texture_normal: .. rst-class:: classref-property :ref:`Texture2D` **texture_normal** .. rst-class:: classref-property-setget - void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** - :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_texture_orm: .. rst-class:: classref-property :ref:`Texture2D` **texture_orm** .. rst-class:: classref-property-setget - void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** - :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_property_upper_fade: .. rst-class:: classref-property :ref:`float` **upper_fade** = ``0.3`` .. rst-class:: classref-property-setget - void **set_upper_fade** **(** :ref:`float` value **)** - :ref:`float` **get_upper_fade** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Decal_method_get_texture: .. rst-class:: classref-method :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Decal_method_set_texture: .. rst-class:: classref-method void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`