PortableCompressedTexture2D

Hérite de : Texture2D < Texture < Resource < RefCounted < Object

Fournit une texture compressée pour le disque et/ou la VRAM d'une manière qui est portable.

Description

This class allows storing compressed textures as self contained (not imported) resources.

For 2D usage (compressed on disk, uncompressed on VRAM), the lossy and lossless modes are recommended. For 3D usage (compressed on VRAM) it depends on the target platform.

If you intend to only use desktop, S3TC or BPTC are recommended. For only mobile, ETC2 is recommended.

For portable, self contained 3D textures that work on both desktop and mobile, Basis Universal is recommended (although it has a small quality cost and longer compression time as a tradeoff).

This resource is intended to be created from code.

Propriétés

bool

keep_compressed_buffer

false

bool

resource_local_to_scene

false (overrides Resource)

Vector2

size_override

Vector2(0, 0)

Méthodes

void

create_from_image(image: Image, compression_mode: CompressionMode, normal_map: bool = false, lossy_quality: float = 0.8)

CompressionMode

get_compression_mode() const

Format

get_format() const

bool

is_keeping_all_compressed_buffers() static

void

set_basisu_compressor_params(uastc_level: int, rdo_quality_loss: float)

void

set_keep_all_compressed_buffers(keep: bool) static

Énumérations

enum CompressionMode: 🔗

CompressionMode COMPRESSION_MODE_LOSSLESS = 0

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_MODE_LOSSY = 1

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_MODE_BASIS_UNIVERSAL = 2

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_MODE_S3TC = 3

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_MODE_ETC2 = 4

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_MODE_BPTC = 5

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_MODE_ASTC = 6

There is currently no description for this enum. Please help us by contributing one!

Descriptions des propriétés

bool keep_compressed_buffer = false 🔗

  • void set_keep_compressed_buffer(value: bool)

  • bool is_keeping_compressed_buffer()

Lors de l'exécution dans l'éditeur, cette classe conservera les données compressées source en mémoire. Sinon, les données compressées source sont perdues après le chargement et la ressource ne peut pas être re-sauvegardée.

Ce drapeau permet de garder les données compressées en mémoire si vous l'avez l'intention de les faire persister après le chargement.

Note : Ceci doit être défini avant create_from_image() pour prendre effet.

Vector2 size_override = Vector2(0, 0) 🔗

Permettre de redéfinir la taille de la texture (en 2D seulement).

Descriptions des méthodes

void create_from_image(image: Image, compression_mode: CompressionMode, normal_map: bool = false, lossy_quality: float = 0.8) 🔗

Initialise la texture compressée à partir d'une image de base. Le mode de compression doit être fourni.

normal_map est recommandé pour assurer une qualité optimale si cette image sera utilisée comme normal map.

Si une compression avec perte est demandée, le réglage de la qualité peut être fourni en option. Cela est associé à la qualité de compression de Lossy WebP.

CompressionMode get_compression_mode() const 🔗

Renvoie le mode de compression utilisé (valide après l'initialisation).

Format get_format() const 🔗

Renvoie le format d'image utilisé (valide après l'initialisation).

bool is_keeping_all_compressed_buffers() static 🔗

Renvoie si le drapeau est redéfini pour toutes les textures de ce type.

void set_basisu_compressor_params(uastc_level: int, rdo_quality_loss: float) 🔗

Définit les paramètres du compresseur pour la compression Basis Universal. Voir aussi les paramètres dans ResourceImporterTexture.

Note : Ceci doit être défini avant create_from_image() pour prendre effet.

void set_keep_all_compressed_buffers(keep: bool) static 🔗

Redéfinit le drapeau globalement pour toutes les textures de ce type. Ceci est utilisé principalement par l'éditeur.