# Header only C++ tiny glTF library(loader/saver). `TinyGLTF` is a header only C++11 glTF 2.0 https://github.com/KhronosGroup/glTF library. `TinyGLTF` uses dropbox/json11 JSON library(https://github.com/dropbox/json11), so now it requires C++11 compiler. If you are looking for old, C++03 version, please use `devel-picojson` branch. ## Status v2.2.0 Use dropbox/json11 instead of nlohmann's json.hpp v2.0.0 release(22 Aug, 2018)! ## Builds [![Build Status](https://travis-ci.org/syoyo/tinygltf.svg?branch=devel)](https://travis-ci.org/syoyo/tinygltf) [![Build status](https://ci.appveyor.com/api/projects/status/warngenu9wjjhlm8?svg=true)](https://ci.appveyor.com/project/syoyo/tinygltf) ## Features * Written in portable C++. C++-11 with STL dependency only. * [x] macOS + clang(LLVM) * [x] iOS + clang * [x] Linux + gcc/clang * [x] Windows + MinGW * [x] Windows + Visual Studio 2015 Update 3 or later. * Visual Studio 2013 is not supported since they have limited C++11 support. * [x] Android NDK * [x] Android + CrystaX(NDK drop-in replacement) GCC * [x] Web using Emscripten(LLVM) * [x] Can be compiled with no RTTI, noexception. * Moderate parsing time and memory consumption. * glTF specification v2.0.0 * [x] ASCII glTF * [x] Binary glTF(GLB) * [x] PBR material description * Buffers * [x] Parse BASE64 encoded embedded buffer data(DataURI). * [x] Load `.bin` file. * Image(Using stb_image) * [x] Parse BASE64 encoded embedded image data(DataURI). * [x] Load external image file. * [x] PNG(8bit only) * [x] JPEG(8bit only) * [x] BMP * [x] GIF * [x] Custom Image decoder callback(e.g. for decoding OpenEXR image) * Load from memory * Custom callback handler * [x] Image load * Extensions * [x] Draco mesh decoding ## Examples * [glview](examples/glview) : Simple glTF geometry viewer. * [validator](examples/validator) : Simple glTF validator with JSON schema. * [basic](examples/basic) : Basic glTF viewer with texturing support. ## Projects using TinyGLTF * px_render Single header C++ Libraries for Thread Scheduling, Rendering, and so on... https://github.com/pplux/px * Physical based rendering with Vulkan using glTF 2.0 models https://github.com/SaschaWillems/Vulkan-glTF-PBR * GLTF loader plugin for OGRE 2.1. Support for PBR materials via HLMS/PBS https://github.com/Ybalrid/Ogre_glTF * [TinyGltfImporter](http://doc.magnum.graphics/magnum/classMagnum_1_1Trade_1_1TinyGltfImporter.html) plugin for [Magnum](https://github.com/mosra/magnum), a lightweight and modular C++11/C++14 graphics middleware for games and data visualization. * Your projects here! (Please send PR) ## TODOs * [ ] Write C++ code generator which emits C++ code from JSON schema for robust parsing. * [ ] Mesh Compression/decompression(Open3DGC, etc) * [x] Load Draco compressed mesh * [x] Save Draco compressed mesh * [ ] Support `extensions` and `extras` property * [ ] HDR image? * [ ] OpenEXR extension through TinyEXR. * [ ] Write example and tests for `animation` and `skin` * [ ] Skinning * [ ] Morph targets ## Licenses TinyGLTF is licensed under MIT license. TinyGLTF uses the following third party libraries. * json11 : Copyright (c) 2013 Dropbox, Inc. MIT license. * base64 : Copyright (C) 2004-2008 René Nyffenegger * stb_image.h : v2.08 - public domain image loader - [Github link](https://github.com/nothings/stb/blob/master/stb_image.h) * stb_image_write.h : v1.09 - public domain image writer - [Github link](https://github.com/nothings/stb/blob/master/stb_image_write.h) ## Build and example Copy `stb_image.h`, `stb_image_write.h`, and `tiny_gltf.h` to your project. json11 code is embeded into `tiny_gltf.h` ### Loading glTF 2.0 model ```c++ // Define these only in *one* .cc file. #define TINYGLTF_IMPLEMENTATION #define STB_IMAGE_IMPLEMENTATION #define STB_IMAGE_WRITE_IMPLEMENTATION // Optional. Uncomment these if you want external json11.cpp instead of embedded json11.cpp code //#define TINYGLTF_USE_EXTERNAL_JSON11_CPP //#include "json11.hpp" #include "tiny_gltf.h" using namespace tinygltf; Model model; TinyGLTF loader; std::string err; std::string warn; bool ret = loader.LoadASCIIFromFile(&model, &err, &warn, argv[1]); //bool ret = loader.LoadBinaryFromFile(&model, &err, &warn, argv[1]); // for binary glTF(.glb) if (!warn.empty()) { printf("Warn: %s\n", warn.c_str()); } if (!err.empty()) { printf("Err: %s\n", err.c_str()); } if (!ret) { printf("Failed to parse glTF\n"); return -1; } ``` ## Compile options * `TINYGLTF_NO_STB_IMAGE` : Do not load images with stb_image. Instead use `TinyGLTF::SetImageLoader(LoadimageDataFunction LoadImageData, void *user_data)` to set a callback for loading images. * `TINYGLTF_NO_STB_IMAGE_WRITE` : Do not write images with stb_image_write. Instead use `TinyGLTF::SetImageWriter(WriteimageDataFunction WriteImageData, void *user_data)` to set a callback for writing images. * `TINYGLTF_NO_EXTERNAL_IMAGE` : Do not try to load external image file. This option woulde be helpful if you do not want load image file during glTF parsing. * `TINYGLTF_ANDROID_LOAD_FROM_ASSETS`: Load all files from packaged app assets instead of the regular file system. **Note:** You must pass a valid asset manager from your android app to `tinygltf::asset_manager` beforehand. * `TINYGLTF_ENABLE_DRACO`: Enable Draco compression. User must provide include path and link correspnding libraries in your project file. * `TINYGLTF_USE_EXTERNAL_JSON11_CPP` : Use externally supplied json11.cpp/json11.hpp. This option may be helpful if you use json11.cpp in other source codes of your project. ### Saving gltTF 2.0 model * [ ] Buffers. * [x] To file * [x] Embedded * [ ] Draco compressed? * [x] Images * [x] To file * [x] Embedded * [ ] Binary(.glb) ## Running tests. ### glTF parsing test #### Setup Python 2.6 or 2.7 required. Git clone https://github.com/KhronosGroup/glTF-Sample-Models to your local dir. #### Run parsing test After building `loader_example`, edit `test_runner.py`, then, ```bash $ python test_runner.py ``` ### Unit tests ```bash $ cd tests $ make $ ./tester $ ./tester_noexcept ``` ## Third party licenses * json11 : Licensed under the MIT License . * stb_image : Public domain. * catch : Copyright (c) 2012 Two Blue Cubes Ltd. All rights reserved. Distributed under the Boost Software License, Version 1.0.