This crate contains high-level wrappers around the core types of Godot Engine's GDNative API, and the NativeScript feature which enables Rust code to be used as scripts.
Wrappers for most core types expose safe Rust interfaces, and it's unnecessary to mind
memory management most of the times. The exceptions are
internally reference-counted collections with "interior mutability" in Rust parlance. These
types are modelled using the "typestate" pattern to enforce that the official
thread-safety guidelines. For more information, read the type-level
documentation for these types.
Since it is easy to expect containers and other types to allocate a copy of their
content when using the
Clone trait, some types do not implement
Clone and instead
NewRef which provides a
new_ref(&self) -> Self method
to create references to the same collection or object.
Types that represent core-datatypes of Godot.
Types and functions related to the NativeScript extension of GDNative.
Marker types to express the memory management method of Godot types.
Typestates to express thread safety of Godot types.
Prints and returns the value of a given expression for quick and dirty debugging, using the engine's logging system (visible in the editor).
Print an error using the engine's logging system (visible in the editor).
Declare the API endpoint to initialize the gdnative API on startup.
Declare the API endpoint invoked during shutdown.
Declare all the API endpoints necessary to initialize a NativeScript library.
Declare the API endpoint to initialize nativescript classes on startup.
Print a message using the engine's logging system (visible in the editor).
Print a warning using the engine's logging system (visible in the editor).
Convenience macro to wrap an object's method into a function pointer that can be passed to the engine when registering a class.
Convenience macro to create a profiling signature with a given tag.
A trait for incrementing the reference count to a Godot object.