Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

EditorResourcePreviewGenerator

繼承: RefCounted < Object

自訂的預覽生成器。

說明

生成預覽的自訂程式碼。請查看 EditorSettings.filesystem/file_dialog/thumbnail_size 找出適合做預覽的尺寸。

方法

bool

_can_generate_small_preview() virtual const

Texture2D

_generate(resource: Resource, size: Vector2i, metadata: Dictionary) virtual required const

Texture2D

_generate_from_path(path: String, size: Vector2i, metadata: Dictionary) virtual const

bool

_generate_small_preview_automatically() virtual const

bool

_handles(type: String) virtual required const

void

request_draw_and_wait(viewport: RID) const


方法說明

bool _can_generate_small_preview() virtual const 🔗

如果該函式返回 true,則該生成器也會為小型預覽呼叫 _generate() 或 _generate_from_path()。

預設情況下,它返回 false。


Texture2D _generate(resource: Resource, size: Vector2i, metadata: Dictionary) virtual required const 🔗

根據給定的資源生成指定大小的預覽。必須始終實作。

失敗時允許回傳 null,會由其他生成器接手。

必須保持謹慎,因為這個函式始終是從(主執行緒以外的)執行緒中呼叫的。

可以修改 metadata 字典,從而儲存能夠在 EditorResourceTooltipPlugin._make_tooltip_for_path() 中使用的檔案相關的來源資料(例如圖片大小、取樣長度等)。


Texture2D _generate_from_path(path: String, size: Vector2i, metadata: Dictionary) virtual const 🔗

根據路徑直接生成指定大小的預覽。可選實作,預設程式碼會在載入後呼叫 _generate()。

失敗時允許回傳 null,會由其他生成器接手。

必須保持謹慎,因為這個函式始終是從(主執行緒以外的)執行緒中呼叫的。

可以修改 metadata 字典,從而儲存能夠在 EditorResourceTooltipPlugin._make_tooltip_for_path() 中使用的檔案相關的來源資料(例如圖片大小、取樣長度等)。


bool _generate_small_preview_automatically() virtual const 🔗

如果該函式返回 true,則該生成器將自動從通過方法 _generate() 或 _generate_from_path() 生成的普通預覽紋理生成小型預覽。

預設情況下,它返回 false。


bool _handles(type: String) virtual required const 🔗

如果你的生成器支援型別為 type 的資源,則返回 true。


void request_draw_and_wait(viewport: RID) const 🔗

從 _generate() 方法內部呼叫,以請求渲染伺服器繪製到 viewport。