mirror of
https://github.com/godotengine/godot.git
synced 2024-12-09 10:09:20 +08:00
49 lines
1.7 KiB
XML
49 lines
1.7 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
|
||
|
|
<brief_description>
|
||
|
|
Custom generator of previews.
|
||
|
|
</brief_description>
|
||
|
|
<description>
|
||
|
|
Custom code to generate previews. Please check "file_dialog/thumbnail_size" in EditorSettings to find out the right size to do previews at.
|
||
|
|
</description>
|
||
|
|
<tutorials>
|
||
|
|
</tutorials>
|
||
|
|
<demos>
|
||
|
|
</demos>
|
||
|
|
<methods>
|
||
|
|
<method name="generate" qualifiers="virtual">
|
||
|
|
<return type="Texture">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="from" type="Resource">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Generate a preview from a given resource. This must be always implemented.
|
||
|
|
Returning an empty texture is an OK way to fail and let another generator take care.
|
||
|
|
Care must be taken because this function is always called from a thread (not the main thread).
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="generate_from_path" qualifiers="virtual">
|
||
|
|
<return type="Texture">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="path" type="String">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Generate a preview directly from a path, implementing this is optional, as default code will load and call generate()
|
||
|
|
Returning an empty texture is an OK way to fail and let another generator take care.
|
||
|
|
Care must be taken because this function is always called from a thread (not the main thread).
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="handles" qualifiers="virtual">
|
||
|
|
<return type="bool">
|
||
|
|
</return>
|
||
|
|
<argument index="0" name="type" type="String">
|
||
|
|
</argument>
|
||
|
|
<description>
|
||
|
|
Return if your generator supports this resource type.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
</methods>
|
||
|
|
<constants>
|
||
|
|
</constants>
|
||
|
|
</class>
|