gdextension_interface.h 129 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136
  1. /**************************************************************************/
  2. /* gdextension_interface.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #pragma once
  31. /* This is a C class header, you can copy it and use it directly in your own binders.
  32. * Together with the JSON file, you should be able to generate any binder.
  33. */
  34. #ifndef __cplusplus
  35. #include <stddef.h>
  36. #include <stdint.h>
  37. typedef uint32_t char32_t;
  38. typedef uint16_t char16_t;
  39. #else
  40. #include <cstddef>
  41. #include <cstdint>
  42. extern "C" {
  43. #endif
  44. /* VARIANT TYPES */
  45. typedef enum {
  46. GDEXTENSION_VARIANT_TYPE_NIL,
  47. /* atomic types */
  48. GDEXTENSION_VARIANT_TYPE_BOOL,
  49. GDEXTENSION_VARIANT_TYPE_INT,
  50. GDEXTENSION_VARIANT_TYPE_FLOAT,
  51. GDEXTENSION_VARIANT_TYPE_STRING,
  52. /* math types */
  53. GDEXTENSION_VARIANT_TYPE_VECTOR2,
  54. GDEXTENSION_VARIANT_TYPE_VECTOR2I,
  55. GDEXTENSION_VARIANT_TYPE_RECT2,
  56. GDEXTENSION_VARIANT_TYPE_RECT2I,
  57. GDEXTENSION_VARIANT_TYPE_VECTOR3,
  58. GDEXTENSION_VARIANT_TYPE_VECTOR3I,
  59. GDEXTENSION_VARIANT_TYPE_TRANSFORM2D,
  60. GDEXTENSION_VARIANT_TYPE_VECTOR4,
  61. GDEXTENSION_VARIANT_TYPE_VECTOR4I,
  62. GDEXTENSION_VARIANT_TYPE_PLANE,
  63. GDEXTENSION_VARIANT_TYPE_QUATERNION,
  64. GDEXTENSION_VARIANT_TYPE_AABB,
  65. GDEXTENSION_VARIANT_TYPE_BASIS,
  66. GDEXTENSION_VARIANT_TYPE_TRANSFORM3D,
  67. GDEXTENSION_VARIANT_TYPE_PROJECTION,
  68. /* misc types */
  69. GDEXTENSION_VARIANT_TYPE_COLOR,
  70. GDEXTENSION_VARIANT_TYPE_STRING_NAME,
  71. GDEXTENSION_VARIANT_TYPE_NODE_PATH,
  72. GDEXTENSION_VARIANT_TYPE_RID,
  73. GDEXTENSION_VARIANT_TYPE_OBJECT,
  74. GDEXTENSION_VARIANT_TYPE_CALLABLE,
  75. GDEXTENSION_VARIANT_TYPE_SIGNAL,
  76. GDEXTENSION_VARIANT_TYPE_DICTIONARY,
  77. GDEXTENSION_VARIANT_TYPE_ARRAY,
  78. /* typed arrays */
  79. GDEXTENSION_VARIANT_TYPE_PACKED_BYTE_ARRAY,
  80. GDEXTENSION_VARIANT_TYPE_PACKED_INT32_ARRAY,
  81. GDEXTENSION_VARIANT_TYPE_PACKED_INT64_ARRAY,
  82. GDEXTENSION_VARIANT_TYPE_PACKED_FLOAT32_ARRAY,
  83. GDEXTENSION_VARIANT_TYPE_PACKED_FLOAT64_ARRAY,
  84. GDEXTENSION_VARIANT_TYPE_PACKED_STRING_ARRAY,
  85. GDEXTENSION_VARIANT_TYPE_PACKED_VECTOR2_ARRAY,
  86. GDEXTENSION_VARIANT_TYPE_PACKED_VECTOR3_ARRAY,
  87. GDEXTENSION_VARIANT_TYPE_PACKED_COLOR_ARRAY,
  88. GDEXTENSION_VARIANT_TYPE_PACKED_VECTOR4_ARRAY,
  89. GDEXTENSION_VARIANT_TYPE_VARIANT_MAX
  90. } GDExtensionVariantType;
  91. typedef enum {
  92. /* comparison */
  93. GDEXTENSION_VARIANT_OP_EQUAL,
  94. GDEXTENSION_VARIANT_OP_NOT_EQUAL,
  95. GDEXTENSION_VARIANT_OP_LESS,
  96. GDEXTENSION_VARIANT_OP_LESS_EQUAL,
  97. GDEXTENSION_VARIANT_OP_GREATER,
  98. GDEXTENSION_VARIANT_OP_GREATER_EQUAL,
  99. /* mathematic */
  100. GDEXTENSION_VARIANT_OP_ADD,
  101. GDEXTENSION_VARIANT_OP_SUBTRACT,
  102. GDEXTENSION_VARIANT_OP_MULTIPLY,
  103. GDEXTENSION_VARIANT_OP_DIVIDE,
  104. GDEXTENSION_VARIANT_OP_NEGATE,
  105. GDEXTENSION_VARIANT_OP_POSITIVE,
  106. GDEXTENSION_VARIANT_OP_MODULE,
  107. GDEXTENSION_VARIANT_OP_POWER,
  108. /* bitwise */
  109. GDEXTENSION_VARIANT_OP_SHIFT_LEFT,
  110. GDEXTENSION_VARIANT_OP_SHIFT_RIGHT,
  111. GDEXTENSION_VARIANT_OP_BIT_AND,
  112. GDEXTENSION_VARIANT_OP_BIT_OR,
  113. GDEXTENSION_VARIANT_OP_BIT_XOR,
  114. GDEXTENSION_VARIANT_OP_BIT_NEGATE,
  115. /* logic */
  116. GDEXTENSION_VARIANT_OP_AND,
  117. GDEXTENSION_VARIANT_OP_OR,
  118. GDEXTENSION_VARIANT_OP_XOR,
  119. GDEXTENSION_VARIANT_OP_NOT,
  120. /* containment */
  121. GDEXTENSION_VARIANT_OP_IN,
  122. GDEXTENSION_VARIANT_OP_MAX
  123. } GDExtensionVariantOperator;
  124. // In this API there are multiple functions which expect the caller to pass a pointer
  125. // on return value as parameter.
  126. // In order to make it clear if the caller should initialize the return value or not
  127. // we have two flavor of types:
  128. // - `GDExtensionXXXPtr` for pointer on an initialized value
  129. // - `GDExtensionUninitializedXXXPtr` for pointer on uninitialized value
  130. //
  131. // Notes:
  132. // - Not respecting those requirements can seems harmless, but will lead to unexpected
  133. // segfault or memory leak (for instance with a specific compiler/OS, or when two
  134. // native extensions start doing ptrcall on each other).
  135. // - Initialization must be done with the function pointer returned by `variant_get_ptr_constructor`,
  136. // zero-initializing the variable should not be considered a valid initialization method here !
  137. // - Some types have no destructor (see `extension_api.json`'s `has_destructor` field), for
  138. // them it is always safe to skip the constructor for the return value if you are in a hurry ;-)
  139. typedef void *GDExtensionVariantPtr;
  140. typedef const void *GDExtensionConstVariantPtr;
  141. typedef void *GDExtensionUninitializedVariantPtr;
  142. typedef void *GDExtensionStringNamePtr;
  143. typedef const void *GDExtensionConstStringNamePtr;
  144. typedef void *GDExtensionUninitializedStringNamePtr;
  145. typedef void *GDExtensionStringPtr;
  146. typedef const void *GDExtensionConstStringPtr;
  147. typedef void *GDExtensionUninitializedStringPtr;
  148. typedef void *GDExtensionObjectPtr;
  149. typedef const void *GDExtensionConstObjectPtr;
  150. typedef void *GDExtensionUninitializedObjectPtr;
  151. typedef void *GDExtensionTypePtr;
  152. typedef const void *GDExtensionConstTypePtr;
  153. typedef void *GDExtensionUninitializedTypePtr;
  154. typedef const void *GDExtensionMethodBindPtr;
  155. typedef int64_t GDExtensionInt;
  156. typedef uint8_t GDExtensionBool;
  157. typedef uint64_t GDObjectInstanceID;
  158. typedef void *GDExtensionRefPtr;
  159. typedef const void *GDExtensionConstRefPtr;
  160. /* VARIANT DATA I/O */
  161. typedef enum {
  162. GDEXTENSION_CALL_OK,
  163. GDEXTENSION_CALL_ERROR_INVALID_METHOD,
  164. GDEXTENSION_CALL_ERROR_INVALID_ARGUMENT, // Expected a different variant type.
  165. GDEXTENSION_CALL_ERROR_TOO_MANY_ARGUMENTS, // Expected lower number of arguments.
  166. GDEXTENSION_CALL_ERROR_TOO_FEW_ARGUMENTS, // Expected higher number of arguments.
  167. GDEXTENSION_CALL_ERROR_INSTANCE_IS_NULL,
  168. GDEXTENSION_CALL_ERROR_METHOD_NOT_CONST, // Used for const call.
  169. } GDExtensionCallErrorType;
  170. typedef struct {
  171. GDExtensionCallErrorType error;
  172. int32_t argument;
  173. int32_t expected;
  174. } GDExtensionCallError;
  175. typedef void (*GDExtensionVariantFromTypeConstructorFunc)(GDExtensionUninitializedVariantPtr, GDExtensionTypePtr);
  176. typedef void (*GDExtensionTypeFromVariantConstructorFunc)(GDExtensionUninitializedTypePtr, GDExtensionVariantPtr);
  177. typedef void *(*GDExtensionVariantGetInternalPtrFunc)(GDExtensionVariantPtr);
  178. typedef void (*GDExtensionPtrOperatorEvaluator)(GDExtensionConstTypePtr p_left, GDExtensionConstTypePtr p_right, GDExtensionTypePtr r_result);
  179. typedef void (*GDExtensionPtrBuiltInMethod)(GDExtensionTypePtr p_base, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_return, int p_argument_count);
  180. typedef void (*GDExtensionPtrConstructor)(GDExtensionUninitializedTypePtr p_base, const GDExtensionConstTypePtr *p_args);
  181. typedef void (*GDExtensionPtrDestructor)(GDExtensionTypePtr p_base);
  182. typedef void (*GDExtensionPtrSetter)(GDExtensionTypePtr p_base, GDExtensionConstTypePtr p_value);
  183. typedef void (*GDExtensionPtrGetter)(GDExtensionConstTypePtr p_base, GDExtensionTypePtr r_value);
  184. typedef void (*GDExtensionPtrIndexedSetter)(GDExtensionTypePtr p_base, GDExtensionInt p_index, GDExtensionConstTypePtr p_value);
  185. typedef void (*GDExtensionPtrIndexedGetter)(GDExtensionConstTypePtr p_base, GDExtensionInt p_index, GDExtensionTypePtr r_value);
  186. typedef void (*GDExtensionPtrKeyedSetter)(GDExtensionTypePtr p_base, GDExtensionConstTypePtr p_key, GDExtensionConstTypePtr p_value);
  187. typedef void (*GDExtensionPtrKeyedGetter)(GDExtensionConstTypePtr p_base, GDExtensionConstTypePtr p_key, GDExtensionTypePtr r_value);
  188. typedef uint32_t (*GDExtensionPtrKeyedChecker)(GDExtensionConstVariantPtr p_base, GDExtensionConstVariantPtr p_key);
  189. typedef void (*GDExtensionPtrUtilityFunction)(GDExtensionTypePtr r_return, const GDExtensionConstTypePtr *p_args, int p_argument_count);
  190. typedef GDExtensionObjectPtr (*GDExtensionClassConstructor)();
  191. typedef void *(*GDExtensionInstanceBindingCreateCallback)(void *p_token, void *p_instance);
  192. typedef void (*GDExtensionInstanceBindingFreeCallback)(void *p_token, void *p_instance, void *p_binding);
  193. typedef GDExtensionBool (*GDExtensionInstanceBindingReferenceCallback)(void *p_token, void *p_binding, GDExtensionBool p_reference);
  194. typedef struct {
  195. GDExtensionInstanceBindingCreateCallback create_callback;
  196. GDExtensionInstanceBindingFreeCallback free_callback;
  197. GDExtensionInstanceBindingReferenceCallback reference_callback;
  198. } GDExtensionInstanceBindingCallbacks;
  199. /* EXTENSION CLASSES */
  200. typedef void *GDExtensionClassInstancePtr;
  201. typedef GDExtensionBool (*GDExtensionClassSet)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value);
  202. typedef GDExtensionBool (*GDExtensionClassGet)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
  203. typedef uint64_t (*GDExtensionClassGetRID)(GDExtensionClassInstancePtr p_instance);
  204. typedef struct {
  205. GDExtensionVariantType type;
  206. GDExtensionStringNamePtr name;
  207. GDExtensionStringNamePtr class_name;
  208. uint32_t hint; // Bitfield of `PropertyHint` (defined in `extension_api.json`).
  209. GDExtensionStringPtr hint_string;
  210. uint32_t usage; // Bitfield of `PropertyUsageFlags` (defined in `extension_api.json`).
  211. } GDExtensionPropertyInfo;
  212. typedef struct {
  213. GDExtensionStringNamePtr name;
  214. GDExtensionPropertyInfo return_value;
  215. uint32_t flags; // Bitfield of `GDExtensionClassMethodFlags`.
  216. int32_t id;
  217. /* Arguments: `default_arguments` is an array of size `argument_count`. */
  218. uint32_t argument_count;
  219. GDExtensionPropertyInfo *arguments;
  220. /* Default arguments: `default_arguments` is an array of size `default_argument_count`. */
  221. uint32_t default_argument_count;
  222. GDExtensionVariantPtr *default_arguments;
  223. } GDExtensionMethodInfo;
  224. typedef const GDExtensionPropertyInfo *(*GDExtensionClassGetPropertyList)(GDExtensionClassInstancePtr p_instance, uint32_t *r_count);
  225. typedef void (*GDExtensionClassFreePropertyList)(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list);
  226. typedef void (*GDExtensionClassFreePropertyList2)(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t p_count);
  227. typedef GDExtensionBool (*GDExtensionClassPropertyCanRevert)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name);
  228. typedef GDExtensionBool (*GDExtensionClassPropertyGetRevert)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
  229. typedef GDExtensionBool (*GDExtensionClassValidateProperty)(GDExtensionClassInstancePtr p_instance, GDExtensionPropertyInfo *p_property);
  230. typedef void (*GDExtensionClassNotification)(GDExtensionClassInstancePtr p_instance, int32_t p_what); // Deprecated. Use GDExtensionClassNotification2 instead.
  231. typedef void (*GDExtensionClassNotification2)(GDExtensionClassInstancePtr p_instance, int32_t p_what, GDExtensionBool p_reversed);
  232. typedef void (*GDExtensionClassToString)(GDExtensionClassInstancePtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr p_out);
  233. typedef void (*GDExtensionClassReference)(GDExtensionClassInstancePtr p_instance);
  234. typedef void (*GDExtensionClassUnreference)(GDExtensionClassInstancePtr p_instance);
  235. typedef void (*GDExtensionClassCallVirtual)(GDExtensionClassInstancePtr p_instance, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
  236. typedef GDExtensionObjectPtr (*GDExtensionClassCreateInstance)(void *p_class_userdata);
  237. typedef GDExtensionObjectPtr (*GDExtensionClassCreateInstance2)(void *p_class_userdata, GDExtensionBool p_notify_postinitialize);
  238. typedef void (*GDExtensionClassFreeInstance)(void *p_class_userdata, GDExtensionClassInstancePtr p_instance);
  239. typedef GDExtensionClassInstancePtr (*GDExtensionClassRecreateInstance)(void *p_class_userdata, GDExtensionObjectPtr p_object);
  240. typedef GDExtensionClassCallVirtual (*GDExtensionClassGetVirtual)(void *p_class_userdata, GDExtensionConstStringNamePtr p_name);
  241. typedef GDExtensionClassCallVirtual (*GDExtensionClassGetVirtual2)(void *p_class_userdata, GDExtensionConstStringNamePtr p_name, uint32_t p_hash);
  242. typedef void *(*GDExtensionClassGetVirtualCallData)(void *p_class_userdata, GDExtensionConstStringNamePtr p_name);
  243. typedef void *(*GDExtensionClassGetVirtualCallData2)(void *p_class_userdata, GDExtensionConstStringNamePtr p_name, uint32_t p_hash);
  244. typedef void (*GDExtensionClassCallVirtualWithData)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, void *p_virtual_call_userdata, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
  245. typedef struct {
  246. GDExtensionBool is_virtual;
  247. GDExtensionBool is_abstract;
  248. GDExtensionClassSet set_func;
  249. GDExtensionClassGet get_func;
  250. GDExtensionClassGetPropertyList get_property_list_func;
  251. GDExtensionClassFreePropertyList free_property_list_func;
  252. GDExtensionClassPropertyCanRevert property_can_revert_func;
  253. GDExtensionClassPropertyGetRevert property_get_revert_func;
  254. GDExtensionClassNotification notification_func;
  255. GDExtensionClassToString to_string_func;
  256. GDExtensionClassReference reference_func;
  257. GDExtensionClassUnreference unreference_func;
  258. GDExtensionClassCreateInstance create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
  259. GDExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
  260. GDExtensionClassGetVirtual get_virtual_func; // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
  261. GDExtensionClassGetRID get_rid_func;
  262. void *class_userdata; // Per-class user data, later accessible in instance bindings.
  263. } GDExtensionClassCreationInfo; // Deprecated. Use GDExtensionClassCreationInfo4 instead.
  264. typedef struct {
  265. GDExtensionBool is_virtual;
  266. GDExtensionBool is_abstract;
  267. GDExtensionBool is_exposed;
  268. GDExtensionClassSet set_func;
  269. GDExtensionClassGet get_func;
  270. GDExtensionClassGetPropertyList get_property_list_func;
  271. GDExtensionClassFreePropertyList free_property_list_func;
  272. GDExtensionClassPropertyCanRevert property_can_revert_func;
  273. GDExtensionClassPropertyGetRevert property_get_revert_func;
  274. GDExtensionClassValidateProperty validate_property_func;
  275. GDExtensionClassNotification2 notification_func;
  276. GDExtensionClassToString to_string_func;
  277. GDExtensionClassReference reference_func;
  278. GDExtensionClassUnreference unreference_func;
  279. GDExtensionClassCreateInstance create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
  280. GDExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
  281. GDExtensionClassRecreateInstance recreate_instance_func;
  282. // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
  283. GDExtensionClassGetVirtual get_virtual_func;
  284. // Paired with `call_virtual_with_data_func`, this is an alternative to `get_virtual_func` for extensions that
  285. // need or benefit from extra data when calling virtual functions.
  286. // Returns user data that will be passed to `call_virtual_with_data_func`.
  287. // Returning `NULL` from this function signals to Godot that the virtual function is not overridden.
  288. // Data returned from this function should be managed by the extension and must be valid until the extension is deinitialized.
  289. // You should supply either `get_virtual_func`, or `get_virtual_call_data_func` with `call_virtual_with_data_func`.
  290. GDExtensionClassGetVirtualCallData get_virtual_call_data_func;
  291. // Used to call virtual functions when `get_virtual_call_data_func` is not null.
  292. GDExtensionClassCallVirtualWithData call_virtual_with_data_func;
  293. GDExtensionClassGetRID get_rid_func;
  294. void *class_userdata; // Per-class user data, later accessible in instance bindings.
  295. } GDExtensionClassCreationInfo2; // Deprecated. Use GDExtensionClassCreationInfo4 instead.
  296. typedef struct {
  297. GDExtensionBool is_virtual;
  298. GDExtensionBool is_abstract;
  299. GDExtensionBool is_exposed;
  300. GDExtensionBool is_runtime;
  301. GDExtensionClassSet set_func;
  302. GDExtensionClassGet get_func;
  303. GDExtensionClassGetPropertyList get_property_list_func;
  304. GDExtensionClassFreePropertyList2 free_property_list_func;
  305. GDExtensionClassPropertyCanRevert property_can_revert_func;
  306. GDExtensionClassPropertyGetRevert property_get_revert_func;
  307. GDExtensionClassValidateProperty validate_property_func;
  308. GDExtensionClassNotification2 notification_func;
  309. GDExtensionClassToString to_string_func;
  310. GDExtensionClassReference reference_func;
  311. GDExtensionClassUnreference unreference_func;
  312. GDExtensionClassCreateInstance create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
  313. GDExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
  314. GDExtensionClassRecreateInstance recreate_instance_func;
  315. // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
  316. GDExtensionClassGetVirtual get_virtual_func;
  317. // Paired with `call_virtual_with_data_func`, this is an alternative to `get_virtual_func` for extensions that
  318. // need or benefit from extra data when calling virtual functions.
  319. // Returns user data that will be passed to `call_virtual_with_data_func`.
  320. // Returning `NULL` from this function signals to Godot that the virtual function is not overridden.
  321. // Data returned from this function should be managed by the extension and must be valid until the extension is deinitialized.
  322. // You should supply either `get_virtual_func`, or `get_virtual_call_data_func` with `call_virtual_with_data_func`.
  323. GDExtensionClassGetVirtualCallData get_virtual_call_data_func;
  324. // Used to call virtual functions when `get_virtual_call_data_func` is not null.
  325. GDExtensionClassCallVirtualWithData call_virtual_with_data_func;
  326. GDExtensionClassGetRID get_rid_func;
  327. void *class_userdata; // Per-class user data, later accessible in instance bindings.
  328. } GDExtensionClassCreationInfo3; // Deprecated. Use GDExtensionClassCreationInfo4 instead.
  329. typedef struct {
  330. GDExtensionBool is_virtual;
  331. GDExtensionBool is_abstract;
  332. GDExtensionBool is_exposed;
  333. GDExtensionBool is_runtime;
  334. GDExtensionConstStringPtr icon_path;
  335. GDExtensionClassSet set_func;
  336. GDExtensionClassGet get_func;
  337. GDExtensionClassGetPropertyList get_property_list_func;
  338. GDExtensionClassFreePropertyList2 free_property_list_func;
  339. GDExtensionClassPropertyCanRevert property_can_revert_func;
  340. GDExtensionClassPropertyGetRevert property_get_revert_func;
  341. GDExtensionClassValidateProperty validate_property_func;
  342. GDExtensionClassNotification2 notification_func;
  343. GDExtensionClassToString to_string_func;
  344. GDExtensionClassReference reference_func;
  345. GDExtensionClassUnreference unreference_func;
  346. GDExtensionClassCreateInstance2 create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
  347. GDExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
  348. GDExtensionClassRecreateInstance recreate_instance_func;
  349. // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
  350. GDExtensionClassGetVirtual2 get_virtual_func;
  351. // Paired with `call_virtual_with_data_func`, this is an alternative to `get_virtual_func` for extensions that
  352. // need or benefit from extra data when calling virtual functions.
  353. // Returns user data that will be passed to `call_virtual_with_data_func`.
  354. // Returning `NULL` from this function signals to Godot that the virtual function is not overridden.
  355. // Data returned from this function should be managed by the extension and must be valid until the extension is deinitialized.
  356. // You should supply either `get_virtual_func`, or `get_virtual_call_data_func` with `call_virtual_with_data_func`.
  357. GDExtensionClassGetVirtualCallData2 get_virtual_call_data_func;
  358. // Used to call virtual functions when `get_virtual_call_data_func` is not null.
  359. GDExtensionClassCallVirtualWithData call_virtual_with_data_func;
  360. void *class_userdata; // Per-class user data, later accessible in instance bindings.
  361. } GDExtensionClassCreationInfo4;
  362. typedef void *GDExtensionClassLibraryPtr;
  363. /* Passed a pointer to a PackedStringArray that should be filled with the classes that may be used by the GDExtension. */
  364. typedef void (*GDExtensionEditorGetClassesUsedCallback)(GDExtensionTypePtr p_packed_string_array);
  365. /* Method */
  366. typedef enum {
  367. GDEXTENSION_METHOD_FLAG_NORMAL = 1,
  368. GDEXTENSION_METHOD_FLAG_EDITOR = 2,
  369. GDEXTENSION_METHOD_FLAG_CONST = 4,
  370. GDEXTENSION_METHOD_FLAG_VIRTUAL = 8,
  371. GDEXTENSION_METHOD_FLAG_VARARG = 16,
  372. GDEXTENSION_METHOD_FLAG_STATIC = 32,
  373. GDEXTENSION_METHOD_FLAGS_DEFAULT = GDEXTENSION_METHOD_FLAG_NORMAL,
  374. } GDExtensionClassMethodFlags;
  375. typedef enum {
  376. GDEXTENSION_METHOD_ARGUMENT_METADATA_NONE,
  377. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT8,
  378. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT16,
  379. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT32,
  380. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT64,
  381. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT8,
  382. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT16,
  383. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT32,
  384. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT64,
  385. GDEXTENSION_METHOD_ARGUMENT_METADATA_REAL_IS_FLOAT,
  386. GDEXTENSION_METHOD_ARGUMENT_METADATA_REAL_IS_DOUBLE,
  387. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_CHAR16,
  388. GDEXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_CHAR32,
  389. } GDExtensionClassMethodArgumentMetadata;
  390. typedef void (*GDExtensionClassMethodCall)(void *method_userdata, GDExtensionClassInstancePtr p_instance, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error);
  391. typedef void (*GDExtensionClassMethodValidatedCall)(void *method_userdata, GDExtensionClassInstancePtr p_instance, const GDExtensionConstVariantPtr *p_args, GDExtensionVariantPtr r_return);
  392. typedef void (*GDExtensionClassMethodPtrCall)(void *method_userdata, GDExtensionClassInstancePtr p_instance, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
  393. typedef struct {
  394. GDExtensionStringNamePtr name;
  395. void *method_userdata;
  396. GDExtensionClassMethodCall call_func;
  397. GDExtensionClassMethodPtrCall ptrcall_func;
  398. uint32_t method_flags; // Bitfield of `GDExtensionClassMethodFlags`.
  399. /* If `has_return_value` is false, `return_value_info` and `return_value_metadata` are ignored.
  400. *
  401. * @todo Consider dropping `has_return_value` and making the other two properties match `GDExtensionMethodInfo` and `GDExtensionClassVirtualMethod` for consistency in future version of this struct.
  402. */
  403. GDExtensionBool has_return_value;
  404. GDExtensionPropertyInfo *return_value_info;
  405. GDExtensionClassMethodArgumentMetadata return_value_metadata;
  406. /* Arguments: `arguments_info` and `arguments_metadata` are array of size `argument_count`.
  407. * Name and hint information for the argument can be omitted in release builds. Class name should always be present if it applies.
  408. *
  409. * @todo Consider renaming `arguments_info` to `arguments` for consistency in future version of this struct.
  410. */
  411. uint32_t argument_count;
  412. GDExtensionPropertyInfo *arguments_info;
  413. GDExtensionClassMethodArgumentMetadata *arguments_metadata;
  414. /* Default arguments: `default_arguments` is an array of size `default_argument_count`. */
  415. uint32_t default_argument_count;
  416. GDExtensionVariantPtr *default_arguments;
  417. } GDExtensionClassMethodInfo;
  418. typedef struct {
  419. GDExtensionStringNamePtr name;
  420. uint32_t method_flags; // Bitfield of `GDExtensionClassMethodFlags`.
  421. GDExtensionPropertyInfo return_value;
  422. GDExtensionClassMethodArgumentMetadata return_value_metadata;
  423. uint32_t argument_count;
  424. GDExtensionPropertyInfo *arguments;
  425. GDExtensionClassMethodArgumentMetadata *arguments_metadata;
  426. } GDExtensionClassVirtualMethodInfo;
  427. typedef void (*GDExtensionCallableCustomCall)(void *callable_userdata, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error);
  428. typedef GDExtensionBool (*GDExtensionCallableCustomIsValid)(void *callable_userdata);
  429. typedef void (*GDExtensionCallableCustomFree)(void *callable_userdata);
  430. typedef uint32_t (*GDExtensionCallableCustomHash)(void *callable_userdata);
  431. typedef GDExtensionBool (*GDExtensionCallableCustomEqual)(void *callable_userdata_a, void *callable_userdata_b);
  432. typedef GDExtensionBool (*GDExtensionCallableCustomLessThan)(void *callable_userdata_a, void *callable_userdata_b);
  433. typedef void (*GDExtensionCallableCustomToString)(void *callable_userdata, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out);
  434. typedef GDExtensionInt (*GDExtensionCallableCustomGetArgumentCount)(void *callable_userdata, GDExtensionBool *r_is_valid);
  435. typedef struct {
  436. /* Only `call_func` and `token` are strictly required, however, `object_id` should be passed if its not a static method.
  437. *
  438. * `token` should point to an address that uniquely identifies the GDExtension (for example, the
  439. * `GDExtensionClassLibraryPtr` passed to the entry symbol function.
  440. *
  441. * `hash_func`, `equal_func`, and `less_than_func` are optional. If not provided both `call_func` and
  442. * `callable_userdata` together are used as the identity of the callable for hashing and comparison purposes.
  443. *
  444. * The hash returned by `hash_func` is cached, `hash_func` will not be called more than once per callable.
  445. *
  446. * `is_valid_func` is necessary if the validity of the callable can change before destruction.
  447. *
  448. * `free_func` is necessary if `callable_userdata` needs to be cleaned up when the callable is freed.
  449. */
  450. void *callable_userdata;
  451. void *token;
  452. GDObjectInstanceID object_id;
  453. GDExtensionCallableCustomCall call_func;
  454. GDExtensionCallableCustomIsValid is_valid_func;
  455. GDExtensionCallableCustomFree free_func;
  456. GDExtensionCallableCustomHash hash_func;
  457. GDExtensionCallableCustomEqual equal_func;
  458. GDExtensionCallableCustomLessThan less_than_func;
  459. GDExtensionCallableCustomToString to_string_func;
  460. } GDExtensionCallableCustomInfo; // Deprecated. Use GDExtensionCallableCustomInfo2 instead.
  461. typedef struct {
  462. /* Only `call_func` and `token` are strictly required, however, `object_id` should be passed if its not a static method.
  463. *
  464. * `token` should point to an address that uniquely identifies the GDExtension (for example, the
  465. * `GDExtensionClassLibraryPtr` passed to the entry symbol function.
  466. *
  467. * `hash_func`, `equal_func`, and `less_than_func` are optional. If not provided both `call_func` and
  468. * `callable_userdata` together are used as the identity of the callable for hashing and comparison purposes.
  469. *
  470. * The hash returned by `hash_func` is cached, `hash_func` will not be called more than once per callable.
  471. *
  472. * `is_valid_func` is necessary if the validity of the callable can change before destruction.
  473. *
  474. * `free_func` is necessary if `callable_userdata` needs to be cleaned up when the callable is freed.
  475. */
  476. void *callable_userdata;
  477. void *token;
  478. GDObjectInstanceID object_id;
  479. GDExtensionCallableCustomCall call_func;
  480. GDExtensionCallableCustomIsValid is_valid_func;
  481. GDExtensionCallableCustomFree free_func;
  482. GDExtensionCallableCustomHash hash_func;
  483. GDExtensionCallableCustomEqual equal_func;
  484. GDExtensionCallableCustomLessThan less_than_func;
  485. GDExtensionCallableCustomToString to_string_func;
  486. GDExtensionCallableCustomGetArgumentCount get_argument_count_func;
  487. } GDExtensionCallableCustomInfo2;
  488. /* SCRIPT INSTANCE EXTENSION */
  489. typedef void *GDExtensionScriptInstanceDataPtr; // Pointer to custom ScriptInstance native implementation.
  490. typedef GDExtensionBool (*GDExtensionScriptInstanceSet)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value);
  491. typedef GDExtensionBool (*GDExtensionScriptInstanceGet)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
  492. typedef const GDExtensionPropertyInfo *(*GDExtensionScriptInstanceGetPropertyList)(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
  493. typedef void (*GDExtensionScriptInstanceFreePropertyList)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionPropertyInfo *p_list); // Deprecated. Use GDExtensionScriptInstanceFreePropertyList2 instead.
  494. typedef void (*GDExtensionScriptInstanceFreePropertyList2)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t p_count);
  495. typedef GDExtensionBool (*GDExtensionScriptInstanceGetClassCategory)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *p_class_category);
  496. typedef GDExtensionVariantType (*GDExtensionScriptInstanceGetPropertyType)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
  497. typedef GDExtensionBool (*GDExtensionScriptInstanceValidateProperty)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *p_property);
  498. typedef GDExtensionBool (*GDExtensionScriptInstancePropertyCanRevert)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
  499. typedef GDExtensionBool (*GDExtensionScriptInstancePropertyGetRevert)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
  500. typedef GDExtensionObjectPtr (*GDExtensionScriptInstanceGetOwner)(GDExtensionScriptInstanceDataPtr p_instance);
  501. typedef void (*GDExtensionScriptInstancePropertyStateAdd)(GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value, void *p_userdata);
  502. typedef void (*GDExtensionScriptInstanceGetPropertyState)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionScriptInstancePropertyStateAdd p_add_func, void *p_userdata);
  503. typedef const GDExtensionMethodInfo *(*GDExtensionScriptInstanceGetMethodList)(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
  504. typedef void (*GDExtensionScriptInstanceFreeMethodList)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionMethodInfo *p_list); // Deprecated. Use GDExtensionScriptInstanceFreeMethodList2 instead.
  505. typedef void (*GDExtensionScriptInstanceFreeMethodList2)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionMethodInfo *p_list, uint32_t p_count);
  506. typedef GDExtensionBool (*GDExtensionScriptInstanceHasMethod)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
  507. typedef GDExtensionInt (*GDExtensionScriptInstanceGetMethodArgumentCount)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
  508. typedef void (*GDExtensionScriptInstanceCall)(GDExtensionScriptInstanceDataPtr p_self, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error);
  509. typedef void (*GDExtensionScriptInstanceNotification)(GDExtensionScriptInstanceDataPtr p_instance, int32_t p_what); // Deprecated. Use GDExtensionScriptInstanceNotification2 instead.
  510. typedef void (*GDExtensionScriptInstanceNotification2)(GDExtensionScriptInstanceDataPtr p_instance, int32_t p_what, GDExtensionBool p_reversed);
  511. typedef void (*GDExtensionScriptInstanceToString)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out);
  512. typedef void (*GDExtensionScriptInstanceRefCountIncremented)(GDExtensionScriptInstanceDataPtr p_instance);
  513. typedef GDExtensionBool (*GDExtensionScriptInstanceRefCountDecremented)(GDExtensionScriptInstanceDataPtr p_instance);
  514. typedef GDExtensionObjectPtr (*GDExtensionScriptInstanceGetScript)(GDExtensionScriptInstanceDataPtr p_instance);
  515. typedef GDExtensionBool (*GDExtensionScriptInstanceIsPlaceholder)(GDExtensionScriptInstanceDataPtr p_instance);
  516. typedef void *GDExtensionScriptLanguagePtr;
  517. typedef GDExtensionScriptLanguagePtr (*GDExtensionScriptInstanceGetLanguage)(GDExtensionScriptInstanceDataPtr p_instance);
  518. typedef void (*GDExtensionScriptInstanceFree)(GDExtensionScriptInstanceDataPtr p_instance);
  519. typedef void *GDExtensionScriptInstancePtr; // Pointer to ScriptInstance.
  520. typedef struct {
  521. GDExtensionScriptInstanceSet set_func;
  522. GDExtensionScriptInstanceGet get_func;
  523. GDExtensionScriptInstanceGetPropertyList get_property_list_func;
  524. GDExtensionScriptInstanceFreePropertyList free_property_list_func;
  525. GDExtensionScriptInstancePropertyCanRevert property_can_revert_func;
  526. GDExtensionScriptInstancePropertyGetRevert property_get_revert_func;
  527. GDExtensionScriptInstanceGetOwner get_owner_func;
  528. GDExtensionScriptInstanceGetPropertyState get_property_state_func;
  529. GDExtensionScriptInstanceGetMethodList get_method_list_func;
  530. GDExtensionScriptInstanceFreeMethodList free_method_list_func;
  531. GDExtensionScriptInstanceGetPropertyType get_property_type_func;
  532. GDExtensionScriptInstanceHasMethod has_method_func;
  533. GDExtensionScriptInstanceCall call_func;
  534. GDExtensionScriptInstanceNotification notification_func;
  535. GDExtensionScriptInstanceToString to_string_func;
  536. GDExtensionScriptInstanceRefCountIncremented refcount_incremented_func;
  537. GDExtensionScriptInstanceRefCountDecremented refcount_decremented_func;
  538. GDExtensionScriptInstanceGetScript get_script_func;
  539. GDExtensionScriptInstanceIsPlaceholder is_placeholder_func;
  540. GDExtensionScriptInstanceSet set_fallback_func;
  541. GDExtensionScriptInstanceGet get_fallback_func;
  542. GDExtensionScriptInstanceGetLanguage get_language_func;
  543. GDExtensionScriptInstanceFree free_func;
  544. } GDExtensionScriptInstanceInfo; // Deprecated. Use GDExtensionScriptInstanceInfo3 instead.
  545. typedef struct {
  546. GDExtensionScriptInstanceSet set_func;
  547. GDExtensionScriptInstanceGet get_func;
  548. GDExtensionScriptInstanceGetPropertyList get_property_list_func;
  549. GDExtensionScriptInstanceFreePropertyList free_property_list_func;
  550. GDExtensionScriptInstanceGetClassCategory get_class_category_func; // Optional. Set to NULL for the default behavior.
  551. GDExtensionScriptInstancePropertyCanRevert property_can_revert_func;
  552. GDExtensionScriptInstancePropertyGetRevert property_get_revert_func;
  553. GDExtensionScriptInstanceGetOwner get_owner_func;
  554. GDExtensionScriptInstanceGetPropertyState get_property_state_func;
  555. GDExtensionScriptInstanceGetMethodList get_method_list_func;
  556. GDExtensionScriptInstanceFreeMethodList free_method_list_func;
  557. GDExtensionScriptInstanceGetPropertyType get_property_type_func;
  558. GDExtensionScriptInstanceValidateProperty validate_property_func;
  559. GDExtensionScriptInstanceHasMethod has_method_func;
  560. GDExtensionScriptInstanceCall call_func;
  561. GDExtensionScriptInstanceNotification2 notification_func;
  562. GDExtensionScriptInstanceToString to_string_func;
  563. GDExtensionScriptInstanceRefCountIncremented refcount_incremented_func;
  564. GDExtensionScriptInstanceRefCountDecremented refcount_decremented_func;
  565. GDExtensionScriptInstanceGetScript get_script_func;
  566. GDExtensionScriptInstanceIsPlaceholder is_placeholder_func;
  567. GDExtensionScriptInstanceSet set_fallback_func;
  568. GDExtensionScriptInstanceGet get_fallback_func;
  569. GDExtensionScriptInstanceGetLanguage get_language_func;
  570. GDExtensionScriptInstanceFree free_func;
  571. } GDExtensionScriptInstanceInfo2; // Deprecated. Use GDExtensionScriptInstanceInfo3 instead.
  572. typedef struct {
  573. GDExtensionScriptInstanceSet set_func;
  574. GDExtensionScriptInstanceGet get_func;
  575. GDExtensionScriptInstanceGetPropertyList get_property_list_func;
  576. GDExtensionScriptInstanceFreePropertyList2 free_property_list_func;
  577. GDExtensionScriptInstanceGetClassCategory get_class_category_func; // Optional. Set to NULL for the default behavior.
  578. GDExtensionScriptInstancePropertyCanRevert property_can_revert_func;
  579. GDExtensionScriptInstancePropertyGetRevert property_get_revert_func;
  580. GDExtensionScriptInstanceGetOwner get_owner_func;
  581. GDExtensionScriptInstanceGetPropertyState get_property_state_func;
  582. GDExtensionScriptInstanceGetMethodList get_method_list_func;
  583. GDExtensionScriptInstanceFreeMethodList2 free_method_list_func;
  584. GDExtensionScriptInstanceGetPropertyType get_property_type_func;
  585. GDExtensionScriptInstanceValidateProperty validate_property_func;
  586. GDExtensionScriptInstanceHasMethod has_method_func;
  587. GDExtensionScriptInstanceGetMethodArgumentCount get_method_argument_count_func;
  588. GDExtensionScriptInstanceCall call_func;
  589. GDExtensionScriptInstanceNotification2 notification_func;
  590. GDExtensionScriptInstanceToString to_string_func;
  591. GDExtensionScriptInstanceRefCountIncremented refcount_incremented_func;
  592. GDExtensionScriptInstanceRefCountDecremented refcount_decremented_func;
  593. GDExtensionScriptInstanceGetScript get_script_func;
  594. GDExtensionScriptInstanceIsPlaceholder is_placeholder_func;
  595. GDExtensionScriptInstanceSet set_fallback_func;
  596. GDExtensionScriptInstanceGet get_fallback_func;
  597. GDExtensionScriptInstanceGetLanguage get_language_func;
  598. GDExtensionScriptInstanceFree free_func;
  599. } GDExtensionScriptInstanceInfo3;
  600. /* INITIALIZATION */
  601. typedef enum {
  602. GDEXTENSION_INITIALIZATION_CORE,
  603. GDEXTENSION_INITIALIZATION_SERVERS,
  604. GDEXTENSION_INITIALIZATION_SCENE,
  605. GDEXTENSION_INITIALIZATION_EDITOR,
  606. GDEXTENSION_MAX_INITIALIZATION_LEVEL,
  607. } GDExtensionInitializationLevel;
  608. typedef struct {
  609. /* Minimum initialization level required.
  610. * If Core or Servers, the extension needs editor or game restart to take effect */
  611. GDExtensionInitializationLevel minimum_initialization_level;
  612. /* Up to the user to supply when initializing */
  613. void *userdata;
  614. /* This function will be called multiple times for each initialization level. */
  615. void (*initialize)(void *userdata, GDExtensionInitializationLevel p_level);
  616. void (*deinitialize)(void *userdata, GDExtensionInitializationLevel p_level);
  617. } GDExtensionInitialization;
  618. typedef void (*GDExtensionInterfaceFunctionPtr)();
  619. typedef GDExtensionInterfaceFunctionPtr (*GDExtensionInterfaceGetProcAddress)(const char *p_function_name);
  620. /*
  621. * Each GDExtension should define a C function that matches the signature of GDExtensionInitializationFunction,
  622. * and export it so that it can be loaded via dlopen() or equivalent for the given platform.
  623. *
  624. * For example:
  625. *
  626. * GDExtensionBool my_extension_init(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization);
  627. *
  628. * This function's name must be specified as the 'entry_symbol' in the .gdextension file.
  629. *
  630. * This makes it the entry point of the GDExtension and will be called on initialization.
  631. *
  632. * The GDExtension can then modify the r_initialization structure, setting the minimum initialization level,
  633. * and providing pointers to functions that will be called at various stages of initialization/shutdown.
  634. *
  635. * The rest of the GDExtension's interface to Godot consists of function pointers that can be loaded
  636. * by calling p_get_proc_address("...") with the name of the function.
  637. *
  638. * For example:
  639. *
  640. * GDExtensionInterfaceGetGodotVersion get_godot_version = (GDExtensionInterfaceGetGodotVersion)p_get_proc_address("get_godot_version");
  641. *
  642. * (Note that snippet may cause "cast between incompatible function types" on some compilers, you can
  643. * silence this by adding an intermediary `void*` cast.)
  644. *
  645. * You can then call it like a normal function:
  646. *
  647. * GDExtensionGodotVersion godot_version;
  648. * get_godot_version(&godot_version);
  649. * printf("Godot v%d.%d.%d\n", godot_version.major, godot_version.minor, godot_version.patch);
  650. *
  651. * All of these interface functions are described below, together with the name that's used to load it,
  652. * and the function pointer typedef that shows its signature.
  653. */
  654. typedef GDExtensionBool (*GDExtensionInitializationFunction)(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization);
  655. /* INTERFACE */
  656. typedef struct {
  657. uint32_t major;
  658. uint32_t minor;
  659. uint32_t patch;
  660. const char *string;
  661. } GDExtensionGodotVersion;
  662. typedef struct {
  663. uint32_t major;
  664. uint32_t minor;
  665. uint32_t patch;
  666. uint32_t hex; // Full version encoded as hexadecimal with one byte (2 hex digits) per number (e.g. for "3.1.12" it would be 0x03010C)
  667. const char *status; // (e.g. "stable", "beta", "rc1", "rc2")
  668. const char *build; // (e.g. "custom_build")
  669. const char *hash; // Full Git commit hash.
  670. uint64_t timestamp; // Git commit date UNIX timestamp in seconds, or 0 if unavailable.
  671. const char *string; // (e.g. "Godot v3.1.4.stable.official.mono")
  672. } GDExtensionGodotVersion2;
  673. /**
  674. * @name get_godot_version
  675. * @since 4.1
  676. * @deprecated in Godot 4.5. Use `get_godot_version2` instead.
  677. *
  678. * Gets the Godot version that the GDExtension was loaded into.
  679. *
  680. * @param r_godot_version A pointer to the structure to write the version information into.
  681. */
  682. typedef void (*GDExtensionInterfaceGetGodotVersion)(GDExtensionGodotVersion *r_godot_version);
  683. /**
  684. * @name get_godot_version2
  685. * @since 4.5
  686. *
  687. * Gets the Godot version that the GDExtension was loaded into.
  688. *
  689. * @param r_godot_version A pointer to the structure to write the version information into.
  690. */
  691. typedef void (*GDExtensionInterfaceGetGodotVersion2)(GDExtensionGodotVersion2 *r_godot_version);
  692. /* INTERFACE: Memory */
  693. /**
  694. * @name mem_alloc
  695. * @since 4.1
  696. *
  697. * Allocates memory.
  698. *
  699. * @param p_bytes The amount of memory to allocate in bytes.
  700. *
  701. * @return A pointer to the allocated memory, or NULL if unsuccessful.
  702. */
  703. typedef void *(*GDExtensionInterfaceMemAlloc)(size_t p_bytes);
  704. /**
  705. * @name mem_realloc
  706. * @since 4.1
  707. *
  708. * Reallocates memory.
  709. *
  710. * @param p_ptr A pointer to the previously allocated memory.
  711. * @param p_bytes The number of bytes to resize the memory block to.
  712. *
  713. * @return A pointer to the allocated memory, or NULL if unsuccessful.
  714. */
  715. typedef void *(*GDExtensionInterfaceMemRealloc)(void *p_ptr, size_t p_bytes);
  716. /**
  717. * @name mem_free
  718. * @since 4.1
  719. *
  720. * Frees memory.
  721. *
  722. * @param p_ptr A pointer to the previously allocated memory.
  723. */
  724. typedef void (*GDExtensionInterfaceMemFree)(void *p_ptr);
  725. /* INTERFACE: Godot Core */
  726. /**
  727. * @name print_error
  728. * @since 4.1
  729. *
  730. * Logs an error to Godot's built-in debugger and to the OS terminal.
  731. *
  732. * @param p_description The code triggering the error.
  733. * @param p_function The function name where the error occurred.
  734. * @param p_file The file where the error occurred.
  735. * @param p_line The line where the error occurred.
  736. * @param p_editor_notify Whether or not to notify the editor.
  737. */
  738. typedef void (*GDExtensionInterfacePrintError)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  739. /**
  740. * @name print_error_with_message
  741. * @since 4.1
  742. *
  743. * Logs an error with a message to Godot's built-in debugger and to the OS terminal.
  744. *
  745. * @param p_description The code triggering the error.
  746. * @param p_message The message to show along with the error.
  747. * @param p_function The function name where the error occurred.
  748. * @param p_file The file where the error occurred.
  749. * @param p_line The line where the error occurred.
  750. * @param p_editor_notify Whether or not to notify the editor.
  751. */
  752. typedef void (*GDExtensionInterfacePrintErrorWithMessage)(const char *p_description, const char *p_message, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  753. /**
  754. * @name print_warning
  755. * @since 4.1
  756. *
  757. * Logs a warning to Godot's built-in debugger and to the OS terminal.
  758. *
  759. * @param p_description The code triggering the warning.
  760. * @param p_function The function name where the warning occurred.
  761. * @param p_file The file where the warning occurred.
  762. * @param p_line The line where the warning occurred.
  763. * @param p_editor_notify Whether or not to notify the editor.
  764. */
  765. typedef void (*GDExtensionInterfacePrintWarning)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  766. /**
  767. * @name print_warning_with_message
  768. * @since 4.1
  769. *
  770. * Logs a warning with a message to Godot's built-in debugger and to the OS terminal.
  771. *
  772. * @param p_description The code triggering the warning.
  773. * @param p_message The message to show along with the warning.
  774. * @param p_function The function name where the warning occurred.
  775. * @param p_file The file where the warning occurred.
  776. * @param p_line The line where the warning occurred.
  777. * @param p_editor_notify Whether or not to notify the editor.
  778. */
  779. typedef void (*GDExtensionInterfacePrintWarningWithMessage)(const char *p_description, const char *p_message, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  780. /**
  781. * @name print_script_error
  782. * @since 4.1
  783. *
  784. * Logs a script error to Godot's built-in debugger and to the OS terminal.
  785. *
  786. * @param p_description The code triggering the error.
  787. * @param p_function The function name where the error occurred.
  788. * @param p_file The file where the error occurred.
  789. * @param p_line The line where the error occurred.
  790. * @param p_editor_notify Whether or not to notify the editor.
  791. */
  792. typedef void (*GDExtensionInterfacePrintScriptError)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  793. /**
  794. * @name print_script_error_with_message
  795. * @since 4.1
  796. *
  797. * Logs a script error with a message to Godot's built-in debugger and to the OS terminal.
  798. *
  799. * @param p_description The code triggering the error.
  800. * @param p_message The message to show along with the error.
  801. * @param p_function The function name where the error occurred.
  802. * @param p_file The file where the error occurred.
  803. * @param p_line The line where the error occurred.
  804. * @param p_editor_notify Whether or not to notify the editor.
  805. */
  806. typedef void (*GDExtensionInterfacePrintScriptErrorWithMessage)(const char *p_description, const char *p_message, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify);
  807. /**
  808. * @name get_native_struct_size
  809. * @since 4.1
  810. *
  811. * Gets the size of a native struct (ex. ObjectID) in bytes.
  812. *
  813. * @param p_name A pointer to a StringName identifying the struct name.
  814. *
  815. * @return The size in bytes.
  816. */
  817. typedef uint64_t (*GDExtensionInterfaceGetNativeStructSize)(GDExtensionConstStringNamePtr p_name);
  818. /* INTERFACE: Variant */
  819. /**
  820. * @name variant_new_copy
  821. * @since 4.1
  822. *
  823. * Copies one Variant into a another.
  824. *
  825. * @param r_dest A pointer to the destination Variant.
  826. * @param p_src A pointer to the source Variant.
  827. */
  828. typedef void (*GDExtensionInterfaceVariantNewCopy)(GDExtensionUninitializedVariantPtr r_dest, GDExtensionConstVariantPtr p_src);
  829. /**
  830. * @name variant_new_nil
  831. * @since 4.1
  832. *
  833. * Creates a new Variant containing nil.
  834. *
  835. * @param r_dest A pointer to the destination Variant.
  836. */
  837. typedef void (*GDExtensionInterfaceVariantNewNil)(GDExtensionUninitializedVariantPtr r_dest);
  838. /**
  839. * @name variant_destroy
  840. * @since 4.1
  841. *
  842. * Destroys a Variant.
  843. *
  844. * @param p_self A pointer to the Variant to destroy.
  845. */
  846. typedef void (*GDExtensionInterfaceVariantDestroy)(GDExtensionVariantPtr p_self);
  847. /**
  848. * @name variant_call
  849. * @since 4.1
  850. *
  851. * Calls a method on a Variant.
  852. *
  853. * @param p_self A pointer to the Variant.
  854. * @param p_method A pointer to a StringName identifying the method.
  855. * @param p_args A pointer to a C array of Variant.
  856. * @param p_argument_count The number of arguments.
  857. * @param r_return A pointer a Variant which will be assigned the return value.
  858. * @param r_error A pointer the structure which will hold error information.
  859. *
  860. * @see Variant::callp()
  861. */
  862. typedef void (*GDExtensionInterfaceVariantCall)(GDExtensionVariantPtr p_self, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionUninitializedVariantPtr r_return, GDExtensionCallError *r_error);
  863. /**
  864. * @name variant_call_static
  865. * @since 4.1
  866. *
  867. * Calls a static method on a Variant.
  868. *
  869. * @param p_self A pointer to the Variant.
  870. * @param p_method A pointer to a StringName identifying the method.
  871. * @param p_args A pointer to a C array of Variant.
  872. * @param p_argument_count The number of arguments.
  873. * @param r_return A pointer a Variant which will be assigned the return value.
  874. * @param r_error A pointer the structure which will be updated with error information.
  875. *
  876. * @see Variant::call_static()
  877. */
  878. typedef void (*GDExtensionInterfaceVariantCallStatic)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionUninitializedVariantPtr r_return, GDExtensionCallError *r_error);
  879. /**
  880. * @name variant_evaluate
  881. * @since 4.1
  882. *
  883. * Evaluate an operator on two Variants.
  884. *
  885. * @param p_op The operator to evaluate.
  886. * @param p_a The first Variant.
  887. * @param p_b The second Variant.
  888. * @param r_return A pointer a Variant which will be assigned the return value.
  889. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  890. *
  891. * @see Variant::evaluate()
  892. */
  893. typedef void (*GDExtensionInterfaceVariantEvaluate)(GDExtensionVariantOperator p_op, GDExtensionConstVariantPtr p_a, GDExtensionConstVariantPtr p_b, GDExtensionUninitializedVariantPtr r_return, GDExtensionBool *r_valid);
  894. /**
  895. * @name variant_set
  896. * @since 4.1
  897. *
  898. * Sets a key on a Variant to a value.
  899. *
  900. * @param p_self A pointer to the Variant.
  901. * @param p_key A pointer to a Variant representing the key.
  902. * @param p_value A pointer to a Variant representing the value.
  903. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  904. *
  905. * @see Variant::set()
  906. */
  907. typedef void (*GDExtensionInterfaceVariantSet)(GDExtensionVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionConstVariantPtr p_value, GDExtensionBool *r_valid);
  908. /**
  909. * @name variant_set_named
  910. * @since 4.1
  911. *
  912. * Sets a named key on a Variant to a value.
  913. *
  914. * @param p_self A pointer to the Variant.
  915. * @param p_key A pointer to a StringName representing the key.
  916. * @param p_value A pointer to a Variant representing the value.
  917. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  918. *
  919. * @see Variant::set_named()
  920. */
  921. typedef void (*GDExtensionInterfaceVariantSetNamed)(GDExtensionVariantPtr p_self, GDExtensionConstStringNamePtr p_key, GDExtensionConstVariantPtr p_value, GDExtensionBool *r_valid);
  922. /**
  923. * @name variant_set_keyed
  924. * @since 4.1
  925. *
  926. * Sets a keyed property on a Variant to a value.
  927. *
  928. * @param p_self A pointer to the Variant.
  929. * @param p_key A pointer to a Variant representing the key.
  930. * @param p_value A pointer to a Variant representing the value.
  931. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  932. *
  933. * @see Variant::set_keyed()
  934. */
  935. typedef void (*GDExtensionInterfaceVariantSetKeyed)(GDExtensionVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionConstVariantPtr p_value, GDExtensionBool *r_valid);
  936. /**
  937. * @name variant_set_indexed
  938. * @since 4.1
  939. *
  940. * Sets an index on a Variant to a value.
  941. *
  942. * @param p_self A pointer to the Variant.
  943. * @param p_index The index.
  944. * @param p_value A pointer to a Variant representing the value.
  945. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  946. * @param r_oob A pointer to a boolean which will be set to true if the index is out of bounds.
  947. */
  948. typedef void (*GDExtensionInterfaceVariantSetIndexed)(GDExtensionVariantPtr p_self, GDExtensionInt p_index, GDExtensionConstVariantPtr p_value, GDExtensionBool *r_valid, GDExtensionBool *r_oob);
  949. /**
  950. * @name variant_get
  951. * @since 4.1
  952. *
  953. * Gets the value of a key from a Variant.
  954. *
  955. * @param p_self A pointer to the Variant.
  956. * @param p_key A pointer to a Variant representing the key.
  957. * @param r_ret A pointer to a Variant which will be assigned the value.
  958. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  959. */
  960. typedef void (*GDExtensionInterfaceVariantGet)(GDExtensionConstVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid);
  961. /**
  962. * @name variant_get_named
  963. * @since 4.1
  964. *
  965. * Gets the value of a named key from a Variant.
  966. *
  967. * @param p_self A pointer to the Variant.
  968. * @param p_key A pointer to a StringName representing the key.
  969. * @param r_ret A pointer to a Variant which will be assigned the value.
  970. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  971. */
  972. typedef void (*GDExtensionInterfaceVariantGetNamed)(GDExtensionConstVariantPtr p_self, GDExtensionConstStringNamePtr p_key, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid);
  973. /**
  974. * @name variant_get_keyed
  975. * @since 4.1
  976. *
  977. * Gets the value of a keyed property from a Variant.
  978. *
  979. * @param p_self A pointer to the Variant.
  980. * @param p_key A pointer to a Variant representing the key.
  981. * @param r_ret A pointer to a Variant which will be assigned the value.
  982. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  983. */
  984. typedef void (*GDExtensionInterfaceVariantGetKeyed)(GDExtensionConstVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid);
  985. /**
  986. * @name variant_get_indexed
  987. * @since 4.1
  988. *
  989. * Gets the value of an index from a Variant.
  990. *
  991. * @param p_self A pointer to the Variant.
  992. * @param p_index The index.
  993. * @param r_ret A pointer to a Variant which will be assigned the value.
  994. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  995. * @param r_oob A pointer to a boolean which will be set to true if the index is out of bounds.
  996. */
  997. typedef void (*GDExtensionInterfaceVariantGetIndexed)(GDExtensionConstVariantPtr p_self, GDExtensionInt p_index, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid, GDExtensionBool *r_oob);
  998. /**
  999. * @name variant_iter_init
  1000. * @since 4.1
  1001. *
  1002. * Initializes an iterator over a Variant.
  1003. *
  1004. * @param p_self A pointer to the Variant.
  1005. * @param r_iter A pointer to a Variant which will be assigned the iterator.
  1006. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  1007. *
  1008. * @return true if the operation is valid; otherwise false.
  1009. *
  1010. * @see Variant::iter_init()
  1011. */
  1012. typedef GDExtensionBool (*GDExtensionInterfaceVariantIterInit)(GDExtensionConstVariantPtr p_self, GDExtensionUninitializedVariantPtr r_iter, GDExtensionBool *r_valid);
  1013. /**
  1014. * @name variant_iter_next
  1015. * @since 4.1
  1016. *
  1017. * Gets the next value for an iterator over a Variant.
  1018. *
  1019. * @param p_self A pointer to the Variant.
  1020. * @param r_iter A pointer to a Variant which will be assigned the iterator.
  1021. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  1022. *
  1023. * @return true if the operation is valid; otherwise false.
  1024. *
  1025. * @see Variant::iter_next()
  1026. */
  1027. typedef GDExtensionBool (*GDExtensionInterfaceVariantIterNext)(GDExtensionConstVariantPtr p_self, GDExtensionVariantPtr r_iter, GDExtensionBool *r_valid);
  1028. /**
  1029. * @name variant_iter_get
  1030. * @since 4.1
  1031. *
  1032. * Gets the next value for an iterator over a Variant.
  1033. *
  1034. * @param p_self A pointer to the Variant.
  1035. * @param r_iter A pointer to a Variant which will be assigned the iterator.
  1036. * @param r_ret A pointer to a Variant which will be assigned false if the operation is invalid.
  1037. * @param r_valid A pointer to a boolean which will be set to false if the operation is invalid.
  1038. *
  1039. * @see Variant::iter_get()
  1040. */
  1041. typedef void (*GDExtensionInterfaceVariantIterGet)(GDExtensionConstVariantPtr p_self, GDExtensionVariantPtr r_iter, GDExtensionUninitializedVariantPtr r_ret, GDExtensionBool *r_valid);
  1042. /**
  1043. * @name variant_hash
  1044. * @since 4.1
  1045. *
  1046. * Gets the hash of a Variant.
  1047. *
  1048. * @param p_self A pointer to the Variant.
  1049. *
  1050. * @return The hash value.
  1051. *
  1052. * @see Variant::hash()
  1053. */
  1054. typedef GDExtensionInt (*GDExtensionInterfaceVariantHash)(GDExtensionConstVariantPtr p_self);
  1055. /**
  1056. * @name variant_recursive_hash
  1057. * @since 4.1
  1058. *
  1059. * Gets the recursive hash of a Variant.
  1060. *
  1061. * @param p_self A pointer to the Variant.
  1062. * @param p_recursion_count The number of recursive loops so far.
  1063. *
  1064. * @return The hash value.
  1065. *
  1066. * @see Variant::recursive_hash()
  1067. */
  1068. typedef GDExtensionInt (*GDExtensionInterfaceVariantRecursiveHash)(GDExtensionConstVariantPtr p_self, GDExtensionInt p_recursion_count);
  1069. /**
  1070. * @name variant_hash_compare
  1071. * @since 4.1
  1072. *
  1073. * Compares two Variants by their hash.
  1074. *
  1075. * @param p_self A pointer to the Variant.
  1076. * @param p_other A pointer to the other Variant to compare it to.
  1077. *
  1078. * @return The hash value.
  1079. *
  1080. * @see Variant::hash_compare()
  1081. */
  1082. typedef GDExtensionBool (*GDExtensionInterfaceVariantHashCompare)(GDExtensionConstVariantPtr p_self, GDExtensionConstVariantPtr p_other);
  1083. /**
  1084. * @name variant_booleanize
  1085. * @since 4.1
  1086. *
  1087. * Converts a Variant to a boolean.
  1088. *
  1089. * @param p_self A pointer to the Variant.
  1090. *
  1091. * @return The boolean value of the Variant.
  1092. */
  1093. typedef GDExtensionBool (*GDExtensionInterfaceVariantBooleanize)(GDExtensionConstVariantPtr p_self);
  1094. /**
  1095. * @name variant_duplicate
  1096. * @since 4.1
  1097. *
  1098. * Duplicates a Variant.
  1099. *
  1100. * @param p_self A pointer to the Variant.
  1101. * @param r_ret A pointer to a Variant to store the duplicated value.
  1102. * @param p_deep Whether or not to duplicate deeply (when supported by the Variant type).
  1103. */
  1104. typedef void (*GDExtensionInterfaceVariantDuplicate)(GDExtensionConstVariantPtr p_self, GDExtensionVariantPtr r_ret, GDExtensionBool p_deep);
  1105. /**
  1106. * @name variant_stringify
  1107. * @since 4.1
  1108. *
  1109. * Converts a Variant to a string.
  1110. *
  1111. * @param p_self A pointer to the Variant.
  1112. * @param r_ret A pointer to a String to store the resulting value.
  1113. */
  1114. typedef void (*GDExtensionInterfaceVariantStringify)(GDExtensionConstVariantPtr p_self, GDExtensionStringPtr r_ret);
  1115. /**
  1116. * @name variant_get_type
  1117. * @since 4.1
  1118. *
  1119. * Gets the type of a Variant.
  1120. *
  1121. * @param p_self A pointer to the Variant.
  1122. *
  1123. * @return The variant type.
  1124. */
  1125. typedef GDExtensionVariantType (*GDExtensionInterfaceVariantGetType)(GDExtensionConstVariantPtr p_self);
  1126. /**
  1127. * @name variant_has_method
  1128. * @since 4.1
  1129. *
  1130. * Checks if a Variant has the given method.
  1131. *
  1132. * @param p_self A pointer to the Variant.
  1133. * @param p_method A pointer to a StringName with the method name.
  1134. *
  1135. * @return
  1136. */
  1137. typedef GDExtensionBool (*GDExtensionInterfaceVariantHasMethod)(GDExtensionConstVariantPtr p_self, GDExtensionConstStringNamePtr p_method);
  1138. /**
  1139. * @name variant_has_member
  1140. * @since 4.1
  1141. *
  1142. * Checks if a type of Variant has the given member.
  1143. *
  1144. * @param p_type The Variant type.
  1145. * @param p_member A pointer to a StringName with the member name.
  1146. *
  1147. * @return
  1148. */
  1149. typedef GDExtensionBool (*GDExtensionInterfaceVariantHasMember)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_member);
  1150. /**
  1151. * @name variant_has_key
  1152. * @since 4.1
  1153. *
  1154. * Checks if a Variant has a key.
  1155. *
  1156. * @param p_self A pointer to the Variant.
  1157. * @param p_key A pointer to a Variant representing the key.
  1158. * @param r_valid A pointer to a boolean which will be set to false if the key doesn't exist.
  1159. *
  1160. * @return true if the key exists; otherwise false.
  1161. */
  1162. typedef GDExtensionBool (*GDExtensionInterfaceVariantHasKey)(GDExtensionConstVariantPtr p_self, GDExtensionConstVariantPtr p_key, GDExtensionBool *r_valid);
  1163. /**
  1164. * @name variant_get_object_instance_id
  1165. * @since 4.4
  1166. *
  1167. * Gets the object instance ID from a variant of type GDEXTENSION_VARIANT_TYPE_OBJECT.
  1168. *
  1169. * If the variant isn't of type GDEXTENSION_VARIANT_TYPE_OBJECT, then zero will be returned.
  1170. * The instance ID will be returned even if the object is no longer valid - use `object_get_instance_by_id()` to check if the object is still valid.
  1171. *
  1172. * @param p_self A pointer to the Variant.
  1173. *
  1174. * @return The instance ID for the contained object.
  1175. */
  1176. typedef GDObjectInstanceID (*GDExtensionInterfaceVariantGetObjectInstanceId)(GDExtensionConstVariantPtr p_self);
  1177. /**
  1178. * @name variant_get_type_name
  1179. * @since 4.1
  1180. *
  1181. * Gets the name of a Variant type.
  1182. *
  1183. * @param p_type The Variant type.
  1184. * @param r_name A pointer to a String to store the Variant type name.
  1185. */
  1186. typedef void (*GDExtensionInterfaceVariantGetTypeName)(GDExtensionVariantType p_type, GDExtensionUninitializedStringPtr r_name);
  1187. /**
  1188. * @name variant_can_convert
  1189. * @since 4.1
  1190. *
  1191. * Checks if Variants can be converted from one type to another.
  1192. *
  1193. * @param p_from The Variant type to convert from.
  1194. * @param p_to The Variant type to convert to.
  1195. *
  1196. * @return true if the conversion is possible; otherwise false.
  1197. */
  1198. typedef GDExtensionBool (*GDExtensionInterfaceVariantCanConvert)(GDExtensionVariantType p_from, GDExtensionVariantType p_to);
  1199. /**
  1200. * @name variant_can_convert_strict
  1201. * @since 4.1
  1202. *
  1203. * Checks if Variant can be converted from one type to another using stricter rules.
  1204. *
  1205. * @param p_from The Variant type to convert from.
  1206. * @param p_to The Variant type to convert to.
  1207. *
  1208. * @return true if the conversion is possible; otherwise false.
  1209. */
  1210. typedef GDExtensionBool (*GDExtensionInterfaceVariantCanConvertStrict)(GDExtensionVariantType p_from, GDExtensionVariantType p_to);
  1211. /**
  1212. * @name get_variant_from_type_constructor
  1213. * @since 4.1
  1214. *
  1215. * Gets a pointer to a function that can create a Variant of the given type from a raw value.
  1216. *
  1217. * @param p_type The Variant type.
  1218. *
  1219. * @return A pointer to a function that can create a Variant of the given type from a raw value.
  1220. */
  1221. typedef GDExtensionVariantFromTypeConstructorFunc (*GDExtensionInterfaceGetVariantFromTypeConstructor)(GDExtensionVariantType p_type);
  1222. /**
  1223. * @name get_variant_to_type_constructor
  1224. * @since 4.1
  1225. *
  1226. * Gets a pointer to a function that can get the raw value from a Variant of the given type.
  1227. *
  1228. * @param p_type The Variant type.
  1229. *
  1230. * @return A pointer to a function that can get the raw value from a Variant of the given type.
  1231. */
  1232. typedef GDExtensionTypeFromVariantConstructorFunc (*GDExtensionInterfaceGetVariantToTypeConstructor)(GDExtensionVariantType p_type);
  1233. /**
  1234. * @name variant_get_ptr_internal_getter
  1235. * @since 4.4
  1236. *
  1237. * Provides a function pointer for retrieving a pointer to a variant's internal value.
  1238. * Access to a variant's internal value can be used to modify it in-place, or to retrieve its value without the overhead of variant conversion functions.
  1239. * It is recommended to cache the getter for all variant types in a function table to avoid retrieval overhead upon use.
  1240. *
  1241. * @note Each function assumes the variant's type has already been determined and matches the function.
  1242. * Invoking the function with a variant of a mismatched type has undefined behavior, and may lead to a segmentation fault.
  1243. *
  1244. * @param p_type The Variant type.
  1245. *
  1246. * @return A pointer to a type-specific function that returns a pointer to the internal value of a variant. Check the implementation of this function (gdextension_variant_get_ptr_internal_getter) for pointee type info of each variant type.
  1247. */
  1248. typedef GDExtensionVariantGetInternalPtrFunc (*GDExtensionInterfaceGetVariantGetInternalPtrFunc)(GDExtensionVariantType p_type);
  1249. /**
  1250. * @name variant_get_ptr_operator_evaluator
  1251. * @since 4.1
  1252. *
  1253. * Gets a pointer to a function that can evaluate the given Variant operator on the given Variant types.
  1254. *
  1255. * @param p_operator The variant operator.
  1256. * @param p_type_a The type of the first Variant.
  1257. * @param p_type_b The type of the second Variant.
  1258. *
  1259. * @return A pointer to a function that can evaluate the given Variant operator on the given Variant types.
  1260. */
  1261. typedef GDExtensionPtrOperatorEvaluator (*GDExtensionInterfaceVariantGetPtrOperatorEvaluator)(GDExtensionVariantOperator p_operator, GDExtensionVariantType p_type_a, GDExtensionVariantType p_type_b);
  1262. /**
  1263. * @name variant_get_ptr_builtin_method
  1264. * @since 4.1
  1265. *
  1266. * Gets a pointer to a function that can call a builtin method on a type of Variant.
  1267. *
  1268. * @param p_type The Variant type.
  1269. * @param p_method A pointer to a StringName with the method name.
  1270. * @param p_hash A hash representing the method signature.
  1271. *
  1272. * @return A pointer to a function that can call a builtin method on a type of Variant.
  1273. */
  1274. typedef GDExtensionPtrBuiltInMethod (*GDExtensionInterfaceVariantGetPtrBuiltinMethod)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_method, GDExtensionInt p_hash);
  1275. /**
  1276. * @name variant_get_ptr_constructor
  1277. * @since 4.1
  1278. *
  1279. * Gets a pointer to a function that can call one of the constructors for a type of Variant.
  1280. *
  1281. * @param p_type The Variant type.
  1282. * @param p_constructor The index of the constructor.
  1283. *
  1284. * @return A pointer to a function that can call one of the constructors for a type of Variant.
  1285. */
  1286. typedef GDExtensionPtrConstructor (*GDExtensionInterfaceVariantGetPtrConstructor)(GDExtensionVariantType p_type, int32_t p_constructor);
  1287. /**
  1288. * @name variant_get_ptr_destructor
  1289. * @since 4.1
  1290. *
  1291. * Gets a pointer to a function than can call the destructor for a type of Variant.
  1292. *
  1293. * @param p_type The Variant type.
  1294. *
  1295. * @return A pointer to a function than can call the destructor for a type of Variant.
  1296. */
  1297. typedef GDExtensionPtrDestructor (*GDExtensionInterfaceVariantGetPtrDestructor)(GDExtensionVariantType p_type);
  1298. /**
  1299. * @name variant_construct
  1300. * @since 4.1
  1301. *
  1302. * Constructs a Variant of the given type, using the first constructor that matches the given arguments.
  1303. *
  1304. * @param p_type The Variant type.
  1305. * @param p_base A pointer to a Variant to store the constructed value.
  1306. * @param p_args A pointer to a C array of Variant pointers representing the arguments for the constructor.
  1307. * @param p_argument_count The number of arguments to pass to the constructor.
  1308. * @param r_error A pointer the structure which will be updated with error information.
  1309. */
  1310. typedef void (*GDExtensionInterfaceVariantConstruct)(GDExtensionVariantType p_type, GDExtensionUninitializedVariantPtr r_base, const GDExtensionConstVariantPtr *p_args, int32_t p_argument_count, GDExtensionCallError *r_error);
  1311. /**
  1312. * @name variant_get_ptr_setter
  1313. * @since 4.1
  1314. *
  1315. * Gets a pointer to a function that can call a member's setter on the given Variant type.
  1316. *
  1317. * @param p_type The Variant type.
  1318. * @param p_member A pointer to a StringName with the member name.
  1319. *
  1320. * @return A pointer to a function that can call a member's setter on the given Variant type.
  1321. */
  1322. typedef GDExtensionPtrSetter (*GDExtensionInterfaceVariantGetPtrSetter)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_member);
  1323. /**
  1324. * @name variant_get_ptr_getter
  1325. * @since 4.1
  1326. *
  1327. * Gets a pointer to a function that can call a member's getter on the given Variant type.
  1328. *
  1329. * @param p_type The Variant type.
  1330. * @param p_member A pointer to a StringName with the member name.
  1331. *
  1332. * @return A pointer to a function that can call a member's getter on the given Variant type.
  1333. */
  1334. typedef GDExtensionPtrGetter (*GDExtensionInterfaceVariantGetPtrGetter)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_member);
  1335. /**
  1336. * @name variant_get_ptr_indexed_setter
  1337. * @since 4.1
  1338. *
  1339. * Gets a pointer to a function that can set an index on the given Variant type.
  1340. *
  1341. * @param p_type The Variant type.
  1342. *
  1343. * @return A pointer to a function that can set an index on the given Variant type.
  1344. */
  1345. typedef GDExtensionPtrIndexedSetter (*GDExtensionInterfaceVariantGetPtrIndexedSetter)(GDExtensionVariantType p_type);
  1346. /**
  1347. * @name variant_get_ptr_indexed_getter
  1348. * @since 4.1
  1349. *
  1350. * Gets a pointer to a function that can get an index on the given Variant type.
  1351. *
  1352. * @param p_type The Variant type.
  1353. *
  1354. * @return A pointer to a function that can get an index on the given Variant type.
  1355. */
  1356. typedef GDExtensionPtrIndexedGetter (*GDExtensionInterfaceVariantGetPtrIndexedGetter)(GDExtensionVariantType p_type);
  1357. /**
  1358. * @name variant_get_ptr_keyed_setter
  1359. * @since 4.1
  1360. *
  1361. * Gets a pointer to a function that can set a key on the given Variant type.
  1362. *
  1363. * @param p_type The Variant type.
  1364. *
  1365. * @return A pointer to a function that can set a key on the given Variant type.
  1366. */
  1367. typedef GDExtensionPtrKeyedSetter (*GDExtensionInterfaceVariantGetPtrKeyedSetter)(GDExtensionVariantType p_type);
  1368. /**
  1369. * @name variant_get_ptr_keyed_getter
  1370. * @since 4.1
  1371. *
  1372. * Gets a pointer to a function that can get a key on the given Variant type.
  1373. *
  1374. * @param p_type The Variant type.
  1375. *
  1376. * @return A pointer to a function that can get a key on the given Variant type.
  1377. */
  1378. typedef GDExtensionPtrKeyedGetter (*GDExtensionInterfaceVariantGetPtrKeyedGetter)(GDExtensionVariantType p_type);
  1379. /**
  1380. * @name variant_get_ptr_keyed_checker
  1381. * @since 4.1
  1382. *
  1383. * Gets a pointer to a function that can check a key on the given Variant type.
  1384. *
  1385. * @param p_type The Variant type.
  1386. *
  1387. * @return A pointer to a function that can check a key on the given Variant type.
  1388. */
  1389. typedef GDExtensionPtrKeyedChecker (*GDExtensionInterfaceVariantGetPtrKeyedChecker)(GDExtensionVariantType p_type);
  1390. /**
  1391. * @name variant_get_constant_value
  1392. * @since 4.1
  1393. *
  1394. * Gets the value of a constant from the given Variant type.
  1395. *
  1396. * @param p_type The Variant type.
  1397. * @param p_constant A pointer to a StringName with the constant name.
  1398. * @param r_ret A pointer to a Variant to store the value.
  1399. */
  1400. typedef void (*GDExtensionInterfaceVariantGetConstantValue)(GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_constant, GDExtensionUninitializedVariantPtr r_ret);
  1401. /**
  1402. * @name variant_get_ptr_utility_function
  1403. * @since 4.1
  1404. *
  1405. * Gets a pointer to a function that can call a Variant utility function.
  1406. *
  1407. * @param p_function A pointer to a StringName with the function name.
  1408. * @param p_hash A hash representing the function signature.
  1409. *
  1410. * @return A pointer to a function that can call a Variant utility function.
  1411. */
  1412. typedef GDExtensionPtrUtilityFunction (*GDExtensionInterfaceVariantGetPtrUtilityFunction)(GDExtensionConstStringNamePtr p_function, GDExtensionInt p_hash);
  1413. /* INTERFACE: String Utilities */
  1414. /**
  1415. * @name string_new_with_latin1_chars
  1416. * @since 4.1
  1417. *
  1418. * Creates a String from a Latin-1 encoded C string.
  1419. *
  1420. * @param r_dest A pointer to a Variant to hold the newly created String.
  1421. * @param p_contents A pointer to a Latin-1 encoded C string (null terminated).
  1422. */
  1423. typedef void (*GDExtensionInterfaceStringNewWithLatin1Chars)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents);
  1424. /**
  1425. * @name string_new_with_utf8_chars
  1426. * @since 4.1
  1427. *
  1428. * Creates a String from a UTF-8 encoded C string.
  1429. *
  1430. * @param r_dest A pointer to a Variant to hold the newly created String.
  1431. * @param p_contents A pointer to a UTF-8 encoded C string (null terminated).
  1432. */
  1433. typedef void (*GDExtensionInterfaceStringNewWithUtf8Chars)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents);
  1434. /**
  1435. * @name string_new_with_utf16_chars
  1436. * @since 4.1
  1437. *
  1438. * Creates a String from a UTF-16 encoded C string.
  1439. *
  1440. * @param r_dest A pointer to a Variant to hold the newly created String.
  1441. * @param p_contents A pointer to a UTF-16 encoded C string (null terminated).
  1442. */
  1443. typedef void (*GDExtensionInterfaceStringNewWithUtf16Chars)(GDExtensionUninitializedStringPtr r_dest, const char16_t *p_contents);
  1444. /**
  1445. * @name string_new_with_utf32_chars
  1446. * @since 4.1
  1447. *
  1448. * Creates a String from a UTF-32 encoded C string.
  1449. *
  1450. * @param r_dest A pointer to a Variant to hold the newly created String.
  1451. * @param p_contents A pointer to a UTF-32 encoded C string (null terminated).
  1452. */
  1453. typedef void (*GDExtensionInterfaceStringNewWithUtf32Chars)(GDExtensionUninitializedStringPtr r_dest, const char32_t *p_contents);
  1454. /**
  1455. * @name string_new_with_wide_chars
  1456. * @since 4.1
  1457. *
  1458. * Creates a String from a wide C string.
  1459. *
  1460. * @param r_dest A pointer to a Variant to hold the newly created String.
  1461. * @param p_contents A pointer to a wide C string (null terminated).
  1462. */
  1463. typedef void (*GDExtensionInterfaceStringNewWithWideChars)(GDExtensionUninitializedStringPtr r_dest, const wchar_t *p_contents);
  1464. /**
  1465. * @name string_new_with_latin1_chars_and_len
  1466. * @since 4.1
  1467. *
  1468. * Creates a String from a Latin-1 encoded C string with the given length.
  1469. *
  1470. * @param r_dest A pointer to a Variant to hold the newly created String.
  1471. * @param p_contents A pointer to a Latin-1 encoded C string.
  1472. * @param p_size The number of characters (= number of bytes).
  1473. */
  1474. typedef void (*GDExtensionInterfaceStringNewWithLatin1CharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents, GDExtensionInt p_size);
  1475. /**
  1476. * @name string_new_with_utf8_chars_and_len
  1477. * @since 4.1
  1478. * @deprecated in Godot 4.3. Use `string_new_with_utf8_chars_and_len2` instead.
  1479. *
  1480. * Creates a String from a UTF-8 encoded C string with the given length.
  1481. *
  1482. * @param r_dest A pointer to a Variant to hold the newly created String.
  1483. * @param p_contents A pointer to a UTF-8 encoded C string.
  1484. * @param p_size The number of bytes (not code units).
  1485. */
  1486. typedef void (*GDExtensionInterfaceStringNewWithUtf8CharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents, GDExtensionInt p_size);
  1487. /**
  1488. * @name string_new_with_utf8_chars_and_len2
  1489. * @since 4.3
  1490. *
  1491. * Creates a String from a UTF-8 encoded C string with the given length.
  1492. *
  1493. * @param r_dest A pointer to a Variant to hold the newly created String.
  1494. * @param p_contents A pointer to a UTF-8 encoded C string.
  1495. * @param p_size The number of bytes (not code units).
  1496. *
  1497. * @return Error code signifying if the operation successful.
  1498. */
  1499. typedef GDExtensionInt (*GDExtensionInterfaceStringNewWithUtf8CharsAndLen2)(GDExtensionUninitializedStringPtr r_dest, const char *p_contents, GDExtensionInt p_size);
  1500. /**
  1501. * @name string_new_with_utf16_chars_and_len
  1502. * @since 4.1
  1503. * @deprecated in Godot 4.3. Use `string_new_with_utf16_chars_and_len2` instead.
  1504. *
  1505. * Creates a String from a UTF-16 encoded C string with the given length.
  1506. *
  1507. * @param r_dest A pointer to a Variant to hold the newly created String.
  1508. * @param p_contents A pointer to a UTF-16 encoded C string.
  1509. * @param p_size The number of characters (not bytes).
  1510. */
  1511. typedef void (*GDExtensionInterfaceStringNewWithUtf16CharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const char16_t *p_contents, GDExtensionInt p_char_count);
  1512. /**
  1513. * @name string_new_with_utf16_chars_and_len2
  1514. * @since 4.3
  1515. *
  1516. * Creates a String from a UTF-16 encoded C string with the given length.
  1517. *
  1518. * @param r_dest A pointer to a Variant to hold the newly created String.
  1519. * @param p_contents A pointer to a UTF-16 encoded C string.
  1520. * @param p_size The number of characters (not bytes).
  1521. * @param p_default_little_endian If true, UTF-16 use little endian.
  1522. *
  1523. * @return Error code signifying if the operation successful.
  1524. */
  1525. typedef GDExtensionInt (*GDExtensionInterfaceStringNewWithUtf16CharsAndLen2)(GDExtensionUninitializedStringPtr r_dest, const char16_t *p_contents, GDExtensionInt p_char_count, GDExtensionBool p_default_little_endian);
  1526. /**
  1527. * @name string_new_with_utf32_chars_and_len
  1528. * @since 4.1
  1529. *
  1530. * Creates a String from a UTF-32 encoded C string with the given length.
  1531. *
  1532. * @param r_dest A pointer to a Variant to hold the newly created String.
  1533. * @param p_contents A pointer to a UTF-32 encoded C string.
  1534. * @param p_size The number of characters (not bytes).
  1535. */
  1536. typedef void (*GDExtensionInterfaceStringNewWithUtf32CharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const char32_t *p_contents, GDExtensionInt p_char_count);
  1537. /**
  1538. * @name string_new_with_wide_chars_and_len
  1539. * @since 4.1
  1540. *
  1541. * Creates a String from a wide C string with the given length.
  1542. *
  1543. * @param r_dest A pointer to a Variant to hold the newly created String.
  1544. * @param p_contents A pointer to a wide C string.
  1545. * @param p_size The number of characters (not bytes).
  1546. */
  1547. typedef void (*GDExtensionInterfaceStringNewWithWideCharsAndLen)(GDExtensionUninitializedStringPtr r_dest, const wchar_t *p_contents, GDExtensionInt p_char_count);
  1548. /**
  1549. * @name string_to_latin1_chars
  1550. * @since 4.1
  1551. *
  1552. * Converts a String to a Latin-1 encoded C string.
  1553. *
  1554. * It doesn't write a null terminator.
  1555. *
  1556. * @param p_self A pointer to the String.
  1557. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1558. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1559. *
  1560. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1561. */
  1562. typedef GDExtensionInt (*GDExtensionInterfaceStringToLatin1Chars)(GDExtensionConstStringPtr p_self, char *r_text, GDExtensionInt p_max_write_length);
  1563. /**
  1564. * @name string_to_utf8_chars
  1565. * @since 4.1
  1566. *
  1567. * Converts a String to a UTF-8 encoded C string.
  1568. *
  1569. * It doesn't write a null terminator.
  1570. *
  1571. * @param p_self A pointer to the String.
  1572. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1573. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1574. *
  1575. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1576. */
  1577. typedef GDExtensionInt (*GDExtensionInterfaceStringToUtf8Chars)(GDExtensionConstStringPtr p_self, char *r_text, GDExtensionInt p_max_write_length);
  1578. /**
  1579. * @name string_to_utf16_chars
  1580. * @since 4.1
  1581. *
  1582. * Converts a String to a UTF-16 encoded C string.
  1583. *
  1584. * It doesn't write a null terminator.
  1585. *
  1586. * @param p_self A pointer to the String.
  1587. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1588. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1589. *
  1590. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1591. */
  1592. typedef GDExtensionInt (*GDExtensionInterfaceStringToUtf16Chars)(GDExtensionConstStringPtr p_self, char16_t *r_text, GDExtensionInt p_max_write_length);
  1593. /**
  1594. * @name string_to_utf32_chars
  1595. * @since 4.1
  1596. *
  1597. * Converts a String to a UTF-32 encoded C string.
  1598. *
  1599. * It doesn't write a null terminator.
  1600. *
  1601. * @param p_self A pointer to the String.
  1602. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1603. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1604. *
  1605. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1606. */
  1607. typedef GDExtensionInt (*GDExtensionInterfaceStringToUtf32Chars)(GDExtensionConstStringPtr p_self, char32_t *r_text, GDExtensionInt p_max_write_length);
  1608. /**
  1609. * @name string_to_wide_chars
  1610. * @since 4.1
  1611. *
  1612. * Converts a String to a wide C string.
  1613. *
  1614. * It doesn't write a null terminator.
  1615. *
  1616. * @param p_self A pointer to the String.
  1617. * @param r_text A pointer to the buffer to hold the resulting data. If NULL is passed in, only the length will be computed.
  1618. * @param p_max_write_length The maximum number of characters that can be written to r_text. It has no affect on the return value.
  1619. *
  1620. * @return The resulting encoded string length in characters (not bytes), not including a null terminator.
  1621. */
  1622. typedef GDExtensionInt (*GDExtensionInterfaceStringToWideChars)(GDExtensionConstStringPtr p_self, wchar_t *r_text, GDExtensionInt p_max_write_length);
  1623. /**
  1624. * @name string_operator_index
  1625. * @since 4.1
  1626. *
  1627. * Gets a pointer to the character at the given index from a String.
  1628. *
  1629. * @param p_self A pointer to the String.
  1630. * @param p_index The index.
  1631. *
  1632. * @return A pointer to the requested character.
  1633. */
  1634. typedef char32_t *(*GDExtensionInterfaceStringOperatorIndex)(GDExtensionStringPtr p_self, GDExtensionInt p_index);
  1635. /**
  1636. * @name string_operator_index_const
  1637. * @since 4.1
  1638. *
  1639. * Gets a const pointer to the character at the given index from a String.
  1640. *
  1641. * @param p_self A pointer to the String.
  1642. * @param p_index The index.
  1643. *
  1644. * @return A const pointer to the requested character.
  1645. */
  1646. typedef const char32_t *(*GDExtensionInterfaceStringOperatorIndexConst)(GDExtensionConstStringPtr p_self, GDExtensionInt p_index);
  1647. /**
  1648. * @name string_operator_plus_eq_string
  1649. * @since 4.1
  1650. *
  1651. * Appends another String to a String.
  1652. *
  1653. * @param p_self A pointer to the String.
  1654. * @param p_b A pointer to the other String to append.
  1655. */
  1656. typedef void (*GDExtensionInterfaceStringOperatorPlusEqString)(GDExtensionStringPtr p_self, GDExtensionConstStringPtr p_b);
  1657. /**
  1658. * @name string_operator_plus_eq_char
  1659. * @since 4.1
  1660. *
  1661. * Appends a character to a String.
  1662. *
  1663. * @param p_self A pointer to the String.
  1664. * @param p_b A pointer to the character to append.
  1665. */
  1666. typedef void (*GDExtensionInterfaceStringOperatorPlusEqChar)(GDExtensionStringPtr p_self, char32_t p_b);
  1667. /**
  1668. * @name string_operator_plus_eq_cstr
  1669. * @since 4.1
  1670. *
  1671. * Appends a Latin-1 encoded C string to a String.
  1672. *
  1673. * @param p_self A pointer to the String.
  1674. * @param p_b A pointer to a Latin-1 encoded C string (null terminated).
  1675. */
  1676. typedef void (*GDExtensionInterfaceStringOperatorPlusEqCstr)(GDExtensionStringPtr p_self, const char *p_b);
  1677. /**
  1678. * @name string_operator_plus_eq_wcstr
  1679. * @since 4.1
  1680. *
  1681. * Appends a wide C string to a String.
  1682. *
  1683. * @param p_self A pointer to the String.
  1684. * @param p_b A pointer to a wide C string (null terminated).
  1685. */
  1686. typedef void (*GDExtensionInterfaceStringOperatorPlusEqWcstr)(GDExtensionStringPtr p_self, const wchar_t *p_b);
  1687. /**
  1688. * @name string_operator_plus_eq_c32str
  1689. * @since 4.1
  1690. *
  1691. * Appends a UTF-32 encoded C string to a String.
  1692. *
  1693. * @param p_self A pointer to the String.
  1694. * @param p_b A pointer to a UTF-32 encoded C string (null terminated).
  1695. */
  1696. typedef void (*GDExtensionInterfaceStringOperatorPlusEqC32str)(GDExtensionStringPtr p_self, const char32_t *p_b);
  1697. /**
  1698. * @name string_resize
  1699. * @since 4.2
  1700. *
  1701. * Resizes the underlying string data to the given number of characters.
  1702. *
  1703. * Space needs to be allocated for the null terminating character ('\0') which
  1704. * also must be added manually, in order for all string functions to work correctly.
  1705. *
  1706. * Warning: This is an error-prone operation - only use it if there's no other
  1707. * efficient way to accomplish your goal.
  1708. *
  1709. * @param p_self A pointer to the String.
  1710. * @param p_resize The new length for the String.
  1711. *
  1712. * @return Error code signifying if the operation successful.
  1713. */
  1714. typedef GDExtensionInt (*GDExtensionInterfaceStringResize)(GDExtensionStringPtr p_self, GDExtensionInt p_resize);
  1715. /* INTERFACE: StringName Utilities */
  1716. /**
  1717. * @name string_name_new_with_latin1_chars
  1718. * @since 4.2
  1719. *
  1720. * Creates a StringName from a Latin-1 encoded C string.
  1721. *
  1722. * If `p_is_static` is true, then:
  1723. * - The StringName will reuse the `p_contents` buffer instead of copying it.
  1724. * You must guarantee that the buffer remains valid for the duration of the application (e.g. string literal).
  1725. * - You must not call a destructor for this StringName. Incrementing the initial reference once should achieve this.
  1726. *
  1727. * `p_is_static` is purely an optimization and can easily introduce undefined behavior if used wrong. In case of doubt, set it to false.
  1728. *
  1729. * @param r_dest A pointer to uninitialized storage, into which the newly created StringName is constructed.
  1730. * @param p_contents A pointer to a C string (null terminated and Latin-1 or ASCII encoded).
  1731. * @param p_is_static Whether the StringName reuses the buffer directly (see above).
  1732. */
  1733. typedef void (*GDExtensionInterfaceStringNameNewWithLatin1Chars)(GDExtensionUninitializedStringNamePtr r_dest, const char *p_contents, GDExtensionBool p_is_static);
  1734. /**
  1735. * @name string_name_new_with_utf8_chars
  1736. * @since 4.2
  1737. *
  1738. * Creates a StringName from a UTF-8 encoded C string.
  1739. *
  1740. * @param r_dest A pointer to uninitialized storage, into which the newly created StringName is constructed.
  1741. * @param p_contents A pointer to a C string (null terminated and UTF-8 encoded).
  1742. */
  1743. typedef void (*GDExtensionInterfaceStringNameNewWithUtf8Chars)(GDExtensionUninitializedStringNamePtr r_dest, const char *p_contents);
  1744. /**
  1745. * @name string_name_new_with_utf8_chars_and_len
  1746. * @since 4.2
  1747. *
  1748. * Creates a StringName from a UTF-8 encoded string with a given number of characters.
  1749. *
  1750. * @param r_dest A pointer to uninitialized storage, into which the newly created StringName is constructed.
  1751. * @param p_contents A pointer to a C string (null terminated and UTF-8 encoded).
  1752. * @param p_size The number of bytes (not UTF-8 code points).
  1753. */
  1754. typedef void (*GDExtensionInterfaceStringNameNewWithUtf8CharsAndLen)(GDExtensionUninitializedStringNamePtr r_dest, const char *p_contents, GDExtensionInt p_size);
  1755. /* INTERFACE: XMLParser Utilities */
  1756. /**
  1757. * @name xml_parser_open_buffer
  1758. * @since 4.1
  1759. *
  1760. * Opens a raw XML buffer on an XMLParser instance.
  1761. *
  1762. * @param p_instance A pointer to an XMLParser object.
  1763. * @param p_buffer A pointer to the buffer.
  1764. * @param p_size The size of the buffer.
  1765. *
  1766. * @return A Godot error code (ex. OK, ERR_INVALID_DATA, etc).
  1767. *
  1768. * @see XMLParser::open_buffer()
  1769. */
  1770. typedef GDExtensionInt (*GDExtensionInterfaceXmlParserOpenBuffer)(GDExtensionObjectPtr p_instance, const uint8_t *p_buffer, size_t p_size);
  1771. /* INTERFACE: FileAccess Utilities */
  1772. /**
  1773. * @name file_access_store_buffer
  1774. * @since 4.1
  1775. *
  1776. * Stores the given buffer using an instance of FileAccess.
  1777. *
  1778. * @param p_instance A pointer to a FileAccess object.
  1779. * @param p_src A pointer to the buffer.
  1780. * @param p_length The size of the buffer.
  1781. *
  1782. * @see FileAccess::store_buffer()
  1783. */
  1784. typedef void (*GDExtensionInterfaceFileAccessStoreBuffer)(GDExtensionObjectPtr p_instance, const uint8_t *p_src, uint64_t p_length);
  1785. /**
  1786. * @name file_access_get_buffer
  1787. * @since 4.1
  1788. *
  1789. * Reads the next p_length bytes into the given buffer using an instance of FileAccess.
  1790. *
  1791. * @param p_instance A pointer to a FileAccess object.
  1792. * @param p_dst A pointer to the buffer to store the data.
  1793. * @param p_length The requested number of bytes to read.
  1794. *
  1795. * @return The actual number of bytes read (may be less than requested).
  1796. */
  1797. typedef uint64_t (*GDExtensionInterfaceFileAccessGetBuffer)(GDExtensionConstObjectPtr p_instance, uint8_t *p_dst, uint64_t p_length);
  1798. /* INTERFACE: Image Utilities */
  1799. /**
  1800. * @name image_ptrw
  1801. * @since 4.3
  1802. *
  1803. * Returns writable pointer to internal Image buffer.
  1804. *
  1805. * @param p_instance A pointer to a Image object.
  1806. *
  1807. * @return Pointer to internal Image buffer.
  1808. *
  1809. * @see Image::ptrw()
  1810. */
  1811. typedef uint8_t *(*GDExtensionInterfaceImagePtrw)(GDExtensionObjectPtr p_instance);
  1812. /**
  1813. * @name image_ptr
  1814. * @since 4.3
  1815. *
  1816. * Returns read only pointer to internal Image buffer.
  1817. *
  1818. * @param p_instance A pointer to a Image object.
  1819. *
  1820. * @return Pointer to internal Image buffer.
  1821. *
  1822. * @see Image::ptr()
  1823. */
  1824. typedef const uint8_t *(*GDExtensionInterfaceImagePtr)(GDExtensionObjectPtr p_instance);
  1825. /* INTERFACE: WorkerThreadPool Utilities */
  1826. /**
  1827. * @name worker_thread_pool_add_native_group_task
  1828. * @since 4.1
  1829. *
  1830. * Adds a group task to an instance of WorkerThreadPool.
  1831. *
  1832. * @param p_instance A pointer to a WorkerThreadPool object.
  1833. * @param p_func A pointer to a function to run in the thread pool.
  1834. * @param p_userdata A pointer to arbitrary data which will be passed to p_func.
  1835. * @param p_tasks The number of tasks needed in the group.
  1836. * @param p_high_priority Whether or not this is a high priority task.
  1837. * @param p_description A pointer to a String with the task description.
  1838. *
  1839. * @return The task group ID.
  1840. *
  1841. * @see WorkerThreadPool::add_group_task()
  1842. */
  1843. typedef int64_t (*GDExtensionInterfaceWorkerThreadPoolAddNativeGroupTask)(GDExtensionObjectPtr p_instance, void (*p_func)(void *, uint32_t), void *p_userdata, int p_elements, int p_tasks, GDExtensionBool p_high_priority, GDExtensionConstStringPtr p_description);
  1844. /**
  1845. * @name worker_thread_pool_add_native_task
  1846. * @since 4.1
  1847. *
  1848. * Adds a task to an instance of WorkerThreadPool.
  1849. *
  1850. * @param p_instance A pointer to a WorkerThreadPool object.
  1851. * @param p_func A pointer to a function to run in the thread pool.
  1852. * @param p_userdata A pointer to arbitrary data which will be passed to p_func.
  1853. * @param p_high_priority Whether or not this is a high priority task.
  1854. * @param p_description A pointer to a String with the task description.
  1855. *
  1856. * @return The task ID.
  1857. */
  1858. typedef int64_t (*GDExtensionInterfaceWorkerThreadPoolAddNativeTask)(GDExtensionObjectPtr p_instance, void (*p_func)(void *), void *p_userdata, GDExtensionBool p_high_priority, GDExtensionConstStringPtr p_description);
  1859. /* INTERFACE: Packed Array */
  1860. /**
  1861. * @name packed_byte_array_operator_index
  1862. * @since 4.1
  1863. *
  1864. * Gets a pointer to a byte in a PackedByteArray.
  1865. *
  1866. * @param p_self A pointer to a PackedByteArray object.
  1867. * @param p_index The index of the byte to get.
  1868. *
  1869. * @return A pointer to the requested byte.
  1870. */
  1871. typedef uint8_t *(*GDExtensionInterfacePackedByteArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1872. /**
  1873. * @name packed_byte_array_operator_index_const
  1874. * @since 4.1
  1875. *
  1876. * Gets a const pointer to a byte in a PackedByteArray.
  1877. *
  1878. * @param p_self A const pointer to a PackedByteArray object.
  1879. * @param p_index The index of the byte to get.
  1880. *
  1881. * @return A const pointer to the requested byte.
  1882. */
  1883. typedef const uint8_t *(*GDExtensionInterfacePackedByteArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1884. /**
  1885. * @name packed_float32_array_operator_index
  1886. * @since 4.1
  1887. *
  1888. * Gets a pointer to a 32-bit float in a PackedFloat32Array.
  1889. *
  1890. * @param p_self A pointer to a PackedFloat32Array object.
  1891. * @param p_index The index of the float to get.
  1892. *
  1893. * @return A pointer to the requested 32-bit float.
  1894. */
  1895. typedef float *(*GDExtensionInterfacePackedFloat32ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1896. /**
  1897. * @name packed_float32_array_operator_index_const
  1898. * @since 4.1
  1899. *
  1900. * Gets a const pointer to a 32-bit float in a PackedFloat32Array.
  1901. *
  1902. * @param p_self A const pointer to a PackedFloat32Array object.
  1903. * @param p_index The index of the float to get.
  1904. *
  1905. * @return A const pointer to the requested 32-bit float.
  1906. */
  1907. typedef const float *(*GDExtensionInterfacePackedFloat32ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1908. /**
  1909. * @name packed_float64_array_operator_index
  1910. * @since 4.1
  1911. *
  1912. * Gets a pointer to a 64-bit float in a PackedFloat64Array.
  1913. *
  1914. * @param p_self A pointer to a PackedFloat64Array object.
  1915. * @param p_index The index of the float to get.
  1916. *
  1917. * @return A pointer to the requested 64-bit float.
  1918. */
  1919. typedef double *(*GDExtensionInterfacePackedFloat64ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1920. /**
  1921. * @name packed_float64_array_operator_index_const
  1922. * @since 4.1
  1923. *
  1924. * Gets a const pointer to a 64-bit float in a PackedFloat64Array.
  1925. *
  1926. * @param p_self A const pointer to a PackedFloat64Array object.
  1927. * @param p_index The index of the float to get.
  1928. *
  1929. * @return A const pointer to the requested 64-bit float.
  1930. */
  1931. typedef const double *(*GDExtensionInterfacePackedFloat64ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1932. /**
  1933. * @name packed_int32_array_operator_index
  1934. * @since 4.1
  1935. *
  1936. * Gets a pointer to a 32-bit integer in a PackedInt32Array.
  1937. *
  1938. * @param p_self A pointer to a PackedInt32Array object.
  1939. * @param p_index The index of the integer to get.
  1940. *
  1941. * @return A pointer to the requested 32-bit integer.
  1942. */
  1943. typedef int32_t *(*GDExtensionInterfacePackedInt32ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1944. /**
  1945. * @name packed_int32_array_operator_index_const
  1946. * @since 4.1
  1947. *
  1948. * Gets a const pointer to a 32-bit integer in a PackedInt32Array.
  1949. *
  1950. * @param p_self A const pointer to a PackedInt32Array object.
  1951. * @param p_index The index of the integer to get.
  1952. *
  1953. * @return A const pointer to the requested 32-bit integer.
  1954. */
  1955. typedef const int32_t *(*GDExtensionInterfacePackedInt32ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1956. /**
  1957. * @name packed_int64_array_operator_index
  1958. * @since 4.1
  1959. *
  1960. * Gets a pointer to a 64-bit integer in a PackedInt64Array.
  1961. *
  1962. * @param p_self A pointer to a PackedInt64Array object.
  1963. * @param p_index The index of the integer to get.
  1964. *
  1965. * @return A pointer to the requested 64-bit integer.
  1966. */
  1967. typedef int64_t *(*GDExtensionInterfacePackedInt64ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1968. /**
  1969. * @name packed_int64_array_operator_index_const
  1970. * @since 4.1
  1971. *
  1972. * Gets a const pointer to a 64-bit integer in a PackedInt64Array.
  1973. *
  1974. * @param p_self A const pointer to a PackedInt64Array object.
  1975. * @param p_index The index of the integer to get.
  1976. *
  1977. * @return A const pointer to the requested 64-bit integer.
  1978. */
  1979. typedef const int64_t *(*GDExtensionInterfacePackedInt64ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  1980. /**
  1981. * @name packed_string_array_operator_index
  1982. * @since 4.1
  1983. *
  1984. * Gets a pointer to a string in a PackedStringArray.
  1985. *
  1986. * @param p_self A pointer to a PackedStringArray object.
  1987. * @param p_index The index of the String to get.
  1988. *
  1989. * @return A pointer to the requested String.
  1990. */
  1991. typedef GDExtensionStringPtr (*GDExtensionInterfacePackedStringArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  1992. /**
  1993. * @name packed_string_array_operator_index_const
  1994. * @since 4.1
  1995. *
  1996. * Gets a const pointer to a string in a PackedStringArray.
  1997. *
  1998. * @param p_self A const pointer to a PackedStringArray object.
  1999. * @param p_index The index of the String to get.
  2000. *
  2001. * @return A const pointer to the requested String.
  2002. */
  2003. typedef GDExtensionStringPtr (*GDExtensionInterfacePackedStringArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  2004. /**
  2005. * @name packed_vector2_array_operator_index
  2006. * @since 4.1
  2007. *
  2008. * Gets a pointer to a Vector2 in a PackedVector2Array.
  2009. *
  2010. * @param p_self A pointer to a PackedVector2Array object.
  2011. * @param p_index The index of the Vector2 to get.
  2012. *
  2013. * @return A pointer to the requested Vector2.
  2014. */
  2015. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector2ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  2016. /**
  2017. * @name packed_vector2_array_operator_index_const
  2018. * @since 4.1
  2019. *
  2020. * Gets a const pointer to a Vector2 in a PackedVector2Array.
  2021. *
  2022. * @param p_self A const pointer to a PackedVector2Array object.
  2023. * @param p_index The index of the Vector2 to get.
  2024. *
  2025. * @return A const pointer to the requested Vector2.
  2026. */
  2027. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector2ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  2028. /**
  2029. * @name packed_vector3_array_operator_index
  2030. * @since 4.1
  2031. *
  2032. * Gets a pointer to a Vector3 in a PackedVector3Array.
  2033. *
  2034. * @param p_self A pointer to a PackedVector3Array object.
  2035. * @param p_index The index of the Vector3 to get.
  2036. *
  2037. * @return A pointer to the requested Vector3.
  2038. */
  2039. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector3ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  2040. /**
  2041. * @name packed_vector3_array_operator_index_const
  2042. * @since 4.1
  2043. *
  2044. * Gets a const pointer to a Vector3 in a PackedVector3Array.
  2045. *
  2046. * @param p_self A const pointer to a PackedVector3Array object.
  2047. * @param p_index The index of the Vector3 to get.
  2048. *
  2049. * @return A const pointer to the requested Vector3.
  2050. */
  2051. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector3ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  2052. /**
  2053. * @name packed_vector4_array_operator_index
  2054. * @since 4.3
  2055. *
  2056. * Gets a pointer to a Vector4 in a PackedVector4Array.
  2057. *
  2058. * @param p_self A pointer to a PackedVector4Array object.
  2059. * @param p_index The index of the Vector4 to get.
  2060. *
  2061. * @return A pointer to the requested Vector4.
  2062. */
  2063. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector4ArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  2064. /**
  2065. * @name packed_vector4_array_operator_index_const
  2066. * @since 4.3
  2067. *
  2068. * Gets a const pointer to a Vector4 in a PackedVector4Array.
  2069. *
  2070. * @param p_self A const pointer to a PackedVector4Array object.
  2071. * @param p_index The index of the Vector4 to get.
  2072. *
  2073. * @return A const pointer to the requested Vector4.
  2074. */
  2075. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedVector4ArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  2076. /**
  2077. * @name packed_color_array_operator_index
  2078. * @since 4.1
  2079. *
  2080. * Gets a pointer to a color in a PackedColorArray.
  2081. *
  2082. * @param p_self A pointer to a PackedColorArray object.
  2083. * @param p_index The index of the Color to get.
  2084. *
  2085. * @return A pointer to the requested Color.
  2086. */
  2087. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedColorArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  2088. /**
  2089. * @name packed_color_array_operator_index_const
  2090. * @since 4.1
  2091. *
  2092. * Gets a const pointer to a color in a PackedColorArray.
  2093. *
  2094. * @param p_self A const pointer to a PackedColorArray object.
  2095. * @param p_index The index of the Color to get.
  2096. *
  2097. * @return A const pointer to the requested Color.
  2098. */
  2099. typedef GDExtensionTypePtr (*GDExtensionInterfacePackedColorArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  2100. /**
  2101. * @name array_operator_index
  2102. * @since 4.1
  2103. *
  2104. * Gets a pointer to a Variant in an Array.
  2105. *
  2106. * @param p_self A pointer to an Array object.
  2107. * @param p_index The index of the Variant to get.
  2108. *
  2109. * @return A pointer to the requested Variant.
  2110. */
  2111. typedef GDExtensionVariantPtr (*GDExtensionInterfaceArrayOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionInt p_index);
  2112. /**
  2113. * @name array_operator_index_const
  2114. * @since 4.1
  2115. *
  2116. * Gets a const pointer to a Variant in an Array.
  2117. *
  2118. * @param p_self A const pointer to an Array object.
  2119. * @param p_index The index of the Variant to get.
  2120. *
  2121. * @return A const pointer to the requested Variant.
  2122. */
  2123. typedef GDExtensionVariantPtr (*GDExtensionInterfaceArrayOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionInt p_index);
  2124. /**
  2125. * @name array_ref
  2126. * @since 4.1
  2127. *
  2128. * Sets an Array to be a reference to another Array object.
  2129. *
  2130. * @param p_self A pointer to the Array object to update.
  2131. * @param p_from A pointer to the Array object to reference.
  2132. */
  2133. typedef void (*GDExtensionInterfaceArrayRef)(GDExtensionTypePtr p_self, GDExtensionConstTypePtr p_from);
  2134. /**
  2135. * @name array_set_typed
  2136. * @since 4.1
  2137. *
  2138. * Makes an Array into a typed Array.
  2139. *
  2140. * @param p_self A pointer to the Array.
  2141. * @param p_type The type of Variant the Array will store.
  2142. * @param p_class_name A pointer to a StringName with the name of the object (if p_type is GDEXTENSION_VARIANT_TYPE_OBJECT).
  2143. * @param p_script A pointer to a Script object (if p_type is GDEXTENSION_VARIANT_TYPE_OBJECT and the base class is extended by a script).
  2144. */
  2145. typedef void (*GDExtensionInterfaceArraySetTyped)(GDExtensionTypePtr p_self, GDExtensionVariantType p_type, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstVariantPtr p_script);
  2146. /* INTERFACE: Dictionary */
  2147. /**
  2148. * @name dictionary_operator_index
  2149. * @since 4.1
  2150. *
  2151. * Gets a pointer to a Variant in a Dictionary with the given key.
  2152. *
  2153. * @param p_self A pointer to a Dictionary object.
  2154. * @param p_key A pointer to a Variant representing the key.
  2155. *
  2156. * @return A pointer to a Variant representing the value at the given key.
  2157. */
  2158. typedef GDExtensionVariantPtr (*GDExtensionInterfaceDictionaryOperatorIndex)(GDExtensionTypePtr p_self, GDExtensionConstVariantPtr p_key);
  2159. /**
  2160. * @name dictionary_operator_index_const
  2161. * @since 4.1
  2162. *
  2163. * Gets a const pointer to a Variant in a Dictionary with the given key.
  2164. *
  2165. * @param p_self A const pointer to a Dictionary object.
  2166. * @param p_key A pointer to a Variant representing the key.
  2167. *
  2168. * @return A const pointer to a Variant representing the value at the given key.
  2169. */
  2170. typedef GDExtensionVariantPtr (*GDExtensionInterfaceDictionaryOperatorIndexConst)(GDExtensionConstTypePtr p_self, GDExtensionConstVariantPtr p_key);
  2171. /**
  2172. * @name dictionary_set_typed
  2173. * @since 4.4
  2174. *
  2175. * Makes a Dictionary into a typed Dictionary.
  2176. *
  2177. * @param p_self A pointer to the Dictionary.
  2178. * @param p_key_type The type of Variant the Dictionary key will store.
  2179. * @param p_key_class_name A pointer to a StringName with the name of the object (if p_key_type is GDEXTENSION_VARIANT_TYPE_OBJECT).
  2180. * @param p_key_script A pointer to a Script object (if p_key_type is GDEXTENSION_VARIANT_TYPE_OBJECT and the base class is extended by a script).
  2181. * @param p_value_type The type of Variant the Dictionary value will store.
  2182. * @param p_value_class_name A pointer to a StringName with the name of the object (if p_value_type is GDEXTENSION_VARIANT_TYPE_OBJECT).
  2183. * @param p_value_script A pointer to a Script object (if p_value_type is GDEXTENSION_VARIANT_TYPE_OBJECT and the base class is extended by a script).
  2184. */
  2185. typedef void (*GDExtensionInterfaceDictionarySetTyped)(GDExtensionTypePtr p_self, GDExtensionVariantType p_key_type, GDExtensionConstStringNamePtr p_key_class_name, GDExtensionConstVariantPtr p_key_script, GDExtensionVariantType p_value_type, GDExtensionConstStringNamePtr p_value_class_name, GDExtensionConstVariantPtr p_value_script);
  2186. /* INTERFACE: Object */
  2187. /**
  2188. * @name object_method_bind_call
  2189. * @since 4.1
  2190. *
  2191. * Calls a method on an Object.
  2192. *
  2193. * @param p_method_bind A pointer to the MethodBind representing the method on the Object's class.
  2194. * @param p_instance A pointer to the Object.
  2195. * @param p_args A pointer to a C array of Variants representing the arguments.
  2196. * @param p_arg_count The number of arguments.
  2197. * @param r_ret A pointer to Variant which will receive the return value.
  2198. * @param r_error A pointer to a GDExtensionCallError struct that will receive error information.
  2199. */
  2200. typedef void (*GDExtensionInterfaceObjectMethodBindCall)(GDExtensionMethodBindPtr p_method_bind, GDExtensionObjectPtr p_instance, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_arg_count, GDExtensionUninitializedVariantPtr r_ret, GDExtensionCallError *r_error);
  2201. /**
  2202. * @name object_method_bind_ptrcall
  2203. * @since 4.1
  2204. *
  2205. * Calls a method on an Object (using a "ptrcall").
  2206. *
  2207. * @param p_method_bind A pointer to the MethodBind representing the method on the Object's class.
  2208. * @param p_instance A pointer to the Object.
  2209. * @param p_args A pointer to a C array representing the arguments.
  2210. * @param r_ret A pointer to the Object that will receive the return value.
  2211. */
  2212. typedef void (*GDExtensionInterfaceObjectMethodBindPtrcall)(GDExtensionMethodBindPtr p_method_bind, GDExtensionObjectPtr p_instance, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
  2213. /**
  2214. * @name object_destroy
  2215. * @since 4.1
  2216. *
  2217. * Destroys an Object.
  2218. *
  2219. * @param p_o A pointer to the Object.
  2220. */
  2221. typedef void (*GDExtensionInterfaceObjectDestroy)(GDExtensionObjectPtr p_o);
  2222. /**
  2223. * @name global_get_singleton
  2224. * @since 4.1
  2225. *
  2226. * Gets a global singleton by name.
  2227. *
  2228. * @param p_name A pointer to a StringName with the singleton name.
  2229. *
  2230. * @return A pointer to the singleton Object.
  2231. */
  2232. typedef GDExtensionObjectPtr (*GDExtensionInterfaceGlobalGetSingleton)(GDExtensionConstStringNamePtr p_name);
  2233. /**
  2234. * @name object_get_instance_binding
  2235. * @since 4.1
  2236. *
  2237. * Gets a pointer representing an Object's instance binding.
  2238. *
  2239. * @param p_o A pointer to the Object.
  2240. * @param p_library A token the library received by the GDExtension's entry point function.
  2241. * @param p_callbacks A pointer to a GDExtensionInstanceBindingCallbacks struct.
  2242. *
  2243. * @return
  2244. */
  2245. typedef void *(*GDExtensionInterfaceObjectGetInstanceBinding)(GDExtensionObjectPtr p_o, void *p_token, const GDExtensionInstanceBindingCallbacks *p_callbacks);
  2246. /**
  2247. * @name object_set_instance_binding
  2248. * @since 4.1
  2249. *
  2250. * Sets an Object's instance binding.
  2251. *
  2252. * @param p_o A pointer to the Object.
  2253. * @param p_library A token the library received by the GDExtension's entry point function.
  2254. * @param p_binding A pointer to the instance binding.
  2255. * @param p_callbacks A pointer to a GDExtensionInstanceBindingCallbacks struct.
  2256. */
  2257. typedef void (*GDExtensionInterfaceObjectSetInstanceBinding)(GDExtensionObjectPtr p_o, void *p_token, void *p_binding, const GDExtensionInstanceBindingCallbacks *p_callbacks);
  2258. /**
  2259. * @name object_free_instance_binding
  2260. * @since 4.2
  2261. *
  2262. * Free an Object's instance binding.
  2263. *
  2264. * @param p_o A pointer to the Object.
  2265. * @param p_library A token the library received by the GDExtension's entry point function.
  2266. */
  2267. typedef void (*GDExtensionInterfaceObjectFreeInstanceBinding)(GDExtensionObjectPtr p_o, void *p_token);
  2268. /**
  2269. * @name object_set_instance
  2270. * @since 4.1
  2271. *
  2272. * Sets an extension class instance on a Object.
  2273. *
  2274. * @param p_o A pointer to the Object.
  2275. * @param p_classname A pointer to a StringName with the registered extension class's name.
  2276. * @param p_instance A pointer to the extension class instance.
  2277. */
  2278. typedef void (*GDExtensionInterfaceObjectSetInstance)(GDExtensionObjectPtr p_o, GDExtensionConstStringNamePtr p_classname, GDExtensionClassInstancePtr p_instance); /* p_classname should be a registered extension class and should extend the p_o object's class. */
  2279. /**
  2280. * @name object_get_class_name
  2281. * @since 4.1
  2282. *
  2283. * Gets the class name of an Object.
  2284. *
  2285. * If the GDExtension wraps the Godot object in an abstraction specific to its class, this is the
  2286. * function that should be used to determine which wrapper to use.
  2287. *
  2288. * @param p_object A pointer to the Object.
  2289. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2290. * @param r_class_name A pointer to a String to receive the class name.
  2291. *
  2292. * @return true if successful in getting the class name; otherwise false.
  2293. */
  2294. typedef GDExtensionBool (*GDExtensionInterfaceObjectGetClassName)(GDExtensionConstObjectPtr p_object, GDExtensionClassLibraryPtr p_library, GDExtensionUninitializedStringNamePtr r_class_name);
  2295. /**
  2296. * @name object_cast_to
  2297. * @since 4.1
  2298. *
  2299. * Casts an Object to a different type.
  2300. *
  2301. * @param p_object A pointer to the Object.
  2302. * @param p_class_tag A pointer uniquely identifying a built-in class in the ClassDB.
  2303. *
  2304. * @return Returns a pointer to the Object, or NULL if it can't be cast to the requested type.
  2305. */
  2306. typedef GDExtensionObjectPtr (*GDExtensionInterfaceObjectCastTo)(GDExtensionConstObjectPtr p_object, void *p_class_tag);
  2307. /**
  2308. * @name object_get_instance_from_id
  2309. * @since 4.1
  2310. *
  2311. * Gets an Object by its instance ID.
  2312. *
  2313. * @param p_instance_id The instance ID.
  2314. *
  2315. * @return A pointer to the Object.
  2316. */
  2317. typedef GDExtensionObjectPtr (*GDExtensionInterfaceObjectGetInstanceFromId)(GDObjectInstanceID p_instance_id);
  2318. /**
  2319. * @name object_get_instance_id
  2320. * @since 4.1
  2321. *
  2322. * Gets the instance ID from an Object.
  2323. *
  2324. * @param p_object A pointer to the Object.
  2325. *
  2326. * @return The instance ID.
  2327. */
  2328. typedef GDObjectInstanceID (*GDExtensionInterfaceObjectGetInstanceId)(GDExtensionConstObjectPtr p_object);
  2329. /**
  2330. * @name object_has_script_method
  2331. * @since 4.3
  2332. *
  2333. * Checks if this object has a script with the given method.
  2334. *
  2335. * @param p_object A pointer to the Object.
  2336. * @param p_method A pointer to a StringName identifying the method.
  2337. *
  2338. * @returns true if the object has a script and that script has a method with the given name. Returns false if the object has no script.
  2339. */
  2340. typedef GDExtensionBool (*GDExtensionInterfaceObjectHasScriptMethod)(GDExtensionConstObjectPtr p_object, GDExtensionConstStringNamePtr p_method);
  2341. /**
  2342. * @name object_call_script_method
  2343. * @since 4.3
  2344. *
  2345. * Call the given script method on this object.
  2346. *
  2347. * @param p_object A pointer to the Object.
  2348. * @param p_method A pointer to a StringName identifying the method.
  2349. * @param p_args A pointer to a C array of Variant.
  2350. * @param p_argument_count The number of arguments.
  2351. * @param r_return A pointer a Variant which will be assigned the return value.
  2352. * @param r_error A pointer the structure which will hold error information.
  2353. */
  2354. typedef void (*GDExtensionInterfaceObjectCallScriptMethod)(GDExtensionObjectPtr p_object, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionUninitializedVariantPtr r_return, GDExtensionCallError *r_error);
  2355. /* INTERFACE: Reference */
  2356. /**
  2357. * @name ref_get_object
  2358. * @since 4.1
  2359. *
  2360. * Gets the Object from a reference.
  2361. *
  2362. * @param p_ref A pointer to the reference.
  2363. *
  2364. * @return A pointer to the Object from the reference or NULL.
  2365. */
  2366. typedef GDExtensionObjectPtr (*GDExtensionInterfaceRefGetObject)(GDExtensionConstRefPtr p_ref);
  2367. /**
  2368. * @name ref_set_object
  2369. * @since 4.1
  2370. *
  2371. * Sets the Object referred to by a reference.
  2372. *
  2373. * @param p_ref A pointer to the reference.
  2374. * @param p_object A pointer to the Object to refer to.
  2375. */
  2376. typedef void (*GDExtensionInterfaceRefSetObject)(GDExtensionRefPtr p_ref, GDExtensionObjectPtr p_object);
  2377. /* INTERFACE: Script Instance */
  2378. /**
  2379. * @name script_instance_create
  2380. * @since 4.1
  2381. * @deprecated in Godot 4.2. Use `script_instance_create3` instead.
  2382. *
  2383. * Creates a script instance that contains the given info and instance data.
  2384. *
  2385. * @param p_info A pointer to a GDExtensionScriptInstanceInfo struct.
  2386. * @param p_instance_data A pointer to a data representing the script instance in the GDExtension. This will be passed to all the function pointers on p_info.
  2387. *
  2388. * @return A pointer to a ScriptInstanceExtension object.
  2389. */
  2390. typedef GDExtensionScriptInstancePtr (*GDExtensionInterfaceScriptInstanceCreate)(const GDExtensionScriptInstanceInfo *p_info, GDExtensionScriptInstanceDataPtr p_instance_data);
  2391. /**
  2392. * @name script_instance_create2
  2393. * @since 4.2
  2394. * @deprecated in Godot 4.3. Use `script_instance_create3` instead.
  2395. *
  2396. * Creates a script instance that contains the given info and instance data.
  2397. *
  2398. * @param p_info A pointer to a GDExtensionScriptInstanceInfo2 struct.
  2399. * @param p_instance_data A pointer to a data representing the script instance in the GDExtension. This will be passed to all the function pointers on p_info.
  2400. *
  2401. * @return A pointer to a ScriptInstanceExtension object.
  2402. */
  2403. typedef GDExtensionScriptInstancePtr (*GDExtensionInterfaceScriptInstanceCreate2)(const GDExtensionScriptInstanceInfo2 *p_info, GDExtensionScriptInstanceDataPtr p_instance_data);
  2404. /**
  2405. * @name script_instance_create3
  2406. * @since 4.3
  2407. *
  2408. * Creates a script instance that contains the given info and instance data.
  2409. *
  2410. * @param p_info A pointer to a GDExtensionScriptInstanceInfo3 struct.
  2411. * @param p_instance_data A pointer to a data representing the script instance in the GDExtension. This will be passed to all the function pointers on p_info.
  2412. *
  2413. * @return A pointer to a ScriptInstanceExtension object.
  2414. */
  2415. typedef GDExtensionScriptInstancePtr (*GDExtensionInterfaceScriptInstanceCreate3)(const GDExtensionScriptInstanceInfo3 *p_info, GDExtensionScriptInstanceDataPtr p_instance_data);
  2416. /**
  2417. * @name placeholder_script_instance_create
  2418. * @since 4.2
  2419. *
  2420. * Creates a placeholder script instance for a given script and instance.
  2421. *
  2422. * This interface is optional as a custom placeholder could also be created with script_instance_create().
  2423. *
  2424. * @param p_language A pointer to a ScriptLanguage.
  2425. * @param p_script A pointer to a Script.
  2426. * @param p_owner A pointer to an Object.
  2427. *
  2428. * @return A pointer to a PlaceHolderScriptInstance object.
  2429. */
  2430. typedef GDExtensionScriptInstancePtr (*GDExtensionInterfacePlaceHolderScriptInstanceCreate)(GDExtensionObjectPtr p_language, GDExtensionObjectPtr p_script, GDExtensionObjectPtr p_owner);
  2431. /**
  2432. * @name placeholder_script_instance_update
  2433. * @since 4.2
  2434. *
  2435. * Updates a placeholder script instance with the given properties and values.
  2436. *
  2437. * The passed in placeholder must be an instance of PlaceHolderScriptInstance
  2438. * such as the one returned by placeholder_script_instance_create().
  2439. *
  2440. * @param p_placeholder A pointer to a PlaceHolderScriptInstance.
  2441. * @param p_properties A pointer to an Array of Dictionary representing PropertyInfo.
  2442. * @param p_values A pointer to a Dictionary mapping StringName to Variant values.
  2443. */
  2444. typedef void (*GDExtensionInterfacePlaceHolderScriptInstanceUpdate)(GDExtensionScriptInstancePtr p_placeholder, GDExtensionConstTypePtr p_properties, GDExtensionConstTypePtr p_values);
  2445. /**
  2446. * @name object_get_script_instance
  2447. * @since 4.2
  2448. *
  2449. * Get the script instance data attached to this object.
  2450. *
  2451. * @param p_object A pointer to the Object.
  2452. * @param p_language A pointer to the language expected for this script instance.
  2453. *
  2454. * @return A GDExtensionScriptInstanceDataPtr that was attached to this object as part of script_instance_create.
  2455. */
  2456. typedef GDExtensionScriptInstanceDataPtr (*GDExtensionInterfaceObjectGetScriptInstance)(GDExtensionConstObjectPtr p_object, GDExtensionObjectPtr p_language);
  2457. /**
  2458. * @name object_set_script_instance
  2459. * @since 4.5
  2460. *
  2461. * Set the script instance data attached to this object.
  2462. *
  2463. * @param p_object A pointer to the Object.
  2464. * @param p_script_instance A pointer to the script instance data to attach to this object.
  2465. */
  2466. typedef void (*GDExtensionInterfaceObjectSetScriptInstance)(GDExtensionObjectPtr p_object, GDExtensionScriptInstanceDataPtr p_script_instance);
  2467. /* INTERFACE: Callable */
  2468. /**
  2469. * @name callable_custom_create
  2470. * @since 4.2
  2471. * @deprecated in Godot 4.3. Use `callable_custom_create2` instead.
  2472. *
  2473. * Creates a custom Callable object from a function pointer.
  2474. *
  2475. * Provided struct can be safely freed once the function returns.
  2476. *
  2477. * @param r_callable A pointer that will receive the new Callable.
  2478. * @param p_callable_custom_info The info required to construct a Callable.
  2479. */
  2480. typedef void (*GDExtensionInterfaceCallableCustomCreate)(GDExtensionUninitializedTypePtr r_callable, GDExtensionCallableCustomInfo *p_callable_custom_info);
  2481. /**
  2482. * @name callable_custom_create2
  2483. * @since 4.3
  2484. *
  2485. * Creates a custom Callable object from a function pointer.
  2486. *
  2487. * Provided struct can be safely freed once the function returns.
  2488. *
  2489. * @param r_callable A pointer that will receive the new Callable.
  2490. * @param p_callable_custom_info The info required to construct a Callable.
  2491. */
  2492. typedef void (*GDExtensionInterfaceCallableCustomCreate2)(GDExtensionUninitializedTypePtr r_callable, GDExtensionCallableCustomInfo2 *p_callable_custom_info);
  2493. /**
  2494. * @name callable_custom_get_userdata
  2495. * @since 4.2
  2496. *
  2497. * Retrieves the userdata pointer from a custom Callable.
  2498. *
  2499. * If the Callable is not a custom Callable or the token does not match the one provided to callable_custom_create() via GDExtensionCallableCustomInfo then NULL will be returned.
  2500. *
  2501. * @param p_callable A pointer to a Callable.
  2502. * @param p_token A pointer to an address that uniquely identifies the GDExtension.
  2503. */
  2504. typedef void *(*GDExtensionInterfaceCallableCustomGetUserData)(GDExtensionConstTypePtr p_callable, void *p_token);
  2505. /* INTERFACE: ClassDB */
  2506. /**
  2507. * @name classdb_construct_object
  2508. * @since 4.1
  2509. * @deprecated in Godot 4.4. Use `classdb_construct_object2` instead.
  2510. *
  2511. * Constructs an Object of the requested class.
  2512. *
  2513. * The passed class must be a built-in godot class, or an already-registered extension class. In both cases, object_set_instance() should be called to fully initialize the object.
  2514. *
  2515. * @param p_classname A pointer to a StringName with the class name.
  2516. *
  2517. * @return A pointer to the newly created Object.
  2518. */
  2519. typedef GDExtensionObjectPtr (*GDExtensionInterfaceClassdbConstructObject)(GDExtensionConstStringNamePtr p_classname);
  2520. /**
  2521. * @name classdb_construct_object2
  2522. * @since 4.4
  2523. *
  2524. * Constructs an Object of the requested class.
  2525. *
  2526. * The passed class must be a built-in godot class, or an already-registered extension class. In both cases, object_set_instance() should be called to fully initialize the object.
  2527. *
  2528. * "NOTIFICATION_POSTINITIALIZE" must be sent after construction.
  2529. *
  2530. * @param p_classname A pointer to a StringName with the class name.
  2531. *
  2532. * @return A pointer to the newly created Object.
  2533. */
  2534. typedef GDExtensionObjectPtr (*GDExtensionInterfaceClassdbConstructObject2)(GDExtensionConstStringNamePtr p_classname);
  2535. /**
  2536. * @name classdb_get_method_bind
  2537. * @since 4.1
  2538. *
  2539. * Gets a pointer to the MethodBind in ClassDB for the given class, method and hash.
  2540. *
  2541. * @param p_classname A pointer to a StringName with the class name.
  2542. * @param p_methodname A pointer to a StringName with the method name.
  2543. * @param p_hash A hash representing the function signature.
  2544. *
  2545. * @return A pointer to the MethodBind from ClassDB.
  2546. */
  2547. typedef GDExtensionMethodBindPtr (*GDExtensionInterfaceClassdbGetMethodBind)(GDExtensionConstStringNamePtr p_classname, GDExtensionConstStringNamePtr p_methodname, GDExtensionInt p_hash);
  2548. /**
  2549. * @name classdb_get_class_tag
  2550. * @since 4.1
  2551. *
  2552. * Gets a pointer uniquely identifying the given built-in class in the ClassDB.
  2553. *
  2554. * @param p_classname A pointer to a StringName with the class name.
  2555. *
  2556. * @return A pointer uniquely identifying the built-in class in the ClassDB.
  2557. */
  2558. typedef void *(*GDExtensionInterfaceClassdbGetClassTag)(GDExtensionConstStringNamePtr p_classname);
  2559. /* INTERFACE: ClassDB Extension */
  2560. /**
  2561. * @name classdb_register_extension_class
  2562. * @since 4.1
  2563. * @deprecated in Godot 4.2. Use `classdb_register_extension_class4` instead.
  2564. *
  2565. * Registers an extension class in the ClassDB.
  2566. *
  2567. * Provided struct can be safely freed once the function returns.
  2568. *
  2569. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2570. * @param p_class_name A pointer to a StringName with the class name.
  2571. * @param p_parent_class_name A pointer to a StringName with the parent class name.
  2572. * @param p_extension_funcs A pointer to a GDExtensionClassCreationInfo struct.
  2573. */
  2574. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClass)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo *p_extension_funcs);
  2575. /**
  2576. * @name classdb_register_extension_class2
  2577. * @since 4.2
  2578. * @deprecated in Godot 4.3. Use `classdb_register_extension_class4` instead.
  2579. *
  2580. * Registers an extension class in the ClassDB.
  2581. *
  2582. * Provided struct can be safely freed once the function returns.
  2583. *
  2584. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2585. * @param p_class_name A pointer to a StringName with the class name.
  2586. * @param p_parent_class_name A pointer to a StringName with the parent class name.
  2587. * @param p_extension_funcs A pointer to a GDExtensionClassCreationInfo2 struct.
  2588. */
  2589. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClass2)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo2 *p_extension_funcs);
  2590. /**
  2591. * @name classdb_register_extension_class3
  2592. * @since 4.3
  2593. * @deprecated in Godot 4.4. Use `classdb_register_extension_class4` instead.
  2594. *
  2595. * Registers an extension class in the ClassDB.
  2596. *
  2597. * Provided struct can be safely freed once the function returns.
  2598. *
  2599. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2600. * @param p_class_name A pointer to a StringName with the class name.
  2601. * @param p_parent_class_name A pointer to a StringName with the parent class name.
  2602. * @param p_extension_funcs A pointer to a GDExtensionClassCreationInfo2 struct.
  2603. */
  2604. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClass3)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo3 *p_extension_funcs);
  2605. /**
  2606. * @name classdb_register_extension_class4
  2607. * @since 4.4
  2608. *
  2609. * Registers an extension class in the ClassDB.
  2610. *
  2611. * Provided struct can be safely freed once the function returns.
  2612. *
  2613. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2614. * @param p_class_name A pointer to a StringName with the class name.
  2615. * @param p_parent_class_name A pointer to a StringName with the parent class name.
  2616. * @param p_extension_funcs A pointer to a GDExtensionClassCreationInfo2 struct.
  2617. */
  2618. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClass4)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo4 *p_extension_funcs);
  2619. /**
  2620. * @name classdb_register_extension_class_method
  2621. * @since 4.1
  2622. *
  2623. * Registers a method on an extension class in the ClassDB.
  2624. *
  2625. * Provided struct can be safely freed once the function returns.
  2626. *
  2627. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2628. * @param p_class_name A pointer to a StringName with the class name.
  2629. * @param p_method_info A pointer to a GDExtensionClassMethodInfo struct.
  2630. */
  2631. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassMethod)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionClassMethodInfo *p_method_info);
  2632. /**
  2633. * @name classdb_register_extension_class_virtual_method
  2634. * @since 4.3
  2635. *
  2636. * Registers a virtual method on an extension class in ClassDB, that can be implemented by scripts or other extensions.
  2637. *
  2638. * Provided struct can be safely freed once the function returns.
  2639. *
  2640. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2641. * @param p_class_name A pointer to a StringName with the class name.
  2642. * @param p_method_info A pointer to a GDExtensionClassMethodInfo struct.
  2643. */
  2644. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassVirtualMethod)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionClassVirtualMethodInfo *p_method_info);
  2645. /**
  2646. * @name classdb_register_extension_class_integer_constant
  2647. * @since 4.1
  2648. *
  2649. * Registers an integer constant on an extension class in the ClassDB.
  2650. *
  2651. * Note about registering bitfield values (if p_is_bitfield is true): even though p_constant_value is signed, language bindings are
  2652. * advised to treat bitfields as uint64_t, since this is generally clearer and can prevent mistakes like using -1 for setting all bits.
  2653. * Language APIs should thus provide an abstraction that registers bitfields (uint64_t) separately from regular constants (int64_t).
  2654. *
  2655. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2656. * @param p_class_name A pointer to a StringName with the class name.
  2657. * @param p_enum_name A pointer to a StringName with the enum name.
  2658. * @param p_constant_name A pointer to a StringName with the constant name.
  2659. * @param p_constant_value The constant value.
  2660. * @param p_is_bitfield Whether or not this constant is part of a bitfield.
  2661. */
  2662. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassIntegerConstant)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_enum_name, GDExtensionConstStringNamePtr p_constant_name, GDExtensionInt p_constant_value, GDExtensionBool p_is_bitfield);
  2663. /**
  2664. * @name classdb_register_extension_class_property
  2665. * @since 4.1
  2666. *
  2667. * Registers a property on an extension class in the ClassDB.
  2668. *
  2669. * Provided struct can be safely freed once the function returns.
  2670. *
  2671. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2672. * @param p_class_name A pointer to a StringName with the class name.
  2673. * @param p_info A pointer to a GDExtensionPropertyInfo struct.
  2674. * @param p_setter A pointer to a StringName with the name of the setter method.
  2675. * @param p_getter A pointer to a StringName with the name of the getter method.
  2676. */
  2677. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassProperty)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionPropertyInfo *p_info, GDExtensionConstStringNamePtr p_setter, GDExtensionConstStringNamePtr p_getter);
  2678. /**
  2679. * @name classdb_register_extension_class_property_indexed
  2680. * @since 4.2
  2681. *
  2682. * Registers an indexed property on an extension class in the ClassDB.
  2683. *
  2684. * Provided struct can be safely freed once the function returns.
  2685. *
  2686. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2687. * @param p_class_name A pointer to a StringName with the class name.
  2688. * @param p_info A pointer to a GDExtensionPropertyInfo struct.
  2689. * @param p_setter A pointer to a StringName with the name of the setter method.
  2690. * @param p_getter A pointer to a StringName with the name of the getter method.
  2691. * @param p_index The index to pass as the first argument to the getter and setter methods.
  2692. */
  2693. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassPropertyIndexed)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionPropertyInfo *p_info, GDExtensionConstStringNamePtr p_setter, GDExtensionConstStringNamePtr p_getter, GDExtensionInt p_index);
  2694. /**
  2695. * @name classdb_register_extension_class_property_group
  2696. * @since 4.1
  2697. *
  2698. * Registers a property group on an extension class in the ClassDB.
  2699. *
  2700. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2701. * @param p_class_name A pointer to a StringName with the class name.
  2702. * @param p_group_name A pointer to a String with the group name.
  2703. * @param p_prefix A pointer to a String with the prefix used by properties in this group.
  2704. */
  2705. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassPropertyGroup)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringPtr p_group_name, GDExtensionConstStringPtr p_prefix);
  2706. /**
  2707. * @name classdb_register_extension_class_property_subgroup
  2708. * @since 4.1
  2709. *
  2710. * Registers a property subgroup on an extension class in the ClassDB.
  2711. *
  2712. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2713. * @param p_class_name A pointer to a StringName with the class name.
  2714. * @param p_subgroup_name A pointer to a String with the subgroup name.
  2715. * @param p_prefix A pointer to a String with the prefix used by properties in this subgroup.
  2716. */
  2717. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassPropertySubgroup)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringPtr p_subgroup_name, GDExtensionConstStringPtr p_prefix);
  2718. /**
  2719. * @name classdb_register_extension_class_signal
  2720. * @since 4.1
  2721. *
  2722. * Registers a signal on an extension class in the ClassDB.
  2723. *
  2724. * Provided structs can be safely freed once the function returns.
  2725. *
  2726. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2727. * @param p_class_name A pointer to a StringName with the class name.
  2728. * @param p_signal_name A pointer to a StringName with the signal name.
  2729. * @param p_argument_info A pointer to a GDExtensionPropertyInfo struct.
  2730. * @param p_argument_count The number of arguments the signal receives.
  2731. */
  2732. typedef void (*GDExtensionInterfaceClassdbRegisterExtensionClassSignal)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_signal_name, const GDExtensionPropertyInfo *p_argument_info, GDExtensionInt p_argument_count);
  2733. /**
  2734. * @name classdb_unregister_extension_class
  2735. * @since 4.1
  2736. *
  2737. * Unregisters an extension class in the ClassDB.
  2738. *
  2739. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2740. * @param p_class_name A pointer to a StringName with the class name.
  2741. */
  2742. typedef void (*GDExtensionInterfaceClassdbUnregisterExtensionClass)(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name); /* Unregistering a parent class before a class that inherits it will result in failure. Inheritors must be unregistered first. */
  2743. /**
  2744. * @name get_library_path
  2745. * @since 4.1
  2746. *
  2747. * Gets the path to the current GDExtension library.
  2748. *
  2749. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2750. * @param r_path A pointer to a String which will receive the path.
  2751. */
  2752. typedef void (*GDExtensionInterfaceGetLibraryPath)(GDExtensionClassLibraryPtr p_library, GDExtensionUninitializedStringPtr r_path);
  2753. /**
  2754. * @name editor_add_plugin
  2755. * @since 4.1
  2756. *
  2757. * Adds an editor plugin.
  2758. *
  2759. * It's safe to call during initialization.
  2760. *
  2761. * @param p_class_name A pointer to a StringName with the name of a class (descending from EditorPlugin) which is already registered with ClassDB.
  2762. */
  2763. typedef void (*GDExtensionInterfaceEditorAddPlugin)(GDExtensionConstStringNamePtr p_class_name);
  2764. /**
  2765. * @name editor_remove_plugin
  2766. * @since 4.1
  2767. *
  2768. * Removes an editor plugin.
  2769. *
  2770. * @param p_class_name A pointer to a StringName with the name of a class that was previously added as an editor plugin.
  2771. */
  2772. typedef void (*GDExtensionInterfaceEditorRemovePlugin)(GDExtensionConstStringNamePtr p_class_name);
  2773. /**
  2774. * @name editor_help_load_xml_from_utf8_chars
  2775. * @since 4.3
  2776. *
  2777. * Loads new XML-formatted documentation data in the editor.
  2778. *
  2779. * The provided pointer can be immediately freed once the function returns.
  2780. *
  2781. * @param p_data A pointer to a UTF-8 encoded C string (null terminated).
  2782. */
  2783. typedef void (*GDExtensionsInterfaceEditorHelpLoadXmlFromUtf8Chars)(const char *p_data);
  2784. /**
  2785. * @name editor_help_load_xml_from_utf8_chars_and_len
  2786. * @since 4.3
  2787. *
  2788. * Loads new XML-formatted documentation data in the editor.
  2789. *
  2790. * The provided pointer can be immediately freed once the function returns.
  2791. *
  2792. * @param p_data A pointer to a UTF-8 encoded C string.
  2793. * @param p_size The number of bytes (not code units).
  2794. */
  2795. typedef void (*GDExtensionsInterfaceEditorHelpLoadXmlFromUtf8CharsAndLen)(const char *p_data, GDExtensionInt p_size);
  2796. /**
  2797. * @name editor_register_get_classes_used_callback
  2798. * @since 4.5
  2799. *
  2800. * Registers a callback that Godot can call to get the list of all classes (from ClassDB) that may be used by the calling GDExtension.
  2801. *
  2802. * This is used by the editor to generate a build profile (in "Tools" > "Engine Compilation Configuration Editor..." > "Detect from project"),
  2803. * in order to recompile Godot with only the classes used.
  2804. * In the provided callback, the GDExtension should provide the list of classes that _may_ be used statically, thus the time of invocation shouldn't matter.
  2805. * If a GDExtension doesn't register a callback, Godot will assume that it could be using any classes.
  2806. *
  2807. * @param p_library A pointer the library received by the GDExtension's entry point function.
  2808. * @param p_callback The callback to retrieve the list of classes used.
  2809. */
  2810. typedef void (*GDExtensionInterfaceEditorRegisterGetClassesUsedCallback)(GDExtensionClassLibraryPtr p_library, GDExtensionEditorGetClassesUsedCallback p_callback);
  2811. #ifdef __cplusplus
  2812. }
  2813. #endif