ImageTexture

Overview ¶

A Texture2D based on an Image. For an image to be displayed, an ImageTexture has to be created from it using the CreateFromImage method:

package main

import (
	"graphics.gd/classdb/Image"
	"graphics.gd/classdb/ImageTexture"
	"graphics.gd/classdb/Sprite2D"
)

func ExampleImageTexture(sprite Sprite2D.Instance) {
	var image = Image.LoadFromFile("res://icon.svg")
	var texture = ImageTexture.CreateFromImage(image)
	sprite.SetTexture(texture.AsTexture2D())
}

This way, textures can be created at run-time by loading images both from within the editor and externally.

Warning: Prefer to load imported textures with @GDScript.Load over loading them from within the filesystem dynamically with Image.Load, as it may not work in exported projects:

package main

import (
	"graphics.gd/classdb/Resource"
	"graphics.gd/classdb/Sprite2D"
	"graphics.gd/classdb/Texture2D"
)

func ExampleLoadImageTexture(sprite Sprite2D.Instance) {
	var texture = Resource.Load[Texture2D.Instance]("res://icon.svg")
	sprite.SetTexture(texture.AsTexture2D())
}

This is because images have to be imported as a CompressedTexture2D first to be loaded with @GDScript.Load. If you'd still like to load an image file just like any other Resource, import it as an Image resource instead, and then load it normally using the @GDScript.Load method.

Note: The image can be retrieved from an imported texture using the Texture2D.GetImage method, which returns a copy of the image:

package main

import (
	"graphics.gd/classdb/Resource"
	"graphics.gd/classdb/Sprite2D"
	"graphics.gd/classdb/Texture2D"
)

func ExampleLoadImage(sprite Sprite2D.Instance) {
	var texture = Resource.Load[Texture2D.Instance]("res://icon.svg")
	var image = texture.GetImage()
	_ = image
}

An ImageTexture is not meant to be operated from within the editor interface directly, and is mostly useful for rendering images on screen dynamically via code. If you need to generate images procedurally from within the editor, consider saving and importing images as custom texture resources implementing a new EditorImportPlugin.

Note: The maximum texture size is 16384×16384 pixels due to graphics hardware limitations.