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.
Checking the stable version of the documentation...
EditorResourcePreviewGenerator
Hérite de : RefCounted < Object
Générateur personnalisé d'aperçus.
Description
Code personnalisé pour générer des aperçus. Verifiez EditorSettings.filesystem/file_dialog/thumbnail_size pour trouver une taille correcte à laquelle générer des aperçus.
Méthodes
_can_generate_small_preview() virtual const |
|
_generate(resource: Resource, size: Vector2i, metadata: Dictionary) virtual required const |
|
_generate_from_path(path: String, size: Vector2i, metadata: Dictionary) virtual const |
|
_generate_small_preview_automatically() virtual const |
|
void |
request_draw_and_wait(viewport: RID) const |
Descriptions des méthodes
bool _can_generate_small_preview() virtual const 🔗
If this function returns true, the generator will call _generate() or _generate_from_path() for small previews as well.
By default, it returns false.
Texture2D _generate(resource: Resource, size: Vector2i, metadata: Dictionary) virtual required const 🔗
Génère un aperçu d'une ressource donnée avec la taille spécifiée. Cette méthode doit toujours être implémenté.
Retourner null est une bonne façon de signaler un échec et laisser un autre générateur s'occuper de l'aperçu.
Cette opération nécessite de prendre des précautions car cette fonction est toujours appelée à partir d'un fil d'exécution qui n'est pas le principal.
Le dictionnaire metadata peut être modifié pour stocker des méta-data spécifiques au fichier, qui peuvent être utilisées dans EditorResourceTooltipPlugin._make_tooltip_for_path() (comme la taille des images la longueur d'échantillonnage, etc.).
Texture2D _generate_from_path(path: String, size: Vector2i, metadata: Dictionary) virtual const 🔗
Génère un aperçu directement à partir d'un chemin avec la taille spécifiée. L'implémentation est facultative, car le code par défaut va charger et appeler _generate().
Retourner null est une bonne façon de signaler un échec et laisser un autre générateur s'occuper de l'aperçu.
Cette méthode nécessite de prendre des précautions car cette fonction est toujours appelée à partir d'un fil d'exécution qui n'est pas le principal.
Le dictionnaire metadata peut être modifié pour stocker des méta-datas spécifiques au fichier, pouvant être utilisées dans EditorResourceTooltipPlugin._make_tooltip_for_path() (comme la taille de l'image, la longueur d'échantillonnage etc.).
bool _generate_small_preview_automatically() virtual const 🔗
If this function returns true, the generator will automatically generate the small previews from the normal preview texture generated by the methods _generate() or _generate_from_path().
By default, it returns false.
bool _handles(type: String) virtual required const 🔗
Retourne true si votre générateur supporte les ressources du type type.
void request_draw_and_wait(viewport: RID) const 🔗
Call from within _generate() to request the rendering server draw to the viewport.