polyscope-render 0.5.10

Rendering backend for polyscope-rs: wgpu engine, shaders, and materials
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

//! Rendering backend for polyscope-rs.
//!
//! This crate provides the wgpu-based rendering engine, including:
//! - GPU resource management (buffers, textures, pipelines)
//! - Shader compilation and management (WGSL)
//! - Material and color map systems
//! - Camera and view management

// Type casts in graphics code: These lints flag intentional conversions between
// GPU types (u32 indices, f32 coordinates) and CPU types (usize, f64). The values
// involved are bounded (mesh vertices, texture dimensions, pixel coordinates) and
// will not overflow in practice. Suppressing at crate level to avoid noise.
#![allow(clippy::cast_possible_truncation)]
#![allow(clippy::cast_sign_loss)]
#![allow(clippy::cast_precision_loss)]
#![allow(clippy::cast_possible_wrap)]
// Documentation lints: Detailed error/panic docs will be added as the API stabilizes.
#![allow(clippy::missing_errors_doc)]
#![allow(clippy::missing_panics_doc)]
// Function length: Rendering and initialization functions are legitimately complex.
#![allow(clippy::too_many_lines)]
// Method design: Some methods take &self for API consistency even when not using it.
#![allow(clippy::unused_self)]
// Variable naming: In graphics code, similar variable names (e.g., color1, color2) are common.
#![allow(clippy::similar_names)]
// Argument design: Some functions take ownership for API consistency.
#![allow(clippy::needless_pass_by_value)]
// Slice handling: Sometimes &mut Vec is needed for push/pop operations.
#![allow(clippy::ptr_arg)]
// Default initialization: Sometimes we need to modify fields after default.
#![allow(clippy::field_reassign_with_default)]
// Default access: In wgpu pipeline code, Default::default() is idiomatic.
#![allow(clippy::default_trait_access)]
// Lifetimes: Some patterns require explicit lifetimes for clarity.
#![allow(clippy::needless_lifetimes)]
// Control flow: Sometimes if-let-else is clearer than let-else.
#![allow(clippy::manual_let_else)]
// Function signatures: Complex rendering functions need many parameters.
#![allow(clippy::too_many_arguments)]

pub mod buffer;
pub mod camera;
pub mod color_maps;
pub mod curve_network_render;
pub mod depth_peel_pass;
pub mod dual_quat;
pub mod engine;
pub mod error;
pub mod ground_plane;
pub mod materials;
pub mod pick;
pub mod point_cloud_render;
pub mod reflection;
pub mod reflection_pass;
pub mod screenshot;
pub mod shader;
pub mod shadow_map;
pub mod slice_mesh_render;
pub mod slice_plane_render;
pub mod ssaa_pass;
pub mod ssao_pass;
pub mod surface_mesh_render;
pub mod tone_mapping;
pub mod vector_render;
pub mod volume_grid_render;

pub use camera::{AxisDirection, Camera, NavigationStyle, ProjectionMode};
pub use color_maps::{ColorMap, ColorMapRegistry};
pub use curve_network_render::{CurveNetworkRenderData, CurveNetworkUniforms};
pub use depth_peel_pass::DepthPeelPass;
pub use engine::RenderEngine;
pub use error::{RenderError, RenderResult};
pub use ground_plane::{GroundPlaneRenderData, GroundPlaneUniforms};
pub use materials::{Material, MaterialRegistry, MaterialUniforms};
pub use pick::{
    MeshPickUniforms, PickElementType, PickResult, PickUniforms, TubePickUniforms, color_to_index,
    index_to_color,
};
pub use point_cloud_render::{PointCloudRenderData, PointUniforms};
pub use reflection::{ground_reflection_matrix, reflection_matrix};
pub use reflection_pass::{ReflectionPass, ReflectionUniforms};
pub use screenshot::{ScreenshotError, ScreenshotOptions, save_image, save_to_buffer};
pub use shader::{ShaderBuilder, ShaderProgram};
pub use shadow_map::{LightUniforms, SHADOW_MAP_SIZE, ShadowMapPass};
pub use slice_mesh_render::SliceMeshRenderData;
pub use slice_plane_render::{
    PlaneRenderUniforms, SlicePlaneRenderData, create_slice_plane_bind_group_layout,
    create_slice_plane_pipeline,
};
pub use ssaa_pass::SsaaPass;
pub use ssao_pass::{SsaoPass, SsaoUniforms};
pub use surface_mesh_render::{MeshUniforms, SurfaceMeshRenderData};
pub use tone_mapping::{ToneMapPass, ToneMapUniforms};
pub use vector_render::{VectorRenderData, VectorUniforms};
pub use volume_grid_render::{
    GridcubePickUniforms, GridcubeRenderData, GridcubeUniforms, IsosurfaceRenderData,
    SimpleMeshUniforms,
};

/// Render context passed to structures during drawing.
pub struct RenderContext<'a> {
    /// The wgpu device.
    pub device: &'a wgpu::Device,
    /// The wgpu queue.
    pub queue: &'a wgpu::Queue,
    /// The command encoder.
    pub encoder: &'a mut wgpu::CommandEncoder,
    /// The target texture view.
    pub view: &'a wgpu::TextureView,
    /// The depth texture view.
    pub depth_view: &'a wgpu::TextureView,
    /// The current camera.
    pub camera: &'a Camera,
    /// The material registry.
    pub materials: &'a MaterialRegistry,
    /// The color map registry.
    pub color_maps: &'a ColorMapRegistry,
}

impl polyscope_core::structure::RenderContext for RenderContext<'_> {}