.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/modules/gltf/doc_classes/GLTFDocument.xml. .. _class_GLTFDocument: GLTFDocument ============ **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`FBXDocument` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`image_format` | ``"PNG"`` | +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`lossy_quality` | ``0.75`` | +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ | :ref:`RootNodeMode` | :ref:`root_node_mode` | ``0`` | +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`append_from_buffer` **(** :ref:`PackedByteArray` bytes, :ref:`String` base_path, :ref:`GLTFState` state, :ref:`int` flags=0 **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`append_from_file` **(** :ref:`String` path, :ref:`GLTFState` state, :ref:`int` flags=0, :ref:`String` base_path="" **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`append_from_scene` **(** :ref:`Node` node, :ref:`GLTFState` state, :ref:`int` flags=0 **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`generate_buffer` **(** :ref:`GLTFState` state **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`generate_scene` **(** :ref:`GLTFState` state, :ref:`float` bake_fps=30, :ref:`bool` trimming=false, :ref:`bool` remove_immutable_tracks=true **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`register_gltf_document_extension` **(** :ref:`GLTFDocumentExtension` extension, :ref:`bool` first_priority=false **)** |static| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unregister_gltf_document_extension` **(** :ref:`GLTFDocumentExtension` extension **)** |static| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`write_to_filesystem` **(** :ref:`GLTFState` state, :ref:`String` path **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_GLTFDocument_RootNodeMode: .. rst-class:: classref-enumeration enum **RootNodeMode**: .. _class_GLTFDocument_constant_ROOT_NODE_MODE_SINGLE_ROOT: .. rst-class:: classref-enumeration-constant :ref:`RootNodeMode` **ROOT_NODE_MODE_SINGLE_ROOT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GLTFDocument_constant_ROOT_NODE_MODE_KEEP_ROOT: .. rst-class:: classref-enumeration-constant :ref:`RootNodeMode` **ROOT_NODE_MODE_KEEP_ROOT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GLTFDocument_constant_ROOT_NODE_MODE_MULTI_ROOT: .. rst-class:: classref-enumeration-constant :ref:`RootNodeMode` **ROOT_NODE_MODE_MULTI_ROOT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GLTFDocument_property_image_format: .. rst-class:: classref-property :ref:`String` **image_format** = ``"PNG"`` .. rst-class:: classref-property-setget - void **set_image_format** **(** :ref:`String` value **)** - :ref:`String` **get_image_format** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_property_lossy_quality: .. rst-class:: classref-property :ref:`float` **lossy_quality** = ``0.75`` .. rst-class:: classref-property-setget - void **set_lossy_quality** **(** :ref:`float` value **)** - :ref:`float` **get_lossy_quality** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_property_root_node_mode: .. rst-class:: classref-property :ref:`RootNodeMode` **root_node_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_root_node_mode** **(** :ref:`RootNodeMode` value **)** - :ref:`RootNodeMode` **get_root_node_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GLTFDocument_method_append_from_buffer: .. rst-class:: classref-method :ref:`Error` **append_from_buffer** **(** :ref:`PackedByteArray` bytes, :ref:`String` base_path, :ref:`GLTFState` state, :ref:`int` flags=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_method_append_from_file: .. rst-class:: classref-method :ref:`Error` **append_from_file** **(** :ref:`String` path, :ref:`GLTFState` state, :ref:`int` flags=0, :ref:`String` base_path="" **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_method_append_from_scene: .. rst-class:: classref-method :ref:`Error` **append_from_scene** **(** :ref:`Node` node, :ref:`GLTFState` state, :ref:`int` flags=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_method_generate_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **generate_buffer** **(** :ref:`GLTFState` state **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_method_generate_scene: .. rst-class:: classref-method :ref:`Node` **generate_scene** **(** :ref:`GLTFState` state, :ref:`float` bake_fps=30, :ref:`bool` trimming=false, :ref:`bool` remove_immutable_tracks=true **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_method_register_gltf_document_extension: .. rst-class:: classref-method void **register_gltf_document_extension** **(** :ref:`GLTFDocumentExtension` extension, :ref:`bool` first_priority=false **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_method_unregister_gltf_document_extension: .. rst-class:: classref-method void **unregister_gltf_document_extension** **(** :ref:`GLTFDocumentExtension` extension **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFDocument_method_write_to_filesystem: .. rst-class:: classref-method :ref:`Error` **write_to_filesystem** **(** :ref:`GLTFState` state, :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`