[−][src]Module gdnative::prelude
Curated re-exports of common items.
Modules
core_types | Types that represent core-datatypes of Godot. |
nativescript | Types and functions related to the NativeScript extension of GDNative. |
user_data | Customizable user-data wrappers. |
Macros
godot_dbg | Prints and returns the value of a given expression for quick and dirty debugging, using the engine's logging system (visible in the editor). |
godot_error | Print an error using the engine's logging system (visible in the editor). |
godot_gdnative_init | Declare the API endpoint to initialize the gdnative API on startup. |
godot_gdnative_terminate | Declare the API endpoint invoked during shutdown. |
godot_init | Declare all the API endpoints necessary to initialize a NativeScript library. |
godot_nativescript_init | Declare the API endpoint to initialize nativescript classes on startup. |
godot_print | Print a message using the engine's logging system (visible in the editor). |
godot_warn | Print a warning using the engine's logging system (visible in the editor). |
Structs
Aabb | Axis-aligned bounding box. |
Aether | Special user-data wrapper intended for zero-sized types, that does not perform any
allocation or synchronization at runtime. Does not implement |
ArcData | User-data wrapper encapsulating a |
Basis | A 3x3 matrix. |
Button |
|
CanvasItem |
|
CanvasLayer |
|
ClassBuilder | |
Color | RGBA color with 32 bits floating point components. |
ColorRect |
|
Control |
|
Dictionary | A reference-counted |
ExportInfo | Metadata about the exported property. |
GodotString | Godot's reference-counted string type. |
Image |
|
InitHandle | A handle that can register new classes to the engine during initialization. |
Input |
|
InputEvent |
|
InputEventKey |
|
Instance | A persistent reference to a GodotObject with a rust NativeClass attached. |
KinematicBody |
|
KinematicBody2D |
|
Label |
|
LocalCellData | User-data wrapper analogous to a |
ManuallyManaged | Marker that indicates that a type is manually managed. |
MutexData | User-data wrapper encapsulating a |
Node |
|
Node2D |
|
NodePath | A reference-counted relative or absolute path in a scene tree, for use with |
Null | Represents an explicit null reference in method arguments. This works around type inference
issues with |
Object | The base class of most Godot classes. |
PackedScene |
|
Plane | Plane in hessian form. |
PropertyUsage | |
Ref | A polymorphic smart pointer for Godot objects whose behavior changes depending on the memory management method of the underlying type and the thread access status. |
RefCounted | Marker that indicates that a type is reference-counted. |
RefInstance | A reference to a GodotObject with a rust NativeClass attached that is assumed safe during a certain lifetime. |
Reference | Base class of all reference-counted types. Inherits |
ResourceLoader |
|
Rid | The RID type is used to access the unique integer ID of a resource. They are opaque, so they do not grant access to the associated resource by themselves. |
RwLockData | User-data wrapper encapsulating a |
SceneTree |
|
Shader |
|
Shared | Marker that indicates that a value currently might be shared in the same or over multiple threads. |
Signal | |
SignalArgument | |
Spatial |
|
Sprite |
|
StringName | |
TRef | A temporary safe pointer to Godot objects that tracks thread access status. |
Texture |
|
ThreadLocal | Marker that indicates that a value can currently only be shared in the same thread. |
Timer |
|
Transform | 3D Transformation (3x4 matrix) Using basis + origin representation. |
Tween |
|
TypedArray | A reference-counted CoW typed vector using Godot's pool allocator, generic over possible element types. |
Unique | Marker that indicates that a value currently only has a single unique reference. |
Variant | A |
VariantArray | A reference-counted |
Viewport |
|
Enums
FromVariantError | Error type returned by |
GodotError | Error codes used in various Godot APIs. |
VariantOperator | Godot variant operator kind. |
VariantType |
Traits
AsArg | Trait for safe conversion from Godot object references into API method arguments. This is a sealed trait with no public interface. |
FromVariant | Types that can be converted from a |
GodotObject | Trait for Godot API objects. This trait is sealed, and implemented for generated wrapper types. |
Instanciable | GodotObjects that have a zero argument constructor. |
NativeClass | Trait used for describing and initializing a Godot script class. |
NativeClassMethods | Trait used to provide information of Godot-exposed methods of a script class. |
NewRef | A trait for incrementing the reference count to a Godot object. |
OwnedToVariant | Types that can only be safely converted to a |
QueueFree | Manually managed Godot classes implementing |
SubClass | Marker trait for API types that are subclasses of another type. This trait is implemented by the bindings generator, and has no public interface. Users should not attempt to implement this trait. |
ToVariant | Types that can be converted to a |
ToVariantEq | Trait for types whose |
Vector2Godot | Helper methods for |
Vector3Godot | Helper methods for |
Type Definitions
Angle | |
ByteArray | A reference-counted vector of |
ColorArray | A reference-counted vector of |
Float32Array | A reference-counted vector of |
Int32Array | A reference-counted vector of |
Point2 | |
Point3 | |
Quat | |
Rect2 | |
Rotation2D | |
Rotation3D | |
Size2 | |
StringArray | A reference-counted vector of |
Transform2D | |
Vector2 | |
Vector2Array | A reference-counted vector of |
Vector3 | |
Vector3Array | A reference-counted vector of |
Attribute Macros
methods | |
profiled | Makes a function profiled in Godot's built-in profiler. This macro automatically creates a tag using the name of the current module and the function by default. |
Derive Macros
FromVariant | |
NativeClass | |
OwnedToVariant | |
ToVariant |