summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-05-22 12:16:32 +0200
committerGitHub <noreply@github.com>2019-05-22 12:16:32 +0200
commit02bc82f9be11a89f474a384652796fd5d8103741 (patch)
treecaf3e41776ed7f8b4aba2e7b02e14edfd543b957 /doc
parent5fa3204008cffb2c69e3f17a18babe441d704b3d (diff)
parentf8a9844d804252fc3c887c26a846508a88c85bb9 (diff)
Merge pull request #29022 from mrcdk/preview_generator_fixes
Add some extra functions to EditorResourcePreviewGenerator
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/EditorResourcePreviewGenerator.xml16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml
index 6592ffd1a8..76b9445933 100644
--- a/doc/classes/EditorResourcePreviewGenerator.xml
+++ b/doc/classes/EditorResourcePreviewGenerator.xml
@@ -9,6 +9,14 @@
<tutorials>
</tutorials>
<methods>
+ <method name="can_generate_small_preview" qualifiers="virtual">
+ <return type="bool">
+ </return>
+ <description>
+ If this function returns true the generator will call [method generate] or [method generate_from_path] for small previews too.
+ By default it returns false.
+ </description>
+ </method>
<method name="generate" qualifiers="virtual">
<return type="Texture">
</return>
@@ -35,6 +43,14 @@
Care must be taken because this function is always called from a thread (not the main thread).
</description>
</method>
+ <method name="generate_small_preview_automatically" qualifiers="virtual">
+ <return type="bool">
+ </return>
+ <description>
+ If this function returns true the generator will automatically generate the small previews from the normal preview texture generated by the methods [method generate] or [method generate_from_path].
+ By default it returns false.
+ </description>
+ </method>
<method name="handles" qualifiers="virtual">
<return type="bool">
</return>