# 🔆 superluminal-perf-rs

[![Embark](https://img.shields.io/badge/embark-open%20source-blueviolet.svg)](https://embark.dev)
[![Embark](https://img.shields.io/badge/discord-ark-%237289da.svg?logo=discord)](https://discord.gg/dAuKfZS)
[![Crates.io](https://img.shields.io/crates/v/superluminal-perf.svg)](https://crates.io/crates/superluminal-perf)
[![Docs](https://docs.rs/superluminal-perf/badge.svg)](https://docs.rs/superluminal-perf)
[![dependency status](https://deps.rs/repo/github/EmbarkStudios/superluminal-perf-rs/status.svg)](https://deps.rs/repo/github/EmbarkStudios/superluminal-perf-rs)
[![Build Status](https://github.com/EmbarkStudios/superluminal-perf-rs/workflows/CI/badge.svg)](https://github.com/EmbarkStudios/superluminal-perf-rs/actions?workflow=CI)

[Superluminal Performance](https://superluminal.eu/) profiler Rust API for adding user events to captures.

## How to use

In `Cargo.toml` add:

```toml
[dependencies]
superluminal-perf = "0.2.0"
```

Example usage:

```rust
superluminal_perf::begin_event("my-event");
calc();
superluminal_perf::end_event();

superluminal_perf::begin_event("my-event2");
calc2();
superluminal_perf::end_event();
```

On non-Windows platforms the events will be compiled out.

## Contributing

[![Contributor Covenant](https://img.shields.io/badge/contributor%20covenant-v1.4-ff69b4.svg)](../CODE_OF_CONDUCT.md)

We welcome community contributions to this project.

Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

Note that the Superluminal Performance C API, that this crate uses and embeds, is licensed under BSD.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.