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.