GFThumbnailRenderer¶
API Reference / Kernel / 类索引
- 路径：
addons/gf/kernel/editor/gf_thumbnail_renderer.gd - 模块：
Kernel - 继承：
Node - API：
public - 类别：编辑器 API (
editor_api) - 首次版本：
3.17.0
编辑器缩略图渲染辅助节点。 使用独立 SubViewport 渲染 CanvasItem、Node3D 或 Mesh，供项目自定义编辑器工具复用。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 方法 | render_node3d |
func render_node3d(source: Node3D, size: Vector2i = Vector2i(256, 256), transparent: bool = true) -> Image: |
| 方法 | render_node3d_texture |
func render_node3d_texture( source: Node3D, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> ImageTexture: |
| 方法 | render_canvas_item |
func render_canvas_item( source: CanvasItem, size: Vector2i = Vector2i(256, 256), transparent: bool = true, content_bounds: Rect2 = Rect2(), margin_ratio: float = 0.08 ) -> Image: |
| 方法 | render_canvas_item_texture |
func render_canvas_item_texture( source: CanvasItem, size: Vector2i = Vector2i(256, 256), transparent: bool = true, content_bounds: Rect2 = Rect2(), margin_ratio: float = 0.08 ) -> ImageTexture: |
| 方法 | render_mesh |
func render_mesh(mesh: Mesh, size: Vector2i = Vector2i(256, 256), transparent: bool = true) -> Image: |
| 方法 | render_mesh_texture |
func render_mesh_texture( mesh: Mesh, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> ImageTexture: |
| 方法 | submit_render_request |
func submit_render_request(request: GFThumbnailRenderRequest) -> GFThumbnailRenderTask: |
| 方法 | cancel_render_task |
func cancel_render_task(task: GFThumbnailRenderTask, reason: StringName = &"cancelled") -> bool: |
| 方法 | render_mesh_library_previews |
func render_mesh_library_previews( mesh_library: MeshLibrary, size: Vector2i = Vector2i(128, 128), overwrite_existing: bool = true ) -> int: |
| 方法 | build_mesh_library_preview_plan |
func build_mesh_library_preview_plan( mesh_library: MeshLibrary, size: Vector2i = Vector2i(128, 128), overwrite_existing: bool = true ) -> Dictionary: |
| 方法 | apply_mesh_library_preview_plan |
func apply_mesh_library_preview_plan(mesh_library: MeshLibrary, plan: Dictionary) -> int: |
| 方法 | revert_mesh_library_preview_plan |
func revert_mesh_library_preview_plan(mesh_library: MeshLibrary, plan: Dictionary) -> int: |
| 方法 | add_mesh_library_preview_plan_to_undo_manager |
func add_mesh_library_preview_plan_to_undo_manager( mesh_library: MeshLibrary, plan: Dictionary, undo_manager: Object, action_name: String = "Generate MeshLibrary Previews" ) -> Error: |
方法¶
render_node3d¶
- API：
public
func render_node3d(source: Node3D, size: Vector2i = Vector2i(256, 256), transparent: bool = true) -> Image:
渲染一个 3D 节点缩略图。
参数：
| 名称 | 说明 |
|---|---|
source |
要渲染的 3D 节点，会被复制后放入内部 Viewport。 |
size |
输出尺寸。 |
transparent |
是否透明背景。 |
返回：渲染出的 Image；失败时返回 null。
render_node3d_texture¶
- API：
public
func render_node3d_texture( source: Node3D, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> ImageTexture:
渲染一个 3D 节点缩略图纹理。
参数：
| 名称 | 说明 |
|---|---|
source |
要渲染的 3D 节点。 |
size |
输出尺寸。 |
transparent |
是否透明背景。 |
返回：渲染出的 ImageTexture；失败时返回 null。
render_canvas_item¶
- API：
public - 首次版本：
unreleased
func render_canvas_item( source: CanvasItem, size: Vector2i = Vector2i(256, 256), transparent: bool = true, content_bounds: Rect2 = Rect2(), margin_ratio: float = 0.08 ) -> Image:
渲染一个 CanvasItem 缩略图。 source 可以是 Node2D 或 Control。自定义 _draw() 等无法可靠估算 几何范围的节点应传入显式 content_bounds。
参数：
| 名称 | 说明 |
|---|---|
source |
要渲染的 2D 画布节点，会被复制后放入内部 Viewport。 |
size |
输出尺寸。 |
transparent |
是否透明背景。 |
content_bounds |
来源局部坐标中的显式内容边界；非正尺寸表示自动估算。 |
margin_ratio |
内容边界四周的相对留白，钳制到 0.0 至 1.0。 |
返回：渲染出的 Image；失败时返回 null。
render_canvas_item_texture¶
- API：
public - 首次版本：
unreleased
func render_canvas_item_texture( source: CanvasItem, size: Vector2i = Vector2i(256, 256), transparent: bool = true, content_bounds: Rect2 = Rect2(), margin_ratio: float = 0.08 ) -> ImageTexture:
渲染一个 CanvasItem 缩略图纹理。 source 可以是 Node2D 或 Control。自定义 _draw() 等无法可靠估算 几何范围的节点应传入显式 content_bounds。
参数：
| 名称 | 说明 |
|---|---|
source |
要渲染的 2D 画布节点。 |
size |
输出尺寸。 |
transparent |
是否透明背景。 |
content_bounds |
来源局部坐标中的显式内容边界；非正尺寸表示自动估算。 |
margin_ratio |
内容边界四周的相对留白，钳制到 0.0 至 1.0。 |
返回：渲染出的 ImageTexture；失败时返回 null。
render_mesh¶
- API：
public
func render_mesh(mesh: Mesh, size: Vector2i = Vector2i(256, 256), transparent: bool = true) -> Image:
渲染一个 Mesh 缩略图。
参数：
| 名称 | 说明 |
|---|---|
mesh |
要渲染的 Mesh。 |
size |
输出尺寸。 |
transparent |
是否透明背景。 |
返回：渲染出的 Image；失败时返回 null。
render_mesh_texture¶
- API：
public
func render_mesh_texture( mesh: Mesh, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> ImageTexture:
渲染一个 Mesh 缩略图纹理。
参数：
| 名称 | 说明 |
|---|---|
mesh |
要渲染的 Mesh。 |
size |
输出尺寸。 |
transparent |
是否透明背景。 |
返回：渲染出的 ImageTexture；失败时返回 null。
submit_render_request¶
- API：
public - 首次版本：
8.0.0
提交一个缩略图渲染请求。
参数：
| 名称 | 说明 |
|---|---|
request |
缩略图渲染请求。 |
返回：可取消、可等待的渲染任务。
cancel_render_task¶
- API：
public - 首次版本：
8.0.0
取消一个渲染任务。
参数：
| 名称 | 说明 |
|---|---|
task |
要取消的任务。 |
reason |
取消原因。 |
返回：本次调用是否发出新的取消请求。
render_mesh_library_previews¶
- API：
public
func render_mesh_library_previews( mesh_library: MeshLibrary, size: Vector2i = Vector2i(128, 128), overwrite_existing: bool = true ) -> int:
为 MeshLibrary 批量生成条目预览。
参数：
| 名称 | 说明 |
|---|---|
mesh_library |
目标 MeshLibrary。 |
size |
预览尺寸。 |
overwrite_existing |
是否覆盖已有预览。 |
返回：成功生成的预览数量。
build_mesh_library_preview_plan¶
- API：
public - 首次版本：
6.0.0
func build_mesh_library_preview_plan( mesh_library: MeshLibrary, size: Vector2i = Vector2i(128, 128), overwrite_existing: bool = true ) -> Dictionary:
为 MeshLibrary 批量生成预览修改计划，不直接修改资源。
参数：
| 名称 | 说明 |
|---|---|
mesh_library |
目标 MeshLibrary。 |
size |
预览尺寸。 |
overwrite_existing |
是否覆盖已有预览。 |
返回：包含 changes、generated_count 和 cancelled 的修改计划。
结构：
return: Dictionary { ok: bool, generated_count: int, cancelled: bool, changes: Array[Dictionary] }.
apply_mesh_library_preview_plan¶
- API：
public - 首次版本：
6.0.0
应用 MeshLibrary 预览修改计划。
参数：
| 名称 | 说明 |
|---|---|
mesh_library |
目标 MeshLibrary。 |
plan |
build_mesh_library_preview_plan() 返回的计划。 |
返回：实际应用的变更数量。
结构：
plan: Dictionary { ok: bool, generated_count: int, cancelled: bool, changes: Array[Dictionary] }.
revert_mesh_library_preview_plan¶
- API：
public - 首次版本：
6.0.0
撤销 MeshLibrary 预览修改计划。
参数：
| 名称 | 说明 |
|---|---|
mesh_library |
目标 MeshLibrary。 |
plan |
build_mesh_library_preview_plan() 返回的计划。 |
返回：实际还原的变更数量。
结构：
plan: Dictionary { ok: bool, generated_count: int, cancelled: bool, changes: Array[Dictionary] }.
add_mesh_library_preview_plan_to_undo_manager¶
- API：
public - 首次版本：
6.0.0
func add_mesh_library_preview_plan_to_undo_manager( mesh_library: MeshLibrary, plan: Dictionary, undo_manager: Object, action_name: String = "Generate MeshLibrary Previews" ) -> Error:
将 MeshLibrary 预览修改计划注册到 UndoRedo 管理器。
参数：
| 名称 | 说明 |
|---|---|
mesh_library |
目标 MeshLibrary。 |
plan |
build_mesh_library_preview_plan() 返回的计划。 |
undo_manager |
EditorUndoRedoManager 或兼容对象。 |
action_name |
UndoRedo 动作名。 |
返回：Godot 错误码。
结构：
plan: Dictionary { ok: bool, generated_count: int, cancelled: bool, changes: Array[Dictionary] }.