Update method names for Game, add documentation for renderers, remove position argument from DrawSdfText and DrawDebugText in Renderer.

Source/Rendering/Renderer.cs

@@ -2,22 +2,47 @@ using System.Numerics;
 
 namespace DaggerFramework.Rendering
 {
+    /// <summary>
+    /// An abstract class representing the graphics renderer.
+    /// </summary>
     public abstract class Renderer
     {
         // INIT
+        /// <summary>
+        /// Creates the renderer window and initializes internal resources.
+        /// </summary>
+        /// <param name="windowSettings">Settings for the rendering window.</param>
+        /// <param name="renderSettings">Rendering settings.</param>
         public abstract void CreateAndInitialize(WindowSettings windowSettings, RendererSettings renderSettings);
+        /// <summary>
+        /// Initializes internal resources. Should be called before other methods.
+        /// </summary>
+        /// <param name="settings">Rendering settings.</param>
         public abstract void Initialize(RendererSettings settings);
 
         // UTIL
+        /// <summary>
+        /// Indicates if the renderer will render the next frame.
+        /// </summary>
         public abstract bool ShouldRun { get; }
 
         // WINDOW
+        /// <summary>
+        /// The size of the render window.
+        /// </summary>
         public abstract Vector2 WindowSize { get; }
+        /// <summary>
+        /// Creates the window with a given title and size.
+        /// </summary>
+        /// <param name="title">Title of the window.</param>
+        /// <param name="size">Vector2 representing size.</param>
         public abstract void CreateWindow(string title, Vector2 size);
         public void CreateWindow(WindowSettings windowSettings)
         {
             CreateWindow(windowSettings.Title, windowSettings.Size);
         }
+
+        // TODO: use properties for these.
         public abstract void SetWindowTitle(string title);
         public abstract void SetWindowVSync(bool value);
         public abstract void SetTargetFps(int fps);
@@ -25,17 +50,70 @@ namespace DaggerFramework.Rendering
         public abstract void Shutdown();
 
         // DRAWING
+        /// <summary>
+        /// Prepares the renderer for drawing the next frame.
+        /// </summary>
         public abstract void BeginFrame();
+        /// <summary>
+        /// Ends rendering of the frame.
+        /// </summary>
         public abstract void EndFrame();
+        /// <summary>
+        /// Clears the render canvas and sets a background color.
+        /// </summary>
+        /// <param name="color">Background color.</param>
         public abstract void ClearBackground(Color color);
         public abstract double GetFrameTime();
+
+        /// <summary>
+        /// Loads the texture onto the GPU for later use in DrawTexture or other Texture related methods.
+        /// </summary>
+        /// <param name="texture">Texture to load.</param>
+        /// <returns>A texture handler on the GPU.</returns>
         public abstract int LoadTexture(Texture2d texture);
+        /// <summary>
+        /// Sets transforms for the next draw operation.
+        /// </summary>
+        /// <param name="position">Global transform position.</param>
+        /// <param name="rotation">Rotation.</param>
         public abstract void SetTransform(Vector2 position, float rotation = 0.0f);
+        /// <summary>
+        /// Sets the transform for the next draw operation.
+        /// </summary>
+        /// <param name="transform">Transform matrix.</param>
         public abstract void SetTransform(Matrix4x4 transform);
+        /// <summary>
+        /// Draws a filled circle.
+        /// </summary>
+        /// <param name="radius">Radius of a circle.</param>
+        /// <param name="color">Fill color.</param>
         public abstract void DrawCircle(float radius, Color color);
+        /// <summary>
+        /// Draws a filled rectangle.
+        /// </summary>
+        /// <param name="size">Rectangle size.</param>
+        /// <param name="color">Fill color.</param>
         public abstract void DrawRectangle(Vector2 size, Color color);
-        public abstract void DrawDebugText(Vector2 position, string text, int fontSize, Color color);
-        public abstract void DrawSdfText(Vector2 position, string text, int fontSize, Color color);
+        /// <summary>
+        /// Draws a debug text with a default font.
+        /// </summary>
+        /// <param name="position"></param>
+        /// <param name="text"></param>
+        /// <param name="fontSize"></param>
+        /// <param name="color"></param>
+        public abstract void DrawDebugText(string text, int fontSize, Color color);
+        /// <summary>
+        /// Draws text using a signed distance field font atlas.
+        /// </summary>
+        /// <param name="text">Text to draw.</param>
+        /// <param name="fontSize">Size of the font.</param>
+        /// <param name="color">Color of the text.</param>
+        public abstract void DrawSdfText(string text, int fontSize, Color color);
+        /// <summary>
+        /// Draws the texture.
+        /// </summary>
+        /// <param name="id">Texture handle.</param>
+        /// <param name="tint">Texture tint.</param>
         public abstract void DrawTexture(int id, Color tint);
     }