Docs.

Author: tychedelia

crates/processing_pyo3/src/graphics.rs

@@ -807,13 +807,25 @@ impl Graphics {
             .map_err(|e| PyRuntimeError::new_err(format!("{e}")))
     }
 
+    /// Loads an image from a file and returns an Image object.
+    ///
+    /// The path is relative to the sketch's assets directory.
     pub fn load_image(&self, file: &str) -> PyResult<Image> {
         match image_load(file) {
             Ok(image) => Ok(Image { entity: image }),
             Err(e) => Err(PyRuntimeError::new_err(format!("{e}"))),
         }
     }
 
+    /// Draws an image to the screen.
+    ///
+    /// Optional `d_width` and `d_height` resize the image on screen. If omitted,
+    /// the image's original dimensions are used.
+    ///
+    /// Optional `sx`, `sy`, `s_width`, and `s_height` define a sub-region
+    /// of the source image to draw, specified in pixels.
+    ///
+    /// Affected by `image_mode()`, `tint()`, and the current transform.
     #[pyo3(signature = (source, dx, dy, d_width=None, d_height=None, sx=None, sy=None, s_width=None, s_height=None))]
     pub fn image(
         &self,
@@ -844,6 +856,10 @@ impl Graphics {
         .map_err(|e| PyRuntimeError::new_err(format!("{e}")))
     }
 
+    /// Sets a tint color applied when drawing images.
+    ///
+    /// Accepts the same color arguments as `fill()`. The tint is multiplied
+    /// with the image's pixel colors. Use `no_tint()` to remove.
     #[pyo3(signature = (*args))]
     pub fn tint(&self, args: &Bound<'_, PyTuple>) -> PyResult<()> {
         let color = extract_color_with_mode(
@@ -855,11 +871,17 @@ impl Graphics {
             .map_err(|e| PyRuntimeError::new_err(format!("{e}")))
     }
 
+    /// Removes the current tint color so images draw without color modification.
     pub fn no_tint(&self) -> PyResult<()> {
         graphics_record_command(self.entity, DrawCommand::NoTint)
             .map_err(|e| PyRuntimeError::new_err(format!("{e}")))
     }
 
+    /// Changes how image position arguments are interpreted.
+    ///
+    /// - `CORNER` (default) — `dx`, `dy` is the top-left corner.
+    /// - `CORNERS` — `dx`, `dy` and `d_width`, `d_height` are opposite corners.
+    /// - `CENTER` — `dx`, `dy` is the center of the image.
     pub fn image_mode(&self, mode: u8) -> PyResult<()> {
         graphics_record_command(
             self.entity,

crates/processing_pyo3/src/lib.rs

@@ -1376,6 +1376,7 @@ mod mewnala {
         graphics!(module).rect(x, y, w, h, tl, tr, br, bl)
     }
 
+    /// Loads an image from a file and returns an Image object.
     #[pyfunction]
     #[pyo3(pass_module, signature = (image_file))]
     fn load_image(module: &Bound<'_, PyModule>, image_file: &str) -> PyResult<Image> {
@@ -1384,6 +1385,11 @@ mod mewnala {
         graphics.load_image(image_file)
     }
 
+    /// Draws an image to the screen.
+    ///
+    /// Optional `d_width`/`d_height` resize on screen; defaults to the image's
+    /// original dimensions. Optional `sx`/`sy`/`s_width`/`s_height` select a
+    /// sub-region of the source image in pixels.
     #[pyfunction]
     #[pyo3(pass_module, signature = (source, dx, dy, d_width=None, d_height=None, sx=None, sy=None, s_width=None, s_height=None))]
     #[allow(clippy::too_many_arguments)]
@@ -1402,18 +1408,25 @@ mod mewnala {
         graphics!(module).image(source, dx, dy, d_width, d_height, sx, sy, s_width, s_height)
     }
 
+    /// Sets a tint color applied when drawing images.
     #[pyfunction]
     #[pyo3(pass_module, signature = (*args))]
     fn tint(module: &Bound<'_, PyModule>, args: &Bound<'_, PyTuple>) -> PyResult<()> {
         graphics!(module).tint(args)
     }
 
+    /// Removes the current tint so images draw without color modification.
     #[pyfunction]
     #[pyo3(pass_module)]
     fn no_tint(module: &Bound<'_, PyModule>) -> PyResult<()> {
         graphics!(module).no_tint()
     }
 
+    /// Changes how image position arguments are interpreted.
+    ///
+    /// - `CORNER` (default) — `dx`, `dy` is the top-left corner.
+    /// - `CENTER` — `dx`, `dy` is the center.
+    /// - `CORNERS` — `dx`, `dy` and `d_width`, `d_height` are opposite corners.
     #[pyfunction]
     #[pyo3(pass_module)]
     fn image_mode(module: &Bound<'_, PyModule>, mode: u8) -> PyResult<()> {