GltfDocument

public string FallbackImageFormat { get; set; }

The user-friendly name of the fallback image format. This is used when exporting the glTF file, including writing to a file and writing to a byte array. This property may only be one of "None", "PNG", or "JPEG", and is only used when the GltfDocument.ImageFormat is not one of "None", "PNG", or "JPEG". If having multiple extension image formats is desired, that can be done using a GltfDocumentExtension class - this property only covers the use case of providing a base glTF fallback image when using a custom image format.

public float FallbackImageQuality { get; set; }

The quality of the fallback image, if any. For PNG files, this downscales the image on both dimensions by this factor. For JPEG files, this is the lossy quality of the image. A low value is recommended, since including multiple high quality images in a glTF file defeats the file size gains of using a more efficient image format.

public string ImageFormat { get; set; }

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, Reckfell allows the following options: "None", "PNG", "JPEG", "Lossless WebP", and "Lossy WebP". Support for more image formats can be added in GltfDocumentExtension classes. A single extension class can provide multiple options for the specific format to use, or even an option that uses multiple formats at once.

public float LossyQuality { get; set; }

If GltfDocument.ImageFormat is a lossy image format, this determines the lossy quality of the image. On a range of 0.0 to 1.0, where 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.

public GltfDocument.RootNodeModeEnum RootNodeMode { get; set; }

How to process the root node during export. The default and recommended value is GltfDocument.RootNodeModeEnum.SingleRoot. 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.

public GltfDocument.TextureMapModeEnum TextureMapMode { get; set; }

How to handle texture maps during import. The default and recommended value is GltfDocument.TextureMapModeEnum.RemapToStandardMaterial, which automatically remaps from glTF's flexible texture map system to the more specific texture map slots in Reckfell's StandardMaterial3D class. Alternatively, GltfDocument.TextureMapModeEnum.DoNotRemap can be used to preserve the original texture maps from the glTF file, which may be desirable if using the glTF file with custom shaders, but may not display correctly with Reckfell's built-in materials.

public GltfDocument.VisibilityModeEnum VisibilityMode { get; set; }

How to deal with node visibility during export. This setting does nothing if all nodes are visible. The default and recommended value is GltfDocument.VisibilityModeEnum.IncludeRequired, which uses the KHR_node_visibility extension.

public Error AppendFromBuffer(byte[] bytes, string basePath, GltfState state, uint flags = 0);

Takes a byte[] defining a glTF and imports the data to the given GltfState object through the state parameter. Note: The base_path tells GltfDocument.AppendFromBuffer where to find dependencies and can be empty.

public Error AppendFromBuffer(ReadOnlySpan<byte> bytes, string basePath, GltfState state, uint flags);

Takes a byte[] defining a glTF and imports the data to the given GltfState object through the state parameter. Note: The base_path tells GltfDocument.AppendFromBuffer where to find dependencies and can be empty.

public Error AppendFromFile(string path, GltfState state, uint flags = 0, string basePath = "");

Reads glTF/GLB into GltfState, resolving dependencies relative to basePath. Does not create the Entity tree yet: call GenerateScene after Error.Ok. Use a fresh state for independent loading. Not a universal FBX, Blender or Reckfell project loader.

public Error AppendFromScene(Entity node, GltfState state, uint flags = 0);

Converts the supplied Entity root and descendants into GltfState data. Does not write a file or free the source tree. For independent export, use a fresh state, then call WriteToFilesystem. Successful conversion does not guarantee transfer of ShaderMaterial or gameplay features.

public static GltfObjectModelProperty ExportObjectModelProperty(GltfState state, EntityPath entityPath, Entity reckfellNode, int gltfNodeIndex);

Determines a mapping between the given Reckfell entity_path and the corresponding glTF Object Model JSON pointer(s) in the generated glTF file. The details of this mapping are returned in a GltfObjectModelProperty object. Additional mappings can be supplied via the GltfDocumentExtension._ImportObjectModelProperty callback method.

public byte[] GenerateBuffer(GltfState state);

Takes a GltfState object through the state parameter and returns a glTF byte[].

public Entity GenerateScene(GltfState state, float bakeFps = 30f, bool trimming = false, bool removeImmutableTracks = true);

Creates an Entity tree from a prepared GltfState. Does not automatically add it to EntityTree; attach explicitly or release with Free. bakeFps replaces the state bake rate. Animation creation also depends on state data and settings.

public static string[] GetSupportedGltfExtensions();

Returns a list of all support glTF extensions, including extensions supported directly by the engine, and extensions supported by user plugins registering GltfDocumentExtension classes. Note: If this method is run before a GLTFDocumentExtension is registered, its extensions won't be included in the list. Be sure to only run this method after all extensions are registered. If you run this when the engine starts, consider waiting a frame before calling this method to ensure all extensions are registered.

public static GltfObjectModelProperty ImportObjectModelProperty(GltfState state, string jsonPointer);

Determines a mapping between the given glTF Object Model json_pointer and the corresponding Reckfell node path(s) in the generated Reckfell scene. The details of this mapping are returned in a GltfObjectModelProperty object. Additional mappings can be supplied via the GltfDocumentExtension._ExportObjectModelProperty callback method.

public static void RegisterGltfDocumentExtension(GltfDocumentExtension extension, bool firstPriority = false);

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 set_additional_data and get_additional_data methods in GltfState or GltfNode.

public static void UnregisterGltfDocumentExtension(GltfDocumentExtension extension);

Unregisters the given GltfDocumentExtension instance.

public Error WriteToFilesystem(GltfState state, string path);

Serializes a prepared GltfState and writes a glTF file. Use .glb for a binary container or .gltf for JSON with dependencies. The parent directory must exist. Can write several files; failure does not automatically roll back partial output.