EditorResourcePreviewGenerator
继承: RefCounted < Object
自定义的预览生成器。
描述
生成预览的自定义代码。请查看 EditorSettings.filesystem/file_dialog/thumbnail_size 找出适合做预览的尺寸。
方法
_can_generate_small_preview() virtual const |
|
_generate(resource: Resource, size: Vector2i, metadata: Dictionary) virtual required const |
|
_generate_from_path(path: String, size: Vector2i, metadata: Dictionary) virtual const |
|
_generate_small_preview_automatically() virtual 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 🔗
Call from within _generate() to request the rendering server draw to the viewport.