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, String receiver_func, Variant userdata )
void	queue_resource_preview ( String path, Object receiver, String 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, String receiver_func, Variant userdata )

Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.

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

Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.

void remove_preview_generator ( EditorResourcePreviewGenerator generator )

Removes a custom preview generator.