godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
classes/class_editorresourcepreviewgenerator.rst
View File

@@ -14,42 +14,61 @@ EditorResourcePreviewGenerator
Custom generator of previews.
.. rst-class:: classref-introduction-group
Description
-----------
Custom code to generate previews. Please check ``file_dialog/thumbnail_size`` in :ref:`EditorSettings<class_EditorSettings>` to find out the right size to do previews at.
.. rst-class:: classref-reftable-group
Methods
-------
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_can_generate_small_preview<class_EditorResourcePreviewGenerator_method__can_generate_small_preview>` **(** **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`_generate<class_EditorResourcePreviewGenerator_method__generate>` **(** :ref:`Resource<class_Resource>` resource, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`_generate_from_path<class_EditorResourcePreviewGenerator_method__generate_from_path>` **(** :ref:`String<class_String>` path, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_generate_small_preview_automatically<class_EditorResourcePreviewGenerator_method__generate_small_preview_automatically>` **(** **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_handles<class_EditorResourcePreviewGenerator_method__handles>` **(** :ref:`String<class_String>` type **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table::
:widths: auto
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_can_generate_small_preview<class_EditorResourcePreviewGenerator_method__can_generate_small_preview>` **(** **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`_generate<class_EditorResourcePreviewGenerator_method__generate>` **(** :ref:`Resource<class_Resource>` resource, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`_generate_from_path<class_EditorResourcePreviewGenerator_method__generate_from_path>` **(** :ref:`String<class_String>` path, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_generate_small_preview_automatically<class_EditorResourcePreviewGenerator_method__generate_small_preview_automatically>` **(** **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_handles<class_EditorResourcePreviewGenerator_method__handles>` **(** :ref:`String<class_String>` type **)** |virtual| |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_EditorResourcePreviewGenerator_method__can_generate_small_preview:
- :ref:`bool<class_bool>` **_can_generate_small_preview** **(** **)** |virtual| |const|
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_can_generate_small_preview** **(** **)** |virtual| |const|
If this function returns ``true``, the generator will call :ref:`_generate<class_EditorResourcePreviewGenerator_method__generate>` or :ref:`_generate_from_path<class_EditorResourcePreviewGenerator_method__generate_from_path>` for small previews as well.
By default, it returns ``false``.
.. rst-class:: classref-item-separator
----
.. _class_EditorResourcePreviewGenerator_method__generate:
- :ref:`Texture2D<class_Texture2D>` **_generate** **(** :ref:`Resource<class_Resource>` resource, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const|
.. rst-class:: classref-method
:ref:`Texture2D<class_Texture2D>` **_generate** **(** :ref:`Resource<class_Resource>` resource, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const|
Generate a preview from a given resource with the specified size. This must always be implemented.
@@ -57,11 +76,15 @@ Returning an empty texture is an OK way to fail and let another generator take c
Care must be taken because this function is always called from a thread (not the main thread).
.. rst-class:: classref-item-separator
----
.. _class_EditorResourcePreviewGenerator_method__generate_from_path:
- :ref:`Texture2D<class_Texture2D>` **_generate_from_path** **(** :ref:`String<class_String>` path, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const|
.. rst-class:: classref-method
:ref:`Texture2D<class_Texture2D>` **_generate_from_path** **(** :ref:`String<class_String>` path, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const|
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call :ref:`_generate<class_EditorResourcePreviewGenerator_method__generate>`.
@@ -69,21 +92,29 @@ Returning an empty texture is an OK way to fail and let another generator take c
Care must be taken because this function is always called from a thread (not the main thread).
.. rst-class:: classref-item-separator
----
.. _class_EditorResourcePreviewGenerator_method__generate_small_preview_automatically:
- :ref:`bool<class_bool>` **_generate_small_preview_automatically** **(** **)** |virtual| |const|
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_generate_small_preview_automatically** **(** **)** |virtual| |const|
If this function returns ``true``, the generator will automatically generate the small previews from the normal preview texture generated by the methods :ref:`_generate<class_EditorResourcePreviewGenerator_method__generate>` or :ref:`_generate_from_path<class_EditorResourcePreviewGenerator_method__generate_from_path>`.
By default, it returns ``false``.
.. rst-class:: classref-item-separator
----
.. _class_EditorResourcePreviewGenerator_method__handles:
- :ref:`bool<class_bool>` **_handles** **(** :ref:`String<class_String>` type **)** |virtual| |const|
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_handles** **(** :ref:`String<class_String>` type **)** |virtual| |const|
Returns ``true`` if your generator supports the resource of type ``type``.