1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//#![warn(missing_docs)]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/virtualritz/opensubdiv/master/osd-logo.png"
)]
//! # Pixar OpenSubdiv Wrapper
//!
//! This is an oxidized wrapper around parts of [*Pixar’s
//! OpenSubdiv*](https://graphics.pixar.com/opensubdiv/).
//!
//! *OpenSubdiv* is a set of open source libraries that implement high
//! performance/parallel [subdivision surface](https://en.wikipedia.org/wiki/Subdivision_surface)
//! (subdiv) evaluation on CPU and GPU architectures.
//!
//! The code is optimized for drawing deforming surfaces with static topology at
//! interactive framerates.
//!
//! ## Features
//!
//! There are several features to gate the resp. [build
//! flags](https://github.com/PixarAnimationStudios/OpenSubdiv#useful-cmake-options-and-environment-variables)
//! when *OpenSubdiv* is built.
//!
//! Almost all of them are not yet implemented.
//!
//! - [ ] `clew` – TBD. Adds support for [`CLEW`](https://github.com/martijnberger/clew).
//! - [ ] `cuda` – Adds support for the [*Nvidia CUDA*](https://developer.nvidia.com/cuda-toolkit)
//!   backend. *Only valid on Linux/Windows.* *CUDA* support is almost done
//!   (Rust API wrappers are there). It just require some more work in
//!   `build.rs`. Ideally, if the `cuda` feature flag is present, `build.rs`
//!   would detect a *CUDA* installation on *Linux*/*Windows* and configure the
//!   *OpenSubdiv* build resp. panic if no installation can be found.
//! - [ ] TBD. `metal` – Adds support for the *Apple* [*Metal*](https://developer.apple.com/metal/)
//!   backend. *Only valid on macOS.*
//! - [ ] `opencl` – TBD. Adds support for the [`OpenCL`](https://www.khronos.org/opencl/)
//!   backend.
//! - [ ] `ptex` – TBD. Adds support for [`PTex`](http://ptex.us/).
//! - [x] `topology_validation` – Do (expensive) validation of topology. This
//!   checks index bounds on the Rust side and activates a bunch of topology
//!   checks on the FFI side.  *This is on by default!* Set `default-features =
//!   false` in `Cargo.toml` to switch this *off* – suggested for `release`
//!   builds.
//!
//! ## Limitations
//!
//! The original library does make use of templates in quite a few places.
//! The wrapper has specializations that cover the most common use case.
//!
//! C++ factory classes have been collapsed into the `new()` method of the resp.
//! struct that mirrors the class the C++ factory was building.
//!
//! ## API Changes From C++
//!
//! Many methods have slightly different names on the Rust side.
//!
//! Renaming was done considering these constraints:
//! * Be verbose consistently (the original API is quite verbose but does make
//!   use of abbreviations in some suprising places).
//! * Use canonical Rust naming (`num_vertices()` becomes `vertices_len()`).
//! * Use canonical Rust constructs.  Most option/configuraion structs use the
//!   [init struct pattern](https://xaeroxe.github.io/init-struct-pattern/).
//!   In places where the no simple type case is possible, the builder pattern
//!   (or anti-pattern, depending whom you ask) is used.
//! * Be brief when possible. Example: `StencilTable::numStencils()` in C++
//!   becomes `StencilTable::len()` in Rust.
//! * Use unsigned integer types, specifically `usize` and `u32`, instead of
//!   signed ones (`i32`) for anything that can only contain positive values
//!   (indices, sizes/lengths/counts, valences, arities, etc.). Types should
//!   express intent.  See also
//!   [here](https://github.com/PixarAnimationStudios/OpenSubdiv/issues/1222).
pub mod far;
pub mod osd;

#[cfg(feature = "tri_mesh_buffers")]
pub mod tri_mesh_buffers;

pub use opensubdiv_petite_sys::vtr::Index;

#[macro_use]
extern crate derive_more;

#[derive(Display, Debug)]
pub enum Error {
    #[display(fmt = "Failed to create TopologyRefiner")]
    CreateTopologyRefinerFailed,
    #[display(fmt = "Stencil evaluation failed")]
    EvalStencilsFailed,
}