:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorResourcePreview.xml. .. _class_EditorResourcePreview: EditorResourcePreview ===================== **Inherits:** :ref:`Node` **<** :ref:`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 :ref:`EditorInterface.get_resource_previewer`. Methods ------- +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorResourcePreview_signal_preview_invalidated: - **preview_invalidated** **(** :ref:`String` path **)** Emitted if a preview was invalidated (changed). ``path`` corresponds to the path of the preview. Method Descriptions ------------------- .. _class_EditorResourcePreview_method_add_preview_generator: - void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Create an own, custom preview generator. ---- .. _class_EditorResourcePreview_method_check_for_invalidation: - void **check_for_invalidation** **(** :ref:`String` path **)** Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. ---- .. _class_EditorResourcePreview_method_queue_edited_resource_preview: - void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`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: :ref:`String` path, :ref:`Texture` preview, :ref:`Texture` thumbnail_preview, :ref:`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. ---- .. _class_EditorResourcePreview_method_queue_resource_preview: - void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`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: :ref:`String` path, :ref:`Texture` preview, :ref:`Texture` thumbnail_preview, :ref:`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. ---- .. _class_EditorResourcePreview_method_remove_preview_generator: - void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Removes a custom preview generator. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`