Attention

You are reading the latest (unstable) version of this documentation, which may document features not available or compatible with Godot 3.x.

Checking the stable version of the documentation...

Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

EditorResourcePreview

Inherits: Node < Object

Helper to generate previews of resources or files.

Description

This object is used to generate previews for resources of files.

Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorInterface.get_resource_previewer.

Methods

void	add_preview_generator ( EditorResourcePreviewGenerator generator )
void	check_for_invalidation ( String path )
void	queue_edited_resource_preview ( Resource resource, Object receiver, StringName receiver_func, Variant userdata )
void	queue_resource_preview ( String path, Object receiver, StringName receiver_func, Variant userdata )
void	remove_preview_generator ( EditorResourcePreviewGenerator generator )

---

Signals

preview_invalidated ( String path )

Emitted if a preview was invalidated (changed). path corresponds to the path of the preview.

---

Method Descriptions

void add_preview_generator ( EditorResourcePreviewGenerator generator )

Create an own, custom preview generator.

---

void check_for_invalidation ( String path )

Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.

---

void queue_edited_resource_preview ( Resource resource, Object receiver, StringName receiver_func, Variant userdata )

Queue the resource being edited for preview. Once the preview is ready, the receiver's receiver_func will be called. The receiver_func must take the following four arguments: String path, Texture2D preview, Texture2D thumbnail_preview, Variant userdata. userdata can be anything, and will be returned when receiver_func is called.

Note: If it was not possible to create the preview the receiver_func will still be called, but the preview will be null.

---

void queue_resource_preview ( String path, Object receiver, StringName receiver_func, Variant userdata )

Queue a resource file located at path for preview. Once the preview is ready, the receiver's receiver_func will be called. The receiver_func must take the following four arguments: String path, Texture2D preview, Texture2D thumbnail_preview, Variant userdata. userdata can be anything, and will be returned when receiver_func is called.

Note: If it was not possible to create the preview the receiver_func will still be called, but the preview will be null.

---

void remove_preview_generator ( EditorResourcePreviewGenerator generator )

Removes a custom preview generator.