Skip to content

Commit 427df40

Browse files
committed
Update API Docs and add samples
1 parent f3a85cd commit 427df40

1,187 files changed

Lines changed: 79320 additions & 11222 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/api-docs/clay-native/backend/Backend.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,53 @@ All backend services are automatically instantiated.
152152
HTTP networking backend service.
153153
Handles HTTP requests and responses (when http plugin is enabled).
154154

155+
## Events
156+
157+
<div class="signature field-event has-description" id="event-ready"><code><span class="event-keyword">@event</span> <span class="field-name">ready</span><span class="parenthesis">(</span><span class="parenthesis">)</span></code><a class="header-anchor" href="#event-ready"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
158+
159+
Fired when the backend is ready and fully initialized.
160+
This event is emitted after all backend services are set up.
161+
162+
<div class="event-methods"><code>onReady(owner, handler)</code> <code>onceReady(owner, handler)</code> <code>offReady(?handler)</code> <code>listensReady()</code></div>
163+
164+
<hr class="field-separator" />
165+
166+
<div class="signature field-event has-description" id="event-update"><code><span class="event-keyword">@event</span> <span class="field-name">update</span><span class="parenthesis">(</span><span class="arg-name">delta</span><span class="operator">:</span> <a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="parenthesis">)</span></code><a class="header-anchor" href="#event-update"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
167+
168+
Fired every frame during the update phase.
169+
170+
171+
172+
| Name | Type | Description |
173+
|------|------|-------------|
174+
| `delta` | [Float](/api-docs/clay-native/Float/) | Time elapsed since the last update in seconds |
175+
176+
<div class="event-methods"><code>onUpdate(owner, handler)</code> <code>onceUpdate(owner, handler)</code> <code>offUpdate(?handler)</code> <code>listensUpdate()</code></div>
177+
178+
<hr class="field-separator" />
179+
180+
<div class="signature field-event has-description" id="event-render"><code><span class="event-keyword">@event</span> <span class="field-name">render</span><span class="parenthesis">(</span><span class="parenthesis">)</span></code><a class="header-anchor" href="#event-render"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
181+
182+
Fired every frame during the render phase.
183+
This event is emitted after the update phase is complete.
184+
185+
<div class="event-methods"><code>onRender(owner, handler)</code> <code>onceRender(owner, handler)</code> <code>offRender(?handler)</code> <code>listensRender()</code></div>
186+
187+
<hr class="field-separator" />
188+
189+
<div class="signature field-event has-description" id="event-sdlEvent"><code><span class="event-keyword">@event</span> <span class="field-name">sdlEvent</span><span class="parenthesis">(</span><span class="arg-name">event</span><span class="operator">:</span> <a href="/api-docs/clay-native/clay/sdl/SDLEvent/" class="type-link">clay.sdl.SDLEvent</a><span class="parenthesis">)</span></code><a class="header-anchor" href="#event-sdlEvent"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
190+
191+
Fired when an SDL event is received (SDL platforms only).
192+
Provides direct access to low-level SDL events for advanced use cases.
193+
194+
195+
196+
| Name | Type | Description |
197+
|------|------|-------------|
198+
| `event` | [clay.sdl.SDLEvent](/api-docs/clay-native/clay/sdl/SDLEvent/) | The SDL event data |
199+
200+
<div class="event-methods"><code>onSdlEvent(owner, handler)</code> <code>onceSdlEvent(owner, handler)</code> <code>offSdlEvent(?handler)</code> <code>listensSdlEvent()</code></div>
201+
155202
## Private Members
156203

157204
<div class="signature field-method has-description has-plugin" id="emitReady"><div class="plugin-name">clay</div><code><span class="field-name">emitReady</span><span class="parenthesis">(</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="#emitReady"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>

‎content/api-docs/clay-native/backend/Draw.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -641,6 +641,54 @@ float attributes (that path stays scalar).
641641

642642
<hr class="field-separator" />
643643

644+
<div class="signature field-method has-description has-plugin" id="putIndexedMeshPart"><div class="plugin-name">clay</div><code><span class="field-name">putIndexedMeshPart</span><span class="parenthesis">(</span><span class="arg-name">vertices32</span><span class="operator">:</span> <a href="/api-docs/clay-native/ceramic/Float32Array/" class="type-link">ceramic.Float32Array</a><span class="operator">,</span> <span class="arg-name">vertices</span><span class="operator">:</span> <a href="/api-docs/clay-native/Array/" class="type-link">Array</a><span class="operator">&lt;</span><a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">&gt;</span><span class="operator">,</span> <span class="arg-name">vertexList</span><span class="operator">:</span> <a href="/api-docs/clay-native/Array/" class="type-link">Array</a><span class="operator">&lt;</span><a href="/api-docs/clay-native/Int/" class="type-link">Int</a><span class="operator">&gt;</span><span class="operator">,</span> <span class="arg-name">vertexCount</span><span class="operator">:</span> <a href="/api-docs/clay-native/Int/" class="type-link">Int</a><span class="operator">,</span> <span class="arg-name">localIndices</span><span class="operator">:</span> <a href="/api-docs/clay-native/Array/" class="type-link">Array</a><span class="operator">&lt;</span><a href="/api-docs/clay-native/Int/" class="type-link">Int</a><span class="operator">&gt;</span><span class="operator">,</span> <span class="arg-name">indexCount</span><span class="operator">:</span> <a href="/api-docs/clay-native/Int/" class="type-link">Int</a><span class="operator">,</span> <span class="arg-name">hasUvs</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a><span class="operator">,</span> <span class="arg-name">uvs</span><span class="operator">:</span> <a href="/api-docs/clay-native/Array/" class="type-link">Array</a><span class="operator">&lt;</span><a href="/api-docs/clay-native/Float/" class="type-link">Float</a><span class="operator">&gt;</span><span class="operator">,</span> <span class="arg-name">uvFactorX</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">uvFactorY</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">singleColor</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a><span class="operator">,</span> <span class="arg-name">floatColors</span><span class="operator">:</span> <a href="/api-docs/clay-native/ceramic/Float32Array/" class="type-link">ceramic.Float32Array</a><span class="operator">,</span> <span class="arg-name">colors</span><span class="operator">:</span> <a href="/api-docs/clay-native/Array/" class="type-link">Array</a><span class="operator">&lt;</span><a href="/api-docs/clay-native/ceramic/AlphaColor/" class="type-link">ceramic.AlphaColor</a><span class="operator">&gt;</span><span class="operator">,</span> <span class="arg-name">r</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">g</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">b</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">a</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">globalAlpha</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">premultiply</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a><span class="operator">,</span> <span class="arg-name">zeroAlpha</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a><span class="operator">,</span> <span class="arg-name">meshAttrCount</span><span class="operator">:</span> <a href="/api-docs/clay-native/Int/" class="type-link">Int</a><span class="operator">,</span> <span class="arg-name">shaderAttrCount</span><span class="operator">:</span> <a href="/api-docs/clay-native/Int/" class="type-link">Int</a><span class="operator">,</span> <span class="arg-name">matA</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">matB</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">matC</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">matD</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">matTX</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">matTY</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">z</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">textureSlot</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="#putIndexedMeshPart"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
645+
646+
Writes a part of a mesh with its own indices (see `Renderer`): the vertices
647+
numbered in `vertexList` (`vertexCount` of them), each written once, then
648+
`indexCount` indices `base + localIndices[n]`, `base` being the first vertex
649+
written. The vertices go through `putTransformedMeshPart()`, which also writes
650+
sequential indices for them: these are then replaced by the real ones. A part
651+
never has more vertices than indices, so they fit in the same range. Colors are
652+
single or per vertex, never per index.
653+
654+
The caller must have checked buffer capacity for `vertexCount` vertices and
655+
`indexCount` indices first.
656+
657+
| Name | Type |
658+
|------|------|
659+
| `vertices32` | [ceramic.Float32Array](/api-docs/clay-native/ceramic/Float32Array/) |
660+
| `vertices` | [Array](/api-docs/clay-native/Array/)<[Float](/api-docs/clay-native/Float/)> |
661+
| `vertexList` | [Array](/api-docs/clay-native/Array/)<[Int](/api-docs/clay-native/Int/)> |
662+
| `vertexCount` | [Int](/api-docs/clay-native/Int/) |
663+
| `localIndices` | [Array](/api-docs/clay-native/Array/)<[Int](/api-docs/clay-native/Int/)> |
664+
| `indexCount` | [Int](/api-docs/clay-native/Int/) |
665+
| `hasUvs` | [Bool](/api-docs/clay-native/Bool/) |
666+
| `uvs` | [Array](/api-docs/clay-native/Array/)<[Float](/api-docs/clay-native/Float/)> |
667+
| `uvFactorX` | [Float](/api-docs/clay-native/Float/) |
668+
| `uvFactorY` | [Float](/api-docs/clay-native/Float/) |
669+
| `singleColor` | [Bool](/api-docs/clay-native/Bool/) |
670+
| `floatColors` | [ceramic.Float32Array](/api-docs/clay-native/ceramic/Float32Array/) |
671+
| `colors` | [Array](/api-docs/clay-native/Array/)<[ceramic.AlphaColor](/api-docs/clay-native/ceramic/AlphaColor/)> |
672+
| `r` | [Float](/api-docs/clay-native/Float/) |
673+
| `g` | [Float](/api-docs/clay-native/Float/) |
674+
| `b` | [Float](/api-docs/clay-native/Float/) |
675+
| `a` | [Float](/api-docs/clay-native/Float/) |
676+
| `globalAlpha` | [Float](/api-docs/clay-native/Float/) |
677+
| `premultiply` | [Bool](/api-docs/clay-native/Bool/) |
678+
| `zeroAlpha` | [Bool](/api-docs/clay-native/Bool/) |
679+
| `meshAttrCount` | [Int](/api-docs/clay-native/Int/) |
680+
| `shaderAttrCount` | [Int](/api-docs/clay-native/Int/) |
681+
| `matA` | [Float](/api-docs/clay-native/Float/) |
682+
| `matB` | [Float](/api-docs/clay-native/Float/) |
683+
| `matC` | [Float](/api-docs/clay-native/Float/) |
684+
| `matD` | [Float](/api-docs/clay-native/Float/) |
685+
| `matTX` | [Float](/api-docs/clay-native/Float/) |
686+
| `matTY` | [Float](/api-docs/clay-native/Float/) |
687+
| `z` | [Float](/api-docs/clay-native/Float/) |
688+
| `textureSlot` | [Float](/api-docs/clay-native/Float/) |
689+
690+
<hr class="field-separator" />
691+
644692
<div class="signature field-method has-description has-plugin" id="hasAnythingToFlush"><div class="plugin-name">clay</div><code><span class="field-name">hasAnythingToFlush</span><span class="parenthesis">(</span><span class="parenthesis">)</span><span class="operator">:</span> <a href="/api-docs/clay-native/Bool/" class="type-link">Bool</a></code><a class="header-anchor" href="#hasAnythingToFlush"><span aria-hidden="true" class="header-anchor__symbol">#</span></a></div>
645693

646694
Checks if there is any geometry in the buffer to flush.

0 commit comments

Comments
 (0)