fix docu

Author: LoneWandererProductions

RenderEngine/Simple3DRenderer.cs

@@ -13,29 +13,81 @@
 
 namespace RenderEngine
 {
+    /// <summary>
+    /// 3D Renderer that supports drawing solid colored triangles, textured triangles, and sprites (billboards).
+    /// It uses OpenGL 4.5 and OpenTK for rendering. The renderer manages its own shaders and buffers, and provides a simple API for drawing primitives and flushing batches.
+    /// </summary>
+    /// <seealso cref="System.IDisposable" />
     public sealed class Simple3DRenderer : IDisposable
     {
+        /// <summary>
+        /// Gets the width.
+        /// </summary>
+        /// <value>
+        /// The width.
+        /// </value>
         public int Width { get; private set; }
+
+        /// <summary>
+        /// Gets the height.
+        /// </summary>
+        /// <value>
+        /// The height.
+        /// </value>
         public int Height { get; private set; }
+
+        /// <summary>
+        /// The resource Manager, used to load shaders and textures. The renderer does not own the resources, it only uses them.
+        /// </summary>
         private readonly GlResourceManager _resources;
 
         private int _vaoSolid, _vboSolid, _vaoTex, _vboTex;
+
         private int _shaderSolid, _shaderTex;
+
+        /// <summary>
+        /// The initialized
+        /// </summary>
         private bool _initialized;
+
         private int _vboSolidCapacity = 16384, _vboTexCapacity = 16384;
 
+        /// <summary>
+        /// The projection
+        /// </summary>
         private TK.Matrix4 _projection;
+
+        /// <summary>
+        /// The view
+        /// </summary>
         private TK.Matrix4 _view;
 
+        /// <summary>
+        /// Gets the view matrix.
+        /// </summary>
+        /// <value>
+        /// The view matrix.
+        /// </value>
         public TK.Matrix4 ViewMatrix => _view;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Simple3DRenderer"/> class.
+        /// </summary>
+        /// <param name="width">The width.</param>
+        /// <param name="height">The height.</param>
+        /// <param name="resources">The resources.</param>
         public Simple3DRenderer(int width, int height, GlResourceManager resources)
         {
             _resources = resources;
             UpdateProjection(width, height);
             SetCamera(new Vector3(8, 15, 25), new Vector3(8, 0, 8), Vector3.UnitY);
         }
 
+        /// <summary>
+        /// Updates the projection.
+        /// </summary>
+        /// <param name="width">The width.</param>
+        /// <param name="height">The height.</param>
         public void UpdateProjection(int width, int height)
         {
             if (width <= 0) width = 1;
@@ -45,6 +97,12 @@ public void UpdateProjection(int width, int height)
             _projection = TK.Matrix4.CreatePerspectiveFieldOfView(TK.MathHelper.DegreesToRadians(45f), aspect, 0.1f, 1000f);
         }
 
+        /// <summary>
+        /// Sets the camera.
+        /// </summary>
+        /// <param name="position">The position.</param>
+        /// <param name="target">The target.</param>
+        /// <param name="up">Up.</param>
         public void SetCamera(Vector3 position, Vector3 target, Vector3 up)
         {
             // Convert System.Numerics to OpenTK here using the extension or manual copy
@@ -54,6 +112,9 @@ public void SetCamera(Vector3 position, Vector3 target, Vector3 up)
                 new TK.Vector3(up.X, up.Y, up.Z));
         }
 
+        /// <summary>
+        /// Ensures the initialized.
+        /// </summary>
         private void EnsureInitialized()
         {
             if (_initialized) return;
@@ -81,7 +142,14 @@ private void EnsureInitialized()
             _initialized = true;
         }
 
-        // --- FIXED SIGNATURES ---
+        // --- SIGNATURES ---
+        /// <summary>
+        /// Draws the triangle.
+        /// </summary>
+        /// <param name="v0">The v0.</param>
+        /// <param name="v1">The v1.</param>
+        /// <param name="v2">The v2.</param>
+        /// <param name="color">The color.</param>
         public void DrawTriangle(Vector3 v0, Vector3 v1, Vector3 v2, (int r, int g, int b, int a) color)
         {
             EnsureInitialized();
@@ -95,6 +163,16 @@ public void DrawTriangle(Vector3 v0, Vector3 v1, Vector3 v2, (int r, int g, int
             GL.DrawArrays(PrimitiveType.Triangles, 0, 3);
         }
 
+        /// <summary>
+        /// Draws the textured triangle.
+        /// </summary>
+        /// <param name="v0">The v0.</param>
+        /// <param name="uv0">The uv0.</param>
+        /// <param name="v1">The v1.</param>
+        /// <param name="uv1">The uv1.</param>
+        /// <param name="v2">The v2.</param>
+        /// <param name="uv2">The uv2.</param>
+        /// <param name="textureId">The texture identifier.</param>
         public void DrawTexturedTriangle(Vector3 v0, Vector2 uv0, Vector3 v1, Vector2 uv1, Vector3 v2, Vector2 uv2, int textureId)
         {
             EnsureInitialized();
@@ -108,6 +186,12 @@ public void DrawTexturedTriangle(Vector3 v0, Vector2 uv0, Vector3 v1, Vector2 uv
             GL.DrawArrays(PrimitiveType.Triangles, 0, 3);
         }
 
+        /// <summary>
+        /// Draws the sprite.
+        /// </summary>
+        /// <param name="position">The position.</param>
+        /// <param name="radius">The radius.</param>
+        /// <param name="textureId">The texture identifier.</param>
         public void DrawSprite(Vector3 position, float radius, int textureId)
         {
             EnsureInitialized();
@@ -130,6 +214,10 @@ public void DrawSprite(Vector3 position, float radius, int textureId)
             GL.DrawArrays(PrimitiveType.Triangles, 0, 6);
         }
 
+        /// <summary>
+        /// Flushes the specified batch.
+        /// </summary>
+        /// <param name="batch">The batch.</param>
         public unsafe void Flush(RenderBatch batch)
         {
             EnsureInitialized();
@@ -160,14 +248,29 @@ public unsafe void Flush(RenderBatch batch)
             GL.BindVertexArray(0);
         }
 
+        /// <summary>
+        /// Uploads the matrices.
+        /// </summary>
+        /// <param name="shader">The shader.</param>
+        /// <param name="model">The model.</param>
         private void UploadMatrices(int shader, ref TK.Matrix4 model)
         {
             GL.UniformMatrix4(GL.GetUniformLocation(shader, "model"), false, ref model);
             GL.UniformMatrix4(GL.GetUniformLocation(shader, "view"), false, ref _view);
             GL.UniformMatrix4(GL.GetUniformLocation(shader, "projection"), false, ref _projection);
         }
 
+        /// <summary>
+        /// Ensures the buffer capacity.
+        /// </summary>
+        /// <param name="vbo">The vbo.</param>
+        /// <param name="cap">The cap.</param>
+        /// <param name="req">The req.</param>
         private void EnsureBufferCapacity(int vbo, ref int cap, int req) { if (req <= cap) return; while (cap < req) cap *= 2; GL.BindBuffer(BufferTarget.ArrayBuffer, vbo); GL.BufferData(BufferTarget.ArrayBuffer, cap * sizeof(float), IntPtr.Zero, BufferUsageHint.DynamicDraw); }
+        
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
         public void Dispose() { if (!_initialized) return; GL.DeleteBuffer(_vboSolid); GL.DeleteVertexArray(_vaoSolid); GL.DeleteBuffer(_vboTex); GL.DeleteVertexArray(_vaoTex); }
     }
 }