godot/doc/classes/GDExtension.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GDExtension" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A native library for GDExtension.
	</brief_description>
	<description>
		The [GDExtension] resource type represents a [url=https://en.wikipedia.org/wiki/Shared_library]shared library[/url] which can expand the functionality of the engine. The [GDExtensionManager] singleton is responsible for loading, reloading, and unloading [GDExtension] resources.
		[b]Note:[/b] GDExtension itself is not a scripting language and has no relation to [GDScript] resources.
	</description>
	<tutorials>
		<link title="GDExtension overview">$DOCS_URL/tutorials/scripting/gdextension/what_is_gdextension.html</link>
		<link title="GDExtension example in C++">$DOCS_URL/tutorials/scripting/gdextension/gdextension_cpp_example.html</link>
	</tutorials>
	<methods>
		<method name="get_minimum_library_initialization_level" qualifiers="const">
			<return type="int" enum="GDExtension.InitializationLevel" />
			<description>
				Returns the lowest level required for this extension to be properly initialized (see the [enum InitializationLevel] enum).
			</description>
		</method>
		<method name="is_library_open" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if this extension's library has been opened.
			</description>
		</method>
	</methods>
	<constants>
		<constant name="INITIALIZATION_LEVEL_CORE" value="0" enum="InitializationLevel">
			The library is initialized at the same time as the core features of the engine.
		</constant>
		<constant name="INITIALIZATION_LEVEL_SERVERS" value="1" enum="InitializationLevel">
			The library is initialized at the same time as the engine's servers (such as [RenderingServer] or [PhysicsServer3D]).
		</constant>
		<constant name="INITIALIZATION_LEVEL_SCENE" value="2" enum="InitializationLevel">
			The library is initialized at the same time as the engine's scene-related classes.
		</constant>
		<constant name="INITIALIZATION_LEVEL_EDITOR" value="3" enum="InitializationLevel">
			The library is initialized at the same time as the engine's editor classes. Only happens when loading the GDExtension in the editor.
		</constant>
	</constants>
</class>
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 16:08:05 +08:00			`<class name="GDExtension" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`<brief_description>`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`A native library for GDExtension.`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</brief_description>`
			`<description>`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`The [GDExtension] resource type represents a [url=https://en.wikipedia.org/wiki/Shared_library]shared library[/url] which can expand the functionality of the engine. The [GDExtensionManager] singleton is responsible for loading, reloading, and unloading [GDExtension] resources.`
			`[b]Note:[/b] GDExtension itself is not a scripting language and has no relation to [GDScript] resources.`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</description>`
			`<tutorials>`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`<link title="GDExtension overview">$DOCS_URL/tutorials/scripting/gdextension/what_is_gdextension.html</link>`
			`<link title="GDExtension example in C++">$DOCS_URL/tutorials/scripting/gdextension/gdextension_cpp_example.html</link>`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</tutorials>`
			`<methods>`
			`<method name="get_minimum_library_initialization_level" qualifiers="const">`
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface 2022-12-07 19:11:28 +08:00			`<return type="int" enum="GDExtension.InitializationLevel" />`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`<description>`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`Returns the lowest level required for this extension to be properly initialized (see the [enum InitializationLevel] enum).`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</description>`
			`</method>`
			`<method name="is_library_open" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="bool" />`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`<description>`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`Returns [code]true[/code] if this extension's library has been opened.`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</description>`
			`</method>`
			`</methods>`
			`<constants>`
			`<constant name="INITIALIZATION_LEVEL_CORE" value="0" enum="InitializationLevel">`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`The library is initialized at the same time as the core features of the engine.`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</constant>`
			`<constant name="INITIALIZATION_LEVEL_SERVERS" value="1" enum="InitializationLevel">`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`The library is initialized at the same time as the engine's servers (such as [RenderingServer] or [PhysicsServer3D]).`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</constant>`
			`<constant name="INITIALIZATION_LEVEL_SCENE" value="2" enum="InitializationLevel">`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`The library is initialized at the same time as the engine's scene-related classes.`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</constant>`
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed). 2022-05-03 17:56:08 +08:00			`<constant name="INITIALIZATION_LEVEL_EDITOR" value="3" enum="InitializationLevel">`
Add documentation for GDExtension & GDExtensionManager 2024-01-08 22:44:06 +08:00			`The library is initialized at the same time as the engine's editor classes. Only happens when loading the GDExtension in the editor.`
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h 2021-06-19 23:58:49 +08:00			`</constant>`
			`</constants>`
			`</class>`