Home Verkennen Help
Inloggen
godotengine
/
godot-docs
spiegel van https://github.com/godotengine/godot-docs
Volgen 1
Ster 1
Vork 0
Bestanden
Boom: 9ffd5f53c4
Aftakkingen Labels
godot-docs
/
classes
/
class_editorresourcepreviewgenerator.rst

class_editorresourcepreviewgenerator.rst 8.7 KB
Geschiedenis Ruwe

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePreviewGenerator.xml.
    7. 

  7. 

  8. .. _class_EditorResourcePreviewGenerator:
    9. 

  9. 

  10. EditorResourcePreviewGenerator
    11. 

  11. ==============================
    12. 

  12. 

  13. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. Custom generator of previews.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. Custom code to generate previews. Check :ref:`EditorSettings.filesystem/file_dialog/thumbnail_size<class_EditorSettings_property_filesystem/file_dialog/thumbnail_size>` to find a proper size to generate previews at.
    23. 

  23. 

  24. .. rst-class:: classref-reftable-group
    25. 

  25. 

  26. Methods
    27. 

  27. -------
    28. 

  28. 

  29. .. table::
    30. 

  30.    :widths: auto
    31. 

  31. 

  32.    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33.    | :ref:`bool<class_bool>`           | :ref:`_can_generate_small_preview<class_EditorResourcePreviewGenerator_private_method__can_generate_small_preview>`\ (\ ) |virtual| |const|                                                                                                             |
    34. 

  34.    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35.    | :ref:`Texture2D<class_Texture2D>` | :ref:`_generate<class_EditorResourcePreviewGenerator_private_method__generate>`\ (\ resource\: :ref:`Resource<class_Resource>`, size\: :ref:`Vector2i<class_Vector2i>`, metadata\: :ref:`Dictionary<class_Dictionary>`\ ) |virtual| |const|             |
    36. 

  36.    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37.    | :ref:`Texture2D<class_Texture2D>` | :ref:`_generate_from_path<class_EditorResourcePreviewGenerator_private_method__generate_from_path>`\ (\ path\: :ref:`String<class_String>`, size\: :ref:`Vector2i<class_Vector2i>`, metadata\: :ref:`Dictionary<class_Dictionary>`\ ) |virtual| |const| |
    38. 

  38.    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39.    | :ref:`bool<class_bool>`           | :ref:`_generate_small_preview_automatically<class_EditorResourcePreviewGenerator_private_method__generate_small_preview_automatically>`\ (\ ) |virtual| |const|                                                                                         |
    40. 

  40.    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41.    | :ref:`bool<class_bool>`           | :ref:`_handles<class_EditorResourcePreviewGenerator_private_method__handles>`\ (\ type\: :ref:`String<class_String>`\ ) |virtual| |const|                                                                                                               |
    42. 

  42.    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. 

  44. .. rst-class:: classref-section-separator
    45. 

  45. 

  46. ----
    47. 

  47. 

  48. .. rst-class:: classref-descriptions-group
    49. 

  49. 

  50. Method Descriptions
    51. 

  51. -------------------
    52. 

  52. 

  53. .. _class_EditorResourcePreviewGenerator_private_method__can_generate_small_preview:
    54. 

  54. 

  55. .. rst-class:: classref-method
    56. 

  56. 

  57. :ref:`bool<class_bool>` **_can_generate_small_preview**\ (\ ) |virtual| |const| :ref:`🔗<class_EditorResourcePreviewGenerator_private_method__can_generate_small_preview>`
    58. 

  58. 

  59. If this function returns ``true``, the generator will call :ref:`_generate<class_EditorResourcePreviewGenerator_private_method__generate>` or :ref:`_generate_from_path<class_EditorResourcePreviewGenerator_private_method__generate_from_path>` for small previews as well.
    60. 

  60. 

  61. By default, it returns ``false``.
    62. 

  62. 

  63. .. rst-class:: classref-item-separator
    64. 

  64. 

  65. ----
    66. 

  66. 

  67. .. _class_EditorResourcePreviewGenerator_private_method__generate:
    68. 

  68. 

  69. .. rst-class:: classref-method
    70. 

  70. 

  71. :ref:`Texture2D<class_Texture2D>` **_generate**\ (\ resource\: :ref:`Resource<class_Resource>`, size\: :ref:`Vector2i<class_Vector2i>`, metadata\: :ref:`Dictionary<class_Dictionary>`\ ) |virtual| |const| :ref:`🔗<class_EditorResourcePreviewGenerator_private_method__generate>`
    72. 

  72. 

  73. Generate a preview from a given resource with the specified size. This must always be implemented.
    74. 

  74. 

  75. Returning ``null`` is an OK way to fail and let another generator take care.
    76. 

  76. 

  77. Care must be taken because this function is always called from a thread (not the main thread).
    78. 

  78. 

  79. \ ``metadata`` dictionary can be modified to store file-specific metadata that can be used in :ref:`EditorResourceTooltipPlugin._make_tooltip_for_path<class_EditorResourceTooltipPlugin_private_method__make_tooltip_for_path>` (like image size, sample length etc.).
    80. 

  80. 

  81. .. rst-class:: classref-item-separator
    82. 

  82. 

  83. ----
    84. 

  84. 

  85. .. _class_EditorResourcePreviewGenerator_private_method__generate_from_path:
    86. 

  86. 

  87. .. rst-class:: classref-method
    88. 

  88. 

  89. :ref:`Texture2D<class_Texture2D>` **_generate_from_path**\ (\ path\: :ref:`String<class_String>`, size\: :ref:`Vector2i<class_Vector2i>`, metadata\: :ref:`Dictionary<class_Dictionary>`\ ) |virtual| |const| :ref:`🔗<class_EditorResourcePreviewGenerator_private_method__generate_from_path>`
    90. 

  90. 

  91. 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_private_method__generate>`.
    92. 

  92. 

  93. Returning ``null`` is an OK way to fail and let another generator take care.
    94. 

  94. 

  95. Care must be taken because this function is always called from a thread (not the main thread).
    96. 

  96. 

  97. \ ``metadata`` dictionary can be modified to store file-specific metadata that can be used in :ref:`EditorResourceTooltipPlugin._make_tooltip_for_path<class_EditorResourceTooltipPlugin_private_method__make_tooltip_for_path>` (like image size, sample length etc.).
    98. 

  98. 

  99. .. rst-class:: classref-item-separator
    100. 

  100. 

  101. ----
    102. 

  102. 

  103. .. _class_EditorResourcePreviewGenerator_private_method__generate_small_preview_automatically:
    104. 

  104. 

  105. .. rst-class:: classref-method
    106. 

  106. 

  107. :ref:`bool<class_bool>` **_generate_small_preview_automatically**\ (\ ) |virtual| |const| :ref:`🔗<class_EditorResourcePreviewGenerator_private_method__generate_small_preview_automatically>`
    108. 

  108. 

  109. 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_private_method__generate>` or :ref:`_generate_from_path<class_EditorResourcePreviewGenerator_private_method__generate_from_path>`.
    110. 

  110. 

  111. By default, it returns ``false``.
    112. 

  112. 

  113. .. rst-class:: classref-item-separator
    114. 

  114. 

  115. ----
    116. 

  116. 

  117. .. _class_EditorResourcePreviewGenerator_private_method__handles:
    118. 

  118. 

  119. .. rst-class:: classref-method
    120. 

  120. 

  121. :ref:`bool<class_bool>` **_handles**\ (\ type\: :ref:`String<class_String>`\ ) |virtual| |const| :ref:`🔗<class_EditorResourcePreviewGenerator_private_method__handles>`
    122. 

  122. 

  123. Returns ``true`` if your generator supports the resource of type ``type``.
    124. 

  124. 

  125. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    126. 

  126. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    127. 

  127. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    128. 

  128. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    129. 

  129. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    130. 

  130. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    131. 

  131. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    132. 

  132. .. |void| replace:: :abbr:`void (No return value.)`
    133. 

  133.