Attention: Here be dragons

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

CompressedCubemap

Inherits: CompressedTextureLayered < TextureLayered < Texture < Resource < RefCounted < Object

An optionally compressed Cubemap.

Description

A cubemap that is loaded from a .ccube file. This file format is internal to Godot; it is created by importing other image formats with the import system. CompressedCubemap can use one of 4 compression methods:

  • Lossless (WebP or PNG, uncompressed on the GPU)

  • Lossy (WebP, uncompressed on the GPU)

  • VRAM Compressed (compressed on the GPU)

  • VRAM Uncompressed (uncompressed on the GPU)

  • Basis Universal (compressed on the GPU. Lower file sizes than VRAM Compressed, but slower to compress and lower quality than VRAM Compressed)

Only VRAM Compressed actually reduces the memory usage on the GPU. The Lossless and Lossy compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed.

Using VRAM Compressed also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.

See Cubemap for a general description of cubemaps.


User-contributed notes

Please read the User-contributed notes policy before submitting a comment.