Crate ark_api

💎 Ark API

Also see 🗺️ APIs in Ark Developer Guide

Modules

applet

🍏 Applet API

behavior

📨 Behavior API

behavior_controller

📤 Behavior Controller API

core

🔩 Core API

feature_toggle

🎚 Feature toggle API

file_ux

💾 File UX API

http_request

📡 HTTP Request API

ml

👾 Machine Learning API

ml_inference

🧠 Machine Learning Inference API

module_run

🏃‍♂️ Module Run API

profiler

🚄 Profiler API

render

🖼️ Render API

resource

🧰 Resource API

storage

💽 Storage API

telemetry

📮 Telemetry API

time

⌚ Time API

unstable

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

user

🧑 User API

world

🌐 World API

Macros

dbg

Like std::dbg! but uses info!.

debug

Logs a message at the debug level.

error

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

info

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_feature_toggle_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.

require_ml_api

Macro to require and use the API.

require_ml_inference_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.

setup_profiler

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

trace

Logs a message at the trace level.

warn

Logs a message at the warn level.

Structs

Affine3A

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

BoundingBox

A 3-dimensional axis-aligned bounding box

ColorRgba8

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

Conformal3

Represents a transform with translation + rotation + uniform scale. Preserves local angles. Scale and rotation will be applied first, then translation.

IsoTransform

An isometric transform represented by translation * rotation.

Mat3

A 3x3 column major matrix.

Mat4

A 4x4 column major matrix.

Mesh

Simple mesh representation, layer on to of MeshData

MeshBounds

Bounding box & sphere of mesh.

MeshData

User-friendly mesh buffer contents struct

Plane3

A 3-dimensional plane primitive.

Quat

A quaternion representing an orientation.

Ray3

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

Vec2

A 2-dimensional vector.

Vec3

A 3-dimensional vector.

Vec4

A 4-dimensional vector.

Enums

Error

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

EulerRot

Euler rotation sequences.

Traits

CoordinateSystem

Coordinate system extension to Vec3

Attribute Macros

ark_test

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