godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/EditorResourcePreviewGenera...

51 lines
1.9 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync classref with current source
2019-07-05 09:32:53 +00:00
<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.1.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<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>
<methods>
<method name="generate" qualifiers="virtual">
<return type="Texture">
</return>
<argument index="0" name="from" type="Resource">
</argument>
doc: Sync classref with current source
2018-09-21 07:33:05 +00:00
<argument index="1" name="size" type="Vector2">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
doc: Sync classref with current source
2018-09-21 07:33:05 +00:00
Generate a preview from a given resource with the specified size. This must always be 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).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="generate_from_path" qualifiers="virtual">
<return type="Texture">
</return>
<argument index="0" name="path" type="String">
</argument>
doc: Sync classref with current source
2018-09-21 07:33:05 +00:00
<argument index="1" name="size" type="Vector2">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
doc: Sync classref with current source
2018-09-21 07:33:05 +00:00
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method 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).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="handles" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60)
2019-05-24 02:15:43 +00:00
Returns if your generator supports this resource type.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants>
</constants>
</class>