Add XML documentation to Ryujinx.Graphics.Gpu.Image

1 files changed, 33 insertions, 5 deletions

diff --git a/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs b/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs
index a728c66e..4f73bfa8 100644
--- a/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs
+++ b/Ryujinx.Graphics.Gpu/Image/FormatInfo.cs
@@ -2,20 +2,48 @@ using Ryujinx.Graphics.GAL;
 
 namespace Ryujinx.Graphics.Gpu.Image
 {
+    /// <summary>
+    /// Represents texture format information.
+    /// </summary>
     struct FormatInfo
     {
-        private static FormatInfo _rgba8 = new FormatInfo(Format.R8G8B8A8Unorm, 1, 1, 4);
-
-        public static FormatInfo Default => _rgba8;
+        /// <summary>
+        /// A default, generic RGBA8 texture format.
+        /// </summary>
+        public static FormatInfo Default { get; } = new FormatInfo(Format.R8G8B8A8Unorm, 1, 1, 4);
 
+        /// <summary>
+        /// The format of the texture data.
+        /// </summary>
         public Format Format { get; }
 
-        public int BlockWidth    { get; }
-        public int BlockHeight   { get; }
+        /// <summary>
+        /// The block width for compressed formats. Must be 1 for non-compressed formats.
+        /// </summary>
+        public int BlockWidth { get; }
+
+        /// <summary>
+        /// The block height for compressed formats. Must be 1 for non-compressed formats.
+        /// </summary>
+        public int BlockHeight { get; }
+
+        /// <summary>
+        /// The number of bytes occupied by a single pixel in memory of the texture data.
+        /// </summary>
         public int BytesPerPixel { get; }
 
+        /// <summary>
+        /// Whenever or not the texture format is a compressed format. Determined from block size.
+        /// </summary>
         public bool IsCompressed => (BlockWidth | BlockHeight) != 1;
 
+        /// <summary>
+        /// Constructs the texture format info structure.
+        /// </summary>
+        /// <param name="format">The format of the texture data</param>
+        /// <param name="blockWidth">The block width for compressed formats. Must be 1 for non-compressed formats</param>
+        /// <param name="blockHeight">The block height for compressed formats. Must be 1 for non-compressed formats</param>
+        /// <param name="bytesPerPixel">The number of bytes occupied by a single pixel in memory of the texture data</param>
         public FormatInfo(
             Format format,
             int    blockWidth,