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.

EditorResourcePreviewGenerator

Успадковує: RefCounted < Object

Призначений для користувача генератор попереднього перегляду.

Опис

Спеціальний код для створення попереднього перегляду. Перевірте EditorSettings.filesystem/file_dialog/thumbnail_size, щоб знайти відповідний розмір для створення попереднього перегляду.

Методи

bool

_can_generate_small_preview() virtual const

Texture2D

_generate(resource: Resource, size: Vector2i, metadata: Dictionary) virtual required const

Texture2D

_generate_from_path(path: String, size: Vector2i, metadata: Dictionary) virtual const

bool

_generate_small_preview_automatically() virtual const

bool

_handles(type: String) virtual required const

void

request_draw_and_wait(viewport: RID) const


Описи методів

bool _can_generate_small_preview() virtual const 🔗

Якщо ця функція повертає true, генератор також викличе _generate() або _generate_from_path() для невеликих попередніх переглядів.

За замовчуванням вона повертає false.


Texture2D _generate(resource: Resource, size: Vector2i, metadata: Dictionary) virtual required const 🔗

Створіть попередній перегляд із заданого ресурсу з указаним розміром. Це потрібно завжди виконувати.

Повернення null — це нормальний спосіб вийти з ладу та дозволити іншому генератору подбати про це.

Потрібно бути обережним, оскільки ця функція завжди викликається з потоку (а не основного потоку).

Словник metadata можна змінити для зберігання метаданих файлів, які можна використовувати в EditorResourceTooltipPlugin._make_tooltip_for_path() (наприклад, розмір зображення, довжина зразка тощо).


Texture2D _generate_from_path(path: String, size: Vector2i, metadata: Dictionary) virtual const 🔗

Створіть попередній перегляд безпосередньо з контуру вказаного розміру. Реалізація цього необов’язкова, оскільки код за замовчуванням завантажуватиме та викличе _generate().

Повернення null — це нормальний спосіб вийти з ладу та дозволити іншому генератору подбати про це.

Потрібно бути обережним, оскільки ця функція завжди викликається з потоку (а не основного потоку).

Словник metadata можна змінити для зберігання метаданих файлів, які можна використовувати в EditorResourceTooltipPlugin._make_tooltip_for_path() (наприклад, розмір зображення, довжина зразка тощо).


bool _generate_small_preview_automatically() virtual const 🔗

Якщо ця функція повертає true, генератор автоматично генерує дрібні попередні перегляди з нормальної текстури попереднього перегляду, створеної методами _generate() або _generate_from_path().

За зам овчуванням, він повертає false.


bool _handles(type: String) virtual required const 🔗

Повертає true, якщо ваш генератор підтримує ресурс типу type.


void request_draw_and_wait(viewport: RID) const 🔗

Викличте метод _generate(), щоб запросити відображення сервера рендерингу в області перегляду viewport.