Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
Class for importing and exporting glTF files in and out of Godot.
GLTFDocument supports reading data from a glTF file, buffer, or Godot scene. This data can then be written to the filesystem, buffer, or used to create a Godot scene.
All of the data in a GLTF scene is stored in the GLTFState class. GLTFDocument processes state objects, but does not contain any scene data itself. GLTFDocument has member variables to store export configuration settings such as the image format, but is otherwise stateless. Multiple scenes can be processed with the same settings using the same GLTFDocument object and different GLTFState objects.
GLTFDocument can be extended with arbitrary functionality by extending the GLTFDocumentExtension class and registering it with GLTFDocument via register_gltf_document_extension. This allows for custom data to be imported and exported.
RootNodeMode ROOT_NODE_MODE_SINGLE_ROOT =
Treat the Godot scene's root node as the root node of the glTF file, and mark it as the single root node via the
GODOT_single_root glTF extension. This will be parsed the same as ROOT_NODE_MODE_KEEP_ROOT if the implementation does not support
RootNodeMode ROOT_NODE_MODE_KEEP_ROOT =
Treat the Godot scene's root node as the root node of the glTF file, but do not mark it as anything special. An extra root node will be generated when importing into Godot. This uses only vanilla glTF features. This is equivalent to the behavior in Godot 4.1 and earlier.
RootNodeMode ROOT_NODE_MODE_MULTI_ROOT =
Treat the Godot scene's root node as the name of the glTF scene, and add all of its children as root nodes of the glTF file. This uses only vanilla glTF features. This avoids an extra root node, but only the name of the Godot scene's root node will be preserved, as it will not be saved as a node.
String image_format =
The user-friendly name of the export image format. This is used when exporting the GLTF file, including writing to a file and writing to a byte array.
By default, Godot allows the following options: "None", "PNG", "JPEG", "Lossless WebP", and "Lossy WebP". Support for more image formats can be added in GLTFDocumentExtension classes.
float lossy_quality =
If image_format is a lossy image format, this determines the lossy quality of the image. On a range of
0.0 is the lowest quality and
1.0 is the highest quality. A lossy quality of
1.0 is not the same as lossless.
RootNodeMode root_node_mode =
Note: Regardless of how the glTF file is exported, when importing, the root node type and name can be overridden in the scene import settings tab.
base_path tells append_from_buffer where to find dependencies and can be empty.
Takes a path to a GLTF file and imports the data at that file path to the given GLTFState object through the
base_path tells append_from_file where to find dependencies and can be empty.
Takes a Godot Engine scene node and exports it and its descendants to the given GLTFState object through the
Takes a GLTFState object through the
state parameter and returns a Godot Engine scene node.
Registers the given GLTFDocumentExtension instance with GLTFDocument. If
first_priority is true, this extension will be run first. Otherwise, it will be run last.
Note: Like GLTFDocument itself, all GLTFDocumentExtension classes must be stateless in order to function properly. If you need to store data, use the
get_additional_data methods in GLTFState or GLTFNode.
void unregister_gltf_document_extension ( GLTFDocumentExtension extension ) static
Unregisters the given GLTFDocumentExtension instance.
Takes a GLTFState object through the
state parameter and writes a glTF file to the filesystem.
Note: The extension of the glTF file determines if it is a .glb binary file or a .gltf file.