@@ -57,13 +57,14 @@ Clear all graphics and recycle visuals to pools
5757
5858<hr class =" field-separator " />
5959
60- <div class="signature field-method has-description" id="lineStyle"><code><span class="field-name">lineStyle</span><span class="parenthesis">(</span><span class="operator">?</span><span class="arg-name">thickness</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a> <span class="operator">=</span> <span class="default-value">1.0</span><span class="operator">,</span> <span class="operator">?</span><span class="arg-name">color</span><span class="operator">:</span> <a href="/api-docs/clay-native/ceramic/Color/" class="type-link">Color</a> <span class="operator">=</span> <span class="default-value">null</span><span class="operator">,</span> <span class="operator">?</span><span class="arg-name">alpha</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a> <span class="operator">=</span> <span class="default-value">1.0</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Void/" class="type-link">Void</a></code><a class="header-anchor" href="#lineStyle"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
60+ <div class="signature field-method has-description" id="lineStyle"><code><span class="field-name">lineStyle</span><span class="parenthesis">(</span><span class="operator">?</span><span class="arg-name">thickness</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a> <span class="operator">=</span> <span class="default-value">0</span><span class="operator">,</span> <span class="operator">?</span><span class="arg-name">color</span><span class="operator">:</span> <a href="/api-docs/clay-native/ceramic/Color/" class="type-link">Color</a> <span class="operator">=</span> <span class="default-value">null</span><span class="operator">,</span> <span class="operator">?</span><span class="arg-name">alpha</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a> <span class="operator">=</span> <span class="default-value">1.0</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Void/" class="type-link">Void</a></code><a class="header-anchor" href="#lineStyle"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
6161
62- Set the line style for subsequent drawing operations
62+ Set the line style for subsequent drawing operations.
63+ Call with no arguments or thickness <= 0 to disable stroking.
6364
6465| Name | Type | Default |
6566| ------| ------| ---------|
66- | ` thickness ` | [ Float] ( /api-docs/clay-native/Float/ ) | ` 1. 0` |
67+ | ` thickness ` | [ Float] ( /api-docs/clay-native/Float/ ) | ` 0 ` |
6768| ` color ` | [ Color] ( /api-docs/clay-native/ceramic/Color/ ) | ` null ` |
6869| ` alpha ` | [ Float] ( /api-docs/clay-native/Float/ ) | ` 1.0 ` |
6970
@@ -99,29 +100,31 @@ Draw a rectangle
99100
100101<hr class =" field-separator " />
101102
102- <div class =" signature field-method has-description " id =" drawCircle " ><code ><span class =" field-name " >drawCircle</span ><span class =" parenthesis " >(</span ><span class =" arg-name " >x</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ><span class =" operator " >,</span > <span class =" arg-name " >y</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ><span class =" operator " >,</span > <span class =" arg-name " >radius</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ><span class =" parenthesis " >)</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Void/ " class =" type-link " >Void</a ></code ><a class =" header-anchor " href =" #drawCircle " ><span aria-hidden =" true " class =" header-anchor__symbol " >#</span ></a ></div >
103+ <div class="signature field-method has-description" id="drawCircle"><code><span class="field-name">drawCircle</span><span class="parenthesis">(</span><span class="arg-name">x</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">y</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">radius</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="operator">?</span><span class="arg-name">sides</span><span class="operator">:</span> <a href="/api-docs/clay-native/Int/" class="type-link">Int</a> <span class="operator">=</span> <span class="default-value">-1</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Void/" class="type-link">Void</a></code><a class="header-anchor" href="#drawCircle"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
103104
104105Draw a circle
105106
106- | Name | Type |
107- | ------| ------|
108- | ` x ` | [ Float] ( /api-docs/clay-native/Float/ ) |
109- | ` y ` | [ Float] ( /api-docs/clay-native/Float/ ) |
110- | ` radius ` | [ Float] ( /api-docs/clay-native/Float/ ) |
107+ | Name | Type | Default |
108+ | ------| ------| ---------|
109+ | ` x ` | [ Float] ( /api-docs/clay-native/Float/ ) | |
110+ | ` y ` | [ Float] ( /api-docs/clay-native/Float/ ) | |
111+ | ` radius ` | [ Float] ( /api-docs/clay-native/Float/ ) | |
112+ | ` sides ` | [ Int] ( /api-docs/clay-native/Int/ ) | ` -1 ` |
111113
112114<hr class =" field-separator " />
113115
114- <div class="signature field-method has-description" id="drawArc"><code><span class="field-name">drawArc</span><span class="parenthesis">(</span><span class="arg-name">x</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">y</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">radius</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">startAngle</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">endAngle</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Void/" class="type-link">Void</a></code><a class="header-anchor" href="#drawArc"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
116+ <div class="signature field-method has-description" id="drawArc"><code><span class="field-name">drawArc</span><span class="parenthesis">(</span><span class="arg-name">x</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">y</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">radius</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">startAngle</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">endAngle</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="operator">?</span><span class="arg-name">sides</span><span class="operator">:</span> <a href="/api-docs/clay-native/Int/" class="type-link">Int</a> <span class="operator">=</span> <span class="default-value">-1</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Void/" class="type-link">Void</a></code><a class="header-anchor" href="#drawArc"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
115117
116118Draw an arc
117119
118- | Name | Type |
119- | ------| ------|
120- | ` x ` | [ Float] ( /api-docs/clay-native/Float/ ) |
121- | ` y ` | [ Float] ( /api-docs/clay-native/Float/ ) |
122- | ` radius ` | [ Float] ( /api-docs/clay-native/Float/ ) |
123- | ` startAngle ` | [ Float] ( /api-docs/clay-native/Float/ ) |
124- | ` endAngle ` | [ Float] ( /api-docs/clay-native/Float/ ) |
120+ | Name | Type | Default |
121+ | ------| ------| ---------|
122+ | ` x ` | [ Float] ( /api-docs/clay-native/Float/ ) | |
123+ | ` y ` | [ Float] ( /api-docs/clay-native/Float/ ) | |
124+ | ` radius ` | [ Float] ( /api-docs/clay-native/Float/ ) | |
125+ | ` startAngle ` | [ Float] ( /api-docs/clay-native/Float/ ) | |
126+ | ` endAngle ` | [ Float] ( /api-docs/clay-native/Float/ ) | |
127+ | ` sides ` | [ Int] ( /api-docs/clay-native/Int/ ) | ` -1 ` |
125128
126129<hr class =" field-separator " />
127130
@@ -317,6 +320,12 @@ Current line alpha
317320
318321<hr class =" field-separator " />
319322
323+ <div class =" signature field-var has-description " id =" stroking " ><code ><span class =" field-name " >stroking</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Bool/ " class =" type-link " >Bool</a ></code ><a class =" header-anchor " href =" #stroking " ><span aria-hidden =" true " class =" header-anchor__symbol " >#</span ></a ></div >
324+
325+ Whether we have an active line style for stroking
326+
327+ <hr class =" field-separator " />
328+
320329<div class =" signature field-var has-description " id =" currentPath " ><code ><span class =" field-name " >currentPath</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Array/ " class =" type-link " >Array</a ><span class =" operator " >< ; </span ><a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ><span class =" operator " >> ; </span ></code ><a class =" header-anchor " href =" #currentPath " ><span aria-hidden =" true " class =" header-anchor__symbol " >#</span ></a ></div >
321330
322331Current path being built
@@ -341,6 +350,14 @@ Path segments for complex shapes
341350
342351<hr class =" field-separator " />
343352
353+ <div class =" signature field-var has-description " id =" currentDepth " ><code ><span class =" field-name " >currentDepth</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ></code ><a class =" header-anchor " href =" #currentDepth " ><span aria-hidden =" true " class =" header-anchor__symbol " >#</span ></a ></div >
354+
355+ Current depth value for ordering visuals.
356+ Incremented for each visual added to ensure proper render order.
357+ Strokes are given higher depth than fills to render on top.
358+
359+ <hr class =" field-separator " />
360+
344361<div class =" signature field-method has-description " id =" getMesh " ><code ><span class =" field-name " >getMesh</span ><span class =" parenthesis " >(</span ><span class =" parenthesis " >)</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/ceramic/Mesh/ " class =" type-link " >Mesh</a ></code ><a class =" header-anchor " href =" #getMesh " ><span aria-hidden =" true " class =" header-anchor__symbol " >#</span ></a ></div >
345362
346363Get a mesh from the pool or create a new one
@@ -375,6 +392,33 @@ Get an arc from the pool or create a new one
375392| ---------|
376393| [ Arc] ( /api-docs/clay-native/ceramic/Arc/ ) |
377394
395+ <hr class =" field-separator " />
396+
397+ <div class =" signature field-method has-description " id =" fillRect " ><code ><span class =" field-name " >fillRect</span ><span class =" parenthesis " >(</span ><span class =" arg-name " >x</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ><span class =" operator " >,</span > <span class =" arg-name " >y</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ><span class =" operator " >,</span > <span class =" arg-name " >width</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ><span class =" operator " >,</span > <span class =" arg-name " >height</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Float/ " class =" type-link " >Float</a ><span class =" parenthesis " >)</span ><span class =" operator " >:</span > <a href =" /api-docs/clay-native/Void/ " class =" type-link " >Void</a ></code ><a class =" header-anchor " href =" #fillRect " ><span aria-hidden =" true " class =" header-anchor__symbol " >#</span ></a ></div >
398+
399+ Draw a filled rectangle using a mesh with 4 vertices.
400+
401+ | Name | Type |
402+ | ------| ------|
403+ | ` x ` | [ Float] ( /api-docs/clay-native/Float/ ) |
404+ | ` y ` | [ Float] ( /api-docs/clay-native/Float/ ) |
405+ | ` width ` | [ Float] ( /api-docs/clay-native/Float/ ) |
406+ | ` height ` | [ Float] ( /api-docs/clay-native/Float/ ) |
407+
408+ <hr class =" field-separator " />
409+
410+ <div class="signature field-method has-description" id="strokeRect"><code><span class="field-name">strokeRect</span><span class="parenthesis">(</span><span class="arg-name">x</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">y</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">width</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">,</span> <span class="arg-name">height</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Void/" class="type-link">Void</a></code><a class="header-anchor" href="#strokeRect"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
411+
412+ Draw a stroked rectangle outline using a mesh with 8 vertices.
413+ More efficient than using 4 Line objects.
414+
415+ | Name | Type |
416+ | ------| ------|
417+ | ` x ` | [ Float] ( /api-docs/clay-native/Float/ ) |
418+ | ` y ` | [ Float] ( /api-docs/clay-native/Float/ ) |
419+ | ` width ` | [ Float] ( /api-docs/clay-native/Float/ ) |
420+ | ` height ` | [ Float] ( /api-docs/clay-native/Float/ ) |
421+
378422## Metadata
379423
380424| Name | Parameters |
0 commit comments