Table of Contents

Class CanvasTexture

Texture with optional normal and specular maps for use in 2D rendering.

Inheritance
CanvasTexture

Remarks

CanvasTexture is an alternative to ImageTexture for 2D rendering. It allows using normal maps and specular maps in any node that inherits from 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 VisualInstance3D, such as Sprite3D or Decal. For physically-based materials in 3D, use BaseMaterial3D instead.

See Also

2D Lights and Shadows

Properties

diffuse_texture

The diffuse (color) texture to use. This is the main texture you want to set in most cases.

var diffuse_texture : Texture2D

Property Value

Texture2D

Remarks

normal_texture

The normal map texture to use. Only has a visible effect if Light2Ds 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.

var normal_texture : Texture2D

Property Value

Texture2D

Remarks

specular_color

The multiplier for specular reflection colors. The Light2D's color is also taken into account when determining the reflection color. Only has a visible effect if Light2Ds are affecting this CanvasTexture.

var specular_color : Color = Color(1, 1, 1, 1)

Property Value

Color

Remarks

  • void set_specular_color(Color value)
  • Color get_specular_color

specular_shininess

The specular exponent for 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 Light2Ds are affecting this CanvasTexture.

var specular_shininess : float = 1.0

Property Value

float

Remarks

  • void set_specular_shininess(float value)
  • float get_specular_shininess

specular_texture

The specular map to use for Light2D specular reflections. This should be a grayscale or colored texture, with brighter areas resulting in a higher specular_shininess value. Using a colored specular_texture allows controlling specular shininess on a per-channel basis. Only has a visible effect if Light2Ds are affecting this CanvasTexture.

var specular_texture : Texture2D

Property Value

Texture2D

Remarks

texture_filter

The texture filtering mode to use when drawing this CanvasTexture.

var texture_filter : int = 0

Property Value

int

Remarks

  • void set_texture_filter(int value)
  • int get_texture_filter

texture_repeat

The texture repeat mode to use when drawing this CanvasTexture.

var texture_repeat : int = 0

Property Value

int

Remarks

  • void set_texture_repeat(int value)
  • int get_texture_repeat