bevy_ratatui_camera 0.16.0

A bevy plugin for rendering your bevy app to the terminal using ratatui.
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
use bevy::{
    camera::RenderTarget,
    core_pipeline::prepass::{DepthPrepass, NormalPrepass},
    prelude::*,
    render::{
        Render, RenderApp, RenderSystems,
        extract_component::{ExtractComponent, ExtractComponentPlugin},
        renderer::RenderDevice,
    },
};

use crate::{
    RatatuiCamera, RatatuiCameraEdgeDetection, RatatuiCameraSet, RatatuiCameraStrategy,
    RatatuiCameraWidget, RatatuiSubcamera, RatatuiSubcameras,
    camera::{RatatuiCameraDepthDetection, RatatuiCameraLastArea},
    camera_image_pipe::{
        ImageReceiver, ImageSender, create_image_pipe, receive_image, send_image_buffer,
    },
};

pub struct RatatuiCameraReadbackPlugin;

impl Plugin for RatatuiCameraReadbackPlugin {
    fn build(&self, app: &mut App) {
        app.add_plugins((
            ExtractComponentPlugin::<RatatuiCameraSender>::default(),
            ExtractComponentPlugin::<RatatuiDepthSender>::default(),
            ExtractComponentPlugin::<RatatuiSobelSender>::default(),
        ))
        .add_message::<CameraTargetingMessage>()
        .add_observer(handle_ratatui_camera_insert_observer)
        .add_observer(handle_ratatui_subcamera_insert_observer)
        .add_observer(ratatui_depth_readback_insert_observer)
        .add_observer(handle_ratatui_edge_detection_insert_observer)
        .add_observer(handle_ratatui_camera_removal_observer)
        .add_observer(ratatui_depth_readback_removal_observer)
        .add_observer(handle_ratatui_edge_detection_removal_observer)
        .add_observer(resize_ratatui_camera_observer)
        .add_systems(
            First,
            (
                create_ratatui_camera_widgets_system,
                handle_camera_targeting_messages_system,
                (
                    update_ratatui_camera_readback_system,
                    update_ratatui_depth_readback_system,
                    update_ratatui_edge_detection_readback_system,
                    receive_camera_images_system,
                    receive_depth_images_system,
                    receive_sobel_images_system,
                ),
            )
                .chain()
                .in_set(RatatuiCameraSet),
        );

        let render_app = app.sub_app_mut(RenderApp);
        render_app.add_systems(
            Render,
            (
                send_camera_images_system,
                send_depth_images_system,
                send_sobel_images_system,
            )
                .after(RenderSystems::Render),
        );
    }
}

#[derive(Component, ExtractComponent, Deref, DerefMut, Clone, Debug)]
pub struct RatatuiCameraSender(ImageSender);

#[derive(Component, Deref, DerefMut, Debug)]
pub struct RatatuiCameraReceiver(ImageReceiver);

#[derive(Component, ExtractComponent, Deref, DerefMut, Clone, Debug)]
pub struct RatatuiSobelSender(ImageSender);

#[derive(Component, Deref, DerefMut, Debug)]
pub struct RatatuiSobelReceiver(ImageReceiver);

#[derive(Component, ExtractComponent, Deref, DerefMut, Clone, Debug)]
pub struct RatatuiDepthSender(ImageSender);

#[derive(Component, Deref, DerefMut, Debug)]
pub struct RatatuiDepthReceiver(ImageReceiver);

#[derive(Message, Debug)]
pub struct CameraTargetingMessage {
    pub targeter_entity: Entity,
    pub target_entity: Entity,
}

fn handle_ratatui_camera_insert_observer(
    insert: On<Insert, RatatuiCamera>,
    mut commands: Commands,
    ratatui_cameras: Query<&RatatuiCamera>,
    mut camera_targeting_messages: MessageWriter<CameraTargetingMessage>,
    mut image_assets: ResMut<Assets<Image>>,
    render_device: Res<RenderDevice>,
) {
    if let Ok(ratatui_camera) = ratatui_cameras.get(insert.entity) {
        insert_camera_readback_components(
            commands.reborrow(),
            insert.entity,
            &mut image_assets,
            &render_device,
            ratatui_camera,
            &mut camera_targeting_messages,
        );
    }
}

fn handle_ratatui_subcamera_insert_observer(
    insert: On<Insert, RatatuiSubcamera>,
    mut ratatui_subcameras: Query<&RatatuiSubcamera>,
    mut camera_targeting_messages: MessageWriter<CameraTargetingMessage>,
) {
    let RatatuiSubcamera(target_entity) = ratatui_subcameras.get_mut(insert.entity).unwrap();

    camera_targeting_messages.write(CameraTargetingMessage {
        targeter_entity: insert.entity,
        target_entity: *target_entity,
    });
}

fn ratatui_depth_readback_insert_observer(
    insert: On<Insert, RatatuiCameraDepthDetection>,
    mut commands: Commands,
    ratatui_cameras: Query<&RatatuiCamera>,
    mut image_assets: ResMut<Assets<Image>>,
    render_device: Res<RenderDevice>,
) {
    if let Ok(ratatui_camera) = ratatui_cameras.get(insert.entity) {
        insert_camera_depth_readback_components(
            commands.reborrow(),
            insert.entity,
            &mut image_assets,
            &render_device,
            ratatui_camera,
        );
    }
}

fn handle_ratatui_edge_detection_insert_observer(
    insert: On<Insert, RatatuiCameraEdgeDetection>,
    mut commands: Commands,
    ratatui_cameras: Query<&RatatuiCamera>,
    mut image_assets: ResMut<Assets<Image>>,
    render_device: Res<RenderDevice>,
) {
    if let Ok(ratatui_camera) = ratatui_cameras.get(insert.entity) {
        insert_edge_detection_readback_components(
            commands.reborrow(),
            insert.entity,
            &mut image_assets,
            &render_device,
            ratatui_camera,
        );
    }
}

fn handle_ratatui_camera_removal_observer(
    remove: On<Remove, RatatuiCamera>,
    mut commands: Commands,
) {
    let mut entity = commands.entity(remove.entity);
    entity.remove::<(RatatuiCameraSender, RatatuiCameraReceiver)>();
}

fn ratatui_depth_readback_removal_observer(
    remove: On<Remove, RatatuiCameraDepthDetection>,
    mut commands: Commands,
) {
    let mut entity = commands.entity(remove.entity);
    entity.remove::<(RatatuiDepthSender, RatatuiDepthReceiver)>();
}

fn handle_ratatui_edge_detection_removal_observer(
    remove: On<Remove, RatatuiCameraEdgeDetection>,
    mut commands: Commands,
) {
    let mut entity = commands.entity(remove.entity);
    entity.remove::<(RatatuiSobelSender, RatatuiSobelReceiver)>();
}

fn update_ratatui_camera_readback_system(
    mut commands: Commands,
    ratatui_cameras: Query<(Entity, &RatatuiCamera), Changed<RatatuiCamera>>,
    mut camera_targeting_messages: MessageWriter<CameraTargetingMessage>,
    mut image_assets: ResMut<Assets<Image>>,
    render_device: Res<RenderDevice>,
) {
    for (entity, ratatui_camera) in &ratatui_cameras {
        insert_camera_readback_components(
            commands.reborrow(),
            entity,
            &mut image_assets,
            &render_device,
            ratatui_camera,
            &mut camera_targeting_messages,
        );
    }
}

fn update_ratatui_depth_readback_system(
    mut commands: Commands,
    ratatui_cameras: Query<
        (Entity, &RatatuiCamera),
        (With<RatatuiCameraDepthDetection>, Changed<RatatuiCamera>),
    >,
    mut image_assets: ResMut<Assets<Image>>,
    render_device: Res<RenderDevice>,
) {
    for (entity, ratatui_camera) in &ratatui_cameras {
        insert_camera_depth_readback_components(
            commands.reborrow(),
            entity,
            &mut image_assets,
            &render_device,
            ratatui_camera,
        );
    }
}

fn update_ratatui_edge_detection_readback_system(
    mut commands: Commands,
    ratatui_cameras: Query<
        (Entity, &RatatuiCamera),
        (With<RatatuiCameraEdgeDetection>, Changed<RatatuiCamera>),
    >,
    mut image_assets: ResMut<Assets<Image>>,
    render_device: Res<RenderDevice>,
) {
    for (entity, ratatui_camera) in &ratatui_cameras {
        insert_edge_detection_readback_components(
            commands.reborrow(),
            entity,
            &mut image_assets,
            &render_device,
            ratatui_camera,
        );
    }
}

fn send_camera_images_system(
    ratatui_camera_senders: Query<&RatatuiCameraSender>,
    render_device: Res<RenderDevice>,
) {
    for camera_sender in &ratatui_camera_senders {
        send_image_buffer(&render_device, &camera_sender.buffer, &camera_sender.sender);
    }
}

fn send_depth_images_system(
    ratatui_depth_senders: Query<&RatatuiDepthSender>,
    render_device: Res<RenderDevice>,
) {
    for depth_sender in &ratatui_depth_senders {
        send_image_buffer(&render_device, &depth_sender.buffer, &depth_sender.sender);
    }
}

fn send_sobel_images_system(
    ratatui_sobel_senders: Query<&RatatuiSobelSender>,
    render_device: Res<RenderDevice>,
) {
    for sobel_sender in &ratatui_sobel_senders {
        send_image_buffer(&render_device, &sobel_sender.buffer, &sobel_sender.sender);
    }
}

fn receive_camera_images_system(mut camera_receivers: Query<&mut RatatuiCameraReceiver>) {
    for mut camera_receiver in &mut camera_receivers {
        receive_image(&mut camera_receiver);
    }
}

fn receive_depth_images_system(mut depth_receivers: Query<&mut RatatuiDepthReceiver>) {
    for mut depth_receiver in &mut depth_receivers {
        receive_image(&mut depth_receiver);
    }
}

fn receive_sobel_images_system(mut sobel_receivers: Query<&mut RatatuiSobelReceiver>) {
    for mut sobel_receiver in &mut sobel_receivers {
        receive_image(&mut sobel_receiver);
    }
}

fn create_ratatui_camera_widgets_system(
    mut commands: Commands,
    ratatui_cameras: Query<(
        Entity,
        &RatatuiCameraStrategy,
        &RatatuiCameraLastArea,
        Option<&RatatuiCameraEdgeDetection>,
        &RatatuiCameraReceiver,
        Option<&RatatuiDepthReceiver>,
        Option<&RatatuiSobelReceiver>,
    )>,
) {
    for (
        entity_id,
        strategy,
        last_area,
        edge_detection,
        camera_receiver,
        depth_receiver,
        sobel_receiver,
    ) in &ratatui_cameras
    {
        let mut entity = commands.entity(entity_id);

        let camera_image = match camera_receiver.receiver_image.clone().try_into_dynamic() {
            Ok(image) => image,
            Err(e) => panic!("failed to create camera image from buffer {e:?}"),
        };

        let depth_image = depth_receiver.as_ref().map(|image_depth| {
            match image_depth.receiver_image.clone().try_into_dynamic() {
                Ok(image) => image,
                Err(e) => panic!("failed to create depth image from buffer {e:?}"),
            }
        });

        let sobel_image = sobel_receiver.as_ref().map(|image_sobel| {
            match image_sobel.receiver_image.clone().try_into_dynamic() {
                Ok(image) => image,
                Err(e) => panic!("failed to create sobel image buffer {e:?}"),
            }
        });

        let widget = RatatuiCameraWidget {
            entity: entity_id,
            camera_image,
            depth_image,
            sobel_image,
            strategy: strategy.clone(),
            edge_detection: edge_detection.cloned(),
            last_area: **last_area,
            next_last_area: **last_area,
        };

        entity.insert(widget);
    }
}

fn resize_ratatui_camera_observer(
    replace: On<Replace, RatatuiCameraWidget>,
    mut commands: Commands,
    widgets: Query<(&RatatuiCameraWidget, &RatatuiCameraLastArea)>,
    mut ratatui_cameras: Query<&mut RatatuiCamera>,
) -> Result {
    let (widget, last_area) = widgets.get(replace.entity)?;

    commands
        .entity(replace.entity)
        .insert(RatatuiCameraLastArea(widget.next_last_area));

    if last_area.width == widget.next_last_area.width
        && last_area.height == widget.next_last_area.height
    {
        return Ok(());
    }

    if !ratatui_cameras.get(replace.entity)?.autoresize {
        return Ok(());
    }

    let mut ratatui_camera = ratatui_cameras.get_mut(replace.entity)?;
    ratatui_camera.dimensions = UVec2::new(
        (widget.next_last_area.width as u32 * 2).max(1),
        (widget.next_last_area.height as u32 * 4).max(1),
    );

    Ok(())
}

// TODO: When observers can be explicitly ordered, use another observer ordered after the
// RatatuiCamera observers instead.
//
/// Handles camera targeting messages to point cameras at the correct render targets. A message
/// handler is used here instead of observers to make sure that the render target is created after
/// the RatatuiCamera insert/update observers run and so the camera entity definitely already has
/// its RatatuiCameraSender component. Otherwise, for example, if a RatatuiCamera and related
/// RatatuiSubcamera is spawned in a single system run, we could potentially try to update the
/// subcamera's render target before the main camera's render texture is created.
fn handle_camera_targeting_messages_system(
    target_cameras: Query<(&RatatuiCameraSender, Option<&RatatuiSubcameras>), With<RatatuiCamera>>,
    mut cameras: Query<&mut Camera>,
    mut camera_targeting_messages: MessageReader<CameraTargetingMessage>,
) {
    for CameraTargetingMessage {
        targeter_entity,
        target_entity,
    } in camera_targeting_messages.read()
    {
        let (sender, targeting_subcameras) = target_cameras
            .get(*target_entity)
            .expect("CameraTargetingMessage sent with invalid targeting entity");

        let render_target = RenderTarget::from(sender.sender_image.clone());

        if let Some(targeting_subcameras) = targeting_subcameras {
            for targeting_subcamera in targeting_subcameras.iter() {
                if let Ok(mut camera) = cameras.get_mut(targeting_subcamera) {
                    camera.target = render_target.clone()
                }
            }
        }

        let mut camera = cameras
            .get_mut(*targeter_entity)
            .expect("CameraTargetingMessage sent with invalid target entity");

        camera.target = render_target;
    }
}

fn insert_camera_readback_components(
    mut commands: Commands,
    entity: Entity,
    image_assets: &mut Assets<Image>,
    render_device: &RenderDevice,
    ratatui_camera: &RatatuiCamera,
    camera_targeting_messages: &mut MessageWriter<CameraTargetingMessage>,
) {
    let mut entity_commands = commands.entity(entity);

    let (sender, receiver) =
        create_image_pipe(image_assets, render_device, ratatui_camera.dimensions);

    camera_targeting_messages.write(CameraTargetingMessage {
        targeter_entity: entity,
        target_entity: entity,
    });

    entity_commands.insert((RatatuiCameraSender(sender), RatatuiCameraReceiver(receiver)));
}

fn insert_edge_detection_readback_components(
    mut commands: Commands,
    entity: Entity,
    image_assets: &mut Assets<Image>,
    render_device: &RenderDevice,
    ratatui_camera: &RatatuiCamera,
) {
    let mut entity = commands.entity(entity);

    let (sender, receiver) =
        create_image_pipe(image_assets, render_device, ratatui_camera.dimensions);

    entity.insert((
        RatatuiSobelSender(sender),
        RatatuiSobelReceiver(receiver),
        DepthPrepass,
        NormalPrepass,
        Msaa::Off,
    ));
}

fn insert_camera_depth_readback_components(
    mut commands: Commands,
    entity: Entity,
    image_assets: &mut Assets<Image>,
    render_device: &RenderDevice,
    ratatui_camera: &RatatuiCamera,
) {
    let mut entity = commands.entity(entity);

    let (sender, receiver) =
        create_image_pipe(image_assets, render_device, ratatui_camera.dimensions);

    entity.insert((
        RatatuiDepthSender(sender),
        RatatuiDepthReceiver(receiver),
        DepthPrepass,
        Msaa::Off,
    ));
}