Skip to content

Commit

Permalink
Add unity-native-plugin-vulkan/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aosoft committed Sep 12, 2020
1 parent c59bd17 commit ad93105
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 3 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Unity Native Plugin API for Rust
## Notice

* WIP
* Currently supports D3D11 and D3D12
* Currently supports D3D11, D3D12, Vulkan
* API is not stable.

## How to use
Expand All @@ -16,6 +16,13 @@ Unity Native Plugin API for Rust
[dependencies]
unity-native-plugin = { version = "*", features = ["d3d11"] }
```
* If you use Vulkan, define "unity-native-plugin-vulkan" in your dependencies.
```cargo
[dependencies]
unity-native-plugin = "*"
unity-native-plugin-vulkan = "*"
```

* Use a macro in lib.rs to define your entry points. Without this definition, UnityInterfaces cannot be used.
```rust
unity_native_plugin::unity_native_plugin_entry_point! {
Expand Down
3 changes: 2 additions & 1 deletion unity-native-plugin-sample/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ crate-type = ["cdylib"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
unity-native-plugin = { version = "0.3.0", path = "../unity-native-plugin", features = ["d3d11", "d3d12","vulkan"] }
unity-native-plugin = { version = "0.3.0", path = "../unity-native-plugin", features = ["d3d11", "d3d12"] }
unity-native-plugin-vulkan = { version = "0.3.0", path = "../unity-native-plugin-vulkan" }
winapi = { version = "0.3.9", features = ["winuser", "d3d11", "dxgiformat"] }
wio = "0.2.2"
2 changes: 1 addition & 1 deletion unity-native-plugin-vulkan/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ license = "MIT"
description = "Unity Native Plugin API (Vulkan) for Rust"
homepage = "https://github.com/aosoft/unity-native-plugin-rs"
repository = "https://github.com/aosoft/unity-native-plugin-rs"
readme = "../README.md"
readme = "README.md"
categories = ["api-bindings", "game-engines"]
keywords = ["unity"]
edition = "2018"
Expand Down
12 changes: 12 additions & 0 deletions unity-native-plugin-vulkan/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
unity-native-plugin-vulkan
====

* Define in Cargo.toml
```cargo
[dependencies]
unity-native-plugin = "*"
unity-native-plugin-vulkan = "*"
```

See Also: [unity-native-plugin-rs/README.md](../README.md)

0 comments on commit ad93105

Please sign in to comment.