Repository navigation
Expand file tree
/
Copy pathpy_rendering.cpp
More file actions
1989 lines (1806 loc) · 94.1 KB
/
Copy pathpy_rendering.cpp
File metadata and controls
1989 lines (1806 loc) · 94.1 KB
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* SPDX-FileCopyrightText: 2025 LichtFeld Studio Authors
* SPDX-License-Identifier: GPL-3.0-or-later */
#include "py_rendering.hpp"
#include "core/checkpoint_format.hpp"
#include "core/image_io.hpp"
#include "core/logger.hpp"
#include "core/mesh_data.hpp"
#include "core/native_fs.hpp"
#include "core/path_utils.hpp"
#include "core/point_cloud.hpp"
#include "core/property_defaults.hpp"
#include "core/property_registry.hpp"
#include "core/provenance.hpp"
#include "core/scene.hpp"
#include "core/splat_data.hpp"
#include "core/splat_data_transform.hpp"
#include "core/tensor.hpp"
#include "io/loader.hpp"
#include "py_error.hpp"
#include "py_scene.hpp"
#include "python/python_runtime.hpp"
#include "rendering/coordinate_conventions.hpp"
#include "rendering/image_layout.hpp"
#include "rendering/render_constants.hpp"
#include "rendering/rendering.hpp"
#include "scene/scene_render_state.hpp"
#include "visualizer/internal/viewport.hpp"
#include "visualizer/ipc/render_settings_convert.hpp"
#include "visualizer/ipc/view_context.hpp"
#include "visualizer/post_work_utils.hpp"
#include "visualizer/rendering/rendering_manager.hpp"
#include "visualizer/rendering/viewport_appearance_correction.hpp"
#include "visualizer/visualizer.hpp"
#include <algorithm>
#include <array>
#include <cassert>
#include <cctype>
#include <cmath>
#include <cstdint>
#include <cstring>
#include <expected>
#include <filesystem>
#include <functional>
#include <numbers>
#include <optional>
#include <variant>
#include <glm/glm.hpp>
namespace nb = nanobind;
namespace lfs::python {
namespace {
constexpr std::uintmax_t MAX_RENDERED_ASSET_PREVIEW_BYTES =
2ull * 1024ull * 1024ull * 1024ull;
enum class PreviewReadback {
FloatRgb,
UInt8Rgb,
};
[[nodiscard]] std::optional<core::Tensor> viewportRenderImageHwc(
const std::optional<vis::ViewportRender>& render,
const bool clone_for_async) {
if (!render || !render->image)
return std::nullopt;
auto image = clone_for_async ? render->image->clone() : *render->image;
const auto layout = rendering::detectImageLayout(image);
if (layout == rendering::ImageLayout::Unknown)
return std::nullopt;
if (layout == rendering::ImageLayout::CHW) {
image = rendering::flipImageVertical(image, layout).permute({1, 2, 0}).contiguous();
} else {
image = image.contiguous();
}
return image;
}
[[nodiscard]] std::optional<PyViewportRender> toPyViewportRender(
const std::optional<vis::ViewportRender>& render,
const bool clone_for_async) {
auto image = viewportRenderImageHwc(render, clone_for_async);
if (!image)
return std::nullopt;
std::optional<PyTensor> screen_pos;
if (render->screen_positions) {
auto screen_positions = clone_for_async
? render->screen_positions->clone()
: *render->screen_positions;
screen_pos = PyTensor(std::move(screen_positions), true);
}
return PyViewportRender{
.image = PyTensor(std::move(*image), true),
.screen_positions = std::move(screen_pos),
};
}
[[nodiscard]] std::optional<vis::ViewportRender> captureViewportRenderThreadSafe() {
auto invoke_capture = []() -> std::optional<vis::ViewportRender> {
return vis::capture_viewport_render();
};
auto* const viewer = get_visualizer();
if (!viewer || viewer->isOnViewerThread()) {
return invoke_capture();
}
if (!viewer->acceptsPostedWork()) {
return std::nullopt;
}
nb::gil_scoped_release release;
return vis::post_work_and_wait(
[viewer](vis::Visualizer::WorkItem work) { return viewer->postWork(std::move(work)); },
invoke_capture,
[]() -> std::optional<vis::ViewportRender> { return std::nullopt; });
}
[[nodiscard]] core::PointCloud pointCloudFromMesh(const core::MeshData& mesh) {
core::Tensor colors;
const auto vertex_count = static_cast<std::size_t>(mesh.vertex_count());
if (mesh.colors.is_valid() && mesh.colors.ndim() == 2 &&
mesh.colors.size(0) == mesh.vertex_count() && mesh.colors.size(1) >= 3) {
colors = mesh.colors.slice(1, 0, 3).contiguous();
} else {
colors = core::Tensor::full(
{vertex_count, static_cast<std::size_t>(3)},
0.72f,
mesh.vertices.device(),
core::DataType::Float32);
}
return core::PointCloud(mesh.vertices, std::move(colors));
}
[[nodiscard]] std::optional<core::Tensor> renderSplatAssetPreview(
vis::RenderingManager& rendering_manager,
core::SplatData& splat,
const int width,
const int height,
const float focal_length_mm,
const glm::mat3* custom_rotation = nullptr,
const glm::vec3* custom_translation = nullptr) {
if (splat.size() == 0) {
return std::nullopt;
}
Viewport preview_viewport(
static_cast<std::size_t>(width),
static_cast<std::size_t>(height));
if (custom_rotation && custom_translation) {
preview_viewport.setViewMatrix(*custom_rotation, *custom_translation);
} else {
preview_viewport.camera.resetToHome();
}
vis::SceneRenderState scene_state;
scene_state.combined_model = &splat;
scene_state.model_transforms = {
rendering::dataWorldTransformToVisualizerWorld(glm::mat4(1.0f)),
};
scene_state.transform_indices = std::make_shared<core::Tensor>(
core::Tensor::zeros(
{static_cast<std::size_t>(splat.size())},
core::Device::CUDA,
core::DataType::Int32));
scene_state.node_visibility_mask = {true};
scene_state.selected_node_mask = {true};
scene_state.visible_splat_count = 1;
const auto image = rendering_manager.renderPreviewImage(
splat,
std::move(scene_state),
preview_viewport.getRotationMatrix(),
preview_viewport.getTranslation(),
focal_length_mm,
width,
height);
if (!image || !image->is_valid()) {
return std::nullopt;
}
return image->clone();
}
[[nodiscard]] std::optional<core::Tensor> renderPointCloudAssetPreview(
vis::RenderingManager& rendering_manager,
const core::PointCloud& point_cloud,
const int width,
const int height,
const float focal_length_mm,
const glm::mat3* custom_rotation = nullptr,
const glm::vec3* custom_translation = nullptr) {
if (point_cloud.size() == 0) {
return std::nullopt;
}
auto* const engine = rendering_manager.getRenderingEngine();
if (!engine) {
return std::nullopt;
}
Viewport preview_viewport(
static_cast<std::size_t>(width),
static_cast<std::size_t>(height));
if (custom_rotation && custom_translation) {
preview_viewport.setViewMatrix(*custom_rotation, *custom_translation);
} else {
preview_viewport.camera.resetToHome();
}
std::vector<glm::mat4> model_transforms{
rendering::dataWorldTransformToVisualizerWorld(glm::mat4(1.0f)),
};
auto transform_indices = std::make_shared<core::Tensor>(
core::Tensor::zeros(
{static_cast<std::size_t>(point_cloud.size())},
core::Device::CUDA,
core::DataType::Int32));
rendering::PointCloudRenderRequest request{};
request.frame_view.rotation = preview_viewport.getRotationMatrix();
request.frame_view.translation = preview_viewport.getTranslation();
request.frame_view.size = {width, height};
request.frame_view.focal_length_mm = focal_length_mm;
request.render.scaling_modifier = 1.0f;
request.render.voxel_size = 0.01f;
request.render.equirectangular = false;
request.scene.model_transforms = &model_transforms;
request.scene.transform_indices = std::move(transform_indices);
request.scene.node_visibility_mask = {true};
request.transparent_background = false;
auto render_result = engine->renderPointCloudImage(point_cloud, request);
if (!render_result || !render_result->image || !render_result->image->is_valid()) {
if (!render_result) {
LOG_DEBUG("Point-cloud asset preview render failed: {}", render_result.error());
}
return std::nullopt;
}
return render_result->image->clone();
}
[[nodiscard]] std::optional<core::Tensor> renderAssetPreviewOnViewerThread(
const std::string& path,
const int width,
const int height,
const float focal_length_mm,
const glm::mat3* rotation = nullptr,
const glm::vec3* translation = nullptr) {
if (width <= 0 || height <= 0) {
return std::nullopt;
}
auto* const viewer = get_visualizer();
auto* const rendering_manager = viewer ? viewer->getRenderingManager() : nullptr;
if (!rendering_manager) {
return std::nullopt;
}
try {
auto loader = io::Loader::create();
if (!loader) {
return std::nullopt;
}
io::LoadOptions options;
options.resize_factor = -1;
options.max_width = 0;
options.images_folder = "images";
options.validate_only = false;
options.splat_tensor_allocator = rendering_manager->makeSplatTensorAllocator();
const auto asset_path = core::utf8_to_path(path);
std::error_code file_size_error;
if (lfs::core::native_fs::is_regular_file(asset_path, file_size_error)) {
const auto file_size = lfs::core::native_fs::file_size(asset_path, file_size_error);
if (!file_size_error && file_size > MAX_RENDERED_ASSET_PREVIEW_BYTES) {
LOG_DEBUG("Skipping rendered asset preview for '{}' ({} MB exceeds {} MB budget)",
path,
file_size / (1024 * 1024),
MAX_RENDERED_ASSET_PREVIEW_BYTES / (1024 * 1024));
return std::nullopt;
}
}
auto ext = lfs::core::path_to_utf8(asset_path.extension());
std::transform(ext.begin(), ext.end(), ext.begin(), ::tolower);
if (ext == ".ckpt" || ext == ".resume") {
auto checkpoint_result = core::load_checkpoint_splat_data(
asset_path,
rendering_manager->makeSplatTensorAllocator());
if (!checkpoint_result) {
LOG_DEBUG(
"Checkpoint asset preview load failed for '{}': {}",
path,
checkpoint_result.error());
return std::nullopt;
}
return renderSplatAssetPreview(
*rendering_manager,
*checkpoint_result,
width,
height,
focal_length_mm,
rotation,
translation);
}
auto load_result = loader->load(asset_path, options);
if (!load_result) {
LOG_DEBUG("Asset preview load failed for '{}': {}", path, load_result.error().format());
return std::nullopt;
}
const auto* loaded_splat = std::get_if<std::shared_ptr<core::SplatData>>(&load_result->data);
if (loaded_splat && *loaded_splat) {
return renderSplatAssetPreview(
*rendering_manager,
**loaded_splat,
width,
height,
focal_length_mm,
rotation,
translation);
}
const auto* loaded_scene = std::get_if<io::LoadedScene>(&load_result->data);
if (loaded_scene && loaded_scene->point_cloud) {
return renderPointCloudAssetPreview(
*rendering_manager,
*loaded_scene->point_cloud,
width,
height,
focal_length_mm,
rotation,
translation);
}
const auto* loaded_mesh = std::get_if<std::shared_ptr<core::MeshData>>(&load_result->data);
if (loaded_mesh && *loaded_mesh && (*loaded_mesh)->vertex_count() > 0) {
auto mesh_points = pointCloudFromMesh(**loaded_mesh);
return renderPointCloudAssetPreview(
*rendering_manager,
mesh_points,
width,
height,
focal_length_mm,
rotation,
translation);
}
} catch (const std::exception& e) {
LOG_DEBUG("Asset preview render failed for '{}': {}", path, e.what());
} catch (...) {
LOG_DEBUG("Asset preview render failed for '{}': unknown error", path);
}
return std::nullopt;
}
[[nodiscard]] std::optional<core::Tensor> renderAssetPreviewThreadSafe(
const std::string& path,
const int width,
const int height,
const float focal_length_mm,
const glm::mat3* rotation = nullptr,
const glm::vec3* translation = nullptr) {
auto invoke_render = [&]() -> std::optional<core::Tensor> {
return renderAssetPreviewOnViewerThread(path, width, height, focal_length_mm, rotation, translation);
};
auto* const viewer = get_visualizer();
if (!viewer || viewer->isOnViewerThread()) {
return invoke_render();
}
if (!viewer->acceptsPostedWork()) {
return std::nullopt;
}
nb::gil_scoped_release release;
return vis::post_work_and_wait(
[viewer](vis::Visualizer::WorkItem work) { return viewer->postWork(std::move(work)); },
invoke_render,
[]() -> std::optional<core::Tensor> { return std::nullopt; });
}
[[nodiscard]] std::optional<glm::mat3> tensorToVisualizerRotation(const PyTensor& py_tensor) {
const auto& tensor = py_tensor.tensor();
if (!tensor.is_valid() || tensor.ndim() != 2 || tensor.size(0) != 3 || tensor.size(1) != 3) {
return std::nullopt;
}
try {
const auto cpu = tensor.to(core::Device::CPU).to(core::DataType::Float32).contiguous();
const auto* const data = static_cast<const float*>(cpu.data_ptr());
if (!data) {
return std::nullopt;
}
glm::mat3 rotation{};
for (int row = 0; row < 3; ++row) {
for (int col = 0; col < 3; ++col) {
const float value = data[row * 3 + col];
if (!std::isfinite(value)) {
return std::nullopt;
}
rotation[col][row] = value;
}
}
return rotation;
} catch (const std::exception& e) {
LOG_DEBUG("render_view rotation conversion failed: {}", e.what());
} catch (...) {
LOG_DEBUG("render_view rotation conversion failed: unknown error");
}
return std::nullopt;
}
[[nodiscard]] std::optional<glm::vec3> tensorToVisualizerTranslation(const PyTensor& py_tensor) {
const auto& tensor = py_tensor.tensor();
if (!tensor.is_valid() || tensor.ndim() != 1 || tensor.size(0) != 3) {
return std::nullopt;
}
try {
const auto cpu = tensor.to(core::Device::CPU).to(core::DataType::Float32).contiguous();
const auto* const data = static_cast<const float*>(cpu.data_ptr());
if (!data) {
return std::nullopt;
}
const glm::vec3 translation{data[0], data[1], data[2]};
if (!std::isfinite(translation.x) || !std::isfinite(translation.y) || !std::isfinite(translation.z)) {
return std::nullopt;
}
return translation;
} catch (const std::exception& e) {
LOG_DEBUG("render_view translation conversion failed: {}", e.what());
} catch (...) {
LOG_DEBUG("render_view translation conversion failed: unknown error");
}
return std::nullopt;
}
// Runs `draw` on the viewer thread with the shaders the viewport binds:
// an export freezes them and throws when they cannot draw, a live render
// draws what the viewport would; see RenderingManager::drawWithShaders.
// `frame` describes what `draw` renders. `cancelled` when the viewer takes no work or drops it.
template <class Draw, class Drawn = std::invoke_result_t<Draw&>>
[[nodiscard]] Drawn drawWithViewportShaders(std::type_identity_t<Drawn> cancelled,
const std::function<vis::RenderingManager::ExportFrame()>& frame,
Draw draw, const bool exporting = false) {
auto* const viewer = get_visualizer();
auto* const rendering_manager = viewer ? viewer->getRenderingManager() : nullptr;
if (!rendering_manager)
return draw();
const auto shaded = [&]() -> Result<Drawn> { return draw(); };
if (viewer->isOnViewerThread())
return unwrap(rendering_manager->drawWithShaders(exporting, [](auto run) { return run(); }, shaded, frame));
if (!viewer->acceptsPostedWork())
return cancelled;
nb::gil_scoped_release release;
const auto post = [viewer, cancelled](auto run) {
return vis::post_work_and_wait(
[viewer](vis::Visualizer::WorkItem work) { return viewer->postWork(std::move(work)); },
std::move(run), [cancelled] { return Result<Drawn>(cancelled); });
};
return unwrap(rendering_manager->drawWithShaders(exporting, post, shaded, frame));
}
[[nodiscard]] std::optional<core::Tensor> renderViewOnViewerThread(
const glm::mat3& rotation,
const glm::vec3& translation,
const int width,
const int height,
const float fov_degrees,
const PreviewReadback readback,
const std::optional<glm::vec3>& background_color_override,
const std::optional<bool> orthographic_override = std::nullopt,
const std::optional<float> ortho_scale_override = std::nullopt,
const int reference_height = 0) {
if (width <= 0 || height <= 0 || !std::isfinite(fov_degrees) || fov_degrees <= 0.0f) {
return std::nullopt;
}
auto* const viewer = get_visualizer();
auto* const rendering_manager = viewer ? viewer->getRenderingManager() : nullptr;
auto* const scene_manager = viewer ? viewer->getSceneManager() : nullptr;
if (!rendering_manager || !scene_manager) {
return std::nullopt;
}
std::shared_ptr<core::Tensor> image;
if (readback == PreviewReadback::UInt8Rgb) {
image = rendering_manager->renderPreviewImageRgb8(
scene_manager,
rotation,
translation,
lfs::rendering::vFovToFocalLength(fov_degrees),
width,
height,
background_color_override,
orthographic_override,
ortho_scale_override,
reference_height);
} else {
image = rendering_manager->renderPreviewImage(
scene_manager,
rotation,
translation,
lfs::rendering::vFovToFocalLength(fov_degrees),
width,
height,
background_color_override,
orthographic_override,
ortho_scale_override);
}
if (readback != PreviewReadback::FloatRgb) {
rendering_manager->releasePreviewImageResources();
}
if (!image || !image->is_valid()) {
return std::nullopt;
}
return *image;
}
[[nodiscard]] std::optional<core::Tensor> renderViewThreadSafe(
const glm::mat3& rotation,
const glm::vec3& translation,
const int width,
const int height,
const float fov_degrees,
const PreviewReadback readback,
const std::optional<glm::vec3>& background_color_override,
const std::optional<bool> orthographic_override = std::nullopt,
const std::optional<float> ortho_scale_override = std::nullopt,
const int reference_height = 0) {
const auto frame = [width, height] { return vis::RenderingManager::ExportFrame{.width = width, .height = height}; };
return drawWithViewportShaders(std::nullopt, frame, [&] {
return renderViewOnViewerThread(
rotation,
translation,
width,
height,
fov_degrees,
readback,
background_color_override,
orthographic_override,
ortho_scale_override,
reference_height);
});
}
[[nodiscard]] std::optional<std::pair<core::Tensor, core::Tensor>> renderViewAndDepthOnViewerThread(
const glm::mat3& rotation,
const glm::vec3& translation,
const int width,
const int height,
const float fov_degrees,
const bool expected_depth) {
if (width <= 0 || height <= 0 || !std::isfinite(fov_degrees) || fov_degrees <= 0.0f) {
return std::nullopt;
}
auto* const viewer = get_visualizer();
auto* const rendering_manager = viewer ? viewer->getRenderingManager() : nullptr;
auto* const scene_manager = viewer ? viewer->getSceneManager() : nullptr;
if (!rendering_manager || !scene_manager) {
return std::nullopt;
}
auto rgbd = rendering_manager->renderPreviewImageAndDepth(
scene_manager,
rotation,
translation,
lfs::rendering::vFovToFocalLength(fov_degrees),
width,
height,
expected_depth,
std::nullopt);
if (!rgbd.image || !rgbd.depth || !rgbd.image->is_valid() || !rgbd.depth->is_valid()) {
return std::nullopt;
}
auto image = *rgbd.image;
auto depth = *rgbd.depth;
if (image.device() != core::Device::CPU) {
image = image.cpu();
}
if (depth.device() != core::Device::CPU) {
depth = depth.cpu();
}
return std::make_pair(image.contiguous(), depth.contiguous());
}
[[nodiscard]] std::optional<std::pair<core::Tensor, core::Tensor>> renderViewAndDepthThreadSafe(
const glm::mat3& rotation,
const glm::vec3& translation,
const int width,
const int height,
const float fov_degrees,
const bool expected_depth) {
const auto frame = [width, height] { return vis::RenderingManager::ExportFrame{.width = width, .height = height, .depth = true}; };
return drawWithViewportShaders(std::nullopt, frame, [&] {
return renderViewAndDepthOnViewerThread(rotation, translation, width, height, fov_degrees, expected_depth);
});
}
} // namespace
void set_render_scene_context(core::Scene* scene) {
set_scene_for_python(scene);
}
core::Scene* get_render_scene() {
if (auto* app_scene = get_application_scene()) {
return app_scene;
}
return get_scene_for_python();
}
void register_render_settings_properties() {
using namespace core::prop;
using Proxy = vis::RenderSettingsProxy;
PropertyGroup group;
group.id = "render_settings";
group.name = "Render Settings";
auto add_color3 = [&](std::array<float, 3> Proxy::*member, const std::string& id, const std::string& name,
const std::string& desc, std::array<double, 3> default_val) {
PropertyMeta meta;
meta.id = id;
meta.name = name;
meta.description = desc;
meta.type = PropType::Color3;
meta.default_value = default_val;
meta.min_value = 0.0;
meta.max_value = 1.0;
meta.getter = [member](const PropertyObjectRef& ref) -> std::any {
const auto& arr = static_cast<const Proxy*>(ref.ptr)->*member;
return std::array<float, 3>{arr[0], arr[1], arr[2]};
};
meta.setter = [member](PropertyObjectRef& ref, const std::any& val) {
static_cast<Proxy*>(ref.ptr)->*member = std::any_cast<std::array<float, 3>>(val);
};
group.properties.push_back(std::move(meta));
};
auto add_bool = [&](bool Proxy::*member, const std::string& id, const std::string& name, const std::string& desc,
bool default_val) {
PropertyMeta meta;
meta.id = id;
meta.name = name;
meta.description = desc;
meta.type = PropType::Bool;
meta.default_value = default_val;
meta.getter = [member](const PropertyObjectRef& ref) -> std::any {
return static_cast<const Proxy*>(ref.ptr)->*member;
};
meta.setter = [member](PropertyObjectRef& ref, const std::any& val) {
static_cast<Proxy*>(ref.ptr)->*member = std::any_cast<bool>(val);
};
group.properties.push_back(std::move(meta));
};
auto add_float = [&](float Proxy::*member, const std::string& id, const std::string& name,
const std::string& desc, double default_val, double min_val, double max_val) {
PropertyMeta meta;
meta.id = id;
meta.name = name;
meta.description = desc;
meta.type = PropType::Float;
meta.default_value = default_val;
meta.min_value = min_val;
meta.max_value = max_val;
meta.getter = [member](const PropertyObjectRef& ref) -> std::any {
return static_cast<const Proxy*>(ref.ptr)->*member;
};
meta.setter = [member](PropertyObjectRef& ref, const std::any& val) {
static_cast<Proxy*>(ref.ptr)->*member = std::any_cast<float>(val);
};
group.properties.push_back(std::move(meta));
};
auto add_int = [&](int Proxy::*member, const std::string& id, const std::string& name,
const std::string& desc, int default_value, int min_value, int max_value) {
PropertyMeta meta;
meta.id = id;
meta.name = name;
meta.description = desc;
meta.type = PropType::Int;
meta.default_value = static_cast<int64_t>(default_value);
meta.min_value = min_value;
meta.max_value = max_value;
meta.step = 1.0;
meta.getter = [member](const PropertyObjectRef& ref) -> std::any {
return static_cast<const Proxy*>(ref.ptr)->*member;
};
meta.setter = [member](PropertyObjectRef& ref, const std::any& value) {
static_cast<Proxy*>(ref.ptr)->*member = std::any_cast<int>(value);
};
group.properties.push_back(std::move(meta));
};
auto add_int_enum = [&](int Proxy::*member, const std::string& id, const std::string& name,
const std::string& desc, std::vector<EnumItem> items, int default_value) {
PropertyMeta meta;
meta.id = id;
meta.name = name;
meta.description = desc;
meta.type = PropType::Enum;
meta.enum_items = items;
meta.default_value = static_cast<int64_t>(default_value);
meta.getter = [member, items](const PropertyObjectRef& ref) -> std::any {
int val = static_cast<const Proxy*>(ref.ptr)->*member;
for (const auto& item : items) {
if (item.value == val) {
return item.identifier;
}
}
return std::to_string(val);
};
meta.setter = [member, items](PropertyObjectRef& ref, const std::any& val) {
if (val.type() == typeid(int)) {
static_cast<Proxy*>(ref.ptr)->*member = std::any_cast<int>(val);
} else if (val.type() == typeid(std::string)) {
std::string id_str = std::any_cast<std::string>(val);
for (const auto& item : items) {
if (item.identifier == id_str) {
static_cast<Proxy*>(ref.ptr)->*member = item.value;
return;
}
}
static_cast<Proxy*>(ref.ptr)->*member = std::stoi(id_str);
}
};
group.properties.push_back(std::move(meta));
};
auto add_string = [&](std::string Proxy::*member, const std::string& id, const std::string& name,
const std::string& desc, const std::string& default_val) {
PropertyMeta meta;
meta.id = id;
meta.name = name;
meta.description = desc;
meta.type = PropType::String;
meta.default_value = default_val;
meta.getter = [member](const PropertyObjectRef& ref) -> std::any {
return static_cast<const Proxy*>(ref.ptr)->*member;
};
meta.setter = [member](PropertyObjectRef& ref, const std::any& val) {
static_cast<Proxy*>(ref.ptr)->*member = std::any_cast<std::string>(val);
};
group.properties.push_back(std::move(meta));
};
add_float(&Proxy::color_exposure, "color_exposure", "Splat exposure", "Splat brightness multiplier", 1.0, 0.1, 8.0);
add_int_enum(&Proxy::color_tonemapping, "color_tonemapping", "Tone mapping", "Splat display tone mapping",
{{"None", "none", 0}, {"Linear", "linear", 1}, {"Filmic", "filmic", 2}, {"Hejl", "hejl", 3}, {"ACES", "aces", 4}, {"ACES 2", "aces2", 5}, {"Neutral", "neutral", 6}}, 0);
add_int_enum(&Proxy::splat_render_profile, "splat_render_profile", "Splat rendering profile",
"Preserve the source scene rendering when importing from the gallery",
{{"Studio", "studio", 0}, {"Standard portal", "standard", 1}}, 0);
// Background
add_color3(&Proxy::background_color, "background_color", "Color", "Viewport background color", {0.0, 0.0, 0.0});
add_int_enum(&Proxy::environment_mode, "environment_mode", "Environment", "Viewport background mode",
{{"Solid Color", "SOLID_COLOR", 0}, {"Equirectangular HDRI", "EQUIRECTANGULAR", 1}}, 0);
add_string(&Proxy::environment_map_path, "environment_map_path", "Preset",
"Relative asset path or absolute HDRI path for the environment background",
std::string(vis::kDefaultEnvironmentMapPath));
add_float(&Proxy::environment_exposure, "environment_exposure", "Exposure", "Environment exposure in EV", 0.0, -6.0, 6.0);
add_float(&Proxy::environment_rotation_degrees, "environment_rotation_degrees", "Rotation",
"Environment yaw rotation in degrees", 0.0, -180.0, 180.0);
// Coordinate Axes
add_bool(&Proxy::show_coord_axes, "show_coord_axes", "Show Coordinate Axes",
"Display coordinate axes in viewport", false);
add_float(&Proxy::axes_size, "axes_size", "Size", "Size of coordinate axes", 2.0, 0.5, 10.0);
// Pivot
add_bool(&Proxy::show_pivot, "show_pivot", "Show Pivot", "Display pivot point", false);
// Grid
add_bool(&Proxy::show_grid, "show_grid", "Show Grid", "Display grid in viewport", true);
add_int_enum(&Proxy::grid_plane, "grid_plane", "Plane", "Grid orientation",
{{"YZ (Right)", "0", 0}, {"XZ (Top)", "1", 1}, {"XY (Front)", "2", 2}}, 1);
add_float(&Proxy::collision_preview_opacity, "collision_preview_opacity", "Collision Opacity", "Collision preview face opacity; edges remain stronger", 0.4, 0.0, 1.0);
add_float(&Proxy::grid_opacity, "grid_opacity", "Grid Opacity", "Grid transparency", 0.5, 0.0, 1.0);
// Camera Frustums
add_bool(&Proxy::show_camera_frustums, "show_camera_frustums", "Camera Frustums",
"Show camera frustum wireframes", false);
add_float(&Proxy::camera_frustum_scale, "camera_frustum_scale", "Scale", "Camera frustum display scale", 0.25,
0.01, 10.0);
// Point Cloud Mode
add_bool(&Proxy::point_cloud_mode, "point_cloud_mode", "Point Cloud Mode",
"Render as point cloud instead of splats", false);
add_float(&Proxy::voxel_size, "voxel_size", "Point Size", "Point size in point cloud mode", 0.01, 0.001, 0.1);
// Selection Colors
add_color3(&Proxy::selection_color_preview, "selection_color_preview", "Preview", "Preview selection color",
{0.0, 0.871, 0.298});
add_color3(&Proxy::selection_color_center_marker, "selection_color_center_marker", "Center Marker",
"Selection center marker color", {0.0, 0.604, 0.733});
// Desaturation
add_color3(&Proxy::selection_outline_color, "selection_outline_color", "Outline color", "Selected object outline color", {0.0, 0.604, 0.733});
add_bool(&Proxy::selection_outline_holes, "selection_outline_holes", "Interior contours", "Include contours of fully enclosed holes", true);
add_float(&Proxy::selection_outline_opacity, "selection_outline_opacity", "Opacity", "Outline appearance", 1.0, 0, 1);
add_float(&Proxy::selection_outline_width, "selection_outline_width", "Width", "Outline appearance", 2.0, 1, 12);
add_float(&Proxy::selection_outline_threshold, "selection_outline_threshold", "Threshold", "Outline appearance", 0.5, 0.05, 0.95);
add_bool(&Proxy::selection_outline, "selection_outline", "Selection Outline",
"Outline selected splat objects using precise per-pixel rendering", false);
add_bool(&Proxy::desaturate_unselected, "desaturate_unselected", "Desaturate Unselected",
"Desaturate unselected PLYs when one is selected", false);
add_bool(&Proxy::desaturate_cropping, "desaturate_cropping", "Desaturate Cropping",
"Dim outside crop area instead of hiding", false);
add_bool(&Proxy::hide_outside_depth_box, "hide_outside_depth_box", "Hide Outside Depth Box",
"Hide Gaussians outside the selection depth box", false);
// View Settings
add_float(&Proxy::focal_length_mm, "focal_length_mm", "Focal Length", "Focal length in mm", 35.0, 10.0, 200.0);
add_int_enum(&Proxy::sh_degree, "sh_degree", "SH Degree", "Spherical harmonics degree",
{{"0", "0", 0}, {"1", "1", 1}, {"2", "2", 2}, {"3", "3", 3}}, 3);
add_bool(&Proxy::equirectangular, "equirectangular", "Equirectangular", "Equirectangular projection mode",
false);
add_int_enum(&Proxy::raster_backend, "raster_backend", "Raster Backend", "Gaussian rasterization backend",
{{"3DGS", "3dgs", 2},
{"3DGUT", "3dgut", 3}},
2);
add_int_enum(&Proxy::transparency_mode, "transparency_mode", "Transparency", "3DGS transparency mode",
{{"Alpha blend", "alpha_blend", 0},
{"Stochastic", "stochastic", 1},
{"SteadySplats", "steady_splats", 2}},
0);
add_int(&Proxy::stochastic_max_frames, "stochastic_max_frames", "Refinement Frames",
"Maximum new samples after the view or scene changes",
lfs::rendering::DEFAULT_STOCHASTIC_REFINEMENT_FRAMES, 1, 1024);
add_bool(&Proxy::mip_filter, "mip_filter", "Mip Filter", "Enable mip-map filtering", false);
add_float(&Proxy::render_scale, "render_scale", "Render Scale", "Render resolution scale", 1.0, 0.25, 1.0);
add_string(&Proxy::scene_upscaler,
"scene_upscaler",
"Scene Reconstruction",
"Stable scene reconstruction backend identifier",
"native");
add_string(&Proxy::scene_upscaler_preset,
"scene_upscaler_preset",
"Scene Reconstruction Preset",
"Backend-specific scene reconstruction quality preset",
"native");
add_float(&Proxy::depth_view_min, "depth_view_min", "Depth Near", "Depth-map visualization near range",
lfs::rendering::DEFAULT_DEPTH_VIEW_MIN, 0.0, lfs::rendering::MAX_DEPTH_VIEW_DISTANCE);
add_float(&Proxy::depth_view_max, "depth_view_max", "Depth Far", "Depth-map visualization far range",
lfs::rendering::DEFAULT_DEPTH_VIEW_MAX, lfs::rendering::DEFAULT_DEPTH_VIEW_MIN,
lfs::rendering::MAX_DEPTH_VIEW_DISTANCE);
add_int_enum(&Proxy::depth_visualization_mode, "depth_visualization_mode", "Depth Mode",
"Depth-map visualization mode",
{{"Color", "palette", 0}, {"Gray", "gray", 1}}, 0);
add_int_enum(&Proxy::gt_comparison_mode, "gt_comparison_mode", "GT Compare",
"Ground-truth comparison payload",
{{"RGB", "rgb", 0}, {"Normal", "normal", 1}, {"Depth", "depth", 2}}, 0);
add_int_enum(&Proxy::camera_metrics_mode, "camera_metrics_mode", "Camera Metrics",
"Compute metrics when jumping to a source camera",
{{"Off", "OFF", 0}, {"PSNR", "PSNR", 1}, {"PSNR + SSIM", "PSNR_SSIM", 2}}, 0);
add_bool(&Proxy::lod_enabled, "lod_enabled", "Enable LOD",
"Enable hierarchical level-of-detail rendering", false);
add_bool(&Proxy::lod_debug_colors, "lod_debug_colors", "Debug Colors",
"Color splats by their LOD level for debugging", false);
add_float(&Proxy::lod_max_splats, "lod_max_splats", "LOD Budget",
"Maximum number of splats in the dynamic LOD cut",
static_cast<double>(vis::DEFAULT_LOD_MAX_SPLATS), 1.0, 10000000.0);
add_float(&Proxy::lod_page_pool_splats, "lod_page_pool_splats", "LOD Cache Budget",
"VRAM page-pool budget in splats for streamed RAD scenes (0 = auto)",
static_cast<double>(vis::DEFAULT_LOD_PAGE_POOL_SPLATS), 0.0, 100000000.0);
add_float(&Proxy::lod_pool_vram_fraction, "lod_pool_vram_fraction", "LOD Pool VRAM Fraction",
"Share of free VRAM granted to the out-of-core LOD page pool",
static_cast<double>(vis::DEFAULT_LOD_POOL_VRAM_FRACTION), 0.05, 0.9);
add_float(&Proxy::lod_fade_frames, "lod_fade_frames", "LOD Fade Frames",
"Frames a newly streamed LOD page fades in over (0 = instant)",
static_cast<double>(vis::DEFAULT_LOD_FADE_FRAMES), 0.0, 240.0);
add_float(&Proxy::lod_render_scale, "lod_render_scale", "Render Scale",
"Quality multiplier: effective splat target = LOD Budget x Render Scale", vis::DEFAULT_LOD_RENDER_SCALE, 0.1, 5.0);
add_float(&Proxy::lod_cone_foveation, "lod_cone_foveation", "Cone Foveation",
"Peripheral LOD penalty factor (1.0 = no penalty)", vis::DEFAULT_LOD_CONE_FOVEATION, 0.1, 2.0);
add_float(&Proxy::lod_cone_inner_degrees, "lod_cone_inner_degrees", "Cone Inner",
"Inner cone angle in degrees (no penalty inside this angle)", vis::DEFAULT_LOD_CONE_INNER_DEGREES, 0.0, 180.0);
add_float(&Proxy::lod_cone_outer_degrees, "lod_cone_outer_degrees", "Cone Outer",
"Outer cone angle in degrees (full penalty beyond this angle)", vis::DEFAULT_LOD_CONE_OUTER_DEGREES, 0.0, 180.0);
add_bool(&Proxy::apply_appearance_correction, "apply_appearance_correction", "Appearance Correction",
"Enable PPISP appearance correction", false);
add_int_enum(&Proxy::ppisp_mode, "ppisp_mode", "Mode", "PPISP correction mode",
{{"Manual", "MANUAL", 0}, {"Auto", "AUTO", 1}}, 1);
using PPISP = vis::PPISPOverrides;
const auto add_ppisp_float = [&](float PPISP::*member, const char* id, const char* name,
const char* desc, double def, double min_v, double max_v) {
PropertyMeta meta;
meta.id = id;
meta.name = name;
meta.description = desc;
meta.type = PropType::Float;
meta.default_value = def;
meta.min_value = min_v;
meta.max_value = max_v;
meta.getter = [member](const PropertyObjectRef& ref) -> std::any {
return static_cast<const Proxy*>(ref.ptr)->ppisp.*member;
};
meta.setter = [member](PropertyObjectRef& ref, const std::any& val) {
static_cast<Proxy*>(ref.ptr)->ppisp.*member = std::any_cast<float>(val);
};
group.properties.push_back(std::move(meta));
};
const auto add_ppisp_bool = [&](bool PPISP::*member, const char* id, const char* name,
const char* desc, bool def) {
PropertyMeta meta;
meta.id = id;
meta.name = name;
meta.description = desc;
meta.type = PropType::Bool;
meta.default_value = def;
meta.getter = [member](const PropertyObjectRef& ref) -> std::any {
return static_cast<const Proxy*>(ref.ptr)->ppisp.*member;
};
meta.setter = [member](PropertyObjectRef& ref, const std::any& val) {
static_cast<Proxy*>(ref.ptr)->ppisp.*member = std::any_cast<bool>(val);
};
group.properties.push_back(std::move(meta));
};
add_ppisp_float(&PPISP::exposure_offset, "ppisp_exposure", "Exposure", "Exposure offset (EV)", 0.0, -3.0, 3.0);
add_ppisp_bool(&PPISP::vignette_enabled, "ppisp_vignette_enabled", "Vignette", "Enable vignette correction", true);
add_ppisp_float(&PPISP::vignette_strength, "ppisp_vignette_strength", "Vignette Strength", "Vignette strength", 1.0, 0.0, 2.0);
add_ppisp_float(&PPISP::wb_temperature, "ppisp_wb_temperature", "Temperature", "White balance temperature", 0.0, -1.0, 1.0);
add_ppisp_float(&PPISP::wb_tint, "ppisp_wb_tint", "Tint", "White balance tint", 0.0, -1.0, 1.0);
add_ppisp_float(&PPISP::gamma_multiplier, "ppisp_gamma_multiplier", "Gamma", "Gamma multiplier", 1.0, 0.5, 2.5);
add_ppisp_float(&PPISP::gamma_red, "ppisp_gamma_red", "Gamma Red", "Red gamma offset", 0.0, -0.5, 0.5);
add_ppisp_float(&PPISP::gamma_green, "ppisp_gamma_green", "Gamma Green", "Green gamma offset", 0.0, -0.5, 0.5);
add_ppisp_float(&PPISP::gamma_blue, "ppisp_gamma_blue", "Gamma Blue", "Blue gamma offset", 0.0, -0.5, 0.5);
add_ppisp_float(&PPISP::crf_toe, "ppisp_crf_toe", "Toe", "Shadow compression", 0.0, -1.0, 1.0);
add_ppisp_float(&PPISP::crf_shoulder, "ppisp_crf_shoulder", "Shoulder", "Highlight roll-off", 0.0, -1.0, 1.0);
add_ppisp_float(&PPISP::color_red_x, "ppisp_color_red_x", "Red X", "Red chromaticity X", 0.0, -0.5, 0.5);
add_ppisp_float(&PPISP::color_red_y, "ppisp_color_red_y", "Red Y", "Red chromaticity Y", 0.0, -0.5, 0.5);
add_ppisp_float(&PPISP::color_green_x, "ppisp_color_green_x", "Green X", "Green chromaticity X", 0.0, -0.5, 0.5);
add_ppisp_float(&PPISP::color_green_y, "ppisp_color_green_y", "Green Y", "Green chromaticity Y", 0.0, -0.5, 0.5);
add_ppisp_float(&PPISP::color_blue_x, "ppisp_color_blue_x", "Blue X", "Blue chromaticity X", 0.0, -0.5, 0.5);
add_ppisp_float(&PPISP::color_blue_y, "ppisp_color_blue_y", "Blue Y", "Blue chromaticity Y", 0.0, -0.5, 0.5);
add_bool(&Proxy::mesh_wireframe, "mesh_wireframe", "Wireframe Overlay", "Show wireframe on meshes", false);
add_color3(&Proxy::mesh_wireframe_color, "mesh_wireframe_color", "Wireframe Color", "Mesh wireframe color",
{0.2, 0.2, 0.2});
add_float(&Proxy::mesh_wireframe_width, "mesh_wireframe_width", "Wireframe Width", "Wireframe line width", 1.0,
0.5, 5.0);
add_float(&Proxy::mesh_light_intensity, "mesh_light_intensity", "Light Intensity", "Mesh light intensity", 0.7,
0.0, 5.0);
add_float(&Proxy::mesh_ambient, "mesh_ambient", "Ambient", "Mesh ambient light", 0.4, 0.0, 1.0);
add_bool(&Proxy::mesh_backface_culling, "mesh_backface_culling", "Backface Culling", "Cull mesh back faces",
true);
add_bool(&Proxy::mesh_shadow_enabled, "mesh_shadow_enabled", "Shadows", "Enable shadow mapping for meshes",
false);
add_int_enum(&Proxy::mesh_shadow_resolution, "mesh_shadow_resolution", "Shadow Resolution",
"Shadow map resolution",
{{"512", "512", 512},
{"1024", "1024", 1024},
{"2048", "2048", 2048},
{"4096", "4096", 4096}},
2048);
PropertyRegistry::instance().register_group(std::move(group));
}
PyRenderSettings::PyRenderSettings(vis::RenderSettingsProxy settings)
: settings_(std::move(settings)),
prop_(&settings_, "render_settings") {}
nb::dict PyRenderSettings::prop_info(const std::string& name) const {
auto info = prop_.prop_info(name);
const auto meta = core::prop::PropertyRegistry::instance().get_property("render_settings", name);
if (meta && meta->type == core::prop::PropType::Enum) {
// Descriptors and label resets share the value-based enum contract.
// Never offer a raw numeric default to a string-valued control.
const auto identifier = core::prop::enum_default_identifier(*meta);
info["builtin_default"] = identifier ? nb::cast(*identifier) : nb::none();
if (identifier)
info["default_identifier"] = *identifier;
} else if (meta && meta->getter) {
// Resolve scalar/color defaults through the same getter as the
// live value, preserving proxy conversions and canonical defaults.
auto defaults = vis::to_proxy(vis::RenderSettings{});
const auto ref = core::prop::PropertyObjectRef::cpp(&defaults);
info["builtin_default"] = any_to_python(meta->getter(ref), meta->type);
}
return info;
}
void PyRenderSettings::set(const std::string& name, nb::object value) {
set_impl(name, std::move(value), true);
}