Crate ark_api

source · [−]

Expand description

💎 Ark API

Also see 🗺️ APIs in Ark Developer Guide

Modules

🍏 Applet API

📨 Behavior API

behavior_controller

📤 Behavior Controller API

🔩 Core API

💾 File UX API

📡 HTTP Request API

👾 Machine Learning API

🏃‍♂️ Module Run API

🚄 Profiler API

🖼️ Render API

🧰 Resource API

💽 Storage API

📮 Telemetry API

⌚ Time API

🚧 Unstable APIs, may change at any time, does not respect semver nor has stable ABI. Use at own risk.

🧑 User API

🌐 World API

Macros

Like std::dbg! but uses info!.

Logs a message at the debug level.

Logs a message at the error level.

impl_world_accessor

Macro for implementing standard accessor trait

impl_world_accessor_indexed

Macro for implementing standard accessor trait, but with an index parameter.

impl_world_component

Macro for implementing standard component trait

Logs a message at the info level.

require_applet_api

Macro to require and use the API.

require_behavior_api

Macro to require and use the API.

require_behavior_controller_api

Macro to require and use the API.

require_file_ux_api

Macro to require and use the API.

require_http_request_api

Macro to require and use the API.

Macro to require and use the API.

require_module_run_api

Macro to require and use the API.

require_profiler_api

Macro to require and use the API.

require_render_api

Macro to require and use the API.

require_resource_api

Macro to require and use the API.

require_storage_api

Macro to require and use the API.

require_telemetry_api

Macro to require and use the API.

require_time_api

Macro to require and use the API.

require_user_api

Macro to require and use the API.

require_world_api

Macro to require and use the API.

Call at least once from your Module setup code to enable profiling using the puffin profiler.

Logs a message at the trace level.

Logs a message at the warn level.

Structs

A 3D affine transform, which can represent translation, rotation, scaling and shear.

A 3-dimensional axis-aligned bounding box

A compressed sRGBA color, 8-bit per component, 32-bit total.

An isometric transform represented by translation * rotation.

A 3x3 column major matrix.

A 4x4 column major matrix.

Simple mesh representation, layer on to of MeshData

Bounding box & sphere of mesh.

User-friendly mesh buffer contents struct

A 3-dimensional plane primitive.

A quaternion representing an orientation.

A ray in 3-dimensional space: a line through space with a starting point and a direction.

A 2-dimensional vector.

A 3-dimensional vector without SIMD support.

A 4-dimensional vector.

Enums

API error enum, describes how an Ark API call can fail

Euler rotation sequences.

Attribute Macros

Ark’s version of Rust’s #[test] macro