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

Update readme

Browse source
This commit is contained in:
Maik Klein 2017-04-30 15:46:38 +02:00
parent 9807a782f4
commit 67773bd2a0
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -25,10 +25,11 @@ I don't expect any big changes anymore. The library will still remain < 1.0 unti
### Explicit returns with `Result` ### Explicit returns with `Result`
Functions return a `type VkResult<T> = Result<T, vk::Result>` instead of an error code. No mutable references for the output are required. Functions return a `type VkResult<T> = Result<T, vk::Result>` instead of an error code. No mutable references for the output are required.
```Rust ```Rust
// function signature
pub fn create_instance(&self, pub fn create_instance(&self,
create_info: &vk::InstanceCreateInfo, create_info: &vk::InstanceCreateInfo,
allocation_callbacks: Option<&vk::AllocationCallbacks>) allocation_callbacks: Option<&vk::AllocationCallbacks>)
-> Result<Instance, InstanceError> { -> Result<Instance, InstanceError> { .. }
let instance = entry.create_instance(&create_info, None) let instance = entry.create_instance(&create_info, None)
.expect("Instance creation error"); .expect("Instance creation error");
``` ```