Crate godot_ffi

Source

Expand description

§Internal crate of godot-rust

Do not depend on this crate directly, instead use the godot crate. No SemVer or other guarantees are provided.

§Contributor docs

Low level bindings to the provided C core API.

Modules§

conv: Conversions from some rust-types into appropriate Godot types.
linux_reload_workaroundLinux: Linux-specific configuration.
types64-bit

Macros§

ffi_methods: Provides “sys” style methods for FFI and ptrcall integration with Godot. The generated implementations follow one of three patterns:
outNon-debug-log: Trace output.
register_hot_reload_workaround
static_assert: Verifies a condition at compile time.
static_assert_eq_size_align: Verifies at compile time that two types T and U have the same size and alignment.
unsafe_cast_fn_ptr: Extract a function pointer from its Option and convert it to the (dereferenced) target type.

Structs§

Enums§

GlobalLockError: Guard that temporarily gives access to a Global<T>’s inner value.
InitLevel: Stage of the Godot initialization process.
InitStage: Extended initialization stage that includes both initialization levels and the main loop.

Constants§

Traits§

GodotNullableFfi: Types that can represent null-values.
Inner: Metafunction to extract inner function pointer types from all the bindgen Option<F> type names. Needed for unsafe_cast_fn_ptr macro.
SysPtr: Convert a GDExtension pointer type to its uninitialized version.

Functions§

builtin_lifecycle_api^⚠: Safety
builtin_method_table^⚠: Safety
c_str: Returns a C const char* for a null-terminated byte string.
c_str_from_str: Returns a C const char* for a null-terminated string slice. UTF-8 encoded.
class_core_api^⚠: Safety
class_editor_api^⚠: Safety
class_scene_api^⚠: Safety
class_servers_api^⚠: Safety
classdb_construct_object^⚠: Construct Godot object.
config^⚠: Safety
deinitialize^⚠: Deinitializes the library.
discover_main_thread^⚠: Assign the current thread id to be the main thread.
force_mut_ptr: Explicitly cast away const from a pointer, similar to C++ const_cast.
get_interface^⚠: Safety
get_library^⚠: Safety
godot_has_feature^⚠: Safety
hash_value: Returns an ad-hoc hash of any object.
i64_to_ordering
initialize^⚠: Initializes the library.
is_initialized
is_main_thread: Check if the current thread is the main thread.
join
join_debug
join_with
load_class_method_table^⚠: Safety
main_thread_idNon-wasm_nothreads: Get the ThreadId of the main thread.
ptr_then: If ptr is not null, returns Some(mapper(ptr)); otherwise None.
short_type_name: Like std::any::type_name, but returns a short type name without module paths.
short_type_name_of_val: Like std::any::type_name_of_val, but returns a short type name without module paths.
to_const_ptr: Add const to a mut ptr.
unbox: Extract value from box before into_inner() is stable
utility_function_table^⚠: Safety

Type Aliases§

Crate godot_ffi

Crate godot_ffi Copy item path

§Internal crate of godot-rust

§Contributor docs

Modules§

Macros§

Structs§

Enums§

Constants§

Traits§

Functions§

Type Aliases§

Crate godot_ffi