alex/ash
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Typos in README

Browse source
This commit is contained in:
maik klein 2017-01-01 08:37:12 +01:00
parent 568fe0bb11
commit 1e6049f2fa
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -116,13 +116,14 @@ let instance = entry.create_instance(...).expect("Instance creation error.");
let device = instance.create_device(...).expect("Device creation error."); let device = instance.create_device(...).expect("Device creation error.");
``` ```
A `V1_X` struct is used to indicate the version.
```Rust ```Rust
// Define your types // Define your types
type YourDevice = Device<V1_0>; type YourDevice = Device<V1_0>;
type YourInstance = Instance<V1_0>; type YourInstance = Instance<V1_0>;
``` ```
You can upgrade to future version without any breakage. You can upgrade to a future version without any breakage.
```Rust ```Rust
// For example, switching from V1_0 to V1_3 will not cause any breakage. // For example, switching from V1_0 to V1_3 will not cause any breakage.
type YourDevice = Device<V1_3>; type YourDevice = Device<V1_3>;
@ -181,7 +182,7 @@ let pool = device.create_command_pool(&pool_create_info).unwrap();
## Example ## Example
You can find the examples [here](https://github.com/MaikKlein/ash/tree/master/examples). You can find the examples [here](https://github.com/MaikKlein/ash/tree/master/examples).
All examples currently require: the LunarG Validation layers and a Vulkan library that is visible in your `PATH`. An easy way to get start is to use the [LunarG Vulkan SDK](https://lunarg.com/vulkan-sdk/) All examples currently require: the LunarG Validation layers and a Vulkan library that is visible in your `PATH`. An easy way to get started is to use the [LunarG Vulkan SDK](https://lunarg.com/vulkan-sdk/)
### [Triangle](https://github.com/MaikKlein/ash/blob/master/examples/src/bin/triangle.rs) ### [Triangle](https://github.com/MaikKlein/ash/blob/master/examples/src/bin/triangle.rs)
Displays a triangle with vertex colors. Displays a triangle with vertex colors.
``` ```