Attention: Here be dragons (unstable version)

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

CompressedTexture3D

Inherits: Texture3D < Texture < Resource < RefCounted < Object

Texture with 3 dimensions, optionally compressed.

Description

CompressedTexture3D is the VRAM-compressed counterpart of ImageTexture3D. The file extension for CompressedTexture3D files is .ctex3d. This file format is internal to Redot; it is created by importing other image formats with the import system.

CompressedTexture3D uses VRAM compression, which allows to reduce memory usage on the GPU when rendering the texture. This also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.

See Texture3D for a general description of 3D textures.

Properties

String

load_path

""

Methods

Error

load(path: String)

Property Descriptions

String load_path = "" 🔗

Error load(path: String)
String get_load_path()

The CompressedTexture3D's file path to a .ctex3d file.

Method Descriptions

Error load(path: String) 🔗

Loads the texture from the specified path.