Added doc comments

Author: DarthAffe

ScreenCapture/DirectX/DX11ScreenCapture.cs

@@ -3,7 +3,6 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Threading;
-using ScreenCapture.Events;
 using SharpGen.Runtime;
 using Vortice.Direct3D;
 using Vortice.Direct3D11;
@@ -15,6 +14,10 @@
 
 namespace ScreenCapture
 {
+    /// <summary>
+    /// Represents a ScreenCapture using DirectX 11 desktop duplicaton.
+    /// https://docs.microsoft.com/en-us/windows/win32/direct3ddxgi/desktop-dup-api
+    /// </summary>
     // ReSharper disable once InconsistentNaming
     public sealed class DX11ScreenCapture : IScreenCapture
     {
@@ -36,8 +39,14 @@ public sealed class DX11ScreenCapture : IScreenCapture
 
         private int _indexCounter = 0;
 
+        /// <inheritdoc />
         public Display Display { get; }
 
+        /// <summary>
+        /// Gets or sets the timeout in ms used for screen-capturing. (default 1000ms)
+        /// This is used in <see cref="CaptureScreen"/> https://docs.microsoft.com/en-us/windows/win32/api/dxgi1_2/nf-dxgi1_2-idxgioutputduplication-acquirenextframe
+        /// </summary>
+        // ReSharper disable once MemberCanBePrivate.Global
         public int Timeout { get; set; } = 1000;
 
         private readonly IDXGIFactory1 _factory;
@@ -54,12 +63,18 @@ public sealed class DX11ScreenCapture : IScreenCapture
 
         #region Events
 
+        /// <inheritdoc />
         public event EventHandler<ScreenCaptureUpdatedEventArgs>? Updated;
 
         #endregion
 
         #region Constructors
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DX11ScreenCapture"/> class.
+        /// </summary>
+        /// <param name="factory">The <see cref="IDXGIFactory1"/> used to create underlying objects.</param>
+        /// <param name="display">The <see cref="Display"/> to duplicate.</param>
         public DX11ScreenCapture(IDXGIFactory1 factory, Display display)
         {
             this._factory = factory;
@@ -72,6 +87,7 @@ public DX11ScreenCapture(IDXGIFactory1 factory, Display display)
 
         #region Methods
 
+        /// <inheritdoc />
         public bool CaptureScreen()
         {
             bool result = false;
@@ -171,6 +187,7 @@ private void UpdateZones()
             }
         }
 
+        /// <inheritdoc />
         public CaptureZone RegisterCaptureZone(int x, int y, int width, int height, int downscaleLevel = 0)
         {
             if (_device == null) throw new ApplicationException("ScreenCapture isn't initialized.");
@@ -209,6 +226,7 @@ public CaptureZone RegisterCaptureZone(int x, int y, int width, int height, int
             return captureZone;
         }
 
+        /// <inheritdoc />
         public bool UnregisterCaptureZone(CaptureZone captureZone)
         {
             lock (_captureZones)
@@ -268,6 +286,7 @@ private void InitializeCaptureZone(in CaptureZone captureZone)
             _captureZones[captureZone] = (stagingTexture, scalingTexture, scalingTextureView);
         }
 
+        /// <inheritdoc />
         public void Restart()
         {
             lock (_captureLock)
@@ -312,6 +331,7 @@ public void Restart()
             }
         }
 
+        /// <inheritdoc />
         public void Dispose() => Dispose(true);
 
         private void Dispose(bool removeCaptureZones)

ScreenCapture/DirectX/DX11ScreenCaptureService.cs

@@ -1,8 +1,12 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using Vortice.DXGI;
 
 namespace ScreenCapture
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public class DX11ScreenCaptureService : IScreenCaptureService
     {
         #region Properties & Fields
@@ -15,6 +19,9 @@ public class DX11ScreenCaptureService : IScreenCaptureService
 
         #region Constructors
 
+        /// <summary>
+        /// 
+        /// </summary>
         public DX11ScreenCaptureService()
         {
             DXGI.CreateDXGIFactory1(out _factory).CheckError();
@@ -24,6 +31,7 @@ public DX11ScreenCaptureService()
 
         #region Methods
 
+        /// <inheritdoc />
         public IEnumerable<GraphicsCard> GetGraphicsCards()
         {
             int i = 0;
@@ -35,6 +43,7 @@ public IEnumerable<GraphicsCard> GetGraphicsCards()
             }
         }
 
+        /// <inheritdoc />
         public IEnumerable<Display> GetDisplays(GraphicsCard graphicsCard)
         {
             using IDXGIAdapter1? adapter = _factory.GetAdapter1(graphicsCard.Index);
@@ -50,20 +59,24 @@ public IEnumerable<Display> GetDisplays(GraphicsCard graphicsCard)
             }
         }
 
+        /// <inheritdoc />
         public IScreenCapture GetScreenCapture(Display display)
         {
             if (!_screenCaptures.TryGetValue(display, out DX11ScreenCapture? screenCapture))
                 _screenCaptures.Add(display, screenCapture = new DX11ScreenCapture(_factory, display));
             return screenCapture;
         }
 
+        /// <inheritdoc />
         public void Dispose()
         {
             foreach (DX11ScreenCapture screenCapture in _screenCaptures.Values)
                 screenCapture.Dispose();
             _screenCaptures.Clear();
 
             _factory.Dispose();
+
+            GC.SuppressFinalize(this);
         }
 
         #endregion

ScreenCapture/Events/ScreenCaptureUpdatedEventArgs.cs

@@ -1,17 +1,29 @@
-using System;
+// ReSharper disable MemberCanBePrivate.Global
+using System;
 
-namespace ScreenCapture.Events
+namespace ScreenCapture
 {
+    /// <inheritdoc />
+    /// <summary>
+    /// Represents the information supplied with an <see cref="E:ScreenCapture.IDX11ScreenCapture.Updated" />-event.
+    /// </summary>
     public class ScreenCaptureUpdatedEventArgs : EventArgs
     {
         #region Properties & Fields
 
+        /// <summary>
+        /// <c>true</c> if the update was successful; otherwise, <c>false</c>.
+        /// </summary>
         public bool IsSuccessful { get; set; }
 
         #endregion
 
         #region Constructors
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ScreenCaptureUpdatedEventArgs"/> class.
+        /// </summary>
+        /// <param name="isSuccessful">Indicates if the last update was successful.</param>
         public ScreenCaptureUpdatedEventArgs(bool isSuccessful)
         {
             this.IsSuccessful = isSuccessful;

ScreenCapture/Helper/DPIAwareness.cs

@@ -1,8 +1,12 @@
 // ReSharper disable InconsistentNaming
+// ReSharper disable MemberCanBePrivate.Global
 using System.Runtime.InteropServices;
 
 namespace ScreenCapture
 {
+    /// <summary>
+    /// Helper-class for DPI-related WIN-API calls.
+    /// </summary>
     public static class DPIAwareness
     {
         [DllImport("user32.dll", SetLastError = true)]
@@ -29,9 +33,9 @@ internal enum DPI_AWARENESS_CONTEXT
             DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2 = 34
         }
 
-        public static void Initalize()
-        {
-            SetProcessDpiAwarenessContext((int)DPI_AWARENESS_CONTEXT.DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2);
-        }
+        /// <summary>
+        /// Sets the DPI-Awareness-Context to V2. This is needed to prevent issues when using desktop duplication.
+        /// </summary>
+        public static void Initalize() => SetProcessDpiAwarenessContext((int)DPI_AWARENESS_CONTEXT.DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2);
     }
 }

ScreenCapture/IScreenCapture.cs

@@ -2,13 +2,48 @@
 
 namespace ScreenCapture
 {
+    /// <summary>
+    /// Represents the duplication of a single display.
+    /// </summary>
     public interface IScreenCapture : IDisposable
     {
+        /// <summary>
+        /// Gets the <see cref="Display"/> this capture is duplicating.
+        /// </summary>
         Display Display { get; }
 
+        /// <summary>
+        /// Occurs when the <see cref="IScreenCapture"/> is updated.
+        /// </summary>
+        event EventHandler<ScreenCaptureUpdatedEventArgs>? Updated;
+
+        /// <summary>
+        /// Attemts to capture the current frame showed on the <see cref="Display"/>.
+        /// </summary>
+        /// <returns><c>true</c> if the current frame was captures successfully; otherwise, <c>false</c>.</returns>
         bool CaptureScreen();
+
+        /// <summary>
+        /// Creates a new <see cref="CaptureScreen"/> for this <see cref="IScreenCapture"/>.
+        /// </summary>
+        /// <param name="x">The x-location of the region to capture (must be &gt;= 0 and &lt; screen-width).</param>
+        /// <param name="y">The x-location of the region to capture (must be &gt;= 0 and &lt; screen-height).</param>
+        /// <param name="width">The width of the region to capture (must be &gt;= 0 and this + x must be &lt;= screen-width).</param>
+        /// <param name="height">The height of the region to capture (must be &gt;= 0 and this + y must be &lt;= screen-height).</param>
+        /// <param name="downscaleLevel">The level of downscaling applied to the image of this region before copying to local memory. The calculation is (width and height)/2^downscaleLevel.</param>
+        /// <returns>The new <see cref="CaptureScreen"/>.</returns>
         CaptureZone RegisterCaptureZone(int x, int y, int width, int height, int downscaleLevel = 0);
+
+        /// <summary>
+        /// Removes the given <see cref="CaptureScreen"/> from the <see cref="IScreenCapture"/>.
+        /// </summary>
+        /// <param name="captureZone">The previosly registered <see cref="CaptureScreen"/>.</param>
+        /// <returns><c>true</c> if the <see cref="CaptureScreen"/> was successfully removed; otherwise, <c>false</c>.</returns>
         bool UnregisterCaptureZone(CaptureZone captureZone);
+
+        /// <summary>
+        /// Restarts the <see cref="IScreenCapture"/>.
+        /// </summary>
         void Restart();
     }
 }

ScreenCapture/IScreenCaptureService.cs

@@ -3,10 +3,29 @@
 
 namespace ScreenCapture
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public interface IScreenCaptureService : IDisposable
     {
+        /// <summary>
+        /// Gets a enumerable of all available graphics-cards.
+        /// </summary>
+        /// <returns>A enumerable of all available graphics-cards.</returns>
         IEnumerable<GraphicsCard> GetGraphicsCards();
+
+        /// <summary>
+        /// Gets a enumerable of all display connected to the given graphics-cards.
+        /// </summary>
+        /// <param name="graphicsCard">The graphics-card to get the displays from.</param>
+        /// <returns>A enumerable of all display connected to the given graphics-cards.</returns>
         IEnumerable<Display> GetDisplays(GraphicsCard graphicsCard);
+
+        /// <summary>
+        /// Creates a <see cref="IScreenCapture"/> for the given display.
+        /// </summary>
+        /// <param name="display">The display to duplicate.</param>
+        /// <returns>The <see cref="IScreenCapture"/> for the give display.</returns>
         IScreenCapture GetScreenCapture(Display display);
     }
 }

ScreenCapture/Model/BlackBarDetection.cs

@@ -1,26 +1,45 @@
-using System;
+// ReSharper disable MemberCanBePrivate.Global
+using System;
 
 namespace ScreenCapture
 {
+    /// <summary>
+    /// Represents the configuration for the detection and removal of black bars around the screen image.
+    /// </summary>
     public sealed class BlackBarDetection
     {
         #region Properties & Fields
 
         private readonly CaptureZone _captureZone;
 
         private int? _top;
+        /// <summary>
+        /// Gets the size of the detected black bar at the top of the image.
+        /// </summary>
         public int Top => _top ??= CalculateTop();
 
         private int? _bottom;
+        /// <summary>
+        /// Gets the size of the detected black bar at the bottom of the image.
+        /// </summary>
         public int Bottom => _bottom ??= CalculateBottom();
 
         private int? _left;
+        /// <summary>
+        /// Gets the size of the detected black bar at the left of the image.
+        /// </summary>
         public int Left => _left ??= CalculateLeft();
 
         private int? _right;
+        /// <summary>
+        /// Gets the size of the detected black bar at the right of the image.
+        /// </summary>
         public int Right => _right ??= CalculateRight();
 
         private int _theshold = 0;
+        /// <summary>
+        /// Gets or sets the threshold of "blackness" used to detect black bars. (e. g. Threshold 5 will consider a pixel of color [5,5,5] as black.) (default 0)
+        /// </summary>
         public int Threshold
         {
             get => _theshold;
@@ -35,7 +54,7 @@ public int Threshold
 
         #region Constructors
 
-        public BlackBarDetection(CaptureZone captureZone)
+        internal BlackBarDetection(CaptureZone captureZone)
         {
             this._captureZone = captureZone;
         }
@@ -44,6 +63,9 @@ public BlackBarDetection(CaptureZone captureZone)
 
         #region Methods
 
+        /// <summary>
+        /// Invalidates the cached values and recalculates <see cref="Top"/>, <see cref="Bottom"/>, <see cref="Left"/> and <see cref="Right"/>.
+        /// </summary>
         public void InvalidateCache()
         {
             _top = null;