nordic-dev.net/vulkano
nordic-dev.net/vulkano
2
0
Fork 0
mirror of https://github.com/vulkano-rs/vulkano.git synced 2024-11-25 00:04:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #562 from tomaka/lock-doc

Browse Source 
Fix the documentation for locking resources
This commit is contained in:
tomaka 2017-06-27 11:46:19 +02:00 committed by GitHub
commit 39b6ac5f76
2 changed files with 18 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
vulkano/src/buffer/traits.rs
View File

@ -180,19 +180,14 @@ pub unsafe trait BufferAccess: DeviceOwned {
self.conflict_key(0, self.size())
}
/// Locks the resource for usage on the GPU. Returns `false` if the lock was already acquired.
/// Locks the resource for usage on the GPU. Returns an error if the lock can't be acquired.
///
/// This function implementation should remember that it has been called and return `false` if
/// it gets called a second time.
/// This function exists to prevent the user from causing a data race by reading and writing
/// to the same resource at the same time.
///
/// The only way to know that the GPU has stopped accessing a queue is when the buffer object
/// gets destroyed. Therefore you are encouraged to use temporary objects or handles (similar
/// to a lock) in order to represent a GPU access.
///
/// If you call this function, you should call `unlock()` afterwards once the resource is no
/// longer in use. As a consequence, the implementation is not expected to automatically
/// perform any unlocking and can rely on the fact that `unlock()` is going to be called.
/// If you call this function, you should call `unlock()` once the resource is no longer in use
/// by the GPU. The implementation is not expected to automatically perform any unlocking and
/// can rely on the fact that `unlock()` is going to be called.
fn try_gpu_lock(&self, exclusive_access: bool, queue: &Queue) -> Result<(), AccessError>;
/// Locks the resource for usage on the GPU. Supposes that the resource is already locked, and
@ -200,9 +195,9 @@ pub unsafe trait BufferAccess: DeviceOwned {
///
/// Must only be called after `try_gpu_lock()` succeeded.
///
/// If you call this function, you should call `unlock()` afterwards once the resource is no
/// longer in use. As a consequence, the implementation is not expected to automatically
/// perform any unlocking and can rely on the fact that `unlock()` is going to be called.
/// If you call this function, you should call `unlock()` once the resource is no longer in use
/// by the GPU. The implementation is not expected to automatically perform any unlocking and
/// can rely on the fact that `unlock()` is going to be called.
unsafe fn increase_gpu_lock(&self);
/// Unlocks the resource previously acquired with `try_gpu_lock` or `increase_gpu_lock`.

22
vulkano/src/image/traits.rs
View File

@ -195,18 +195,14 @@ pub unsafe trait ImageAccess {
self.conflict_key(0, self.dimensions().array_layers(), 0, self.mipmap_levels())
}
/// Locks the resource for usage on the GPU. Returns `false` if the lock was already acquired.
/// Locks the resource for usage on the GPU. Returns an error if the lock can't be acquired.
///
/// This function implementation should remember that it has been called and return `false` if
/// it gets called a second time.
/// This function exists to prevent the user from causing a data race by reading and writing
/// to the same resource at the same time.
///
/// The only way to know that the GPU has stopped accessing a queue is when the image object
/// gets destroyed. Therefore you are encouraged to use temporary objects or handles (similar
/// to a lock) in order to represent a GPU access.
///
/// If you call this function, you should call `unlock()` afterwards once the resource is no
/// longer in use. As a consequence, the implementation is not expected to automatically
/// perform any unlocking and can rely on the fact that `unlock()` is going to be called.
/// If you call this function, you should call `unlock()` once the resource is no longer in use
/// by the GPU. The implementation is not expected to automatically perform any unlocking and
/// can rely on the fact that `unlock()` is going to be called.
fn try_gpu_lock(&self, exclusive_access: bool, queue: &Queue) -> Result<(), AccessError>;
/// Locks the resource for usage on the GPU. Supposes that the resource is already locked, and
@ -214,9 +210,9 @@ pub unsafe trait ImageAccess {
///
/// Must only be called after `try_gpu_lock()` succeeded.
///
/// If you call this function, you should call `unlock()` afterwards once the resource is no
/// longer in use. As a consequence, the implementation is not expected to automatically
/// perform any unlocking and can rely on the fact that `unlock()` is going to be called.
/// If you call this function, you should call `unlock()` once the resource is no longer in use
/// by the GPU. The implementation is not expected to automatically perform any unlocking and
/// can rely on the fact that `unlock()` is going to be called.
unsafe fn increase_gpu_lock(&self);
/// Unlocks the resource previously acquired with `try_gpu_lock` or `increase_gpu_lock`.