diff options
author | Chris Robinson <[email protected]> | 2014-12-24 16:42:57 -0800 |
---|---|---|
committer | Chris Robinson <[email protected]> | 2014-12-24 16:42:57 -0800 |
commit | ca28d81b369cbb85b8f51f861f78e9fa88565450 (patch) | |
tree | cc13fe12b5b367f77d1bb5cc39443caae37bcaa5 /Alc/alcRing.c | |
parent | c71d8c0fc5367b61a71e1e9c7b42ade05a74d4e2 (diff) |
Update some function comments (bytes -> elements)
Diffstat (limited to 'Alc/alcRing.c')
-rw-r--r-- | Alc/alcRing.c | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/Alc/alcRing.c b/Alc/alcRing.c index 6ad7dd19..c7cbe283 100644 --- a/Alc/alcRing.c +++ b/Alc/alcRing.c @@ -132,7 +132,7 @@ void ReadRingBuffer(RingBuffer *ring, ALubyte *data, ALsizei len) /* NOTE: This lockless ringbuffer implementation is copied from JACK, extended * to include an element size. Consequently, parameters and return values for a * size or count is in 'elements', not bytes. Additionally, it only supports - * single-consumer/single-provider opreation. */ + * single-consumer/single-provider operation. */ struct ll_ringbuffer { volatile size_t write_ptr; volatile size_t read_ptr; @@ -216,8 +216,8 @@ size_t ll_ringbuffer_write_space(const ll_ringbuffer_t *rb) return (rb->size+r-w-1) & rb->size_mask; } -/* The copying data reader. Copy at most `cnt' bytes from `rb' to `dest'. - * Returns the actual number of bytes copied. */ +/* The copying data reader. Copy at most `cnt' elements from `rb' to `dest'. + * Returns the actual number of elements copied. */ size_t ll_ringbuffer_read(ll_ringbuffer_t *rb, char *dest, size_t cnt) { size_t free_cnt; @@ -251,8 +251,9 @@ size_t ll_ringbuffer_read(ll_ringbuffer_t *rb, char *dest, size_t cnt) return to_read; } -/* The copying data reader w/o read pointer advance. Copy at most `cnt' bytes - * from `rb' to `dest'. Returns the actual number of bytes copied. */ +/* The copying data reader w/o read pointer advance. Copy at most `cnt' + * elements from `rb' to `dest'. Returns the actual number of elements copied. + */ size_t ll_ringbuffer_peek(ll_ringbuffer_t *rb, char *dest, size_t cnt) { size_t free_cnt; @@ -285,8 +286,8 @@ size_t ll_ringbuffer_peek(ll_ringbuffer_t *rb, char *dest, size_t cnt) return to_read; } -/* The copying data writer. Copy at most `cnt' bytes to `rb' from `src'. - * Returns the actual number of bytes copied. */ +/* The copying data writer. Copy at most `cnt' elements to `rb' from `src'. + * Returns the actual number of elements copied. */ size_t ll_ringbuffer_write(ll_ringbuffer_t *rb, const char *src, size_t cnt) { size_t free_cnt; |