Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 2c228b4

Browse files
committedApr 23, 2025·
Site changes [skip-ci]
1 parent d4d13ff commit 2c228b4

File tree

5 files changed

+351
-21
lines changed

5 files changed

+351
-21
lines changed
 

‎_data/ref/alpha/camera.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@
613613
],
614614
"info": {
615615
"brief": "Camera API documentation",
616-
"description": "Camera functions, messages and constants.",
616+
"description": "Messages to control camera components and camera focus.",
617617
"file": "",
618618
"group": "COMPONENTS",
619619
"language": "",

‎_data/ref/alpha/dmGameSystem.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -514,13 +514,14 @@
514514
}
515515
],
516516
"info": {
517-
"brief": "Component render constant API documentation",
518-
"description": "<span class=\"file\"><dmsdk/gamesystem/render_constants.h></span>\nApi for setting and updating component render constants",
519-
"file": "",
517+
"brief": "SDK Gui Component API documentation",
518+
"description": "Built-in scripting functions.",
519+
"file": "dmsdk/gamesys/gui.h",
520+
"group": "DEFOLD SDK",
520521
"language": "",
521-
"name": "Component Render Constants",
522+
"name": "GameSystem Gui",
522523
"namespace": "dmGameSystem",
523524
"notes": [],
524-
"path": ""
525+
"path": "engine/gamesys/src/dmsdk/gamesys/gui.h"
525526
}
526527
}

‎_data/ref/alpha/dmGraphics.json

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2555,14 +2555,13 @@
25552555
}
25562556
],
25572557
"info": {
2558-
"brief": "SDK Graphics API documentation",
2559-
"description": "Platform specific native graphics functions.",
2560-
"file": "dmsdk/graphics/graphics_native.h",
2561-
"group": "DEFOLD SDK",
2558+
"brief": "Graphics API documentation",
2559+
"description": "<span class=\"file\"><dmsdk/graphics/graphics_webgpu.h></span>\nGraphics WebGPU API",
2560+
"file": "",
25622561
"language": "",
2563-
"name": "Graphics",
2562+
"name": "Graphics WebGPU",
25642563
"namespace": "dmGraphics",
25652564
"notes": [],
2566-
"path": "engine/dlib/src/dmsdk/graphics/graphics_native.h"
2565+
"path": ""
25672566
}
25682567
}

‎_data/ref/alpha/dmHashTable.json

Lines changed: 330 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,43 @@
11
{
22
"elements": [
3+
{
4+
"brief": "Hashtable capacity. Maximum number of entries poss...",
5+
"description": "Hashtable capacity. Maximum number of entries possible to store in table",
6+
"error": "",
7+
"examples": "",
8+
"language": "",
9+
"members": [],
10+
"name": "Capacity",
11+
"notes": [],
12+
"parameters": [],
13+
"replaces": "",
14+
"returnvalues": [
15+
{
16+
"doc": "the capacity of the table",
17+
"name": "",
18+
"types": [
19+
"uint32_t"
20+
]
21+
}
22+
],
23+
"tparams": [],
24+
"type": "FUNCTION"
25+
},
26+
{
27+
"brief": "Removes all the entries from the table.",
28+
"description": "Removes all the entries from the table.",
29+
"error": "",
30+
"examples": "",
31+
"language": "",
32+
"members": [],
33+
"name": "Clear",
34+
"notes": [],
35+
"parameters": [],
36+
"replaces": "",
37+
"returnvalues": [],
38+
"tparams": [],
39+
"type": "FUNCTION"
40+
},
341
{
442
"brief": "hashtable",
543
"description": "Hashtable with chaining for collision resolution, memcpy-copy semantics (POD types) and 32-bit indicies instead of pointers. (NUMA-friendly)",
@@ -17,6 +55,60 @@
1755
"tparams": [],
1856
"type": "FUNCTION"
1957
},
58+
{
59+
"brief": "Constructor. Create an empty hashtable with zero c...",
60+
"description": "Constructor. Create an empty hashtable with zero capacity and zero hashtable (buckets)",
61+
"error": "",
62+
"examples": "",
63+
"language": "",
64+
"members": [],
65+
"name": "dmHashTable",
66+
"notes": [],
67+
"parameters": [],
68+
"replaces": "",
69+
"returnvalues": [],
70+
"tparams": [],
71+
"type": "FUNCTION"
72+
},
73+
{
74+
"brief": "Creates a hashtable array with user allocated memo...",
75+
"description": "Creates a hashtable array with user allocated memory.",
76+
"error": "",
77+
"examples": "",
78+
"language": "",
79+
"members": [],
80+
"name": "dmHashTable",
81+
"notes": [
82+
"User allocated arrays can not change capacity."
83+
],
84+
"parameters": [
85+
{
86+
"doc": "Pointer to user allocated continous data-block ((table_size<em>sizeof(uint32_t)) + (capacity</em>sizeof(dmHashTable::Entry))",
87+
"name": "user_allocated",
88+
"types": [
89+
""
90+
]
91+
},
92+
{
93+
"doc": "Hashtable size, ie number of buckets. table_size &lt; 0xffffffff",
94+
"name": "table_size",
95+
"types": [
96+
""
97+
]
98+
},
99+
{
100+
"doc": "Capacity. capacity &lt; 0xffffffff",
101+
"name": "capacity",
102+
"types": [
103+
""
104+
]
105+
}
106+
],
107+
"replaces": "",
108+
"returnvalues": [],
109+
"tparams": [],
110+
"type": "FUNCTION"
111+
},
20112
{
21113
"brief": "Specialized hash table with <span class=\"type\">uint16_t</span> as key...",
22114
"description": "Specialized hash table with <span class=\"type\">uint16_t</span> as keys",
@@ -62,6 +154,108 @@
62154
"tparams": [],
63155
"type": "FUNCTION"
64156
},
157+
{
158+
"brief": "Check if the table is empty",
159+
"description": "Check if the table is empty",
160+
"error": "",
161+
"examples": "",
162+
"language": "",
163+
"members": [],
164+
"name": "Empty",
165+
"notes": [],
166+
"parameters": [],
167+
"replaces": "",
168+
"returnvalues": [
169+
{
170+
"doc": "if the table is empty",
171+
"name": "true",
172+
"types": [
173+
""
174+
]
175+
}
176+
],
177+
"tparams": [],
178+
"type": "FUNCTION"
179+
},
180+
{
181+
"brief": "Remove key/value pair.",
182+
"description": "Remove key/value pair.",
183+
"error": "",
184+
"examples": "",
185+
"language": "",
186+
"members": [],
187+
"name": "Erase",
188+
"notes": [
189+
"Only valid if key exists in table"
190+
],
191+
"parameters": [
192+
{
193+
"doc": "Key to remove",
194+
"name": "key",
195+
"types": [
196+
"Key"
197+
]
198+
}
199+
],
200+
"replaces": "",
201+
"returnvalues": [],
202+
"tparams": [],
203+
"type": "FUNCTION"
204+
},
205+
{
206+
"brief": "Check if the table is full",
207+
"description": "Check if the table is full",
208+
"error": "",
209+
"examples": "",
210+
"language": "",
211+
"members": [],
212+
"name": "Full",
213+
"notes": [],
214+
"parameters": [],
215+
"replaces": "",
216+
"returnvalues": [
217+
{
218+
"doc": "if the table is full",
219+
"name": "true",
220+
"types": [
221+
""
222+
]
223+
}
224+
],
225+
"tparams": [],
226+
"type": "FUNCTION"
227+
},
228+
{
229+
"brief": "Get pointer to value from key",
230+
"description": "Get pointer to value from key",
231+
"error": "",
232+
"examples": "",
233+
"language": "",
234+
"members": [],
235+
"name": "Get",
236+
"notes": [],
237+
"parameters": [
238+
{
239+
"doc": "Key",
240+
"name": "key",
241+
"types": [
242+
"Key"
243+
]
244+
}
245+
],
246+
"replaces": "",
247+
"returnvalues": [
248+
{
249+
"doc": "Pointer to value. NULL if the key/value pair doesn't exist.",
250+
"name": "value",
251+
"types": [
252+
"T*"
253+
]
254+
}
255+
],
256+
"tparams": [],
257+
"type": "FUNCTION"
258+
},
65259
{
66260
"brief": "Get an iterator for the key/value pairs",
67261
"description": "Get an iterator for the key/value pairs",
@@ -85,6 +279,36 @@
85279
"tparams": [],
86280
"type": "FUNCTION"
87281
},
282+
{
283+
"brief": "Iterate over all entries in table",
284+
"description": "Iterate over all entries in table",
285+
"error": "",
286+
"examples": "",
287+
"language": "",
288+
"members": [],
289+
"name": "Iterate",
290+
"notes": [],
291+
"parameters": [
292+
{
293+
"doc": "Call-back called for every entry",
294+
"name": "call_back",
295+
"types": [
296+
""
297+
]
298+
},
299+
{
300+
"doc": "Context",
301+
"name": "context",
302+
"types": [
303+
""
304+
]
305+
}
306+
],
307+
"replaces": "",
308+
"returnvalues": [],
309+
"tparams": [],
310+
"type": "FUNCTION"
311+
},
88312
{
89313
"brief": "Iterator to the key/value pairs of a hash table",
90314
"description": "Iterator to the key/value pairs of a hash table",
@@ -133,6 +357,112 @@
133357
"returnvalues": [],
134358
"tparams": [],
135359
"type": "FUNCTION"
360+
},
361+
{
362+
"brief": "Put key/value pair in hash table. NOTE: The method...",
363+
"description": "Put key/value pair in hash table. NOTE: The method will \"assert\" if the hashtable is full.",
364+
"error": "",
365+
"examples": "",
366+
"language": "",
367+
"members": [],
368+
"name": "Put",
369+
"notes": [],
370+
"parameters": [
371+
{
372+
"doc": "Key",
373+
"name": "key",
374+
"types": [
375+
"Key"
376+
]
377+
},
378+
{
379+
"doc": "Value",
380+
"name": "value",
381+
"types": [
382+
"const T&"
383+
]
384+
}
385+
],
386+
"replaces": "",
387+
"returnvalues": [],
388+
"tparams": [],
389+
"type": "FUNCTION"
390+
},
391+
{
392+
"brief": "Set hashtable capacity. New capacity must be great...",
393+
"description": "Set hashtable capacity. New capacity must be greater or equal to current capacity",
394+
"error": "",
395+
"examples": "",
396+
"language": "",
397+
"members": [],
398+
"name": "SetCapacity",
399+
"notes": [],
400+
"parameters": [
401+
{
402+
"doc": "Hashtable size, ie number of buckets. table_size &lt; 0xffffffff",
403+
"name": "table_size",
404+
"types": [
405+
""
406+
]
407+
},
408+
{
409+
"doc": "Capacity. capacity &lt; 0xffffffff",
410+
"name": "capacity",
411+
"types": [
412+
""
413+
]
414+
}
415+
],
416+
"replaces": "",
417+
"returnvalues": [],
418+
"tparams": [],
419+
"type": "FUNCTION"
420+
},
421+
{
422+
"brief": "Number of entries stored in table. (not the actual...",
423+
"description": "Number of entries stored in table. (not the actual hashtable size)",
424+
"error": "",
425+
"examples": "",
426+
"language": "",
427+
"members": [],
428+
"name": "Size",
429+
"notes": [],
430+
"parameters": [],
431+
"replaces": "",
432+
"returnvalues": [
433+
{
434+
"doc": "of entries.",
435+
"name": "Number",
436+
"types": [
437+
""
438+
]
439+
}
440+
],
441+
"tparams": [],
442+
"type": "FUNCTION"
443+
},
444+
{
445+
"brief": "Swaps the contents of two hash tables",
446+
"description": "Swaps the contents of two hash tables",
447+
"error": "",
448+
"examples": "",
449+
"language": "",
450+
"members": [],
451+
"name": "Swap",
452+
"notes": [],
453+
"parameters": [
454+
{
455+
"doc": "the other table",
456+
"name": "other",
457+
"types": [
458+
"dmHashTable<KEY, T>&"
459+
]
460+
}
461+
],
462+
"replaces": "",
463+
"returnvalues": [],
464+
"tparams": [],
465+
"type": "FUNCTION"
136466
}
137467
],
138468
"info": {

‎_data/refindex.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -375,14 +375,6 @@
375375
"type": "defold",
376376
"url": "/ref/stable/physics"
377377
},
378-
{
379-
"branch": "alpha",
380-
"filename": "dmGameSystem",
381-
"name": "Component Render Constants",
382-
"namespace": "dmGameSystem",
383-
"type": "c",
384-
"url": "/ref/alpha/dmGameSystem"
385-
},
386378
{
387379
"branch": "alpha",
388380
"filename": "dmConditionVariable",
@@ -1371,6 +1363,14 @@
13711363
"type": "c",
13721364
"url": "/ref/stable/dmGameObject"
13731365
},
1366+
{
1367+
"branch": "alpha",
1368+
"filename": "dmGameSystem",
1369+
"name": "GameSystem Gui",
1370+
"namespace": "dmGameSystem",
1371+
"type": "c",
1372+
"url": "/ref/alpha/dmGameSystem"
1373+
},
13741374
{
13751375
"branch": "beta",
13761376
"filename": "dmGameSystem",
@@ -1390,7 +1390,7 @@
13901390
{
13911391
"branch": "alpha",
13921392
"filename": "dmGraphics",
1393-
"name": "Graphics",
1393+
"name": "Graphics WebGPU",
13941394
"namespace": "dmGraphics",
13951395
"type": "c",
13961396
"url": "/ref/alpha/dmGraphics"

0 commit comments

Comments
 (0)
Please sign in to comment.