Documentation
¶
Overview ¶
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.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsCanvasTexture() Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
- func (self *Extension[T]) AsResource() Resource.Instance
- func (self *Extension[T]) AsTexture() Texture.Instance
- func (self *Extension[T]) AsTexture2D() Texture2D.Instance
- type ID
- type Instance
- func (self Instance) AsCanvasTexture() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsTexture() Texture.Instance
- func (self Instance) AsTexture2D() Texture2D.Instance
- func (self Instance) DiffuseTexture() Texture2D.Instance
- func (self Instance) ID() ID
- func (self Instance) NormalTexture() Texture2D.Instance
- func (self Instance) SetDiffuseTexture(value Texture2D.Instance)
- func (self Instance) SetNormalTexture(value Texture2D.Instance)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetSpecularColor(value Color.RGBA)
- func (self Instance) SetSpecularShininess(value Float.X)
- func (self Instance) SetSpecularTexture(value Texture2D.Instance)
- func (self Instance) SetTextureFilter(value CanvasItem.TextureFilter)
- func (self Instance) SetTextureRepeat(value CanvasItem.TextureRepeat)
- func (self Instance) SpecularColor() Color.RGBA
- func (self Instance) SpecularShininess() Float.X
- func (self Instance) SpecularTexture() Texture2D.Instance
- func (self Instance) TextureFilter() CanvasItem.TextureFilter
- func (self Instance) TextureRepeat() CanvasItem.TextureRepeat
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsCanvasTexture ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsTexture2D ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.CanvasTexture
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsCanvasTexture ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsTexture2D ¶
func (Instance) DiffuseTexture ¶
The diffuse (color) texture to use. This is the main texture you want to set in most cases.
func (Instance) NormalTexture ¶
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.
func (Instance) SetDiffuseTexture ¶
SetDiffuseTexture sets the property returned by [GetDiffuseTexture].
func (Instance) SetNormalTexture ¶
SetNormalTexture sets the property returned by [GetNormalTexture].
func (Instance) SetSpecularColor ¶
SetSpecularColor sets the property returned by [GetSpecularColor].
func (Instance) SetSpecularShininess ¶
SetSpecularShininess sets the property returned by [GetSpecularShininess].
func (Instance) SetSpecularTexture ¶
SetSpecularTexture sets the property returned by [GetSpecularTexture].
func (Instance) SetTextureFilter ¶
func (self Instance) SetTextureFilter(value CanvasItem.TextureFilter)
SetTextureFilter sets the property returned by [GetTextureFilter].
func (Instance) SetTextureRepeat ¶
func (self Instance) SetTextureRepeat(value CanvasItem.TextureRepeat)
SetTextureRepeat sets the property returned by [GetTextureRepeat].
func (Instance) SpecularColor ¶
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.
func (Instance) SpecularShininess ¶
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.
func (Instance) SpecularTexture ¶
The specular map to use for Light2D specular reflections. This should be a grayscale or colored texture, with brighter areas resulting in a higher SpecularShininess value. Using a colored SpecularTexture allows controlling specular shininess on a per-channel basis. Only has a visible effect if Light2Ds are affecting this CanvasTexture.
func (Instance) TextureFilter ¶
func (self Instance) TextureFilter() CanvasItem.TextureFilter
The texture filtering mode to use when drawing this CanvasTexture.
func (Instance) TextureRepeat ¶
func (self Instance) TextureRepeat() CanvasItem.TextureRepeat
The texture repeat mode to use when drawing this CanvasTexture.
Source Files