Texture2D
Texture for 2D and 3D.
Texture2D.swift:18class Texture2DA texture works by registering an image in the video hardware, which then can be used in 3D models or 2D Sprite2D or GUI Control.
Textures are often created by loading them from a file. See @GDScript.load.
Texture2D is a base for other resources. It cannot be used directly.
Superclasses
class TextureBase class for all texture types.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith 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 VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
func createPlaceholder() -> Resource? Creates a placeholder version of this resource (
PlaceholderTexture2D).func draw(canvasItem: RID, position: Vector2, modulate: Color, transpose: Bool) Draws the texture using a
CanvasItemwith theRenderingServerAPI at the specifiedposition.func drawRect(canvasItem: RID, rect: Rect2, tile: Bool, modulate: Color, transpose: Bool) Draws the texture using a
CanvasItemwith theRenderingServerAPI.func drawRectRegion(canvasItem: RID, rect: Rect2, srcRect: Rect2, modulate: Color, transpose: Bool, clipUv: Bool) Draws a part of the texture using a
CanvasItemwith theRenderingServerAPI.func getHeight() -> Int32 Returns the texture height in pixels.
func getImage() -> Image? Returns an
Imagethat is a copy of data from thisTexture2D(a newImageis created each time).Images can be accessed and manipulated directly.func getSize() -> Vector2 Returns the texture size in pixels.
func getWidth() -> Int32 Returns the texture width in pixels.
func hasAlpha() -> Bool Returns
trueif thisTexture2Dhas an alpha channel.
Show implementation details (7)
Hide implementation details
func _draw(toCanvasItem: RID, pos: Vector2, modulate: Color, transpose: Bool) Called when the entire
Texture2Dis requested to be drawn over aCanvasItem, with the top-left offset specified inpos.modulatespecifies a multiplier for the colors being drawn, whiletransposespecifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation).func _drawRect(toCanvasItem: RID, rect: Rect2, tile: Bool, modulate: Color, transpose: Bool) Called when the
Texture2Dis requested to be drawn ontoCanvasItem’s specifiedrect.modulatespecifies a multiplier for the colors being drawn, whiletransposespecifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation).func _drawRectRegion(toCanvasItem: RID, rect: Rect2, srcRect: Rect2, modulate: Color, transpose: Bool, clipUv: Bool) Called when a part of the
Texture2Dspecified bysrcRect’s coordinates is requested to be drawn ontoCanvasItem’s specifiedrect.modulatespecifies a multiplier for the colors being drawn, whiletransposespecifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation).func _getHeight() -> Int32 Called when the
Texture2D’s height is queried.func _getWidth() -> Int32 Called when the
Texture2D’s width is queried.func _hasAlpha() -> Bool Called when the presence of an alpha channel in the
Texture2Dis queried.func _isPixelOpaque(x: Int32, y: Int32) -> Bool Called when a pixel’s opaque state in the
Texture2Dis queried at the specified(x, y)position.
Subclasses
class AnimatedTextureProxy texture for simple frame-based animations.
class AtlasTextureA texture that crops out part of another Texture2D.
class CameraTextureTexture provided by a
CameraFeed.class CanvasTextureTexture with optional normal and specular maps for use in 2D rendering.
class CompressedTexture2DTexture with 2 dimensions, optionally compressed.
class CurveTextureA 1D texture where pixel brightness corresponds to points on a curve.
class CurveXYZTextureA 1D texture where the red, green, and blue color channels correspond to points on 3 curves.
class GradientTexture1DA 1D texture that uses colors obtained from a
Gradient.class GradientTexture2DA 2D texture that creates a pattern with colors obtained from a
Gradient.class ImageTextureA
Texture2Dbased on anImage.class MeshTextureSimple texture that uses a mesh to draw itself.
class NoiseTexture2DA 2D texture filled with noise generated by a
Noiseobject.class PlaceholderTexture2DPlaceholder class for a 2-dimensional texture.
class PortableCompressedTexture2DProvides a compressed texture for disk and/or VRAM in a way that is portable.
class Texture2DRDTexture for 2D that is bound to a texture created on the
RenderingDevice.class ViewportTextureProvides the content of a
Viewportas a dynamic texture.