gdnative-core 0.11.3

The Godot game engine's gdnative core bindings.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! # Rust bindings for the Godot game engine
//!
//! 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.
//!
//! ## Memory management for core types
//!
//! Wrappers for most core types expose safe Rust interfaces, and it's unnecessary to mind
//! memory management most of the times. The exceptions are `VariantArray` and `Dictionary`,
//! 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][thread-safety]. 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
//! implement [`NewRef`](object::NewRef) which provides a `new_ref(&self) -> Self` method
//! to create references to the same collection or object.
//!
//! [thread-safety]: https://docs.godotengine.org/en/stable/tutorials/threads/thread_safe_apis.html

#![deny(clippy::missing_inline_in_public_items)]
#![allow(
    clippy::transmute_ptr_to_ptr,
    clippy::missing_safety_doc,
    clippy::non_send_fields_in_send_ty
)]
#![cfg_attr(
    any(test, feature = "gd-test"),
    allow(clippy::excessive_precision, clippy::disallowed_names)
)]

#[doc(hidden)]
pub extern crate gdnative_sys as sys;

#[doc(hidden)]
pub extern crate libc;

#[cfg(feature = "gd-test")]
#[macro_use]
extern crate approx;

#[doc(inline)]
pub use gdnative_derive::godot_wrap_method;

/// Derive macros and macro attributes.
#[doc(inline)]
pub use gdnative_derive as derive;

// Macros have to be processed before they are used.
mod macros;

pub mod core_types;

pub mod export;
pub mod globalscope;
pub mod init;
pub mod log;
pub mod object;
pub mod profiler;

/// Internal low-level API for use by macros and generated bindings. Not a part of the public API.
#[doc(hidden)]
pub mod private;