Skip to content

Latest commit

 

History

History
108 lines (68 loc) · 3.66 KB

README.md

File metadata and controls

108 lines (68 loc) · 3.66 KB
Raw

russimp russimp Crates.io

Rust bindings for Assimp (https://github.com/assimp/assimp)

Overview

Russimp is a library for talking to the assimp library which enables you to read 3d models in different formats to a common structure.

By default, russimp looks for the assimp library on your computer. To install it:

  • OSX: You will need to update brew and install assimp with it.
  • Linux: You will need to install assimp through your package manager of choice.
  • Windows: You can use the prebuilt version russimp = { version = "1.0.5", features = ["prebuilt"] }

Alternately, you may prefer to use prebuilt assimp binaries or compile it yourself; in either case russimp will statically link assimp into your binary. Russimp exposes the following Cargo features to manage the assimp dependency (this documentation is reproduced from russimp-sys):

prebuilt

Download prebuilt Assimp static library binaries from github and skip building from source.

Because Assimp build is slow and have build environment requirements. We provide prebuilt binaries for common platforms and features.

When a new version is released, github action automatically runs pre-build tasks, and all prebuilt binaries are saved in github releases.

The russimp-sys build script will try to download the prebuilt binaries from github first, and skip the full source build.

static-link

Enabling static-link feature without prebuilt feature will build assimp from source.

Builds from source need the following dependencies:

  • cmake
  • clang
  • Ninja for Linux and MacOS, Visual Studio 2019 for Windows

nozlib

By default russimp-sys will statically link zlibstatic, you can disable this feature if it conflicts with other dependencies.

nolibcxx

By default russimp-sys links to libstdc++ in linux and libc++ in macos, turning this on russimp-sys won't link to the c++ standard library.

Helping

You are very welcome to help with development, adding a feature, fixing a problem or just refactoring. Try to do it with tests =)

Make sure to run cargo fmt before creating a pull request.

How to use it?

Just call Scene::from_file with the filename and the flags you want. From the scene you will have access to the underlying structs.

let scene = Scene::from_file("myfile.blend",
vec![PostProcess::CalculateTangentSpace,
     PostProcess::Triangulate,
     PostProcess::JoinIdenticalVertices,
     PostProcess::SortByPrimitiveType]).unwrap();

Changelog

2.0.5

Adding Sheen, ClearCoat and Transmission texture types.

2.0.4

Updating edition from 2018 to 2021.

2.0.3

Fixed scene metadata parsing. Fixed error where material property was not read correctly. Fixed memory leak caused by Rc cycles in the node graph.

The scene structure has been modified.

2.0.0

Fixed issue to load embedded textures.

Both material and texture structures have been modified.

1.0.6

Updating documentation

1.0.5

Added missing texture types:

  • Sheen
  • Clearcoat
  • Transmission

Material, MaterialProperty, Texture and PropertyTypeInfo are now cloneable.

1.0.4

  • Builds based on assimp v5.2.5

1.0.3

  • colors vector inside the mesh turned into Vec<Option<Vec<Color4d>>>

1.0.2

  • Expose prebuilt and other new Cargo features from russimp-sys

1.0.1

  • PostProcessing typo, GenenerateUVCoords was changed to GenerateUVCoords.

1.0.0

  • Builds based on 5.1.0 release