Added Summeries

SMCode/SM.OGL/Framebuffer/ColorAttachment.cs

@@ -14,7 +14,7 @@ namespace SM.OGL.Framebuffer
     /// </summary>
     public class ColorAttachment : TextureBase
     {
-        private int _multisamples;
+        private readonly int _multisamples;
         
         /// <summary>
         /// The ID the attachment was given.
@@ -50,6 +50,12 @@ namespace SM.OGL.Framebuffer
         public ColorAttachment(int attachmentId) : this(attachmentId, PixelInformation.RGBA_LDR)
         { }
 
+        /// <summary>
+        /// Creates a color attachment with a specific id, specific pixel informations and multisamples.
+        /// </summary>
+        /// <param name="attachmentID"></param>
+        /// <param name="pixelInformation"></param>
+        /// <param name="multisamples"></param>
         public ColorAttachment(int attachmentID, PixelInformation pixelInformation, int multisamples = 0)
         {
             AttachmentID = attachmentID;

SMCode/SM.OGL/Framebuffer/Framebuffer.cs

@@ -14,6 +14,7 @@ namespace SM.OGL.Framebuffer
     /// </summary>
     public class Framebuffer : GLObject
     {
+        /// <inheritdoc />
         protected override bool AutoCompile { get; set; } = true;
 
         /// <summary>
@@ -25,8 +26,8 @@ namespace SM.OGL.Framebuffer
             CanCompile = false,
         };
         
-        private IFramebufferWindow _window;
-        private float _windowScale;
+        private readonly IFramebufferWindow _window;
+        private readonly float _windowScale;
 
         /// <inheritdoc />
         public override ObjectLabelIdentifier TypeIdentifier { get; } = ObjectLabelIdentifier.Framebuffer;
@@ -42,6 +43,9 @@ namespace SM.OGL.Framebuffer
         public Dictionary<string, ColorAttachment> ColorAttachments { get; private set; } =
             new Dictionary<string, ColorAttachment>();
 
+        /// <summary>
+        /// Contains the current renderbuffer attachments of the framebuffer.
+        /// </summary>
         public List<RenderbufferAttachment> RenderbufferAttachments { get; } = new List<RenderbufferAttachment>();
 
         /// <summary>
@@ -131,6 +135,10 @@ namespace SM.OGL.Framebuffer
             ColorAttachments.Add(key, value);
         }
 
+        /// <summary>
+        /// Appends a renderbuffer attachment to the framebuffer.
+        /// </summary>
+        /// <param name="attachment"></param>
         public void AppendRenderbuffer(RenderbufferAttachment attachment)
         {
             RenderbufferAttachments.Add(attachment);
@@ -173,6 +181,11 @@ namespace SM.OGL.Framebuffer
             GL.Clear(clear);
         }
 
+        /// <summary>
+        /// Returns a <see cref="Framebuffer"/> handle of the current framebuffer.
+        /// </summary>
+        /// <param name="target"></param>
+        /// <returns></returns>
         public static Framebuffer GetCurrentlyActive(FramebufferTarget target = FramebufferTarget.Framebuffer)
         {
             Framebuffer buffer = new Framebuffer()

SMCode/SM.OGL/Framebuffer/IFramebufferWindow.cs

@@ -5,7 +5,13 @@
     /// </summary>
     public interface IFramebufferWindow
     {
+        /// <summary>
+        /// The width of the window.
+        /// </summary>
         int Width { get; }
+        /// <summary>
+        /// The height of the window.
+        /// </summary>
         int Height { get; }
     }
 }