Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

GLTFDocumentExtension

Inherits: Resource < RefCounted < Object

Inherited By: GLTFDocumentExtensionConvertImporterMesh

GLTFDocument extension class.

Description

Extends the functionality of the GLTFDocument class by allowing you to run arbitrary code at various stages of GLTF import or export.

To use, make a new class extending GLTFDocumentExtension, override any methods you need, make an instance of your class, and register it using GLTFDocument.register_gltf_document_extension.

Note: Like GLTFDocument itself, all GLTFDocumentExtension classes must be stateless in order to function properly. If you need to store data, use the set_additional_data and get_additional_data methods in GLTFState or GLTFNode.

Tutorials

Methods

void

_convert_scene_node ( GLTFState state, GLTFNode gltf_node, Node scene_node ) virtual

Error

_export_node ( GLTFState state, GLTFNode gltf_node, Dictionary json, Node node ) virtual

Error

_export_post ( GLTFState state ) virtual

Error

_export_preflight ( GLTFState state, Node root ) virtual

Error

_export_preserialize ( GLTFState state ) virtual

Node3D

_generate_scene_node ( GLTFState state, GLTFNode gltf_node, Node scene_parent ) virtual

String

_get_image_file_extension ( ) virtual

PackedStringArray

_get_saveable_image_formats ( ) virtual

PackedStringArray

_get_supported_extensions ( ) virtual

Error

_import_node ( GLTFState state, GLTFNode gltf_node, Dictionary json, Node node ) virtual

Error

_import_post ( GLTFState state, Node root ) virtual

Error

_import_post_parse ( GLTFState state ) virtual

Error

_import_preflight ( GLTFState state, PackedStringArray extensions ) virtual

Error

_parse_image_data ( GLTFState state, PackedByteArray image_data, String mime_type, Image ret_image ) virtual

Error

_parse_node_extensions ( GLTFState state, GLTFNode gltf_node, Dictionary extensions ) virtual

Error

_parse_texture_json ( GLTFState state, Dictionary texture_json, GLTFTexture ret_gltf_texture ) virtual

Error

_save_image_at_path ( GLTFState state, Image image, String file_path, String image_format, float lossy_quality ) virtual

PackedByteArray

_serialize_image_to_bytes ( GLTFState state,