gdextension_interface.h 127 KB

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