fluid_core 0.1.0

GPU-accelerated fluid simulation core library (wgpu, no winit dependency)
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
65
66
67
68
69
70
71
72
73

# fluid_core API Notes


This file provides a quick API map for crates.io users.

## Core Types


- `FluidEngine`: engine lifecycle and rendering
- `FluidConfig`: all runtime parameters (physics + post-processing)
- `InputManager`: pointer and programmatic splat input
- `RenderContext`: immutable GPU context snapshot for UI upload steps

## Engine Lifecycle


```rust
pub async fn new<W>(
    window: W,
    width: u32,
    height: u32,
    config: &FluidConfig,
) -> FluidEngine<'_>
where
    W: raw_window_handle::HasWindowHandle
      + raw_window_handle::HasDisplayHandle
      + Send
      + Sync
```

Typical frame loop:

1. Feed input into `engine.input.*`
2. Call `engine.update(dt)`
3. Call `engine.render()` or `engine.render_with_ui_split(...)`

## Input API


- `pointer_down(id, x, y, color)`
- `pointer_move(id, x, y)`
- `pointer_up(id)`
- `inject(x, y, dx, dy, color)`
- `burst(count)`

Coordinates use normalized range `[0, 1]`.

## Config API


- `config() -> &FluidConfig`
- `config_mut() -> &mut FluidConfig`
- `set_config(config)`

Important: if resolution-related fields are changed, use `set_config(...)` so GPU textures are rebuilt.

## Rendering API


- `render() -> Result<(), wgpu::SurfaceError>`
- `render_with_ui(...)`
- `render_with_ui_split(...)`
- `resize(width, height)`

## Helper Query API


- `size()`
- `device()`
- `queue()`
- `surface_format()`
- `render_context()`

## Default Reset


`reset_to_js_defaults()` restores parameter values aligned with the original WebGL defaults.

## Full Documentation


For the complete API guide used in this repository, see the top-level `api.md` in the source repository.