mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
160 lines
9.9 KiB
ReStructuredText
160 lines
9.9 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/CanvasTexture.xml.
|
|
|
|
.. _class_CanvasTexture:
|
|
|
|
CanvasTexture
|
|
=============
|
|
|
|
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Texture with optional normal and specular maps for use in 2D rendering.
|
|
|
|
Description
|
|
-----------
|
|
|
|
``CanvasTexture`` is an alternative to :ref:`ImageTexture<class_ImageTexture>` for 2D rendering. It allows using normal maps and specular maps in any node that inherits from :ref:`CanvasItem<class_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 rendering. For physically-based materials in 3D, use :ref:`BaseMaterial3D<class_BaseMaterial3D>` instead.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`diffuse_texture<class_CanvasTexture_property_diffuse_texture>` | |
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`normal_texture<class_CanvasTexture_property_normal_texture>` | |
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`specular_color<class_CanvasTexture_property_specular_color>` | ``Color(1, 1, 1, 1)`` |
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`specular_shininess<class_CanvasTexture_property_specular_shininess>` | ``1.0`` |
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`specular_texture<class_CanvasTexture_property_specular_texture>` | |
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` | :ref:`texture_filter<class_CanvasTexture_property_texture_filter>` | ``0`` |
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` | :ref:`texture_repeat<class_CanvasTexture_property_texture_repeat>` | ``0`` |
|
|
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CanvasTexture_property_diffuse_texture:
|
|
|
|
- :ref:`Texture2D<class_Texture2D>` **diffuse_texture**
|
|
|
|
+----------+----------------------------+
|
|
| *Setter* | set_diffuse_texture(value) |
|
|
+----------+----------------------------+
|
|
| *Getter* | get_diffuse_texture() |
|
|
+----------+----------------------------+
|
|
|
|
The diffuse (color) texture to use. This is the main texture you want to set in most cases.
|
|
|
|
----
|
|
|
|
.. _class_CanvasTexture_property_normal_texture:
|
|
|
|
- :ref:`Texture2D<class_Texture2D>` **normal_texture**
|
|
|
|
+----------+---------------------------+
|
|
| *Setter* | set_normal_texture(value) |
|
|
+----------+---------------------------+
|
|
| *Getter* | get_normal_texture() |
|
|
+----------+---------------------------+
|
|
|
|
The normal map texture to use. Only has a visible effect if :ref:`Light2D<class_Light2D>`\ s are affecting this ``CanvasTexture``.
|
|
|
|
\ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page <http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates>`__ for a comparison of normal map coordinates expected by popular engines.
|
|
|
|
----
|
|
|
|
.. _class_CanvasTexture_property_specular_color:
|
|
|
|
- :ref:`Color<class_Color>` **specular_color**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``Color(1, 1, 1, 1)`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_specular_color(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | get_specular_color() |
|
|
+-----------+---------------------------+
|
|
|
|
The multiplier for specular reflection colors. The :ref:`Light2D<class_Light2D>`'s color is also taken into account when determining the reflection color. Only has a visible effect if :ref:`Light2D<class_Light2D>`\ s are affecting this ``CanvasTexture``.
|
|
|
|
----
|
|
|
|
.. _class_CanvasTexture_property_specular_shininess:
|
|
|
|
- :ref:`float<class_float>` **specular_shininess**
|
|
|
|
+-----------+-------------------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+-------------------------------+
|
|
| *Setter* | set_specular_shininess(value) |
|
|
+-----------+-------------------------------+
|
|
| *Getter* | get_specular_shininess() |
|
|
+-----------+-------------------------------+
|
|
|
|
The specular exponent for :ref:`Light2D<class_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<class_Light2D>`\ s are affecting this ``CanvasTexture``.
|
|
|
|
----
|
|
|
|
.. _class_CanvasTexture_property_specular_texture:
|
|
|
|
- :ref:`Texture2D<class_Texture2D>` **specular_texture**
|
|
|
|
+----------+-----------------------------+
|
|
| *Setter* | set_specular_texture(value) |
|
|
+----------+-----------------------------+
|
|
| *Getter* | get_specular_texture() |
|
|
+----------+-----------------------------+
|
|
|
|
The specular map to use for :ref:`Light2D<class_Light2D>` specular reflections. This should be a grayscale or colored texture, with brighter areas resulting in a higher :ref:`specular_shininess<class_CanvasTexture_property_specular_shininess>` value. Using a colored :ref:`specular_texture<class_CanvasTexture_property_specular_texture>` allows controlling specular shininess on a per-channel basis. Only has a visible effect if :ref:`Light2D<class_Light2D>`\ s are affecting this ``CanvasTexture``.
|
|
|
|
----
|
|
|
|
.. _class_CanvasTexture_property_texture_filter:
|
|
|
|
- :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **texture_filter**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_texture_filter(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | get_texture_filter() |
|
|
+-----------+---------------------------+
|
|
|
|
The texture filtering mode to use when drawing this ``CanvasTexture``.
|
|
|
|
----
|
|
|
|
.. _class_CanvasTexture_property_texture_repeat:
|
|
|
|
- :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **texture_repeat**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_texture_repeat(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | 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.)`
|
|
.. |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.)`
|