Browse Source

Fix description of blocking write to buffer

Peter Colberg 3 years ago
parent
commit
fcb6a2ec7d
2 changed files with 17 additions and 17 deletions
  1. 3
    3
      doc/reference.html
  2. 14
    14
      doc/reference.mdwn

+ 3
- 3
doc/reference.html View File

@@ -437,7 +437,7 @@
437 437
 <p>If <code>events</code> is specified, the command is executed after the given events have completed.</p>
438 438
 </dd>
439 439
 <dt><code>queue:enqueue_map_buffer(buffer, blocking, flags[, offset, size[, events]])</code></dt>
440
-<dd><p>Enqueues a command that maps a region from a buffer object into host memory, and returns a pointer to the mapped memory region and an event object for the command. If <code>blocking</code> is <strong>true</strong>, the function waits for the command to complete; otherwise, if <strong>false</strong>, the function returns immediately. The command maps the buffer region specified by <code>offset</code> and <code>size</code> in bytes (default values are <strong>0</strong> and the size of the buffer).</p>
440
+<dd><p>Enqueues a command that maps a region from a buffer object into host memory, and returns a pointer to the mapped memory region and an event object for the command. If <code>blocking</code> is <strong>true</strong>, the function returns after the data is accessible from host memory; otherwise, if <strong>false</strong>, the function returns immediately. The command maps the buffer region specified by <code>offset</code> and <code>size</code> in bytes (default values are <strong>0</strong> and the size of the buffer).</p>
441 441
 <p><code>flags</code> can be one or a sequence of the following:</p>
442 442
 <ul>
443 443
 <li><strong>&quot;read&quot;</strong>: the buffer region is mapped for reading;</li>
@@ -451,11 +451,11 @@
451 451
 <p>If <code>events</code> is specified, the command is executed after the given events have completed.</p>
452 452
 </dd>
453 453
 <dt><code>queue:enqueue_read_buffer(buffer, blocking, [offset, size,] ptr[, events])</code></dt>
454
-<dd><p>Enqueues a command that reads from a buffer object to host memory, and returns an event object for the command. If <code>blocking</code> is <strong>true</strong>, the function waits for the command to complete; otherwise, if <strong>false</strong>, the function returns immediately. The command reads from the buffer region specified by <code>offset</code> and <code>size</code> in bytes (default values are <strong>0</strong> and the size of the buffer). The command writes to the host memory region specified by <code>ptr</code>.</p>
454
+<dd><p>Enqueues a command that reads from a buffer object to host memory, and returns an event object for the command. If <code>blocking</code> is <strong>true</strong>, the function returns after the data has been written to host memory; otherwise, if <strong>false</strong>, the function returns immediately. The command reads from the buffer region specified by <code>offset</code> and <code>size</code> in bytes (default values are <strong>0</strong> and the size of the buffer). The command writes to the host memory region specified by <code>ptr</code>.</p>
455 455
 <p>If <code>events</code> is specified, the command is executed after the given events have completed.</p>
456 456
 </dd>
457 457
 <dt><code>queue:enqueue_write_buffer(buffer, blocking, [offset, size,] ptr[, events])</code></dt>
458
-<dd><p>Enqueues a command that writes to a buffer object from host memory, and returns an event object for the command. If <code>blocking</code> is <strong>true</strong>, the function waits for the command to complete; otherwise, if <strong>false</strong>, the function returns immediately. The command writes to the buffer region specified by <code>offset</code> and <code>size</code> in bytes (default values are <strong>0</strong> and the size of the buffer). The command reads from the host memory region specified by <code>ptr</code>.</p>
458
+<dd><p>Enqueues a command that writes to a buffer object from host memory, and returns an event object for the command. If <code>blocking</code> is <strong>true</strong>, the function returns after the data has been read from host memory; otherwise, if <strong>false</strong>, the function returns immediately. The command writes to the buffer region specified by <code>offset</code> and <code>size</code> in bytes (default values are <strong>0</strong> and the size of the buffer). The command reads from the host memory region specified by <code>ptr</code>.</p>
459 459
 <p>If <code>events</code> is specified, the command is executed after the given events have completed.</p>
460 460
 </dd>
461 461
 <dt><code>queue:enqueue_copy_buffer(src_buffer, dst_buffer[, src_offset, dst_offset, size[, events]])</code></dt>

+ 14
- 14
doc/reference.mdwn View File

@@ -429,10 +429,10 @@ Command Queues
429 429
 
430 430
   : Enqueues a command that maps a region from a buffer object into host memory,
431 431
     and returns a pointer to the mapped memory region and an event object for the
432
-    command. If `blocking` is **true**, the function waits for the command to
433
-    complete; otherwise, if **false**, the function returns immediately. The
434
-    command maps the buffer region specified by `offset` and `size` in bytes
435
-    (default values are **0** and the size of the buffer).
432
+    command. If `blocking` is **true**, the function returns after the data is
433
+    accessible from host memory; otherwise, if **false**, the function returns
434
+    immediately. The command maps the buffer region specified by `offset` and
435
+    `size` in bytes (default values are **0** and the size of the buffer).
436 436
 
437 437
     `flags` can be one or a sequence of the following:
438 438
 
@@ -455,11 +455,11 @@ Command Queues
455 455
 
456 456
   : Enqueues a command that reads from a buffer object to host memory, and
457 457
     returns an event object for the command. If `blocking` is **true**, the
458
-    function waits for the command to complete; otherwise, if **false**, the
459
-    function returns immediately. The command reads from the buffer region
460
-    specified by `offset` and `size` in bytes (default values are **0** and
461
-    the size of the buffer). The command writes to the host memory region
462
-    specified by `ptr`.
458
+    function returns after the data has been written to host memory; otherwise,
459
+    if **false**, the function returns immediately. The command reads from the
460
+    buffer region specified by `offset` and `size` in bytes (default values are
461
+    **0** and the size of the buffer). The command writes to the host memory
462
+    region specified by `ptr`.
463 463
 
464 464
     If `events` is specified, the command is executed after the given events
465 465
     have completed.
@@ -468,11 +468,11 @@ Command Queues
468 468
 
469 469
   : Enqueues a command that writes to a buffer object from host memory, and
470 470
     returns an event object for the command. If `blocking` is **true**, the
471
-    function waits for the command to complete; otherwise, if **false**, the
472
-    function returns immediately. The command writes to the buffer region
473
-    specified by `offset` and `size` in bytes (default values are **0** and
474
-    the size of the buffer). The command reads from the host memory region
475
-    specified by `ptr`.
471
+    function returns after the data has been read from host memory; otherwise,
472
+    if **false**, the function returns immediately. The command writes to the
473
+    buffer region specified by `offset` and `size` in bytes (default values are
474
+    **0** and the size of the buffer). The command reads from the host memory
475
+    region specified by `ptr`.
476 476
 
477 477
     If `events` is specified, the command is executed after the given events
478 478
     have completed.

Loading…
Cancel
Save