glTFast

Use glTFast to import and export [glTF™][gltf] 3D files efficiently at runtime or in the Editor.

Installing

Unity glTFast is a [Package][UnityPackage] and is installed via the name com.unity.cloud.gltfast in the Package Manager window in Unity®. See installation for detailed instructions.

NOTE: This package originally had the identifier com.atteneder.gltfast. Consult the upgrade guide to learn how to switch to the Unity version (com.unity.cloud.gltfast) or install the original package.

Features

Speed, memory efficiency and a small build footprint are focus points of Unity glTFast.

The [glTF 2.0 specification][gltf-spec] and a large and growing number of [glTF extensions][gltf-ext] are supported.

All platforms as well as Universal, High Definition and Built-In Render Pipelines are supported.

Advanced users can customize or extend glTFast in various ways.

See the comprehensive list of supported features and extensions.

Workflows

There are four use-cases for glTF within Unity

• Import

- Runtime Import/Loading in games/applications - Editor Import (i.e. import assets at design-time)

• Export

- Runtime Export (save and share dynamic, user-generated 3D content) - Editor Export (Unity as glTF authoring tool)

[][workflows]

Read more about the workflows in the [documentation][workflows].

Usage

You can load a glTF asset from an URL or a file path.

Runtime Loading via Component

Add a GltfAsset component to a GameObject.

![GltfAsset component][gltfasset_component]

Runtime Loading via Script

#
var gltf = gameObject.AddComponent<GLTFast.GltfAsset>();
gltf.url = "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Assets/main/Models/Duck/glTF/Duck.gltf";

See Runtime Loading via Script in the documentation for more details and instructions how to customize the loading behavior via script.

Editor Import

Move or copy glTF files into your project's Assets folder, similar to other 3D formats:

![Editor Import][import-gif]

Unity glTFast will import them to native Unity prefabs and add them to the asset database.

See Editor Import in the documentation for details.

Editor Export

The main menu has a couple of entries for glTF export under File > Export and glTFs can also be created via script.

Project Setup

Materials and Shader Variants

❗ IMPORTANT ❗

Unity glTFast uses custom shader graphs that you have to include in builds in order to make materials work. If materials are fine in the Unity Editor but not in builds, chances are some shaders (or variants) are missing.

Read the section Materials and Shader Variants in the Documentation for details.

Contribution

See CONTRIBUTING.md.

License

Copyright 2023 Unity Technologies and the Unity glTFast authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use files in this repository except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Trademarks

Unity® is a registered trademark of [Unity Technologies][unity].

Khronos® is a registered trademark and [glTF™][gltf] is a trademark of [The Khronos Group Inc][khronos].

[gltf]: https://www.khronos.org/gltf [gltf-spec]: https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html [gltf-ext]: https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#specifying-extensions [gltfassetcomponent]: ./Documentation~/Images/gltfassetcomponent.png "Inspector showing a GltfAsset component added to a GameObject" [import-gif]: ./Documentation~/Images/import.gif "Video showing glTF files being copied into the Assets folder and imported" [khronos]: https://www.khronos.org [unity]: https://unity.com [UnityPackage]: https://docs.unity3d.com/Manual/PackagesList.html [workflows]: ./Documentation~/index.md#workflows