Skip to content

Commit 0803f2a

Browse files
github-actions[bot]github-actions[bot]
committed
Site changes
1 parent 55f482a commit 0803f2a

1 file changed

Lines changed: 184 additions & 0 deletions

File tree

‎_data/ref/alpha/engine-gui-src-dmsdk-gui-gui-h.json‎

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,78 @@
5757
"tparams": [],
5858
"type": "ENUM"
5959
},
60+
{
61+
"brief": "Custom GUI node property value",
62+
"description": "Custom GUI node property value.\nString values returned from GetNodeCustomProperty() are owned by the GUI\nscene and must not be freed by the caller. String values passed to\nSetNodeCustomProperty() are copied.",
63+
"error": "",
64+
"examples": "",
65+
"language": "",
66+
"members": [
67+
{
68+
"doc": "the value type",
69+
"name": "m_Type",
70+
"type": "dmGui::CustomPropertyType"
71+
}
72+
],
73+
"name": "CustomProperty",
74+
"notes": [],
75+
"parameters": [],
76+
"replaces": "",
77+
"returnvalues": [],
78+
"tparams": [],
79+
"type": "STRUCT"
80+
},
81+
{
82+
"brief": "",
83+
"description": "",
84+
"error": "",
85+
"examples": "",
86+
"language": "",
87+
"members": [
88+
{
89+
"doc": "",
90+
"name": "CUSTOM_PROPERTY_TYPE_NUMBER",
91+
"type": ""
92+
},
93+
{
94+
"doc": "",
95+
"name": "CUSTOM_PROPERTY_TYPE_BOOLEAN",
96+
"type": ""
97+
},
98+
{
99+
"doc": "",
100+
"name": "CUSTOM_PROPERTY_TYPE_HASH",
101+
"type": ""
102+
},
103+
{
104+
"doc": "",
105+
"name": "CUSTOM_PROPERTY_TYPE_STRING",
106+
"type": ""
107+
},
108+
{
109+
"doc": "",
110+
"name": "CUSTOM_PROPERTY_TYPE_VECTOR3",
111+
"type": ""
112+
},
113+
{
114+
"doc": "",
115+
"name": "CUSTOM_PROPERTY_TYPE_VECTOR4",
116+
"type": ""
117+
},
118+
{
119+
"doc": "",
120+
"name": "CUSTOM_PROPERTY_TYPE_QUAT",
121+
"type": ""
122+
}
123+
],
124+
"name": "CustomPropertyType",
125+
"notes": [],
126+
"parameters": [],
127+
"replaces": "",
128+
"returnvalues": [],
129+
"tparams": [],
130+
"type": "ENUM"
131+
},
60132
{
61133
"brief": "Defer delete a node",
62134
"description": "Defer delete a node",
@@ -249,6 +321,62 @@
249321
"tparams": [],
250322
"type": "FUNCTION"
251323
},
324+
{
325+
"brief": "Get a custom property from a GUI node",
326+
"description": "Get a custom property from a GUI node.\nString values returned in the output property are owned by the GUI scene\nand must not be freed by the caller.",
327+
"error": "",
328+
"examples": "",
329+
"language": "",
330+
"members": [],
331+
"name": "GetNodeCustomProperty",
332+
"notes": [],
333+
"parameters": [
334+
{
335+
"doc": "scene",
336+
"is_optional": "False",
337+
"name": "scene",
338+
"types": [
339+
"dmGui::HScene"
340+
]
341+
},
342+
{
343+
"doc": "node",
344+
"is_optional": "False",
345+
"name": "node",
346+
"types": [
347+
"dmGui::HNode"
348+
]
349+
},
350+
{
351+
"doc": "property name hash",
352+
"is_optional": "False",
353+
"name": "key",
354+
"types": [
355+
"dmhash_t"
356+
]
357+
},
358+
{
359+
"doc": "output property",
360+
"is_optional": "False",
361+
"name": "prop",
362+
"types": [
363+
"dmGui::CustomProperty*"
364+
]
365+
}
366+
],
367+
"replaces": "",
368+
"returnvalues": [
369+
{
370+
"doc": "RESULT_OK on success",
371+
"name": "result",
372+
"types": [
373+
"dmGui::Result"
374+
]
375+
}
376+
],
377+
"tparams": [],
378+
"type": "FUNCTION"
379+
},
252380
{
253381
"brief": "Get the id of a node.",
254382
"description": "Get the id of a node.",
@@ -1009,6 +1137,62 @@
10091137
"tparams": [],
10101138
"type": "FUNCTION"
10111139
},
1140+
{
1141+
"brief": "Set a custom property on a GUI node",
1142+
"description": "Set a custom property on a GUI node.\nString values are copied, and the caller retains ownership of the input\nstring.",
1143+
"error": "",
1144+
"examples": "",
1145+
"language": "",
1146+
"members": [],
1147+
"name": "SetNodeCustomProperty",
1148+
"notes": [],
1149+
"parameters": [
1150+
{
1151+
"doc": "scene",
1152+
"is_optional": "False",
1153+
"name": "scene",
1154+
"types": [
1155+
"dmGui::HScene"
1156+
]
1157+
},
1158+
{
1159+
"doc": "node",
1160+
"is_optional": "False",
1161+
"name": "node",
1162+
"types": [
1163+
"dmGui::HNode"
1164+
]
1165+
},
1166+
{
1167+
"doc": "property name hash",
1168+
"is_optional": "False",
1169+
"name": "key",
1170+
"types": [
1171+
"dmhash_t"
1172+
]
1173+
},
1174+
{
1175+
"doc": "property value",
1176+
"is_optional": "False",
1177+
"name": "prop",
1178+
"types": [
1179+
"const dmGui::CustomProperty*"
1180+
]
1181+
}
1182+
],
1183+
"replaces": "",
1184+
"returnvalues": [
1185+
{
1186+
"doc": "RESULT_OK on success",
1187+
"name": "result",
1188+
"types": [
1189+
"dmGui::Result"
1190+
]
1191+
}
1192+
],
1193+
"tparams": [],
1194+
"type": "FUNCTION"
1195+
},
10121196
{
10131197
"brief": "Set the id of a node.",
10141198
"description": "Set the id of a node.",

0 commit comments

Comments
 (0)