2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "EditorResourcePreview" inherits= "Node" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2017-10-14 18:45:26 +08:00
Helper to generate previews of resources or files.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
This object is used to generate previews for resources of files.
2020-04-15 04:09:21 +08:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_resource_previewer].
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_preview_generator" >
<return type= "void" >
</return>
<argument index= "0" name= "generator" type= "EditorResourcePreviewGenerator" >
</argument>
<description >
Create an own, custom preview generator.
</description>
</method>
<method name= "check_for_invalidation" >
<return type= "void" >
</return>
<argument index= "0" name= "path" type= "String" >
</argument>
<description >
2019-06-22 07:04:47 +08:00
Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "queue_edited_resource_preview" >
<return type= "void" >
</return>
<argument index= "0" name= "resource" type= "Resource" >
</argument>
<argument index= "1" name= "receiver" type= "Object" >
</argument>
2020-02-22 21:59:09 +08:00
<argument index= "2" name= "receiver_func" type= "StringName" >
2017-09-13 04:42:36 +08:00
</argument>
<argument index= "3" name= "userdata" type= "Variant" >
</argument>
<description >
2017-09-29 05:40:01 +08:00
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.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "queue_resource_preview" >
<return type= "void" >
</return>
<argument index= "0" name= "path" type= "String" >
</argument>
<argument index= "1" name= "receiver" type= "Object" >
</argument>
2020-02-22 21:59:09 +08:00
<argument index= "2" name= "receiver_func" type= "StringName" >
2017-09-13 04:42:36 +08:00
</argument>
<argument index= "3" name= "userdata" type= "Variant" >
</argument>
<description >
2017-09-29 05:40:01 +08:00
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.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "remove_preview_generator" >
<return type= "void" >
</return>
<argument index= "0" name= "generator" type= "EditorResourcePreviewGenerator" >
</argument>
<description >
2019-06-22 07:04:47 +08:00
Removes a custom preview generator.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<signals >
<signal name= "preview_invalidated" >
<argument index= "0" name= "path" type= "String" >
</argument>
<description >
2019-06-22 07:04:47 +08:00
Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview.
2017-09-13 04:42:36 +08:00
</description>
</signal>
</signals>
<constants >
</constants>
</class>
