mirror of
https://github.com/italicsjenga/ash-molten.git
synced 2024-12-23 21:31:30 +11:00
2d8c62373f
* lib: Provide entrypoint through Ash loader w.o. implementing Entry Ash recently [dropped all traits](1) to simplify `ash::Device` usage, but this also disallows ash-molten from overriding the `EntryV1_0` trait to provide a static entrypoint intead. Fortunately ash-molten can simply pass a library loading closure that returns the static address of `vkGetInstanceProcAddr` to `EntryCustom::new_custom`, getting rid of the copied `fn create_instance` implementation at the same time. [1]: https://github.com/MaikKlein/ash/pull/412 * cargo: Disable unneeded `libloading` feature in Ash The entry-point is statically linked from `MoltenVK` and does not need any dlopen nor dlsym functionality. * Fix some typos
102 lines
4.7 KiB
Markdown
102 lines
4.7 KiB
Markdown
# 🌋 ash-molten
|
|
|
|
[](https://embark.dev)
|
|
[](https://discord.gg/dAuKfZS)
|
|
[](https://crates.io/crates/ash-molten)
|
|
[](https://docs.rs/ash-molten)
|
|
[](https://deps.rs/repo/github/EmbarkStudios/ash-molten)
|
|
[](https://github.com/EmbarkStudios/ash-molten/actions)
|
|
|
|
`ash-molten` is built on top of [ash](https://github.com/MaikKlein/ash) and exposes a new entry point to statically link with [MoltenVK](https://github.com/KhronosGroup/MoltenVK).
|
|
|
|
Requires Xcode 12 and Mac OS 10.15 (Catalina) to compile.
|
|
|
|
## Why?
|
|
|
|
* You want to compile down to a single binary that doesn't need any environment variables to bet set.
|
|
|
|
* You just want to try out [MoltenVK](https://github.com/KhronosGroup/MoltenVK) without needing to setup the SDK.
|
|
|
|
## Why not?
|
|
|
|
* [ash](https://github.com/MaikKlein/ash) already supports [MoltenVK](https://github.com/KhronosGroup/MoltenVK) via runtime linking. Runtime linking is the preferred way of using Vulkan because the loader can be updated at anytime without needing to recompile.
|
|
|
|
* `ash-molten` doesn't have access to the validation layers and therefore can not output any debug information.
|
|
|
|
## How?
|
|
|
|
```Rust
|
|
let entry = ash_molten::MoltenEntry::load().expect("Unable to load Molten");
|
|
let app_name = CString::new("Hello Static Molten").unwrap();
|
|
|
|
let appinfo = vk::ApplicationInfo::builder()
|
|
.application_name(&app_name)
|
|
.application_version(0)
|
|
.engine_name(&app_name)
|
|
.engine_version(0)
|
|
.api_version(vk_make_version!(1, 0, 0));
|
|
|
|
let create_info = vk::InstanceCreateInfo::builder().application_info(&appinfo);
|
|
let instance = entry.create_instance(&create_info, None).expect("Instance");
|
|
let devices = instance.enumerate_physical_devices();
|
|
println!("{:?}", devices);
|
|
```
|
|
You can run the example with `cargo run`.
|
|
|
|
## How does it work?
|
|
|
|
`ash-molten` links statically with [MoltenVK](https://github.com/KhronosGroup/MoltenVK), it then uses `vkGetInstanceProcAddr` to resolve all the function pointers at runtime.
|
|
|
|
### Features
|
|
|
|
`cargo build` will clone a specific release of [MoltenVK](https://github.com/KhronosGroup/MoltenVK) compile and statically link it with your application.
|
|
`cargo build --features pre-built` will download a pre-built version of MoltenVK from a release of ash-molten.
|
|
`cargo build --features external` provide own MoltenVK library.
|
|
|
|
If you want to compile [MoltenVK](https://github.com/KhronosGroup/MoltenVK) yourself, you can use the `external` feature. `cargo build --features external` requires `libMoltenVK` to be visible (`LD_LIBRARY_PATH`).
|
|
|
|
### How to update
|
|
|
|
To update the version of [MoltenVK](https://github.com/KhronosGroup/MoltenVK) uses, change the following:
|
|
|
|
- In `build.rs`, change `static VERSION = "1.1.0"` to the new [MoltenVK release](https://github.com/KhronosGroup/MoltenVK/releases) tag name
|
|
- Update the crate version in `Cargo.toml`
|
|
- Bump the patch version
|
|
- Set the version metadata to the MoltenVK release.
|
|
- E.g. `0.2.0+37` -> `0.2.1+38`.
|
|
|
|
### Updating pre-built version
|
|
|
|
To update the prebuilt version uses, change the following:
|
|
|
|
- Follow the steps mentioned above.
|
|
- Download the MoltenVK XCFramework from, for example, the Vulkan SDK for Mac or build [MoltenVK](https://github.com/KhronosGroup/MoltenVK/) yourself.
|
|
- in the case of downloading it from an external source make sure MoltenVK version matches `static VERSION`.
|
|
- From the XCFramework folder, from the built version of MoltenVK, zip the folders of platforms that need to be supported individually.
|
|
- Create a release with the tag: MoltenVK-{version number}.
|
|
- Upload the zip files to the release with the MoltenVK-{version number} tag.
|
|
|
|
## Contributing
|
|
|
|
[](../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.
|
|
|
|
### 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.
|