Update README.
1 file changed
tree: ce2a94ac6d4ff43164fdfa30c9def4cb243e6e72
  1. deps/
  2. examples/
  3. models/
  4. tools/
  5. .clang-format
  6. .travis.yml
  7. appveyor.yml
  8. json.hpp
  9. loader_example.cc
  10. Makefile
  11. premake4.lua
  12. README.md
  13. stb_image.h
  14. test_runner.py
  15. tiny_gltf.h
  16. vcsetup.bat
README.md

Header only C++ tiny glTF library(loader/saver).

TinyGLTF is a header only C++11 glTF 2.0 https://github.com/KhronosGroup/glTF library.

Status

Work in process(devel branch). Very near to release, but need more tests and examples.

Builds

Build Status

Build status

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] Android + CrystaX(NDK drop-in replacement) GCC
    • [x] Web using Emscripten(LLVM)
  • 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 fata(DataURI).
    • [x] Load .bin file.
  • Image(Using stb_image)
    • [x] Parse BASE64 encoded embedded image fata(DataURI).
    • [x] Load external image file.
    • [x] PNG(8bit only)
    • [x] JPEG(8bit only)
    • [x] BMP
    • [x] GIF

Examples

  • glview : Simple glTF geometry viewer.
  • validator : Simple glTF validator with JSON schema.

TODOs

  • [ ] Write C++ code generator from json schema for robust parsing.
  • [x] Serialization
  • [ ] Compression/decompression(Open3DGC, etc)
  • [ ] Support extensions and extras property
  • [ ] HDR image?
  • [ ] Write tests for animation and skin

Licenses

TinyGLTF is licensed under MIT license.

TinyGLTF uses the following third party libraries.

  • json.hpp : Copyright (c) 2013-2017 Niels Lohmann. MIT license.
  • base64 : Copyright (C) 2004-2008 RenĂ© Nyffenegger
  • stb_image.h : v2.08 - public domain image loader - http://nothings.org/stb_image.h

Build and example

Copy stb_image.h, json.hpp and tiny_gltf.h to your project.

Loading glTF 2.0 model

// Define these only in *one* .cc file.
#define TINYGLTF_IMPLEMENTATION
#define STB_IMAGE_IMPLEMENTATION
#include "tiny_gltf.h"

using namespace tinygltf;

Model model; 
TinyGLTF loader;
std::string err;
  
bool ret = loader.LoadASCIIFromFile(&model, &err, argv[1]);
//bool ret = loader.LoadBinaryFromFile(&model, &err, argv[1]); // for binary glTF(.glb) 
if (!err.empty()) {
  printf("Err: %s\n", err.c_str());
}

if (!ret) {
  printf("Failed to parse glTF\n");
  return -1;
}

Saving gltTF 2.0 model

T.B.W.

Running tests.

Setup

Python 2.6 or 2.7 required. Git clone https://github.com/KhronosGroup/glTF-Sample-Models to your local dir.

Run test

After building loader_example, edit test_runner.py, then,

$ python test_runner.py