gdext.internal.ffi.interface

Gets a pointer to a Variant in an Array.

Gets a const pointer to a Variant in an Array.

Sets an Array to be a reference to another Array object.

Makes an Array into a typed Array.

Creates a custom Callable object from a function pointer. Provided struct can be safely freed once the function returns.

Creates a custom Callable object from a function pointer. Provided struct can be safely freed once the function returns.

Retrieves the userdata pointer from a custom Callable. 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.

Constructs an Object of the requested class. 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.

Constructs an Object of the requested class. 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.

"NOTIFICATION_POSTINITIALIZE" must be sent after construction.

Gets a pointer uniquely identifying the given built-in class in the ClassDB.

Gets a pointer to the MethodBind in ClassDB for the given class, method and hash.

Registers an extension class in the ClassDB. Provided struct can be safely freed once the function returns.

Registers an extension class in the ClassDB. Provided struct can be safely freed once the function returns.

Registers an extension class in the ClassDB. Provided struct can be safely freed once the function returns.

Registers an extension class in the ClassDB. Provided struct can be safely freed once the function returns.

Registers an extension class in the ClassDB. Provided struct can be safely freed once the function returns.

Registers an integer constant on an extension class in the ClassDB. Note about registering bitfield values (if p_is_bitfield is true): even though p_constant_value is signed, language bindings are advised to treat bitfields as uint64_t, since this is generally clearer and can prevent mistakes like using -1 for setting all bits. Language APIs should thus provide an abstraction that registers bitfields (uint64_t) separately from regular constants (int64_t).

Registers a method on an extension class in the ClassDB. Provided struct can be safely freed once the function returns.

Registers a property on an extension class in the ClassDB. Provided struct can be safely freed once the function returns.

Registers a property group on an extension class in the ClassDB.

Registers an indexed property on an extension class in the ClassDB. Provided struct can be safely freed once the function returns.

Registers a property subgroup on an extension class in the ClassDB.

Registers a signal on an extension class in the ClassDB. Provided structs can be safely freed once the function returns.

Registers a virtual method on an extension class in ClassDB, that can be implemented by scripts or other extensions. Provided struct can be safely freed once the function returns.

Unregisters an extension class in the ClassDB. Unregistering a parent class before a class that inherits it will result in failure. Inheritors must be unregistered first.

Gets a pointer to a Variant in a Dictionary with the given key.

Gets a const pointer to a Variant in a Dictionary with the given key.

Makes a Dictionary into a typed Dictionary.

Adds an editor plugin. It's safe to call during initialization.

Loads new XML-formatted documentation data in the editor. The provided pointer can be immediately freed once the function returns.

Loads new XML-formatted documentation data in the editor. The provided pointer can be immediately freed once the function returns.

Registers a callback that Godot can call to get the list of all classes (from ClassDB) that may be used by the calling GDExtension. This is used by the editor to generate a build profile (in "Tools" > "Engine Compilation Configuration Editor..." > "Detect from project"), in order to recompile Godot with only the classes used. In the provided callback, the GDExtension should provide the list of classes that may be used statically, thus the time of invocation shouldn't matter. If a GDExtension doesn't register a callback, Godot will assume that it could be using any classes.

Removes an editor plugin.

Reads the next p_length bytes into the given buffer using an instance of FileAccess.

Stores the given buffer using an instance of FileAccess.

Gets the Godot version that the GDExtension was loaded into.

Gets the Godot version that the GDExtension was loaded into.

Gets the path to the current GDExtension library.

Gets the size of a native struct (ex. ObjectID) in bytes.

Gets a pointer to a function that can create a Variant of the given type from a raw value.

Gets a pointer to a function that can get the raw value from a Variant of the given type.

Gets a global singleton by name.

Returns read only pointer to internal Image buffer.

Returns writable pointer to internal Image buffer.

Allocates memory.

Allocates memory.

Frees memory.

Frees memory.

Reallocates memory.

Reallocates memory.

Call the given script method on this object.

Casts an Object to a different type.

Destroys an Object.

Free an Object's instance binding.

Gets the class name of an Object. If the GDExtension wraps the Godot object in an abstraction specific to its class, this is the function that should be used to determine which wrapper to use.

Gets a pointer representing an Object's instance binding.

Gets an Object by its instance ID.

Gets the instance ID from an Object.

Get the script instance data attached to this object.

Checks if this object has a script with the given method.

Calls a method on an Object.

Calls a method on an Object (using a "ptrcall").

Sets an extension class instance on a Object. p_classname should be a registered extension class and should extend the p_o Object's class.

Sets an Object's instance binding.

Set the script instance data attached to this object.

Gets a pointer to a byte in a PackedByteArray.

Gets a const pointer to a byte in a PackedByteArray.

Gets a pointer to a color in a PackedColorArray.

Gets a const pointer to a color in a PackedColorArray.

Gets a pointer to a 32-bit float in a PackedFloat32Array.

Gets a const pointer to a 32-bit float in a PackedFloat32Array.

Gets a pointer to a 64-bit float in a PackedFloat64Array.

Gets a const pointer to a 64-bit float in a PackedFloat64Array.

Gets a pointer to a 32-bit integer in a PackedInt32Array.

Gets a const pointer to a 32-bit integer in a PackedInt32Array.

Gets a pointer to a 64-bit integer in a PackedInt64Array.

Gets a const pointer to a 64-bit integer in a PackedInt64Array.

Gets a pointer to a string in a PackedStringArray.

Gets a const pointer to a string in a PackedStringArray.

Gets a pointer to a Vector2 in a PackedVector2Array.

Gets a const pointer to a Vector2 in a PackedVector2Array.

Gets a pointer to a Vector3 in a PackedVector3Array.

Gets a const pointer to a Vector3 in a PackedVector3Array.

Gets a pointer to a Vector4 in a PackedVector4Array.

Gets a const pointer to a Vector4 in a PackedVector4Array.

Creates a placeholder script instance for a given script and instance. This interface is optional as a custom placeholder could also be created with script_instance_create().

Updates a placeholder script instance with the given properties and values. The passed in placeholder must be an instance of PlaceHolderScriptInstance such as the one returned by placeholder_script_instance_create().

Logs an error to Godot's built-in debugger and to the OS terminal.

Logs an error with a message to Godot's built-in debugger and to the OS terminal.

Logs a script error to Godot's built-in debugger and to the OS terminal.

Logs a script error with a message to Godot's built-in debugger and to the OS terminal.

Logs a warning to Godot's built-in debugger and to the OS terminal.

Logs a warning with a message to Godot's built-in debugger and to the OS terminal.

Gets the Object from a reference.

Sets the Object referred to by a reference.

Registers callbacks to be called at different phases of the main loop.

Creates a script instance that contains the given info and instance data.

Creates a script instance that contains the given info and instance data.

Creates a script instance that contains the given info and instance data.

Creates a StringName from a Latin-1 encoded C string. If p_is_static is true, then:

• The StringName will reuse the p_contents buffer instead of copying it.
• You must guarantee that the buffer remains valid for the duration of the application (e.g. string literal).
• You must not call a destructor for this StringName. Incrementing the initial reference once should achieve this.

p_is_static is purely an optimization and can easily introduce undefined behavior if used wrong. In case of doubt, set it to false.

Creates a StringName from a UTF-8 encoded C string.

Creates a StringName from a UTF-8 encoded string with a given number of characters.

Creates a String from a Latin-1 encoded C string.

Creates a String from a Latin-1 encoded C string with the given length.

Creates a String from a UTF-16 encoded C string.

Creates a String from a UTF-16 encoded C string with the given length.

Creates a String from a UTF-16 encoded C string with the given length.

Creates a String from a UTF-32 encoded C string.

Creates a String from a UTF-32 encoded C string with the given length.

Creates a String from a UTF-8 encoded C string.

Creates a String from a UTF-8 encoded C string with the given length.

Creates a String from a UTF-8 encoded C string with the given length.

Creates a String from a wide C string.

Creates a String from a wide C string with the given length.

Gets a pointer to the character at the given index from a String.

Gets a const pointer to the character at the given index from a String.

Appends a UTF-32 encoded C string to a String.

Appends a character to a String.

Appends a Latin-1 encoded C string to a String.

Appends another String to a String.

Appends a wide C string to a String.

Resizes the underlying string data to the given number of characters. Space needs to be allocated for the null terminating character ('\0') which also must be added manually, in order for all string functions to work correctly.

Warning: This is an error-prone operation - only use it if there's no other efficient way to accomplish your goal.

Converts a String to a Latin-1 encoded C string. It doesn't write a null terminator.

Converts a String to a UTF-16 encoded C string. It doesn't write a null terminator.

Converts a String to a UTF-32 encoded C string. It doesn't write a null terminator.

Converts a String to a UTF-8 encoded C string. It doesn't write a null terminator.

Converts a String to a wide C string. It doesn't write a null terminator.

Converts a Variant to a boolean.

Calls a method on a Variant.

Calls a static method on a Variant.

Checks if Variants can be converted from one type to another.

Checks if Variant can be converted from one type to another using stricter rules.

Constructs a Variant of the given type, using the first constructor that matches the given arguments.

Destroys a Variant.

Duplicates a Variant.

Evaluate an operator on two Variants.

Gets the value of a key from a Variant.

Gets the value of a constant from the given Variant type.

Gets the value of an index from a Variant.

Gets the value of a keyed property from a Variant.

Gets the value of a named key from a Variant.

Gets the object instance ID from a variant of type GDEXTENSION_VARIANT_TYPE_OBJECT. If the variant isn't of type GDEXTENSION_VARIANT_TYPE_OBJECT, then zero will be returned. 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.

Gets a pointer to a function that can call a builtin method on a type of Variant.

Gets a pointer to a function that can call one of the constructors for a type of Variant.

Gets a pointer to a function than can call the destructor for a type of Variant.

Gets a pointer to a function that can call a member's getter on the given Variant type.

Gets a pointer to a function that can get an index on the given Variant type.

Gets a pointer to a function that can set an index on the given Variant type.

Provides a function pointer for retrieving a pointer to a variant's internal value. 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. It is recommended to cache the getter for all variant types in a function table to avoid retrieval overhead upon use.

Each function assumes the variant's type has already been determined and matches the function. Invoking the function with a variant of a mismatched type has undefined behavior, and may lead to a segmentation fault.

Gets a pointer to a function that can check a key on the given Variant type.

Gets a pointer to a function that can get a key on the given Variant type.

Gets a pointer to a function that can set a key on the given Variant type.

Gets a pointer to a function that can evaluate the given Variant operator on the given Variant types.

Gets a pointer to a function that can call a member's setter on the given Variant type.

Gets a pointer to a function that can call a Variant utility function.

Gets the type of a Variant.

Gets the name of a Variant type.

Checks if a Variant has a key.

Checks if a type of Variant has the given member.

Checks if a Variant has the given method.

Gets the hash of a Variant.

Compares two Variants by their hash.

Gets the next value for an iterator over a Variant.

Initializes an iterator over a Variant.

Gets the next value for an iterator over a Variant.

Copies one Variant into a another.

Creates a new Variant containing nil.

Gets the recursive hash of a Variant.

Sets a key on a Variant to a value.

Sets an index on a Variant to a value.

Sets a keyed property on a Variant to a value.

Sets a named key on a Variant to a value.

Converts a Variant to a string.

Adds a group task to an instance of WorkerThreadPool.

Adds a task to an instance of WorkerThreadPool.

Opens a raw XML buffer on an XMLParser instance.