File canvas-draw/api/client.wiki artifact 239992612e part of check-in b1dcd0ebc6


<h1><tt>client</tt> Module</h1>

<h2>Synopsis</h2>

<table>
	<tr>
		<th>Racket</th>
		<td><code>(require (planet murphy/canvas-draw:1:0/client))</code></td>
	</tr>
	<tr>
		<th>CHICKEN</th>
		<td><code>(require-extension canvas-draw-client)</code></td>
	</tr>
</table>

Client context support.

<h2>Context Types</h2>

<h3><a id="context:image"><code><nowiki>[context:image context?]</nowiki></code></a></h3>

Context type for client side pixel buffers.

<h3><a id="context:double-buffer"><code><nowiki>[context:double-buffer context?]</nowiki></code></a></h3>

Context type for client side double buffers.

<h2>Auxiliary Functions<h2>

<h3><a id="canvas-image_rgb"><code><nowiki>(canvas-image/rgb [canvas canvas?] [x integer?] [y integer?] [width integer?] [height integer?]) → blob?</nowiki></code></a></h3>

Retrieve a region of the given canvas as an RGB image.

<h3><a id="canvas-image-put_rgb_"><code>
	<nowiki>(canvas-image-put/rgb! [canvas canvas?] [x integer?] [y integer?] [width integer?] [height integer?] [data blob?] #:width [dst-width integer? 0] #:height [dst-height integer? 0] #:x0 [src-x0 integer? 0] #:x1 [src-x1 integer? 0] #:y0 [src-y0 integer? 0] #:y1 [src-y1 integer? 0]) → void?</nowiki><br>
	<nowiki>(set! (canvas-image/rgb [canvas canvas?] [x integer?] [y integer?] [width integer?] [height integer?]) [data blob?]) → void?</nowiki>
</code></a></h3>

Replace a region of the given canvas with an RGB image.

<h3><a id="canvas-image-put_rgba_"><code><nowiki>(canvas-image-put/rgba! [canvas canvas?] [x integer?] [y integer?] [width integer?] [height integer?] [data blob?] #:width [dst-width integer? 0] #:height [dst-height integer? 0] #:x0 [src-x0 integer? 0] #:x1 [src-x1 integer? 0] #:y0 [src-y0 integer? 0] #:y1 [src-y1 integer? 0]) → void?</nowiki></code></a></h3>

Replace a region of the given canvas with an RGBA image.