More cleanup.

Author: tychedelia

crates/processing_ffi/src/lib.rs

@@ -1830,10 +1830,6 @@ pub extern "C" fn processing_material(window_id: u64, mat_id: u64) {
     error::check(|| graphics_record_command(window_entity, DrawCommand::Material(mat_entity)));
 }
 
-// Shader
-
-/// Create a shader from WGSL source.
-///
 /// # Safety
 /// - `source` must be non-null
 #[unsafe(no_mangle)]
@@ -1847,8 +1843,6 @@ pub unsafe extern "C" fn processing_shader_create(source: *const std::ffi::c_cha
     .unwrap_or(0)
 }
 
-/// Load a shader from a file path.
-///
 /// # Safety
 /// - `path` must be non-null
 #[unsafe(no_mangle)]
@@ -1868,8 +1862,6 @@ pub extern "C" fn processing_shader_destroy(shader_id: u64) {
     error::check(|| shader_destroy(Entity::from_bits(shader_id)));
 }
 
-// Buffer
-
 #[unsafe(no_mangle)]
 pub extern "C" fn processing_buffer_create(size: u64) -> u64 {
     error::clear_error();
@@ -1878,8 +1870,6 @@ pub extern "C" fn processing_buffer_create(size: u64) -> u64 {
         .unwrap_or(0)
 }
 
-/// Create a buffer initialized with data.
-///
 /// # Safety
 /// - `data` must point to `len` valid bytes
 #[unsafe(no_mangle)]
@@ -1891,8 +1881,6 @@ pub unsafe extern "C" fn processing_buffer_create_with_data(data: *const u8, len
         .unwrap_or(0)
 }
 
-/// Write data to a buffer.
-///
 /// # Safety
 /// - `data` must point to `len` valid bytes
 #[unsafe(no_mangle)]
@@ -1902,15 +1890,13 @@ pub unsafe extern "C" fn processing_buffer_write(buf_id: u64, data: *const u8, l
     error::check(|| buffer_write(Entity::from_bits(buf_id), bytes));
 }
 
-/// Returns the byte length of a buffer, or 0 if not found.
+/// returns the byte length of a buffer, or 0 if not found.
 #[unsafe(no_mangle)]
 pub extern "C" fn processing_buffer_size(buf_id: u64) -> u64 {
     error::clear_error();
     error::check(|| buffer_size(Entity::from_bits(buf_id))).unwrap_or(0)
 }
 
-/// Read buffer contents into a caller-provided buffer.
-///
 /// # Safety
 /// - `out` must be valid for writes of `out_len` bytes (may be null if
 ///   `out_len == 0`, in which case this acts as a size query).
@@ -1933,8 +1919,6 @@ pub extern "C" fn processing_buffer_destroy(buf_id: u64) {
     error::check(|| buffer_destroy(Entity::from_bits(buf_id)));
 }
 
-// Compute
-
 #[unsafe(no_mangle)]
 pub extern "C" fn processing_compute_create(shader_id: u64) -> u64 {
     error::clear_error();
@@ -1943,8 +1927,6 @@ pub extern "C" fn processing_compute_create(shader_id: u64) -> u64 {
         .unwrap_or(0)
 }
 
-/// Set a float property on a compute shader.
-///
 /// # Safety
 /// - `name` must be non-null
 #[unsafe(no_mangle)]

crates/processing_pyo3/examples/particles_emit.py

@@ -21,7 +21,7 @@ def setup():
         attributes=[Attribute.position(), Attribute.color()],
     )
 
-    # Park unemitted slots far off-screen until the ring buffer fills.
+    # park unemitted slots far off-screen until the ring buffer fills.
     pos_buf = p.buffer(Attribute.position())
     pos_buf.write([1.0e6] * (capacity * 3))
 
@@ -38,7 +38,6 @@ def draw():
     use_material(mat)
     particles(p, sphere)
 
-    # Emit 4 particles per frame in an outward-spiraling ring.
     burst = 4
     positions = []
     colors = []

crates/processing_pyo3/examples/particles_emit_gpu.py

@@ -148,7 +148,7 @@ def setup():
         ],
     )
 
-    # Park unemitted slots until the spawn kernel fills them.
+    # park unemitted slots until the spawn kernel fills them.
     dead_buf = p.buffer(Attribute.dead())
     dead_buf.write([1.0] * CAPACITY)
 

crates/processing_pyo3/examples/particles_lifecycle.py

@@ -74,7 +74,7 @@ def setup():
         attributes=[position_attr, color_attr, scale_attr, dead_attr, age_attr],
     )
 
-    # Park unemitted slots until the spawn loop fills them.
+    # park unemitted slots until the spawn loop fills them.
     dead_buf = p.buffer(dead_attr)
     dead_buf.write([1.0] * capacity)
 

crates/processing_pyo3/src/compute.rs

@@ -22,8 +22,7 @@ pub struct Buffer {
 }
 
 impl Buffer {
-    /// Wrap an existing buffer entity without taking ownership. `Drop` will
-    /// not destroy it.
+    /// borrowed wrapper: `Drop` will not destroy the underlying entity.
     pub(crate) fn from_entity(entity: Entity, element_type: Option<ShaderValue>) -> Self {
         let size = buffer_size(entity).unwrap_or(0);
         Self {
@@ -271,8 +270,6 @@ pub struct Compute {
 }
 
 impl Compute {
-    /// Wrap an existing compute entity (e.g., one created by a Rust-side
-    /// factory like `field_kernel_noise`). Not exposed to Python directly.
     pub(crate) fn from_entity(entity: Entity) -> Self {
         Self { entity }
     }

crates/processing_pyo3/src/graphics.rs

@@ -370,7 +370,6 @@ impl Geometry {
         geometry_vertex_count(self.entity).map_err(|e| PyRuntimeError::new_err(format!("{e}")))
     }
 
-    /// Retained sphere mesh.
     #[staticmethod]
     #[pyo3(signature = (radius, sectors=32, stacks=18))]
     pub fn sphere(radius: f32, sectors: u32, stacks: u32) -> PyResult<Self> {
@@ -379,18 +378,15 @@ impl Geometry {
         Ok(Self { entity })
     }
 
-    /// Retained box mesh.
     #[staticmethod]
     pub fn r#box(width: f32, height: f32, depth: f32) -> PyResult<Self> {
         let entity = geometry_box(width, height, depth)
             .map_err(|e| PyRuntimeError::new_err(format!("{e}")))?;
         Ok(Self { entity })
     }
 
-    /// 3D lattice of `nx * ny * nz` points centered at the origin, with
-    /// `spacing` units between adjacent points. Topology is `PointList` —
-    /// typically used as a position source for `Particles(geometry=...)` rather
-    /// than rasterized directly.
+    /// lattice centered at the origin; topology is `PointList`, intended as a
+    /// position source for `Particles(geometry=...)` rather than rasterized.
     #[staticmethod]
     #[pyo3(signature = (nx, ny, nz, spacing=1.0))]
     pub fn grid(nx: u32, ny: u32, nz: u32, spacing: f32) -> PyResult<Self> {

crates/processing_pyo3/src/lib.rs

@@ -12,7 +12,6 @@ pub(crate) mod color;
 pub(crate) mod compute;
 #[cfg(feature = "cuda")]
 pub(crate) mod cuda;
-pub(crate) mod particles;
 mod glfw;
 mod gltf;
 mod graphics;
@@ -21,6 +20,7 @@ pub(crate) mod material;
 pub(crate) mod math;
 mod midi;
 mod monitor;
+pub(crate) mod particles;
 pub(crate) mod shader;
 mod surface;
 mod time;
@@ -332,16 +332,8 @@ mod mewnala {
     #[pymodule_export]
     use super::Buffer;
     #[pymodule_export]
-    use super::color::PyColor;
-    #[pymodule_export]
     use super::Compute;
     #[pymodule_export]
-    use super::particles::Attribute;
-    #[pymodule_export]
-    use super::particles::AttributeFormat;
-    #[pymodule_export]
-    use super::particles::Particles;
-    #[pymodule_export]
     use super::Geometry;
     #[pymodule_export]
     use super::Gltf;
@@ -354,27 +346,35 @@ mod mewnala {
     #[pymodule_export]
     use super::Material;
     #[pymodule_export]
-    use super::math::PyQuat;
-    #[pymodule_export]
-    use super::math::PyVec2;
-    #[pymodule_export]
-    use super::math::PyVec3;
-    #[pymodule_export]
-    use super::math::PyVec4;
-    #[pymodule_export]
     use super::PyBlendMode;
     #[pymodule_export]
     use super::Sampler;
     #[pymodule_export]
     use super::Shader;
     #[pymodule_export]
     use super::Topology;
+    #[pymodule_export]
+    use super::color::PyColor;
     #[cfg(feature = "cuda")]
     #[pymodule_export]
     use super::cuda::CudaImage;
     #[pymodule_export]
+    use super::math::PyQuat;
+    #[pymodule_export]
+    use super::math::PyVec2;
+    #[pymodule_export]
+    use super::math::PyVec3;
+    #[pymodule_export]
+    use super::math::PyVec4;
+    #[pymodule_export]
     use super::monitor::Monitor;
     #[pymodule_export]
+    use super::particles::Attribute;
+    #[pymodule_export]
+    use super::particles::AttributeFormat;
+    #[pymodule_export]
+    use super::particles::Particles;
+    #[pymodule_export]
     use super::surface::Surface;
 
     // Stroke cap/join
@@ -1351,7 +1351,6 @@ mod mewnala {
         }
     }
 
-
     #[pyfunction]
     #[pyo3(pass_module, signature = (*args))]
     fn background(module: &Bound<'_, PyModule>, args: &Bound<'_, PyTuple>) -> PyResult<()> {

crates/processing_pyo3/src/material.rs

@@ -55,16 +55,18 @@ pub(crate) fn py_to_shader_value(value: &Bound<'_, PyAny>) -> PyResult<shader_va
     )))
 }
 
-// dispatch `albedo=` by python type; may swap the backing asset
 fn apply_albedo(entity: Entity, value: &Bound<'_, PyAny>) -> PyResult<()> {
     if let Ok(buf) = value.extract::<PyRef<Buffer>>() {
         return material_set_albedo_buffer(entity, buf.entity)
             .map_err(|e| PyRuntimeError::new_err(format!("{e}")));
     }
     if let Ok(c) = value.extract::<PyRef<PyColor>>() {
         let srgba: bevy::color::Srgba = c.0.into();
-        return material_set_albedo_color(entity, [srgba.red, srgba.green, srgba.blue, srgba.alpha])
-            .map_err(|e| PyRuntimeError::new_err(format!("{e}")));
+        return material_set_albedo_color(
+            entity,
+            [srgba.red, srgba.green, srgba.blue, srgba.alpha],
+        )
+        .map_err(|e| PyRuntimeError::new_err(format!("{e}")));
     }
     if let Ok(rgba) = value.extract::<[f32; 4]>() {
         return material_set_albedo_color(entity, rgba)
@@ -95,7 +97,6 @@ fn apply_kwargs(entity: Entity, kwargs: &Bound<'_, PyDict>) -> PyResult<()> {
 
 #[pymethods]
 impl Material {
-    /// No args: default PBR. With `shader`: custom material. Kwargs are applied via `set`.
     #[new]
     #[pyo3(signature = (shader=None, **kwargs))]
     pub fn new(shader: Option<&Shader>, kwargs: Option<&Bound<'_, PyDict>>) -> PyResult<Self> {
@@ -112,7 +113,6 @@ impl Material {
         Ok(Self { entity })
     }
 
-    /// PBR-lit material. `albedo` accepts a `Color` or a per-particle `Buffer`.
     #[staticmethod]
     #[pyo3(signature = (**kwargs))]
     pub fn pbr(kwargs: Option<&Bound<'_, PyDict>>) -> PyResult<Self> {
@@ -123,7 +123,6 @@ impl Material {
         Ok(Self { entity })
     }
 
-    /// Like `pbr` but skips lighting; albedo is the final output color.
     #[staticmethod]
     #[pyo3(signature = (**kwargs))]
     pub fn unlit(kwargs: Option<&Bound<'_, PyDict>>) -> PyResult<Self> {
@@ -136,7 +135,6 @@ impl Material {
         Ok(Self { entity })
     }
 
-    /// Set material properties. `albedo` may swap the backing asset; other fields are preserved.
     #[pyo3(signature = (**kwargs))]
     pub fn set(&self, kwargs: Option<&Bound<'_, PyDict>>) -> PyResult<()> {
         let Some(kwargs) = kwargs else {