18 releases (4 stable)

1.0.3 Apr 7, 2022
1.0.2 Mar 22, 2022
1.0.1 Nov 18, 2021
0.2.3 Jul 12, 2021
0.1.1 Dec 15, 2020

#6 in Rendering

Download history 15/week @ 2022-04-17 74/week @ 2022-04-24 117/week @ 2022-05-01 125/week @ 2022-05-08 329/week @ 2022-05-15 86/week @ 2022-05-22 166/week @ 2022-05-29 112/week @ 2022-06-05 9/week @ 2022-06-12 17/week @ 2022-06-19 32/week @ 2022-06-26 18/week @ 2022-07-03 26/week @ 2022-07-10 51/week @ 2022-07-17 46/week @ 2022-07-24 22/week @ 2022-07-31

146 downloads per month
Used in frenderer

Custom license

100KB
2.5K SLoC

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 5.1.0. I guess that ubuntu still has 5.0.1 on their repos. If that is the case then you can take a look at install_assimp.bash on how to install it manually.
  • Windows: Still not supported since vcpkg still only offers assimp 5.0.1.

If you need bindings for version 5.0.1 just pickup a release before 1.0.0.

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

If you want to help maintaining this package on windows or macos, please let me know. For windows support you can check the last PR related to it, https://github.com/jkvargas/russimp/pull/16.

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::CalcTangentSpace,
     PostProcess::Triangulate,
     PostProcess::JoinIdenticalVertices,
     PostProcess::SortByPType]).unwrap();

Changelog

1.0.3

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

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

Dependencies

~0.3–3MB
~66K SLoC