Class reference
EditorResourcePreview
Inherits Node
A node used to generate previews of resources or files.
Description
This node is used to generate previews for resources or 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)
EditorResourcePreviewGenerator generator)Create an own, custom preview generator.
void check_for_invalidation(String path)
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)
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)
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)
EditorResourcePreviewGenerator generator)Removes a custom preview generator.
Signals
preview_invalidated(String path)
String path)Emitted if a preview was invalidated (changed). path corresponds to the path of the preview.