: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/CanvasTexture.xml. .. _class_CanvasTexture: CanvasTexture ============= **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Texture with optional normal and specular maps for use in 2D rendering. .. rst-class:: classref-introduction-group Description ----------- **CanvasTexture** is an alternative to :ref:`ImageTexture` for 2D rendering. It allows using normal maps and specular maps in any node that inherits from :ref:`CanvasItem`. **CanvasTexture** also allows overriding the texture's filter and repeat mode independently of the node's properties (or the project settings). \ **Note:** **CanvasTexture** cannot be used in 3D. It will not display correctly when applied to any :ref:`VisualInstance3D`, such as :ref:`Sprite3D` or :ref:`Decal`. For physically-based materials in 3D, use :ref:`BaseMaterial3D` instead. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`2D Lights and Shadows <../tutorials/2d/2d_lights_and_shadows>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`diffuse_texture` | | +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`normal_texture` | | +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`specular_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`specular_shininess` | ``1.0`` | +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`specular_texture` | | +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`TextureFilter` | :ref:`texture_filter` | ``0`` | +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`TextureRepeat` | :ref:`texture_repeat` | ``0`` | +-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CanvasTexture_property_diffuse_texture: .. rst-class:: classref-property :ref:`Texture2D` **diffuse_texture** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_diffuse_texture**\ (\ value\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_diffuse_texture**\ (\ ) The diffuse (color) texture to use. This is the main texture you want to set in most cases. .. rst-class:: classref-item-separator ---- .. _class_CanvasTexture_property_normal_texture: .. rst-class:: classref-property :ref:`Texture2D` **normal_texture** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_normal_texture**\ (\ value\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_normal_texture**\ (\ ) The normal map texture to use. Only has a visible effect if :ref:`Light2D`\ s are affecting this **CanvasTexture**. \ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page `__ for a comparison of normal map coordinates expected by popular engines. .. rst-class:: classref-item-separator ---- .. _class_CanvasTexture_property_specular_color: .. rst-class:: classref-property :ref:`Color` **specular_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_specular_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_specular_color**\ (\ ) The multiplier for specular reflection colors. The :ref:`Light2D`'s color is also taken into account when determining the reflection color. Only has a visible effect if :ref:`Light2D`\ s are affecting this **CanvasTexture**. .. rst-class:: classref-item-separator ---- .. _class_CanvasTexture_property_specular_shininess: .. rst-class:: classref-property :ref:`float` **specular_shininess** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_specular_shininess**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_specular_shininess**\ (\ ) The specular exponent for :ref:`Light2D` specular reflections. Higher values result in a more glossy/"wet" look, with reflections becoming more localized and less visible overall. The default value of ``1.0`` disables specular reflections entirely. Only has a visible effect if :ref:`Light2D`\ s are affecting this **CanvasTexture**. .. rst-class:: classref-item-separator ---- .. _class_CanvasTexture_property_specular_texture: .. rst-class:: classref-property :ref:`Texture2D` **specular_texture** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_specular_texture**\ (\ value\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_specular_texture**\ (\ ) The specular map to use for :ref:`Light2D` specular reflections. This should be a grayscale or colored texture, with brighter areas resulting in a higher :ref:`specular_shininess` value. Using a colored :ref:`specular_texture` allows controlling specular shininess on a per-channel basis. Only has a visible effect if :ref:`Light2D`\ s are affecting this **CanvasTexture**. .. rst-class:: classref-item-separator ---- .. _class_CanvasTexture_property_texture_filter: .. rst-class:: classref-property :ref:`TextureFilter` **texture_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) - :ref:`TextureFilter` **get_texture_filter**\ (\ ) The texture filtering mode to use when drawing this **CanvasTexture**. .. rst-class:: classref-item-separator ---- .. _class_CanvasTexture_property_texture_repeat: .. rst-class:: classref-property :ref:`TextureRepeat` **texture_repeat** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_repeat**\ (\ value\: :ref:`TextureRepeat`\ ) - :ref:`TextureRepeat` **get_texture_repeat**\ (\ ) The texture repeat mode to use when drawing this **CanvasTexture**. .. |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.)`