viewport_lib/
lib.rs

1#![warn(missing_docs)]
2//! `viewport-lib` — a 3D viewport library for `wgpu` applications.
3//!
4//! Built on `wgpu` and `glam`, with no required UI toolkit. The crate provides
5//! the renderer, camera, picking, and interaction pieces; host applications keep
6//! control of their own windowing and event loop.
7//!
8//! # Quick start
9//!
10//! 1. Create a [`ViewportRenderer`] from a `wgpu::Device` and target format.
11//! 2. Upload meshes or volumes through [`ViewportGpuResources`].
12//! 3. Build a [`FrameData`] each frame (camera via [`CameraFrame`] and
13//!    [`RenderCamera`], scene content via [`SceneFrame`], viewport chrome via
14//!    [`ViewportFrame`], etc.).
15//! 4. Call [`ViewportRenderer::prepare`] and then [`ViewportRenderer::paint_to`].
16
17/// Error types for the viewport library.
18pub mod error;
19
20/// Arcball camera, frustum, view presets, and animator.
21pub mod camera;
22/// BVH picking, marching cubes, isolines, and cap geometry.
23pub mod geometry;
24/// Gizmo, snap, selection, annotation, picking, and input.
25pub mod interaction;
26/// Main viewport renderer wrapping all GPU resources.
27pub mod renderer;
28/// GPU resource container (pipelines, buffers, bind groups).
29pub mod resources;
30/// Scene graph, material, traits, and AABB.
31pub mod scene;
32/// Axes orientation indicator.
33pub mod widgets;
34
35// ---------------------------------------------------------------------------
36// Module re-exports — preserve old `viewport_lib::foo::Bar` paths.
37// ---------------------------------------------------------------------------
38
39pub use geometry::bvh;
40pub use geometry::primitives;
41pub use interaction::annotation;
42pub use interaction::gizmo;
43pub use interaction::input;
44pub use interaction::picking;
45pub use interaction::selection;
46pub use interaction::snap;
47pub use scene::aabb;
48pub use scene::material;
49pub use scene::traits;
50pub use widgets::axes_indicator;
51
52// ---------------------------------------------------------------------------
53// Flat re-exports — these form the public crate API.
54// ---------------------------------------------------------------------------
55
56pub use error::{ViewportError, ViewportResult};
57
58pub use camera::animator::{CameraAnimator, CameraDamping, Easing};
59pub use camera::camera::{Camera, Projection};
60pub use camera::frustum::{CullStats, Frustum};
61pub use camera::view_preset::ViewPreset;
62
63pub use scene::aabb::Aabb;
64pub use scene::material::Material;
65pub use scene::scene::{Group, GroupId, Layer, LayerId, Scene, SceneNode};
66pub use scene::traits::{RenderMode, ViewportObject};
67
68pub use geometry::bvh::PickAccelerator;
69pub use geometry::isoline::{IsolineItem, extract_isolines};
70pub use geometry::marching_cubes::{VolumeData, extract_isosurface};
71
72pub use interaction::annotation::AnnotationLabel;
73#[cfg(feature = "egui")]
74pub use interaction::annotation::draw_annotation_labels;
75pub use interaction::annotation::{world_to_screen, world_to_screen_from_frame};
76pub use interaction::gizmo::{
77    Gizmo, GizmoAxis, GizmoMode, GizmoSpace, PivotMode, gizmo_center_for_pivot,
78};
79pub use interaction::input::{
80    Action, ActionState, Binding, FrameInput, InputMode, InputSystem, KeyCode, Modifiers,
81    MouseButton,
82};
83pub use interaction::picking::{
84    GpuPickHit, PickHit, ProbeBinding, RectPickResult, pick_rect,
85    pick_scene_accelerated_with_probe, pick_scene_nodes_with_probe, pick_scene_with_probe,
86};
87pub use interaction::selection::{NodeId, Selection};
88pub use interaction::snap::{ConstraintOverlay, SnapConfig};
89
90pub use widgets::axes_indicator::AxisView;
91
92pub use renderer::shader_hashes::ShaderValidation;
93pub use renderer::stats::FrameStats;
94pub use renderer::{
95    CacheHints, CameraFrame, ClipPlane, ClipVolume, ComputeFilterItem, ComputeFilterKind,
96    EffectsFrame, FilterMode, FrameData, GlyphItem, GlyphType, InteractionFrame, LightKind,
97    LightSource, LightingSettings, OverlayQuad, PointCloudItem, PointRenderMode, PolylineItem,
98    PostProcessSettings, RenderCamera, SceneFrame, SceneRenderItem, ShadowFilter, StreamtubeItem,
99    SurfaceSubmission, ToneMapping, ViewportFrame, ViewportRenderer, VolumeItem,
100};
101pub use renderer::{ScalarBar, ScalarBarAnchor, ScalarBarOrientation};
102
103pub use resources::colormap_data::{
104    export_paraview_xml_colormap, lerp_colormap_lut, parse_paraview_xml_colormap,
105};
106pub use resources::mesh_store::MeshId;
107pub use resources::{
108    AttributeData, AttributeKind, AttributeRef, BuiltinColormap, CameraUniform, ClipVolumeUniform,
109    ColormapId, ComputeFilterResult, LightUniform, LightsUniform, MeshData, SingleLightUniform,
110    ViewportGpuResources, VolumeId, lerp_attributes,
111};
viewport_lib/lib.rs

viewport_lib/
lib.rs
