Complete Rust API and migration documentation (#102)

crates/libremetaverse-rendering-simple/src/generated.rs

@@ -6,13 +6,24 @@
 #![allow(non_snake_case)]
 
 /// C# type: `T:LibreMetaverse.Rendering.SimpleRenderer`.
+///
+/// Native Rust mapping of C# `LibreMetaverse.Rendering.SimpleRenderer` using decision
+/// `native_metacrate_type`. See the [pinned C# source](https://github.com/cinderblocks/libremetaverse/tree/2aa70bb68513b39795da5d13c88f31b86e85a3ba).
 pub use crate::simple_renderer::SimpleRenderer;
 impl SimpleRenderer {
     /// C# member: `M:LibreMetaverse.Rendering.SimpleRenderer.#ctor`.
+    ///
+    /// C# signature: `LibreMetaverse.Rendering.SimpleRenderer()`.
+    /// Mapping contract: ownership `none`; async `sync`;
+    /// errors `Result<_, crate::Error>`; overload `direct_snake_case`; kind `method`.
     pub fn new() -> Result<Self, crate::Error> {
         Self::native_new()
     }
     /// C# member: `M:LibreMetaverse.Rendering.SimpleRenderer.GenerateFacetedMesh(LibreMetaverse.Primitive,LibreMetaverse.Rendering.DetailLevel)`.
+    ///
+    /// C# signature: `LibreMetaverse.Rendering.FacetedMesh LibreMetaverse.Rendering.SimpleRenderer.GenerateFacetedMesh(LibreMetaverse.Primitive prim, LibreMetaverse.Rendering.DetailLevel lod)`.
+    /// Mapping contract: ownership `shared_self,owned,owned`; async `sync`;
+    /// errors `Result<_, crate::Error>`; overload `direct_snake_case`; kind `method`.
     pub fn generate_faceted_mesh(
         &self,
         prim: libremetaverse::Primitive,
@@ -21,6 +32,10 @@ impl SimpleRenderer {
         self.native_generate_faceted_mesh(prim, lod)
     }
     /// C# member: `M:LibreMetaverse.Rendering.SimpleRenderer.GenerateFacetedSculptMesh(LibreMetaverse.Primitive,LibreMetaverse.Imaging.ManagedImage,LibreMetaverse.Rendering.DetailLevel)`.
+    ///
+    /// C# signature: `LibreMetaverse.Rendering.FacetedMesh LibreMetaverse.Rendering.SimpleRenderer.GenerateFacetedSculptMesh(LibreMetaverse.Primitive prim, LibreMetaverse.Imaging.ManagedImage sculptTexture, LibreMetaverse.Rendering.DetailLevel lod)`.
+    /// Mapping contract: ownership `shared_self,owned,owned,owned`; async `sync`;
+    /// errors `Result<_, crate::Error>`; overload `direct_snake_case`; kind `method`.
     pub fn generate_faceted_sculpt_mesh(
         &self,
         prim: libremetaverse::Primitive,
@@ -30,6 +45,10 @@ impl SimpleRenderer {
         self.native_generate_faceted_sculpt_mesh(prim, sculpt_texture, lod)
     }
     /// C# member: `M:LibreMetaverse.Rendering.SimpleRenderer.GenerateSimpleMesh(LibreMetaverse.Primitive,LibreMetaverse.Rendering.DetailLevel)`.
+    ///
+    /// C# signature: `LibreMetaverse.Rendering.SimpleMesh LibreMetaverse.Rendering.SimpleRenderer.GenerateSimpleMesh(LibreMetaverse.Primitive prim, LibreMetaverse.Rendering.DetailLevel lod)`.
+    /// Mapping contract: ownership `shared_self,owned,owned`; async `sync`;
+    /// errors `Result<_, crate::Error>`; overload `direct_snake_case`; kind `method`.
     pub fn generate_simple_mesh(
         &self,
         prim: libremetaverse::Primitive,
@@ -38,6 +57,10 @@ impl SimpleRenderer {
         self.native_generate_simple_mesh(prim, lod)
     }
     /// C# member: `M:LibreMetaverse.Rendering.SimpleRenderer.GenerateSimpleSculptMesh(LibreMetaverse.Primitive,LibreMetaverse.Imaging.ManagedImage,LibreMetaverse.Rendering.DetailLevel)`.
+    ///
+    /// C# signature: `LibreMetaverse.Rendering.SimpleMesh LibreMetaverse.Rendering.SimpleRenderer.GenerateSimpleSculptMesh(LibreMetaverse.Primitive prim, LibreMetaverse.Imaging.ManagedImage sculptTexture, LibreMetaverse.Rendering.DetailLevel lod)`.
+    /// Mapping contract: ownership `shared_self,owned,owned,owned`; async `sync`;
+    /// errors `Result<_, crate::Error>`; overload `direct_snake_case`; kind `method`.
     pub fn generate_simple_sculpt_mesh(
         &self,
         prim: libremetaverse::Primitive,
@@ -47,6 +70,10 @@ impl SimpleRenderer {
         self.native_generate_simple_sculpt_mesh(prim, sculpt_texture, lod)
     }
     /// C# member: `M:LibreMetaverse.Rendering.SimpleRenderer.TransformTexCoords(System.Collections.Generic.List{LibreMetaverse.Rendering.Vertex},LibreMetaverse.Vector3,LibreMetaverse.Primitive.TextureEntryFace,LibreMetaverse.Vector3)`.
+    ///
+    /// C# signature: `System.Void LibreMetaverse.Rendering.SimpleRenderer.TransformTexCoords(System.Collections.Generic.List<LibreMetaverse.Rendering.Vertex> vertices, LibreMetaverse.Vector3 center, LibreMetaverse.Primitive.TextureEntryFace teFace, LibreMetaverse.Vector3 primScale)`.
+    /// Mapping contract: ownership `shared_self,mutable_borrow,owned,owned,owned`; async `sync`;
+    /// errors `Result<_, crate::Error>`; overload `direct_snake_case`; kind `method`.
     pub fn transform_tex_coords(
         &self,
         vertices: &mut Vec<libremetaverse::rendering::Vertex>,

crates/libremetaverse-rendering-simple/src/lib.rs

@@ -1,7 +1,7 @@
 //! Deterministic reference rendering for legacy prims and decoded sculpt maps.
 //!
 //! [`SimpleRenderer`] converts checked `PrimMesher` geometry into the shared
-//! rendering types without a graphics backend. See the crate README for the
+//! rendering types without a graphics backend. See the crate `README` for the
 //! supported topology, resource bounds, and mesh-asset boundary.
 
 extern crate self as libremetaverse_rendering_simple;