Expand description
euv-engine
A high-performance 2D and 3D game engine built on the euv framework for WebAssembly, featuring an ECS-style entity system, fixed-timestep game loop, canvas rendering, WebGPU rendering, physics simulation, collision detection, sprite animation, scene management, asset loading, and Web Audio integration.
Modules§
- self
- Utilities for formatting and printing
Strings. - self
- Basic functions for dealing with memory, values, and types.
Structs§
- AABB3D
- A 3D axis-aligned bounding box defined by its minimum and maximum corners.
- Aabb
Collider - An axis-aligned bounding box collider wrapping a
Rect. - Aabb
Collider3D - A 3D axis-aligned bounding box collider wrapping an
AABB3D. - Animator
- Manages the playback state of sprite animations.
- Asset
Cache - A cache for storing loaded game assets, keyed by URL.
- Asset
Closure Store - The backing store behind
AssetClosures. - Asset
Entry - An entry in the asset cache containing the loaded data and its state.
- Asset
Loader - An asynchronous asset loader that fetches resources over HTTP
and populates a shared
AssetCache. - Atlas
Regions - The name-to-rectangle index of a sprite atlas, without the image handle.
- Audio
Clip - An audio clip wrapping a decoded
AudioBufferwith playback control. - Bind
Group Layout Entry - A single entry inside a
GpuBindGroupLayoutDescriptor. - Camera2D
- A 2D camera that defines the viewport into the game world.
- Camera3D
- A 3D camera that defines the viewport into a 3D world using perspective or orthographic projection.
- Canvas
Renderer - A wrapper around
CanvasRenderingContext2dproviding convenience drawing methods and camera management for the game engine. - Circle
- A circle defined by its center point and radius.
- Circle
Collider - A circle collider wrapping a
Circle. - Collision
Result - The result of a collision check between two colliders, containing the contact normal and penetration depth if they overlap.
- Collision
Result3D - The result of a collision check between two 3D colliders, containing the contact normal and penetration depth if they overlap.
- Color
- A color represented by red, green, blue, and alpha channels in the range 0.0 to 1.0.
- Draw
List - An ordered buffer of deferred draw commands recorded during a frame.
- Engine
- A zero-sized namespace struct providing static engine entry points.
- Engine
Cell - A
Syncwrapper holding a single value of typeT. - Engine
Config - The top-level engine configuration containing rendering and scheduler settings.
- Engine
Handle - A handle to a running or initialized engine instance.
- Entity
- The fundamental entity in the engine, combining a transform with a collection of behavior-defining components.
- Event
Bus - A publish-subscribe event bus for decoupled inter-entity communication.
- Formatter
- Configuration for formatting.
- Game
Audio Context - A wrapper around the Web Audio API
AudioContextproviding game engine audio playback and volume management. - Gamepad
Manager - Owns the state of every gamepad the page has seen and drives the per-frame poll.
- Gamepad
State - Per-frame and steady-state data for a single gamepad index.
- GpuSampler
Descriptor - A sampler descriptor for
create_sampler. - Hit
- The result of a ray-object intersection.
- Input
- A zero-sized namespace struct providing static input event extraction methods.
- Input
State - Tracks the current state of all input devices (keyboard, mouse, touch) for a single game frame. The state should be updated by event handlers and cleared of per-frame data at the end of each frame.
- Lazy
Lock - A value which is initialized on the first access.
- Light
- A light source contributing illumination to a shaded point.
- Lighting
Uniforms - Bundles of uniforms supplied to lighting and shading routines.
- Linear
Gradient - A linear gradient defined by two endpoints and a list of color stops.
- Material
- A material describing how a surface responds to illumination.
- Matrix4x4
- A 4x4 matrix stored in column-major order, used for 3D transformations.
- Maybe
Engine Cell - A
Syncwrapper that may or may not contain a value. - Nine
Slice - A source image paired with the insets that split it into nine patches.
- Nine
Slice Insets - The four per-edge border insets that carve an image into nine patches.
- Nine
Slice Rects - The nine source or destination sub-rectangles produced by a nine-slice split.
- Numeric
- A zero-sized namespace struct providing static math utility methods.
- Occluder
- A ray-traceable geometric surface with an attached material.
- Particle
- A single live particle.
- Particle
Config - The static configuration of a particle emitter, describing how new particles are spawned and how they evolve over their lifetime.
- Particle
Emitter - A point emitter that continuously (or in bursts) spawns particles,
integrates their motion, and records them into a
DrawListas colored circles whose color and size interpolate over each particle’s lifetime. - Particle
Rng - A deterministic xorshift64* pseudo-random generator used by particle emitters.
- Pending
Error Cell - Interior-mutable slot for the renderer’s pending error-scope value.
- Physics
Config - Configuration parameters for the physics world simulation.
- Physics
Config3D - Configuration parameters for the 3D physics world simulation.
- Physics
World2D - The physics world managing all rigid bodies and simulation steps.
- Physics
World3D - The 3D physics world managing all rigid bodies and simulation steps.
- Plane
- A 3D plane defined by a normal vector and a distance from the origin.
- Quad
Tree2D - A 2D quadtree broad-phase acceleration structure, interface-compatible
with
SpatialHashGrid2D. - Quad
Tree Entry2D - One inserted body inside a 2D quadtree, stored with its exact world-space axis-aligned bounding box.
- Quad
Tree Node2D - One node of the 2D quadtree, holding an axis-aligned region plus the entries that could not be pushed further down.
- Quaternion
- A quaternion representing a 3D rotation with
x,y,z, andwcomponents. - Radial
Gradient - A radial gradient defined by inner and outer circles and a list of color stops.
- Ray
- A 3D ray carrying the parameters needed for traversal and depth tracking.
- Ray2D
- A 2D ray defined by an origin point and a direction vector, used for
raycasting against 2D shapes (
Rect,Circle). - Ray3D
- A 3D ray defined by an origin point and a direction vector.
- RayTrace
Scene - An owned ray-tracing scene with precomputed shadow data.
- Ready
- A future that is immediately ready with a value.
- Rect
- An axis-aligned rectangle defined by its top-left corner and dimensions.
- Render
Config - Rendering configuration controlling the backend type, canvas target, viewport dimensions, quality, and backend-specific options.
- Render
Layer - Represents the rendering priority layer for draw call ordering.
- Render
Pass Color Attachment - The descriptor for a single (color or depth-stencil) render pass
attachment, used as input to
begin_render_pass/begin_render_pass_to_texture. - Render
Pass Depth Stencil Attachment - The depth-stencil portion of a
RenderPassDescriptor, used as input tobegin_render_pass/begin_render_pass_to_texture. - Render
Pass Descriptor Cache - OPT 34: persistent render-pass descriptor and its inner
attachments, reused across
begin_render_pass_fullcalls. - Rigid
Body2D - A 2D rigid body participating in the physics simulation.
- Rigid
Body3D - A 3D rigid body participating in the physics simulation.
- Scene
Manager - Manages scene registration, transitions, and lifecycle.
- Scheduler
Config - Configuration parameters for the fixed-timestep scheduler.
- Scheduler
Handle - A handle to a running scheduler, allowing the caller to stop it later.
- Scheduler
State - The runtime state of a scheduler instance.
- Shadow
Config - Shadow rendering configuration for drop shadow effects on canvas primitives.
- Spatial
Hash Grid2D - A uniform-grid spatial hash for broad-phase collision culling in 2D.
- Spatial
Hash Grid3D - A uniform-grid spatial hash for broad-phase collision culling in 3D.
- Sphere
- A 3D sphere defined by its center point and radius.
- Sphere
Collider3D - A 3D sphere collider wrapping a
Sphere. - Sprite
Animation - A named sequence of frames that form an animation.
- Sprite
Atlas - A named collection of sprite regions packed into one shared image.
- Sprite
Frame - Defines a single frame in a sprite animation.
- Sprite
Sheet - Defines a sprite sheet with uniform frame grid dimensions.
- Ssaa
Canvas - A supersampling anti-aliasing (SSAA) canvas wrapper that renders at a higher resolution on an offscreen canvas and downscales to the display canvas for smoother polygon edges in software-rendered 3D scenes.
- Task
Handle - A handle to a task registered with a
TaskRegistry. - Task
Registry - A registry of
Updatabletasks driven by the fixed-timestep scheduler. - Texture2D
Descriptor - A 2D texture descriptor for
create_texture_2d. - Texture
View Descriptor - Descriptor for
GpuTexture.createView(descriptor). - Texture
Write Descriptor - Descriptor for
queue.writeTexture(destination, data, dataLayout, size). - Timer
- A countdown timer that fires after a fixed duration, optionally repeating.
- Transform2D
- A 2D transform composed of position, rotation (in radians), and scale.
- Transform3D
- A 3D transform composed of position, rotation (as a quaternion), and scale.
- Tween
- A generic tween interpolating a value of type
Tfrom a start to an end value over a fixed duration, driven by anEasingcurve. - UvRect
- Normalized texture coordinates for one sub-rectangle of an atlas image.
- Vector2D
- A 2D vector with
xandycomponents represented asf64. - Vector3D
- A 3D vector with
x,y, andzcomponents represented asf64. - Vertex
Attribute - A single vertex attribute within a vertex buffer layout.
- Vertex
Buffer Layout - The layout of a single vertex buffer, expressed as an array stride plus a list of attributes.
- Viewport
Descriptor - Describes a 2D viewport rectangle plus optional depth range, in the same pixel space as the destination render target.
- WebGl
Renderer - A WebGL 2 rendering backend wrapping the
WebGl2RenderingContext. - WebGpu
Renderer - A WebGPU rendering backend wrapping the GPU device, queue, and canvas context for GPU-accelerated rendering on the web.
Enums§
- Animation
Mode - Defines how an animation behaves when it reaches the last frame.
- Animation
State - Represents the current playback state of an animation.
- Asset
State - Represents the loading state of an asset in the cache.
- Asset
Type - Categorizes the type of a game asset for appropriate loading and storage.
- Audio
Play State - Represents the playback state of an audio clip.
- Bind
Group Entry - A single binding entry inside a
BindGroupDescriptor. - Bind
Group Entry Type - The resource kind bound at a single slot of a
BindGroupLayoutEntry. - Blend
Mode - Defines how new pixels are composited with existing pixels on the canvas.
- Body
Collider - Wraps the concrete collider shape data attached to a rigid body.
- Body
Collider3D - Wraps the concrete 3D collider shape data attached to a 3D rigid body.
- Body
Type - Defines how a rigid body participates in the physics simulation.
- Collider
Shape - Represents the geometric shape of a collider.
- Collider
Shape3D - Represents the geometric shape of a 3D collider.
- Draw
Command - A single deferred draw operation recorded into a
DrawList. - Easing
- The complete set of Robert Penner easing functions used to warp a linear interpolation parameter into an accelerated / decelerated curve.
- Entity
Event - Events that can be emitted by entities for inter-entity communication.
- GpuPower
Preference - The power preference hint passed to
navigator.gpu.requestAdapter. - GpuReceiver
Class - WebGPU receiver-class discriminator for the
cached_methodcache. - Input
Action - Represents a high-level input action category.
- Light
Type - Describes the kind of light source being represented.
- Material
Kind - Describes the shading model applied to a
Materialduring lighting and ray-tracing evaluation. - Mouse
Button - Represents a standard mouse button identifier.
- Occluder
Kind - Identifies the geometric shape of a ray-tracing
Occluder. - Render
Backend Type - The rendering backend type used by the engine.
- Render
Quality - Rendering quality preset controlling anti-aliasing smoothing strategy.
- Tween
State - The playback state of a
Tween. - Vertex
Step Mode - Whether a vertex buffer is consumed per-vertex or per-instance.
- WebGl
Init Error - Errors that can occur while initializing a
WebGlRenderer. - WebGl
Program Error - Errors that can occur while building a WebGL shader program.
- WebGpu
Init Error - Errors that can occur while asynchronously initializing a
WebGpuRenderer.
Constants§
- DEFAULT_
ANGULAR_ DAMPING - The default angular damping coefficient applied per second.
- DEFAULT_
CAMERA_ FAR - The default far clipping plane distance for a 3D perspective camera.
- DEFAULT_
CAMERA_ FOV - The default vertical field of view in radians for a 3D perspective camera (~60 degrees).
- DEFAULT_
CAMERA_ NEAR - The default near clipping plane distance for a 3D perspective camera.
- DEFAULT_
FIXED_ TIMESTEP - The fixed timestep duration in seconds for the game loop (60 FPS).
- DEFAULT_
FRICTION - The default friction coefficient for rigid body surface contact.
- DEFAULT_
GRAVITY - The default gravity acceleration in pixels per second squared.
- DEFAULT_
GRAVITY_ 3D - The default 3D gravity acceleration in meters per second squared (pointing down on the y axis).
- DEFAULT_
LINEAR_ DAMPING - The default linear damping coefficient applied per second.
- DEFAULT_
MAX_ FRAME_ TIME - The maximum accumulated time in seconds before the game loop drops frames.
- DEFAULT_
RESTITUTION - The default restitution (bounciness) for rigid body collisions.
- DEG_
TO_ RAD - Conversion factor from degrees to radians.
- EPSILON
- A small epsilon value used for floating-point comparisons.
- FRAC_
PI_ 2 - π/2
- HALF_PI
- Half of pi, a quarter circle angle in radians (~1.57079).
- LIGHTING_
PBR_ ENERGY_ CONSERVATION - The baseline reflectance weight applied to the
MaterialKind::Pbrdiffuse term before the Schlick fresnel factor is applied. - PI
- Archimedes’ constant (π)
- RAD_
TO_ DEG - Conversion factor from radians to degrees.
- TAU
- The full circle constant (τ)
- TWO_PI
- Two times pi, the full circle angle in radians (~6.28318).
Traits§
- Collider
- A trait for objects that can participate in collision detection.
- Collider3D
- A trait for 3D objects that can participate in collision detection.
- Component
- The base trait for all entity components.
- Debug
?formatting.- Display
- Format trait for an empty format,
{}. - Error
Erroris a trait representing the basic expectations for error values, i.e., values of typeEinResult<T, E>.- Future
- A future represents an asynchronous computation, commonly obtained by use of
async. - Interpolable
- A trait for types that support linear interpolation between two values.
- Lifecycle
- The common lifecycle stage shared by
ComponentandScene. - Render
Backend - An abstract rendering backend that decouples draw calls from the concrete canvas API, enabling future backends such as WebGL or WebGPU.
- Renderable
- A trait for objects that can record themselves into a draw list.
- Scene
- The base trait for all game scenes.
- Tick
Handler - The trait that game implementations must fulfill to receive fixed-timestep update and interpolated render callbacks from the scheduler.
- Updatable
- A trait for objects that participate in the engine’s update step.
- Vector
- A trait abstracting the operations common to
Vector2DandVector3D. - Write
- A trait for writing or formatting into Unicode-accepting buffers or streams.
Functions§
- apply_
axis_ deadzone - Applies the analog deadzone to a single raw axis reading.
- apply_
falloff - Applies the inverse-square falloff formula
1.0 / (1.0 + falloff * d²), clamped to a non-negative result. - apply_
schlick_ fresnel - Computes a Schlick fresnel factor for the
MaterialKind::Pbrbranch ofLightingUniforms::shade. - compute_
held_ buttons - Folds one frame of raw gamepad readings into the per-pad edge sets.
- compute_
lambert - Computes the Lambertian (diffuse) contribution of a single light at a shaded surface point.
- compute_
phong - Computes the Blinn-Phong specular contribution of a single light.
- compute_
pressed_ buttons - Folds one frame of raw gamepad readings into the per-pad edge sets.
- compute_
released_ buttons - Folds one frame of raw gamepad readings into the per-pad edge sets.
- intersect_
triangle - Intersects a ray with the triangle
v0,v1,v2using the Moller-Trumbore algorithm. - is_
button_ down - Tests whether one raw button pressure counts as the button being down.
- mark_
asset_ closure_ settled - Marks the asset load callback occupying
slotas having run. - ray_
aabb_ intersect - Intersects a ray with an axis-aligned bounding box using the slab method.
- ray_
sphere_ intersect - Intersects a ray with a sphere centered at
centerwith radiusradius. - read_
raw_ axis - Reads the nth analog axis out of a raw axis reading list.
- ready
- Creates a future that is immediately ready with a value.
- replace
- Moves
srcinto the referenceddest, returning the previousdestvalue. - soft_
shadow_ factor - Computes a soft-shadow visibility factor in the range 0.0..=1.0.
Type Aliases§
- Asset
Closures - A reference-counted, shared-mutable store of asset load callbacks.
- Asset
Pending - A shared counter of loads that have been requested but not yet settled.
- Cell
Entries - A list of body indices stored within a single grid cell.
- Cell
Key2D - A grid cell key for 2D spatial partitioning, combining x and y indices.
- Cell
Key3D - A grid cell key for 3D spatial partitioning, combining x, y, and z indices.
- Component
Rc - A reference-counted, shared-mutable handle to a
dyn Componenttrait object. - Entity
Rc - A reference-counted, shared-mutable handle to an
Entity. - Event
Handler - A handler function that processes an
EntityEvent. - Event
Handlers - A handler function that processes an
EntityEvent. - Gamepad
Button Set - A set of gamepad button indices in a single frame edge state.
- Gamepad
Index Set - A set of gamepad indices in a single frame edge state.
- Gamepad
Manager Cell - A shared, single-threaded cell holding a
GamepadManager. - Gamepad
State Map - The states of every gamepad the manager has ever observed, keyed by the browser-assigned gamepad index.
- Input
State Cell - A shared, single-threaded cell holding the engine’s
InputState. - KeyState
Set - A set of keyboard key code strings currently in a given state.
- Quad
Tree Children2D - The four child node handles of a subdivided 2D quadtree node, ordered low-x/low-y, high-x/low-y, low-x/high-y, high-x/high-y.
- Quad
Tree Entry List2D - The list of body entries stored directly inside one 2D quadtree node.
- Quad
Tree Node List2D - The flat node arena backing a 2D quadtree, addressed by node handle.
- Quad
Tree Node Stack2D - The explicit traversal stack used by 2D quadtree queries, so no recursion
is needed and no
Box-linked child borrows are required. - RafClosure
Cell - A reference-counted
requestAnimationFrameclosure cell. - SceneRc
- A reference-counted, shared-mutable scene trait object.
- Spatial
Cell Map2D - A hash map from 2D cell keys to lists of body indices.
- Spatial
Cell Map3D - A hash map from 3D cell keys to lists of body indices.
- Task
Registry Rc - A reference-counted shared-mutable
TaskRegistry. - Tick
Handler Rc - A reference-counted shared-mutable container for a
dyn TickHandler. - Touch
Point Map - A map from touch identifier to touch position.
Derive Macros§
- Debug
- Derive macro generating an impl of the trait
Debug.