Commit 4141da44 authored by Janos Buttgereit's avatar Janos Buttgereit
Browse files

CLSampleBuffers: Documentation additions

parent e2daf758
......@@ -925,7 +925,13 @@ namespace ntlab
return err;
}
/** Returns true if host access is enabled, false if CL device access is enabled. */
/**
* Returns true if host device access is enabled, false if CL device access is enabled.
*
* !! Attention: This will also return true if a non-blocking map operation was enqueued. Please verify that
* the mapping has finished either by calling cl::CommandQueue::finish on the queue associated with this
* buffer or with the help of an event.
*/
constexpr bool isCurrentlyMapped() const {return isAlwaysMapped() || isMapped; }
/**
......@@ -1223,8 +1229,12 @@ namespace ntlab
/**
* Returns true if host device access is enabled, false if CL device access is enabled.
*
* !! Attention: This will also return true if a non-blocking map operation was enqueued. Please verify that
* the mapping has finished either by calling cl::CommandQueue::finish on the queue associated with this
* buffer or with the help of an event.
*/
constexpr bool isCurrentlyMapped() const {return isMapped; }
constexpr bool isCurrentlyMapped() const {return isAlwaysMapped() || isMapped; }
/**
* Returns the number of valid samples per channel currently used. To get the maximum possible numer of samples
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment