EditorResourcePreviewGenerator
Hereda: RefCounted < Object
Generador personalizado de vistas previas.
Descripción
Código personalizado para generar vistas previas. Comprueba EditorSettings.filesystem/file_dialog/thumbnail_size para encontrar un tamaño adecuado para generar las vistas previas.
Métodos
_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 |
Descripciones de Métodos
bool _can_generate_small_preview() virtual const 🔗
Si esta función devuelve true, el generador llamará a _generate() o _generate_from_path() también para vistas previas pequeñas.
Por defecto, devuelve false.
Texture2D _generate(resource: Resource, size: Vector2i, metadata: Dictionary) virtual required const 🔗
Generate a preview from a given resource with the specified size. This must always be implemented.
Returning null is an OK way to fail and let another generator take care.
Care must be taken because this function is always called from a thread (not the main thread).
metadata dictionary can be modified to store file-specific metadata that can be used in EditorResourceTooltipPlugin._make_tooltip_for_path() (like image size, sample length etc.).
Texture2D _generate_from_path(path: String, size: Vector2i, metadata: Dictionary) virtual const 🔗
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call _generate().
Returning null is an OK way to fail and let another generator take care.
Care must be taken because this function is always called from a thread (not the main thread).
metadata dictionary can be modified to store file-specific metadata that can be used in EditorResourceTooltipPlugin._make_tooltip_for_path() (like image size, sample length 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 🔗
Returns true if your generator supports the resource of type type.
void request_draw_and_wait(viewport: RID) const 🔗
Call from within _generate() to request the rendering server draw to the viewport.