Sync back some Render Engine Stuff and cleanup

Author: LoneWandererProductions

Core.StateExecutive.Builder/ExecutiveState.cs

@@ -2,7 +2,7 @@
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     Core.StateExecutive.Builder
  * FILE:        ExecutiveState.cs
- * PURPOSE:     Your file purpose here
+ * PURPOSE:     State of the State Executive Engine. Each state has a unique ID and a list of transitions to other states.
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
 
@@ -12,7 +12,7 @@ namespace Core.StateExecutive.Builder
 {
     /// <inheritdoc />
     /// <summary>
-    /// Stat eof the State Executive Engine. Each state has a unique ID and a list of transitions to other states.
+    /// State of the State Executive Engine. Each state has a unique ID and a list of transitions to other states.
     /// </summary>
     /// <seealso cref="Core.StateExecutive.Interfaces.IState" />
     internal sealed class ExecutiveState : IState

RenderEngine/ColumnData.cs

@@ -272,4 +272,4 @@ public void Dispose()
             GC.SuppressFinalize(this);
         }
     }
-}
+}

RenderEngine/CoordinateData.cs

@@ -1,8 +1,8 @@
-/*
+/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     RenderEngine
  * FILE:        Geometry2DBuilder.cs
- * PURPOSE:     Your file purpose here
+ * PURPOSE:     Builder for 2D geometry vertex buffers.
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
 
@@ -16,6 +16,11 @@ namespace RenderEngine
     /// </summary>
     internal static class Geometry2DBuilder
     {
+        /// <summary>
+        /// Builds the colored lines.
+        /// </summary>
+        /// <param name="points">The points.</param>
+        /// <returns>Array of floats representing the colored lines.</returns>
         internal static float[] BuildColoredLines(
             (float x, float y, int r, int g, int b, int a)[] points)
         {
@@ -34,6 +39,15 @@ internal static float[] BuildColoredLines(
             return data;
         }
 
+        /// <summary>
+        /// Builds the solid quad.
+        /// </summary>
+        /// <param name="p0">The p0.</param>
+        /// <param name="p1">The p1.</param>
+        /// <param name="p2">The p2.</param>
+        /// <param name="p3">The p3.</param>
+        /// <param name="fill">The fill.</param>
+        /// <returns>Array of floats representing a solid quad.</returns>
         internal static float[] BuildSolidQuad(
             (int x, int y) p0,
             (int x, int y) p1,
@@ -53,6 +67,13 @@ internal static float[] BuildSolidQuad(
             };
         }
 
+        /// <summary>
+        /// Builds the colored triangle.
+        /// </summary>
+        /// <param name="p0">The p0.</param>
+        /// <param name="p1">The p1.</param>
+        /// <param name="p2">The p2.</param>
+        /// <returns>Array of floats representing a colored triangle.</returns>
         public static float[] BuildColoredTriangle(
             (float x, float y, int r, int g, int b, int a) p0,
             (float x, float y, int r, int g, int b, int a) p1,
@@ -66,6 +87,14 @@ public static float[] BuildColoredTriangle(
             };
         }
 
+        /// <summary>
+        /// Builds the textured quad.
+        /// </summary>
+        /// <param name="p0">The p0.</param>
+        /// <param name="p1">The p1.</param>
+        /// <param name="p2">The p2.</param>
+        /// <param name="p3">The p3.</param>
+        /// <returns>Array of floats representing a textured quad.</returns>
         public static float[] BuildTexturedQuad(
             (int x, int y) p0,
             (int x, int y) p1,
@@ -79,6 +108,12 @@ public static float[] BuildTexturedQuad(
             };
         }
 
+        /// <summary>
+        /// Builds the polyline.
+        /// </summary>
+        /// <param name="points">The points.</param>
+        /// <param name="color">The color.</param>
+        /// <returns>Array of floats representing a polyline.</returns>
         internal static (float x, float y, int r, int g, int b, int a)[] BuildPolyline(
             ReadOnlySpan<(float x, float y)> points,
             (int r, int g, int b, int a) color)
@@ -98,6 +133,15 @@ internal static (float x, float y, int r, int g, int b, int a)[] BuildPolyline(
             return data;
         }
 
+        /// <summary>
+        /// Builds the rect outline.
+        /// </summary>
+        /// <param name="x">The x.</param>
+        /// <param name="y">The y.</param>
+        /// <param name="w">The w.</param>
+        /// <param name="h">The h.</param>
+        /// <param name="color">The color.</param>
+        /// <returns>Array of floats representing a rectangle outline.</returns>
         public static (float x, float y, int r, int g, int b, int a)[]
             BuildRectOutline(
                 float x, float y,
@@ -110,6 +154,15 @@ public static (float x, float y, int r, int g, int b, int a)[]
         }
 
 
+        /// <summary>
+        /// Builds the circle outline.
+        /// </summary>
+        /// <param name="cx">The cx.</param>
+        /// <param name="cy">The cy.</param>
+        /// <param name="radius">The radius.</param>
+        /// <param name="segments">The segments.</param>
+        /// <param name="color">The color.</param>
+        /// <returns>Array of floats representing a circle outline.</returns>
         internal static (float x, float y, int r, int g, int b, int a)[] BuildCircleOutline(
             float cx, float cy,
             float radius,

RenderEngine/GLResourceManager.cs

@@ -187,4 +187,4 @@ public int[] CompositeToBits()
             }
         }
     }
-}
+}

RenderEngine/Geometry2DBuilder.cs

@@ -62,4 +62,4 @@ public interface IImageToolkit
     /// <param name="layerIndices">The layer indices.</param>
     /// <param name="insertAt">The insert at.</param>
     void MergeLayers(LayeredImageContainer container, int[] layerIndices, int insertAt);
-}
+}

RenderEngine/ImageToolkit.cs

@@ -234,4 +234,4 @@ private static unsafe void AlphaBlend(Span<byte> baseSpan, Span<byte> overlaySpa
             }
         }
     }
-}
+}

RenderEngine/Interfaces/IImageToolkit.cs

@@ -23,6 +23,9 @@ namespace RenderEngine
     /// </summary>
     public static class OpenTkHelper
     {
+        /// <summary>
+        /// The gl version
+        /// </summary>
         private static Version? _glVersion;
 
         /// <summary>
@@ -197,7 +200,11 @@ internal static int LoadTextureFromFile(string filePath)
         /// Loads a cubemap texture from six image files.
         /// </summary>
         /// <param name="filePaths">Array of six image file paths in cubemap order.</param>
-        /// <returns>OpenGL cubemap texture ID.</returns>
+        /// <returns>
+        /// OpenGL cubemap texture ID.
+        /// </returns>
+        /// <exception cref="System.ArgumentException">Cube map must have exactly 6 textures. - filePaths</exception>
+        /// <exception cref="System.IO.FileNotFoundException">Cubemap texture not found: {filePaths[i]}</exception>
         /// <exception cref="ArgumentException">Thrown if array length is not 6.</exception>
         internal static int LoadCubeMap(string[] filePaths)
         {
@@ -263,6 +270,11 @@ internal static int LoadCubeMap(string[] filePaths)
         /// Checks if the system supports at least the given OpenGL version.
         /// Caches the result to avoid repeated GLContext queries.
         /// </summary>
+        /// <param name="requiredMajor">The required major.</param>
+        /// <param name="requiredMinor">The required minor.</param>
+        /// <returns>
+        ///   <c>true</c> if [is open gl compatible] [the specified required major]; otherwise, <c>false</c>.
+        /// </returns>
         internal static bool IsOpenGlCompatible(int requiredMajor = 4, int requiredMinor = 5)
         {
             if (_glVersion == null)