CanvasTexture
Texture with optional normal and specular maps for use in 2D rendering.
CanvasTexture.swift:20class CanvasTexture
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).
Superclasses
class Texture2D
Texture for 2D and 3D.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in
Variant
with no conversion. These include all of the Variant types from Godot (for exampleGString
,Rect
,Plane
), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
var diffuseTexture: Texture2D?
The diffuse (color) texture to use. This is the main texture you want to set in most cases.
var normalTexture: Texture2D?
The normal map texture to use. Only has a visible effect if
Light2D
s are affecting thisCanvasTexture
.var specularColor: 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 ifLight2D
s are affecting thisCanvasTexture
.var specularShininess: Double
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 of1.0
disables specular reflections entirely. Only has a visible effect ifLight2D
s are affecting thisCanvasTexture
.var specularTexture: Texture2D?
The specular map to use for
Light2D
specular reflections. This should be a grayscale or colored texture, with brighter areas resulting in a higherspecularShininess
value. Using a coloredspecularTexture
allows controlling specular shininess on a per-channel basis. Only has a visible effect ifLight2D
s are affecting thisCanvasTexture
.var textureFilter: CanvasItem.TextureFilter
The texture filtering mode to use when drawing this
CanvasTexture
.var textureRepeat: CanvasItem.TextureRepeat
The texture repeat mode to use when drawing this
CanvasTexture
.