GFThumbnailRenderer¶
API Reference / Kernel / 类索引
- 路径：
addons/gf/kernel/editor/gf_thumbnail_renderer.gd - 模块：
Kernel - 继承：
Node - API：
public - 类别：编辑器 API (
editor_api) - 首次版本：
3.17.0
编辑器缩略图渲染辅助节点。 使用独立 SubViewport 渲染 Node3D 或 Mesh，供项目自定义编辑器工具复用。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | cancel_preview_generation |
var cancel_preview_generation: bool = false |
| 方法 | 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_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: |
| 方法 | render_mesh_library_previews |
func render_mesh_library_previews( mesh_library: MeshLibrary, size: Vector2i = Vector2i(128, 128), overwrite_existing: bool = true ) -> int: |
属性¶
cancel_preview_generation¶
- API：
public
请求取消正在进行的 MeshLibrary 批量预览生成。
方法¶
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_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。
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 |
是否覆盖已有预览。 |
返回：成功生成的预览数量。