ispc 0.0.1

A build-time dependency for Cargo build scripts to help with compiling and linking to ISPC code and generating Rust bindings for the resulting library 
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

# ispc-rs

A small library meant to be used as a build dependency with Cargo for easily
integrating [ISPC](https://ispc.github.io/) code into Rust projects.

[![Crates.io](https://img.shields.io/crates/v/ispc.svg)](https://crates.io/crates/ispc)
[![Build Status](https://travis-ci.org/Twinklebear/ispc-rs.svg?branch=master)](https://travis-ci.org/Twinklebear/ispc-rs)

## Documentation

Rust doc can be found [here](http://www.willusher.io/ispc-rs/ispc)

## Using ispc-rs

You'll want to add a build script to your crate (`build.rs`), tell Cargo about it and add this crate
as a build dependency.

```toml
# Cargo.toml
[package]
# ...
build = "build.rs"

[build-dependencies]
ispc = "0.0.1"
```

Now you can use `ispc` to compile your code into a static library:

```rust
extern crate ispc;

fn main() {
    let ispc_files = vec!["src/simple.ispc"];
    // Optional: Only re-run the build script if the ISPC files have been changed
    for s in &ispc_files[..] {
        println!("cargo:rerun-if-changed={}", s);
    }
	// Compile our ISPC library and make sure it went ok
    if !ispc::compile_library("simple", &ispc_files[..]) {
        panic!("Failed to compile ISPC library 'simple'");
    }
}
```

Running `cargo build` should now build your ISPC files into a library and link your Rust
application with it. For extra convenience the `ispc_module` macro is provided to import
bindings to the library generated with [rust-bindgen](https://github.com/crabtw/rust-bindgen)
into a module of the same name. Note that all the functions imported will be unsafe as they're
the raw C bindings to your lib.

```rust
#[macro_use]
extern crate ispc;

// Functions exported from simple will be callable under simple::*
ispc_module!(simple);
```

Some more complete examples can be found in the [examples/](examples/) folder.

## Compile-time Requirements

Both the [ISPC compiler](https://ispc.github.io/) and [libclang](http://clang.llvm.org/)
(for [rust-bindgen](https://github.com/crabtw/rust-bindgen)) must be available in your path.

### Windows Users

You'll need to use the MSVC ABI version of Rust since this is what ISPC and Clang link with
on windows. For bindgen to find libclang you'll need to copy `libclang.lib` to `clang.lib` and
place it in your path.

I've also had issues with multiple definition link errors coming up when compiling multiple
ISPC files into a library on MSVC, I haven't figured out the cause yet. On Linux the repeated
symbols are defined in each object as well but the linker doesn't seem to mind.