Sara.Sync
/
godot-cpp
mirror of https://github.com/godotengine/godot-cpp
0
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
godot-cpp/godot-headers/godot/gdnative_interface.h

610 lines
37 KiB
C
Raw Normal View History

Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/*************************************************************************/
/* gdnative_interface.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
#ifndef GDNATIVE_INTERFACE_H
#define GDNATIVE_INTERFACE_H
/* This is a C class header, you can copy it and use it directly in your own binders.
* Together with the JSON file, you should be able to generate any binder.
*/
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#ifndef __cplusplus
typedef uint32_t char32_t;
typedef uint16_t char16_t;
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* VARIANT TYPES */
typedef enum {
GDNATIVE_VARIANT_TYPE_NIL,
/* atomic types */
GDNATIVE_VARIANT_TYPE_BOOL,
GDNATIVE_VARIANT_TYPE_INT,
GDNATIVE_VARIANT_TYPE_FLOAT,
GDNATIVE_VARIANT_TYPE_STRING,
/* math types */
GDNATIVE_VARIANT_TYPE_VECTOR2,
GDNATIVE_VARIANT_TYPE_VECTOR2I,
GDNATIVE_VARIANT_TYPE_RECT2,
GDNATIVE_VARIANT_TYPE_RECT2I,
GDNATIVE_VARIANT_TYPE_VECTOR3,
GDNATIVE_VARIANT_TYPE_VECTOR3I,
GDNATIVE_VARIANT_TYPE_TRANSFORM2D,
Add bindings for Vector4, Vector4i, Projection built-in types.
2022-07-20 20:49:08 +00:00
GDNATIVE_VARIANT_TYPE_VECTOR4,
GDNATIVE_VARIANT_TYPE_VECTOR4I,
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNATIVE_VARIANT_TYPE_PLANE,
GDNATIVE_VARIANT_TYPE_QUATERNION,
GDNATIVE_VARIANT_TYPE_AABB,
GDNATIVE_VARIANT_TYPE_BASIS,
GDNATIVE_VARIANT_TYPE_TRANSFORM3D,
Add bindings for Vector4, Vector4i, Projection built-in types.
2022-07-20 20:49:08 +00:00
GDNATIVE_VARIANT_TYPE_PROJECTION,
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* misc types */
GDNATIVE_VARIANT_TYPE_COLOR,
GDNATIVE_VARIANT_TYPE_STRING_NAME,
GDNATIVE_VARIANT_TYPE_NODE_PATH,
GDNATIVE_VARIANT_TYPE_RID,
GDNATIVE_VARIANT_TYPE_OBJECT,
GDNATIVE_VARIANT_TYPE_CALLABLE,
GDNATIVE_VARIANT_TYPE_SIGNAL,
GDNATIVE_VARIANT_TYPE_DICTIONARY,
GDNATIVE_VARIANT_TYPE_ARRAY,
/* typed arrays */
GDNATIVE_VARIANT_TYPE_PACKED_BYTE_ARRAY,
GDNATIVE_VARIANT_TYPE_PACKED_INT32_ARRAY,
GDNATIVE_VARIANT_TYPE_PACKED_INT64_ARRAY,
GDNATIVE_VARIANT_TYPE_PACKED_FLOAT32_ARRAY,
GDNATIVE_VARIANT_TYPE_PACKED_FLOAT64_ARRAY,
GDNATIVE_VARIANT_TYPE_PACKED_STRING_ARRAY,
GDNATIVE_VARIANT_TYPE_PACKED_VECTOR2_ARRAY,
GDNATIVE_VARIANT_TYPE_PACKED_VECTOR3_ARRAY,
GDNATIVE_VARIANT_TYPE_PACKED_COLOR_ARRAY,
GDNATIVE_VARIANT_TYPE_VARIANT_MAX
} GDNativeVariantType;
typedef enum {
/* comparison */
GDNATIVE_VARIANT_OP_EQUAL,
GDNATIVE_VARIANT_OP_NOT_EQUAL,
GDNATIVE_VARIANT_OP_LESS,
GDNATIVE_VARIANT_OP_LESS_EQUAL,
GDNATIVE_VARIANT_OP_GREATER,
GDNATIVE_VARIANT_OP_GREATER_EQUAL,
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* mathematic */
GDNATIVE_VARIANT_OP_ADD,
GDNATIVE_VARIANT_OP_SUBTRACT,
GDNATIVE_VARIANT_OP_MULTIPLY,
GDNATIVE_VARIANT_OP_DIVIDE,
GDNATIVE_VARIANT_OP_NEGATE,
GDNATIVE_VARIANT_OP_POSITIVE,
GDNATIVE_VARIANT_OP_MODULE,
Sync containers with new HashMap/HashSet, sync API headers.
2022-06-06 09:18:07 +00:00
GDNATIVE_VARIANT_OP_POWER,
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* bitwise */
GDNATIVE_VARIANT_OP_SHIFT_LEFT,
GDNATIVE_VARIANT_OP_SHIFT_RIGHT,
GDNATIVE_VARIANT_OP_BIT_AND,
GDNATIVE_VARIANT_OP_BIT_OR,
GDNATIVE_VARIANT_OP_BIT_XOR,
GDNATIVE_VARIANT_OP_BIT_NEGATE,
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* logic */
GDNATIVE_VARIANT_OP_AND,
GDNATIVE_VARIANT_OP_OR,
GDNATIVE_VARIANT_OP_XOR,
GDNATIVE_VARIANT_OP_NOT,
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* containment */
GDNATIVE_VARIANT_OP_IN,
GDNATIVE_VARIANT_OP_MAX
} GDNativeVariantOperator;
typedef void *GDNativeVariantPtr;
typedef void *GDNativeStringNamePtr;
typedef void *GDNativeStringPtr;
typedef void *GDNativeObjectPtr;
typedef void *GDNativeTypePtr;
typedef void *GDNativeExtensionPtr;
typedef void *GDNativeMethodBindPtr;
typedef int64_t GDNativeInt;
typedef uint8_t GDNativeBool;
typedef uint64_t GDObjectInstanceID;
/* VARIANT DATA I/O */
typedef enum {
GDNATIVE_CALL_OK,
GDNATIVE_CALL_ERROR_INVALID_METHOD,
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
GDNATIVE_CALL_ERROR_INVALID_ARGUMENT, // Expected a different variant type.
GDNATIVE_CALL_ERROR_TOO_MANY_ARGUMENTS, // Expected lower number of arguments.
GDNATIVE_CALL_ERROR_TOO_FEW_ARGUMENTS, // Expected higher number of arguments.
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNATIVE_CALL_ERROR_INSTANCE_IS_NULL,
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
GDNATIVE_CALL_ERROR_METHOD_NOT_CONST, // Used for const call.
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
} GDNativeCallErrorType;
typedef struct {
GDNativeCallErrorType error;
int32_t argument;
int32_t expected;
} GDNativeCallError;
typedef void (*GDNativeVariantFromTypeConstructorFunc)(GDNativeVariantPtr, GDNativeTypePtr);
typedef void (*GDNativeTypeFromVariantConstructorFunc)(GDNativeTypePtr, GDNativeVariantPtr);
typedef void (*GDNativePtrOperatorEvaluator)(const GDNativeTypePtr p_left, const GDNativeTypePtr p_right, GDNativeTypePtr r_result);
typedef void (*GDNativePtrBuiltInMethod)(GDNativeTypePtr p_base, const GDNativeTypePtr *p_args, GDNativeTypePtr r_return, int p_argument_count);
typedef void (*GDNativePtrConstructor)(GDNativeTypePtr p_base, const GDNativeTypePtr *p_args);
typedef void (*GDNativePtrDestructor)(GDNativeTypePtr p_base);
typedef void (*GDNativePtrSetter)(GDNativeTypePtr p_base, const GDNativeTypePtr p_value);
typedef void (*GDNativePtrGetter)(const GDNativeTypePtr p_base, GDNativeTypePtr r_value);
typedef void (*GDNativePtrIndexedSetter)(GDNativeTypePtr p_base, GDNativeInt p_index, const GDNativeTypePtr p_value);
typedef void (*GDNativePtrIndexedGetter)(const GDNativeTypePtr p_base, GDNativeInt p_index, GDNativeTypePtr r_value);
typedef void (*GDNativePtrKeyedSetter)(GDNativeTypePtr p_base, const GDNativeTypePtr p_key, const GDNativeTypePtr p_value);
typedef void (*GDNativePtrKeyedGetter)(const GDNativeTypePtr p_base, const GDNativeTypePtr p_key, GDNativeTypePtr r_value);
typedef uint32_t (*GDNativePtrKeyedChecker)(const GDNativeVariantPtr p_base, const GDNativeVariantPtr p_key);
typedef void (*GDNativePtrUtilityFunction)(GDNativeTypePtr r_return, const GDNativeTypePtr *p_arguments, int p_argument_count);
typedef GDNativeObjectPtr (*GDNativeClassConstructor)();
typedef void *(*GDNativeInstanceBindingCreateCallback)(void *p_token, void *p_instance);
typedef void (*GDNativeInstanceBindingFreeCallback)(void *p_token, void *p_instance, void *p_binding);
typedef GDNativeBool (*GDNativeInstanceBindingReferenceCallback)(void *p_token, void *p_binding, GDNativeBool p_reference);
typedef struct {
GDNativeInstanceBindingCreateCallback create_callback;
GDNativeInstanceBindingFreeCallback free_callback;
GDNativeInstanceBindingReferenceCallback reference_callback;
} GDNativeInstanceBindingCallbacks;
/* EXTENSION CLASSES */
typedef void *GDExtensionClassInstancePtr;
typedef GDNativeBool (*GDNativeExtensionClassSet)(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, const GDNativeVariantPtr p_value);
typedef GDNativeBool (*GDNativeExtensionClassGet)(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, GDNativeVariantPtr r_ret);
Fix build after "Discern between VIRTUAL and ABSTRACT class bindings".
2022-03-14 16:35:52 +00:00
typedef uint64_t (*GDNativeExtensionClassGetRID)(GDExtensionClassInstancePtr p_instance);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
typedef struct {
Type `GDNativePropertyInfo.type` field as `GDNativeVariantType`
2022-10-09 21:21:32 +00:00
GDNativeVariantType type;
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
GDNativeStringNamePtr name;
GDNativeStringNamePtr class_name;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
uint32_t hint; // Bitfield of `PropertyHint` (defined in `extension_api.json`).
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
GDNativeStringPtr hint_string;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
uint32_t usage; // Bitfield of `PropertyUsageFlags` (defined in `extension_api.json`).
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
} GDNativePropertyInfo;
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
typedef struct {
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
GDNativeStringNamePtr name;
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
GDNativePropertyInfo return_value;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
uint32_t flags; // Bitfield of `GDNativeExtensionClassMethodFlags`.
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
int32_t id;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
/* Arguments: `default_arguments` is an array of size `argument_count`. */
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
uint32_t argument_count;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
GDNativePropertyInfo *arguments;
/* Default arguments: `default_arguments` is an array of size `default_argument_count`. */
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
uint32_t default_argument_count;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
GDNativeVariantPtr *default_arguments;
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
} GDNativeMethodInfo;
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
typedef const GDNativePropertyInfo *(*GDNativeExtensionClassGetPropertyList)(GDExtensionClassInstancePtr p_instance, uint32_t *r_count);
typedef void (*GDNativeExtensionClassFreePropertyList)(GDExtensionClassInstancePtr p_instance, const GDNativePropertyInfo *p_list);
Add support for `property_*_revert` methods
2022-08-18 13:43:01 +00:00
typedef GDNativeBool (*GDNativeExtensionClassPropertyCanRevert)(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name);
typedef GDNativeBool (*GDNativeExtensionClassPropertyGetRevert)(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, GDNativeVariantPtr r_ret);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
typedef void (*GDNativeExtensionClassNotification)(GDExtensionClassInstancePtr p_instance, int32_t p_what);
Correct GDNativeExtensionScriptInstanceToString
2022-10-23 12:45:57 +00:00
typedef void (*GDNativeExtensionClassToString)(GDExtensionClassInstancePtr p_instance, GDNativeBool *r_is_valid, GDNativeStringPtr p_out);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
typedef void (*GDNativeExtensionClassReference)(GDExtensionClassInstancePtr p_instance);
typedef void (*GDNativeExtensionClassUnreference)(GDExtensionClassInstancePtr p_instance);
typedef void (*GDNativeExtensionClassCallVirtual)(GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_ret);
typedef GDNativeObjectPtr (*GDNativeExtensionClassCreateInstance)(void *p_userdata);
typedef void (*GDNativeExtensionClassFreeInstance)(void *p_userdata, GDExtensionClassInstancePtr p_instance);
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
typedef GDNativeExtensionClassCallVirtual (*GDNativeExtensionClassGetVirtual)(void *p_userdata, const GDNativeStringNamePtr p_name);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
typedef struct {
Add support for virtual and abstract classes
2022-10-15 10:23:36 +00:00
GDNativeBool is_virtual;
GDNativeBool is_abstract;
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNativeExtensionClassSet set_func;
GDNativeExtensionClassGet get_func;
GDNativeExtensionClassGetPropertyList get_property_list_func;
GDNativeExtensionClassFreePropertyList free_property_list_func;
Add support for `property_*_revert` methods
2022-08-18 13:43:01 +00:00
GDNativeExtensionClassPropertyCanRevert property_can_revert_func;
GDNativeExtensionClassPropertyGetRevert property_get_revert_func;
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNativeExtensionClassNotification notification_func;
GDNativeExtensionClassToString to_string_func;
GDNativeExtensionClassReference reference_func;
GDNativeExtensionClassUnreference unreference_func;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
GDNativeExtensionClassCreateInstance create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
GDNativeExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
GDNativeExtensionClassGetVirtual get_virtual_func; // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
Fix build after "Discern between VIRTUAL and ABSTRACT class bindings".
2022-03-14 16:35:52 +00:00
GDNativeExtensionClassGetRID get_rid_func;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
void *class_userdata; // Per-class user data, later accessible in instance bindings.
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
} GDNativeExtensionClassCreationInfo;
typedef void *GDNativeExtensionClassLibraryPtr;
/* Method */
typedef enum {
GDNATIVE_EXTENSION_METHOD_FLAG_NORMAL = 1,
GDNATIVE_EXTENSION_METHOD_FLAG_EDITOR = 2,
headers: Sync with upstream commit 2c11e6d9e (4.0-alpha12)
2022-07-14 21:51:09 +00:00
GDNATIVE_EXTENSION_METHOD_FLAG_CONST = 4,
GDNATIVE_EXTENSION_METHOD_FLAG_VIRTUAL = 8,
GDNATIVE_EXTENSION_METHOD_FLAG_VARARG = 16,
GDNATIVE_EXTENSION_METHOD_FLAG_STATIC = 32,
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNATIVE_EXTENSION_METHOD_FLAGS_DEFAULT = GDNATIVE_EXTENSION_METHOD_FLAG_NORMAL,
} GDNativeExtensionClassMethodFlags;
typedef enum {
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_NONE,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT8,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT16,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT32,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_INT64,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT8,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT16,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT32,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_INT_IS_UINT64,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_REAL_IS_FLOAT,
GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_REAL_IS_DOUBLE
} GDNativeExtensionClassMethodArgumentMetadata;
typedef void (*GDNativeExtensionClassMethodCall)(void *method_userdata, GDExtensionClassInstancePtr p_instance, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeVariantPtr r_return, GDNativeCallError *r_error);
typedef void (*GDNativeExtensionClassMethodPtrCall)(void *method_userdata, GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_ret);
typedef struct {
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
GDNativeStringNamePtr name;
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
void *method_userdata;
GDNativeExtensionClassMethodCall call_func;
GDNativeExtensionClassMethodPtrCall ptrcall_func;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
uint32_t method_flags; // Bitfield of `GDNativeExtensionClassMethodFlags`.
/* If `has_return_value` is false, `return_value_info` and `return_value_metadata` are ignored. */
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNativeBool has_return_value;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
GDNativePropertyInfo *return_value_info;
GDNativeExtensionClassMethodArgumentMetadata return_value_metadata;
/* Arguments: `arguments_info` and `arguments_metadata` are array of size `argument_count`.
* Name and hint information for the argument can be omitted in release builds. Class name should always be present if it applies.
*/
uint32_t argument_count;
GDNativePropertyInfo *arguments_info;
GDNativeExtensionClassMethodArgumentMetadata *arguments_metadata;
/* Default arguments: `default_arguments` is an array of size `default_argument_count`. */
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
uint32_t default_argument_count;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
GDNativeVariantPtr *default_arguments;
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
} GDNativeExtensionClassMethodInfo;
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
/* SCRIPT INSTANCE EXTENSION */
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
typedef void *GDNativeExtensionScriptInstanceDataPtr; // Pointer to custom ScriptInstance native implementation.
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
typedef GDNativeBool (*GDNativeExtensionScriptInstanceSet)(GDNativeExtensionScriptInstanceDataPtr p_instance, const GDNativeStringNamePtr p_name, const GDNativeVariantPtr p_value);
typedef GDNativeBool (*GDNativeExtensionScriptInstanceGet)(GDNativeExtensionScriptInstanceDataPtr p_instance, const GDNativeStringNamePtr p_name, GDNativeVariantPtr r_ret);
typedef const GDNativePropertyInfo *(*GDNativeExtensionScriptInstanceGetPropertyList)(GDNativeExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
typedef void (*GDNativeExtensionScriptInstanceFreePropertyList)(GDNativeExtensionScriptInstanceDataPtr p_instance, const GDNativePropertyInfo *p_list);
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
typedef GDNativeVariantType (*GDNativeExtensionScriptInstanceGetPropertyType)(GDNativeExtensionScriptInstanceDataPtr p_instance, const GDNativeStringNamePtr p_name, GDNativeBool *r_is_valid);
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
Add support for `property_*_revert` methods
2022-08-18 13:43:01 +00:00
typedef GDNativeBool (*GDNativeExtensionScriptInstancePropertyCanRevert)(GDNativeExtensionScriptInstanceDataPtr p_instance, const GDNativeStringNamePtr p_name);
typedef GDNativeBool (*GDNativeExtensionScriptInstancePropertyGetRevert)(GDNativeExtensionScriptInstanceDataPtr p_instance, const GDNativeStringNamePtr p_name, GDNativeVariantPtr r_ret);
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
typedef GDNativeObjectPtr (*GDNativeExtensionScriptInstanceGetOwner)(GDNativeExtensionScriptInstanceDataPtr p_instance);
typedef void (*GDNativeExtensionScriptInstancePropertyStateAdd)(const GDNativeStringNamePtr p_name, const GDNativeVariantPtr p_value, void *p_userdata);
typedef void (*GDNativeExtensionScriptInstanceGetPropertyState)(GDNativeExtensionScriptInstanceDataPtr p_instance, GDNativeExtensionScriptInstancePropertyStateAdd p_add_func, void *p_userdata);
typedef const GDNativeMethodInfo *(*GDNativeExtensionScriptInstanceGetMethodList)(GDNativeExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
typedef void (*GDNativeExtensionScriptInstanceFreeMethodList)(GDNativeExtensionScriptInstanceDataPtr p_instance, const GDNativeMethodInfo *p_list);
typedef GDNativeBool (*GDNativeExtensionScriptInstanceHasMethod)(GDNativeExtensionScriptInstanceDataPtr p_instance, const GDNativeStringNamePtr p_name);
typedef void (*GDNativeExtensionScriptInstanceCall)(GDNativeExtensionScriptInstanceDataPtr p_self, const GDNativeStringNamePtr p_method, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeVariantPtr r_return, GDNativeCallError *r_error);
typedef void (*GDNativeExtensionScriptInstanceNotification)(GDNativeExtensionScriptInstanceDataPtr p_instance, int32_t p_what);
Correct GDNativeExtensionScriptInstanceToString
2022-10-23 12:45:57 +00:00
typedef void (*GDNativeExtensionScriptInstanceToString)(GDNativeExtensionScriptInstanceDataPtr p_instance, GDNativeBool *r_is_valid, GDNativeStringPtr r_out);
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
typedef void (*GDNativeExtensionScriptInstanceRefCountIncremented)(GDNativeExtensionScriptInstanceDataPtr p_instance);
typedef GDNativeBool (*GDNativeExtensionScriptInstanceRefCountDecremented)(GDNativeExtensionScriptInstanceDataPtr p_instance);
typedef GDNativeObjectPtr (*GDNativeExtensionScriptInstanceGetScript)(GDNativeExtensionScriptInstanceDataPtr p_instance);
typedef GDNativeBool (*GDNativeExtensionScriptInstanceIsPlaceholder)(GDNativeExtensionScriptInstanceDataPtr p_instance);
typedef void *GDNativeExtensionScriptLanguagePtr;
typedef GDNativeExtensionScriptLanguagePtr (*GDNativeExtensionScriptInstanceGetLanguage)(GDNativeExtensionScriptInstanceDataPtr p_instance);
typedef void (*GDNativeExtensionScriptInstanceFree)(GDNativeExtensionScriptInstanceDataPtr p_instance);
typedef void *GDNativeScriptInstancePtr; // Pointer to ScriptInstance.
typedef struct {
GDNativeExtensionScriptInstanceSet set_func;
GDNativeExtensionScriptInstanceGet get_func;
GDNativeExtensionScriptInstanceGetPropertyList get_property_list_func;
GDNativeExtensionScriptInstanceFreePropertyList free_property_list_func;
Add support for `property_*_revert` methods
2022-08-18 13:43:01 +00:00
GDNativeExtensionScriptInstancePropertyCanRevert property_can_revert_func;
GDNativeExtensionScriptInstancePropertyGetRevert property_get_revert_func;
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
GDNativeExtensionScriptInstanceGetOwner get_owner_func;
GDNativeExtensionScriptInstanceGetPropertyState get_property_state_func;
GDNativeExtensionScriptInstanceGetMethodList get_method_list_func;
GDNativeExtensionScriptInstanceFreeMethodList free_method_list_func;
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
GDNativeExtensionScriptInstanceGetPropertyType get_property_type_func;
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
GDNativeExtensionScriptInstanceHasMethod has_method_func;
GDNativeExtensionScriptInstanceCall call_func;
GDNativeExtensionScriptInstanceNotification notification_func;
GDNativeExtensionScriptInstanceToString to_string_func;
GDNativeExtensionScriptInstanceRefCountIncremented refcount_incremented_func;
GDNativeExtensionScriptInstanceRefCountDecremented refcount_decremented_func;
GDNativeExtensionScriptInstanceGetScript get_script_func;
GDNativeExtensionScriptInstanceIsPlaceholder is_placeholder_func;
GDNativeExtensionScriptInstanceSet set_fallback_func;
GDNativeExtensionScriptInstanceGet get_fallback_func;
GDNativeExtensionScriptInstanceGetLanguage get_language_func;
GDNativeExtensionScriptInstanceFree free_func;
} GDNativeExtensionScriptInstanceInfo;
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* INTERFACE */
typedef struct {
uint32_t version_major;
uint32_t version_minor;
uint32_t version_patch;
const char *version_string;
/* GODOT CORE */
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
void *(*mem_alloc)(size_t p_bytes);
void *(*mem_realloc)(void *p_ptr, size_t p_bytes);
void (*mem_free)(void *p_ptr);
void (*print_error)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line);
void (*print_warning)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line);
void (*print_script_error)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line);
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
uint64_t (*get_native_struct_size)(const GDNativeStringNamePtr p_name);
Sync godot-headers and fix build after "Create GDExtension clases for PhysicsServer3D".
2022-03-16 18:33:06 +00:00
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* GODOT VARIANT */
/* variant general */
void (*variant_new_copy)(GDNativeVariantPtr r_dest, const GDNativeVariantPtr p_src);
void (*variant_new_nil)(GDNativeVariantPtr r_dest);
void (*variant_destroy)(GDNativeVariantPtr p_self);
/* variant type */
void (*variant_call)(GDNativeVariantPtr p_self, const GDNativeStringNamePtr p_method, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeVariantPtr r_return, GDNativeCallError *r_error);
void (*variant_call_static)(GDNativeVariantType p_type, const GDNativeStringNamePtr p_method, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeVariantPtr r_return, GDNativeCallError *r_error);
void (*variant_evaluate)(GDNativeVariantOperator p_op, const GDNativeVariantPtr p_a, const GDNativeVariantPtr p_b, GDNativeVariantPtr r_return, GDNativeBool *r_valid);
void (*variant_set)(GDNativeVariantPtr p_self, const GDNativeVariantPtr p_key, const GDNativeVariantPtr p_value, GDNativeBool *r_valid);
void (*variant_set_named)(GDNativeVariantPtr p_self, const GDNativeStringNamePtr p_key, const GDNativeVariantPtr p_value, GDNativeBool *r_valid);
void (*variant_set_keyed)(GDNativeVariantPtr p_self, const GDNativeVariantPtr p_key, const GDNativeVariantPtr p_value, GDNativeBool *r_valid);
void (*variant_set_indexed)(GDNativeVariantPtr p_self, GDNativeInt p_index, const GDNativeVariantPtr p_value, GDNativeBool *r_valid, GDNativeBool *r_oob);
void (*variant_get)(const GDNativeVariantPtr p_self, const GDNativeVariantPtr p_key, GDNativeVariantPtr r_ret, GDNativeBool *r_valid);
void (*variant_get_named)(const GDNativeVariantPtr p_self, const GDNativeStringNamePtr p_key, GDNativeVariantPtr r_ret, GDNativeBool *r_valid);
void (*variant_get_keyed)(const GDNativeVariantPtr p_self, const GDNativeVariantPtr p_key, GDNativeVariantPtr r_ret, GDNativeBool *r_valid);
void (*variant_get_indexed)(const GDNativeVariantPtr p_self, GDNativeInt p_index, GDNativeVariantPtr r_ret, GDNativeBool *r_valid, GDNativeBool *r_oob);
GDNativeBool (*variant_iter_init)(const GDNativeVariantPtr p_self, GDNativeVariantPtr r_iter, GDNativeBool *r_valid);
GDNativeBool (*variant_iter_next)(const GDNativeVariantPtr p_self, GDNativeVariantPtr r_iter, GDNativeBool *r_valid);
void (*variant_iter_get)(const GDNativeVariantPtr p_self, GDNativeVariantPtr r_iter, GDNativeVariantPtr r_ret, GDNativeBool *r_valid);
Sync containers with new HashMap/HashSet, sync API headers.
2022-06-06 09:18:07 +00:00
GDNativeInt (*variant_hash)(const GDNativeVariantPtr p_self);
GDNativeInt (*variant_recursive_hash)(const GDNativeVariantPtr p_self, GDNativeInt p_recursion_count);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNativeBool (*variant_hash_compare)(const GDNativeVariantPtr p_self, const GDNativeVariantPtr p_other);
GDNativeBool (*variant_booleanize)(const GDNativeVariantPtr p_self);
void (*variant_duplicate)(const GDNativeVariantPtr p_self, GDNativeVariantPtr r_ret, GDNativeBool p_deep);
void (*variant_stringify)(const GDNativeVariantPtr p_self, GDNativeStringPtr r_ret);
GDNativeVariantType (*variant_get_type)(const GDNativeVariantPtr p_self);
GDNativeBool (*variant_has_method)(const GDNativeVariantPtr p_self, const GDNativeStringNamePtr p_method);
GDNativeBool (*variant_has_member)(GDNativeVariantType p_type, const GDNativeStringNamePtr p_member);
GDNativeBool (*variant_has_key)(const GDNativeVariantPtr p_self, const GDNativeVariantPtr p_key, GDNativeBool *r_valid);
void (*variant_get_type_name)(GDNativeVariantType p_type, GDNativeStringPtr r_name);
GDNativeBool (*variant_can_convert)(GDNativeVariantType p_from, GDNativeVariantType p_to);
GDNativeBool (*variant_can_convert_strict)(GDNativeVariantType p_from, GDNativeVariantType p_to);
/* ptrcalls */
GDNativeVariantFromTypeConstructorFunc (*get_variant_from_type_constructor)(GDNativeVariantType p_type);
GDNativeTypeFromVariantConstructorFunc (*get_variant_to_type_constructor)(GDNativeVariantType p_type);
GDNativePtrOperatorEvaluator (*variant_get_ptr_operator_evaluator)(GDNativeVariantOperator p_operator, GDNativeVariantType p_type_a, GDNativeVariantType p_type_b);
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
GDNativePtrBuiltInMethod (*variant_get_ptr_builtin_method)(GDNativeVariantType p_type, const GDNativeStringNamePtr p_method, GDNativeInt p_hash);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNativePtrConstructor (*variant_get_ptr_constructor)(GDNativeVariantType p_type, int32_t p_constructor);
GDNativePtrDestructor (*variant_get_ptr_destructor)(GDNativeVariantType p_type);
void (*variant_construct)(GDNativeVariantType p_type, GDNativeVariantPtr p_base, const GDNativeVariantPtr *p_args, int32_t p_argument_count, GDNativeCallError *r_error);
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
GDNativePtrSetter (*variant_get_ptr_setter)(GDNativeVariantType p_type, const GDNativeStringNamePtr p_member);
GDNativePtrGetter (*variant_get_ptr_getter)(GDNativeVariantType p_type, const GDNativeStringNamePtr p_member);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNativePtrIndexedSetter (*variant_get_ptr_indexed_setter)(GDNativeVariantType p_type);
GDNativePtrIndexedGetter (*variant_get_ptr_indexed_getter)(GDNativeVariantType p_type);
GDNativePtrKeyedSetter (*variant_get_ptr_keyed_setter)(GDNativeVariantType p_type);
GDNativePtrKeyedGetter (*variant_get_ptr_keyed_getter)(GDNativeVariantType p_type);
GDNativePtrKeyedChecker (*variant_get_ptr_keyed_checker)(GDNativeVariantType p_type);
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
void (*variant_get_constant_value)(GDNativeVariantType p_type, const GDNativeStringNamePtr p_constant, GDNativeVariantPtr r_ret);
GDNativePtrUtilityFunction (*variant_get_ptr_utility_function)(const GDNativeStringNamePtr p_function, GDNativeInt p_hash);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* extra utilities */
void (*string_new_with_latin1_chars)(GDNativeStringPtr r_dest, const char *p_contents);
void (*string_new_with_utf8_chars)(GDNativeStringPtr r_dest, const char *p_contents);
void (*string_new_with_utf16_chars)(GDNativeStringPtr r_dest, const char16_t *p_contents);
void (*string_new_with_utf32_chars)(GDNativeStringPtr r_dest, const char32_t *p_contents);
void (*string_new_with_wide_chars)(GDNativeStringPtr r_dest, const wchar_t *p_contents);
void (*string_new_with_latin1_chars_and_len)(GDNativeStringPtr r_dest, const char *p_contents, const GDNativeInt p_size);
void (*string_new_with_utf8_chars_and_len)(GDNativeStringPtr r_dest, const char *p_contents, const GDNativeInt p_size);
void (*string_new_with_utf16_chars_and_len)(GDNativeStringPtr r_dest, const char16_t *p_contents, const GDNativeInt p_size);
void (*string_new_with_utf32_chars_and_len)(GDNativeStringPtr r_dest, const char32_t *p_contents, const GDNativeInt p_size);
void (*string_new_with_wide_chars_and_len)(GDNativeStringPtr r_dest, const wchar_t *p_contents, const GDNativeInt p_size);
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* Information about the following functions:
* - The return value is the resulting encoded string length.
* - The length returned is in characters, not in bytes. It also does not include a trailing zero.
* - These functions also do not write trailing zero, If you need it, write it yourself at the position indicated by the length (and make sure to allocate it).
* - Passing NULL in r_text means only the length is computed (again, without including trailing zero).
* - p_max_write_length argument is in characters, not bytes. It will be ignored if r_text is NULL.
* - p_max_write_length argument does not affect the return value, it's only to cap write length.
*/
GDNativeInt (*string_to_latin1_chars)(const GDNativeStringPtr p_self, char *r_text, GDNativeInt p_max_write_length);
GDNativeInt (*string_to_utf8_chars)(const GDNativeStringPtr p_self, char *r_text, GDNativeInt p_max_write_length);
GDNativeInt (*string_to_utf16_chars)(const GDNativeStringPtr p_self, char16_t *r_text, GDNativeInt p_max_write_length);
GDNativeInt (*string_to_utf32_chars)(const GDNativeStringPtr p_self, char32_t *r_text, GDNativeInt p_max_write_length);
GDNativeInt (*string_to_wide_chars)(const GDNativeStringPtr p_self, wchar_t *r_text, GDNativeInt p_max_write_length);
char32_t *(*string_operator_index)(GDNativeStringPtr p_self, GDNativeInt p_index);
const char32_t *(*string_operator_index_const)(const GDNativeStringPtr p_self, GDNativeInt p_index);
/* Packed array functions */
uint8_t *(*packed_byte_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedByteArray
const uint8_t *(*packed_byte_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedByteArray
GDNativeTypePtr (*packed_color_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedColorArray, returns Color ptr
GDNativeTypePtr (*packed_color_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedColorArray, returns Color ptr
float *(*packed_float32_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedFloat32Array
const float *(*packed_float32_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedFloat32Array
double *(*packed_float64_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedFloat64Array
const double *(*packed_float64_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedFloat64Array
int32_t *(*packed_int32_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedInt32Array
const int32_t *(*packed_int32_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedInt32Array
int64_t *(*packed_int64_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedInt32Array
const int64_t *(*packed_int64_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedInt32Array
GDNativeStringPtr (*packed_string_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedStringArray
GDNativeStringPtr (*packed_string_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedStringArray
GDNativeTypePtr (*packed_vector2_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedVector2Array, returns Vector2 ptr
GDNativeTypePtr (*packed_vector2_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedVector2Array, returns Vector2 ptr
GDNativeTypePtr (*packed_vector3_array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedVector3Array, returns Vector3 ptr
GDNativeTypePtr (*packed_vector3_array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be a PackedVector3Array, returns Vector3 ptr
GDNativeVariantPtr (*array_operator_index)(GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be an Array ptr
GDNativeVariantPtr (*array_operator_index_const)(const GDNativeTypePtr p_self, GDNativeInt p_index); // p_self should be an Array ptr
/* Dictionary functions */
GDNativeVariantPtr (*dictionary_operator_index)(GDNativeTypePtr p_self, const GDNativeVariantPtr p_key); // p_self should be an Dictionary ptr
GDNativeVariantPtr (*dictionary_operator_index_const)(const GDNativeTypePtr p_self, const GDNativeVariantPtr p_key); // p_self should be an Dictionary ptr
/* OBJECT */
void (*object_method_bind_call)(const GDNativeMethodBindPtr p_method_bind, GDNativeObjectPtr p_instance, const GDNativeVariantPtr *p_args, GDNativeInt p_arg_count, GDNativeVariantPtr r_ret, GDNativeCallError *r_error);
void (*object_method_bind_ptrcall)(const GDNativeMethodBindPtr p_method_bind, GDNativeObjectPtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_ret);
void (*object_destroy)(GDNativeObjectPtr p_o);
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
GDNativeObjectPtr (*global_get_singleton)(const GDNativeStringNamePtr p_name);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
void *(*object_get_instance_binding)(GDNativeObjectPtr p_o, void *p_token, const GDNativeInstanceBindingCallbacks *p_callbacks);
void (*object_set_instance_binding)(GDNativeObjectPtr p_o, void *p_token, void *p_binding, const GDNativeInstanceBindingCallbacks *p_callbacks);
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
void (*object_set_instance)(GDNativeObjectPtr p_o, const GDNativeStringNamePtr p_classname, GDExtensionClassInstancePtr p_instance); /* p_classname should be a registered extension class and should extend the p_o object's class. */
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
GDNativeObjectPtr (*object_cast_to)(const GDNativeObjectPtr p_object, void *p_class_tag);
GDNativeObjectPtr (*object_get_instance_from_id)(GDObjectInstanceID p_instance_id);
GDObjectInstanceID (*object_get_instance_id)(const GDNativeObjectPtr p_object);
Add support for variadic method binds with the typed return. Sync headers.
2022-03-29 11:44:07 +00:00
/* SCRIPT INSTANCE */
GDNativeScriptInstancePtr (*script_instance_create)(const GDNativeExtensionScriptInstanceInfo *p_info, GDNativeExtensionScriptInstanceDataPtr p_instance_data);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* CLASSDB */
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
GDNativeObjectPtr (*classdb_construct_object)(const GDNativeStringNamePtr p_classname); /* The passed class must be a built-in godot class, or an already-registered extension class. In both case, object_set_instance should be called to fully initialize the object. */
GDNativeMethodBindPtr (*classdb_get_method_bind)(const GDNativeStringNamePtr p_classname, const GDNativeStringNamePtr p_methodname, GDNativeInt p_hash);
void *(*classdb_get_class_tag)(const GDNativeStringNamePtr p_classname);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
/* CLASSDB EXTENSION */
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
/* Provided parameters for `classdb_register_extension_*` can be safely freed once the function returns. */
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
void (*classdb_register_extension_class)(const GDNativeExtensionClassLibraryPtr p_library, const GDNativeStringNamePtr p_class_name, const GDNativeStringNamePtr p_parent_class_name, const GDNativeExtensionClassCreationInfo *p_extension_funcs);
void (*classdb_register_extension_class_method)(const GDNativeExtensionClassLibraryPtr p_library, const GDNativeStringNamePtr p_class_name, const GDNativeExtensionClassMethodInfo *p_method_info);
void (*classdb_register_extension_class_integer_constant)(const GDNativeExtensionClassLibraryPtr p_library, const GDNativeStringNamePtr p_class_name, const GDNativeStringNamePtr p_enum_name, const GDNativeStringNamePtr p_constant_name, GDNativeInt p_constant_value, GDNativeBool p_is_bitfield);
void (*classdb_register_extension_class_property)(const GDNativeExtensionClassLibraryPtr p_library, const GDNativeStringNamePtr p_class_name, const GDNativePropertyInfo *p_info, const GDNativeStringNamePtr p_setter, const GDNativeStringNamePtr p_getter);
void (*classdb_register_extension_class_property_group)(const GDNativeExtensionClassLibraryPtr p_library, const GDNativeStringNamePtr p_class_name, const GDNativeStringPtr p_group_name, const GDNativeStringPtr p_prefix);
void (*classdb_register_extension_class_property_subgroup)(const GDNativeExtensionClassLibraryPtr p_library, const GDNativeStringNamePtr p_class_name, const GDNativeStringPtr p_subgroup_name, const GDNativeStringPtr p_prefix);
void (*classdb_register_extension_class_signal)(const GDNativeExtensionClassLibraryPtr p_library, const GDNativeStringNamePtr p_class_name, const GDNativeStringNamePtr p_signal_name, const GDNativePropertyInfo *p_argument_info, GDNativeInt p_argument_count);
void (*classdb_unregister_extension_class)(const GDNativeExtensionClassLibraryPtr p_library, const GDNativeStringNamePtr p_class_name); /* Unregistering a parent class before a class that inherits it will result in failure. Inheritors must be unregistered first. */
Change registered initializers / terminators to the single function with level argument.
2022-05-04 08:00:14 +00:00
void (*get_library_path)(const GDNativeExtensionClassLibraryPtr p_library, GDNativeStringPtr r_path);
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
} GDNativeInterface;
/* INITIALIZATION */
typedef enum {
GDNATIVE_INITIALIZATION_CORE,
GDNATIVE_INITIALIZATION_SERVERS,
GDNATIVE_INITIALIZATION_SCENE,
GDNATIVE_INITIALIZATION_EDITOR,
GDNATIVE_MAX_INITIALIZATION_LEVEL,
} GDNativeInitializationLevel;
typedef struct {
/* Minimum initialization level required.
* If Core or Servers, the extension needs editor or game restart to take effect */
GDNativeInitializationLevel minimum_initialization_level;
/* Up to the user to supply when initializing */
void *userdata;
/* This function will be called multiple times for each initialization level. */
void (*initialize)(void *userdata, GDNativeInitializationLevel p_level);
void (*deinitialize)(void *userdata, GDNativeInitializationLevel p_level);
} GDNativeInitialization;
/* Define a C function prototype that implements the function below and expose it to dlopen() (or similar).
Sync gdnative_interface.h with upstream refactoring Syncs with https://github.com/godotengine/godot/pull/68701. Breaks compat slightly by reordering member variables.
2022-11-16 08:54:36 +00:00
* This is the entry point of the GDExtension library and will be called on initialization.
* It can be used to set up different init levels, which are called during various stages of initialization/shutdown.
* The function name must be a unique one specified in the .gdextension config file.
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
*/
typedef GDNativeBool (*GDNativeInitializationFunction)(const GDNativeInterface *p_interface, const GDNativeExtensionClassLibraryPtr p_library, GDNativeInitialization *r_initialization);
#ifdef __cplusplus
}
#endif
headers: Sync with upstream commit cc5135959
2022-07-27 12:36:57 +00:00
#endif // GDNATIVE_INTERFACE_H