Added some missing doc-comments

Author: DarthAffe

ScreenCapture.NET.DX11/DX11ScreenCapture.cs

@@ -68,7 +68,7 @@ public sealed class DX11ScreenCapture : AbstractScreenCapture<ColorBGRA>
     /// <param name="factory">The <see cref="IDXGIFactory1"/> used to create underlying objects.</param>
     /// <param name="display">The <see cref="Display"/> to duplicate.</param>
     /// <param name="useNewDuplicationAdapter">Indicates if the DuplicateOutput1 interface should be used instead of the older DuplicateOutput. Currently there's no real use in setting this to true.</param>
-    public DX11ScreenCapture(IDXGIFactory1 factory, Display display, bool useNewDuplicationAdapter = false)
+    internal DX11ScreenCapture(IDXGIFactory1 factory, Display display, bool useNewDuplicationAdapter = false)
         : base(display)
     {
         this._factory = factory;
@@ -81,6 +81,7 @@ public DX11ScreenCapture(IDXGIFactory1 factory, Display display, bool useNewDupl
 
     #region Methods
 
+    /// <inheritdoc />
     protected override bool PerformScreenCapture()
     {
         bool result = false;
@@ -133,6 +134,7 @@ protected override bool PerformScreenCapture()
         return result;
     }
 
+    /// <inheritdoc />
     protected override void PerformCaptureZoneUpdate(CaptureZone<ColorBGRA> captureZone, in Span<byte> buffer)
     {
         if (_context == null) return;
@@ -299,6 +301,7 @@ public override void UpdateCaptureZone(CaptureZone<ColorBGRA> captureZone, int?
         }
     }
 
+    /// <inheritdoc />
     protected override void ValidateCaptureZoneAndThrow(int x, int y, int width, int height, int downscaleLevel)
     {
         if (_device == null) throw new ApplicationException("ScreenCapture isn't initialized.");
@@ -429,10 +432,13 @@ public override void Restart()
             }
     }
 
+    /// <inheritdoc />
     protected override void Dispose(bool disposing)
     {
         base.Dispose(disposing);
-        DisposeDX();
+
+        lock (_captureLock)
+            DisposeDX();
     }
 
     private void DisposeDX()

ScreenCapture.NET.DX9/DX9ScreenCapture.cs

@@ -9,8 +9,8 @@
 namespace ScreenCapture.NET;
 
 /// <summary>
-/// Represents a ScreenCapture using DirectX 11 desktop duplicaton.
-/// https://docs.microsoft.com/en-us/windows/win32/direct3ddxgi/desktop-dup-api
+/// Represents a ScreenCapture using DirectX 9.
+/// https://learn.microsoft.com/en-us/windows/win32/api/d3d9/nf-d3d9-idirect3ddevice9-getfrontbufferdata
 /// </summary>
 // ReSharper disable once InconsistentNaming
 public sealed class DX9ScreenCapture : AbstractScreenCapture<ColorBGRA>
@@ -32,8 +32,9 @@ public sealed class DX9ScreenCapture : AbstractScreenCapture<ColorBGRA>
     /// <summary>
     /// Initializes a new instance of the <see cref="DX9ScreenCapture"/> class.
     /// </summary>
+    /// <param name="direct3D9">The D3D9 instance used.</param>
     /// <param name="display">The <see cref="Display"/> to duplicate.</param>
-    public DX9ScreenCapture(IDirect3D9 direct3D9, Display display)
+    internal DX9ScreenCapture(IDirect3D9 direct3D9, Display display)
         : base(display)
     {
         this._direct3D9 = direct3D9;
@@ -45,6 +46,7 @@ public DX9ScreenCapture(IDirect3D9 direct3D9, Display display)
 
     #region Methods
 
+    /// <inheritdoc />
     protected override bool PerformScreenCapture()
     {
         bool result = false;
@@ -89,6 +91,7 @@ protected override bool PerformScreenCapture()
         return result;
     }
 
+    /// <inheritdoc />
     protected override void PerformCaptureZoneUpdate(CaptureZone<ColorBGRA> captureZone, in Span<byte> buffer)
     {
         if (_buffer == null) return;
@@ -195,10 +198,13 @@ public override void Restart()
         }
     }
 
+    /// <inheritdoc />
     protected override void Dispose(bool disposing)
     {
         base.Dispose(disposing);
-        DisposeDX();
+
+        lock (_captureLock)
+            DisposeDX();
     }
 
     private void DisposeDX()

ScreenCapture.NET.DX9/Downscale/SamplerInfo.cs

@@ -43,8 +43,12 @@ internal readonly ref struct SamplerInfo<T>
     /// <summary>
     /// Initializes a new instance of the <see cref="SamplerInfo{T}" /> class.
     /// </summary>
+    /// <param name="x">The X-location of the region the data comes from.</param>
+    /// <param name="y">The Y-location of the region the data comes from.</param>
     /// <param name="width">The width of the region the data comes from.</param>
     /// <param name="height">The height of region the data comes from.</param>
+    /// <param name="stride">The number of pixels in a row of data.</param>
+    /// <param name="dataPerPixel">The number of {T} representing a single pixel.</param>
     /// <param name="data">The data to sample.</param>
     public SamplerInfo(int x, int y, int width, int height, int stride, int dataPerPixel, in ReadOnlySpan<T> data)
     {

ScreenCapture.NET.X11/Downscale/SamplerInfo.cs

@@ -43,8 +43,12 @@ internal readonly ref struct SamplerInfo<T>
     /// <summary>
     /// Initializes a new instance of the <see cref="SamplerInfo{T}" /> class.
     /// </summary>
+    /// <param name="x">The X-location of the region the data comes from.</param>
+    /// <param name="y">The Y-location of the region the data comes from.</param>
     /// <param name="width">The width of the region the data comes from.</param>
     /// <param name="height">The height of region the data comes from.</param>
+    /// <param name="stride">The number of pixels in a row of data.</param>
+    /// <param name="dataPerPixel">The number of {T} representing a single pixel.</param>
     /// <param name="data">The data to sample.</param>
     public SamplerInfo(int x, int y, int width, int height, int stride, int dataPerPixel, in ReadOnlySpan<T> data)
     {

ScreenCapture.NET.X11/X11ScreenCapture.cs

@@ -7,7 +7,7 @@ namespace ScreenCapture.NET;
 
 /// <summary>
 /// Represents a ScreenCapture using libX11.
-/// https://docs.microsoft.com/en-us/windows/win32/direct3ddxgi/desktop-dup-api
+/// https://x.org/releases/current/doc/libX11/libX11/libX11.html#XGetImage
 /// </summary>
 // ReSharper disable once InconsistentNaming
 public sealed class X11ScreenCapture : AbstractScreenCapture<ColorBGRA>
@@ -31,7 +31,7 @@ public sealed class X11ScreenCapture : AbstractScreenCapture<ColorBGRA>
     /// Initializes a new instance of the <see cref="X11ScreenCapture"/> class.
     /// </summary>
     /// <param name="display">The <see cref="Display"/> to duplicate.</param>
-    public X11ScreenCapture(Display display)
+    internal X11ScreenCapture(Display display)
         : base(display)
     {
         Restart();
@@ -41,6 +41,7 @@ public X11ScreenCapture(Display display)
 
     #region Methods
 
+    /// <inheritdoc />
     protected override bool PerformScreenCapture()
     {
         lock (_captureLock)
@@ -57,6 +58,7 @@ protected override bool PerformScreenCapture()
         }
     }
 
+    /// <inheritdoc />
     protected override void PerformCaptureZoneUpdate(CaptureZone<ColorBGRA> captureZone, in Span<byte> buffer)
     {
         using IDisposable @lock = captureZone.Lock();
@@ -158,6 +160,7 @@ public override void Restart()
         }
     }
 
+    /// <inheritdoc />
     protected override void Dispose(bool disposing)
     {
         base.Dispose(disposing);

ScreenCapture.NET.X11/X11ScreenCaptureService.cs

@@ -75,6 +75,8 @@ public IEnumerable<Display> GetDisplays(GraphicsCard graphicsCard)
 
     /// <inheritdoc />
     IScreenCapture IScreenCaptureService.GetScreenCapture(Display display) => GetScreenCapture(display);
+
+    /// <inheritdoc cref="IScreenCaptureService.GetScreenCapture"/>
     public X11ScreenCapture GetScreenCapture(Display display)
     {
         if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);

ScreenCapture.NET/Generic/AbstractScreenCapture.cs

@@ -4,27 +4,37 @@
 
 namespace ScreenCapture.NET;
 
+/// <inheritdoc />
 public abstract class AbstractScreenCapture<TColor> : IScreenCapture
     where TColor : struct, IColor
 {
     #region Properties & Fields
 
     private bool _isDisposed;
 
+    /// <summary>
+    /// Gets a list of <see cref="CaptureZone{TColol}"/> registered on this ScreenCature.
+    /// </summary>
     protected HashSet<CaptureZone<TColor>> CaptureZones { get; } = new();
 
+    /// <inheritdoc />
     public Display Display { get; }
 
     #endregion
 
     #region Events
 
+    /// <inheritdoc />
     public event EventHandler<ScreenCaptureUpdatedEventArgs>? Updated;
 
     #endregion
 
     #region Constructors
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AbstractScreenCapture{T}"/> class.
+    /// </summary>
+    /// <param name="display">The <see cref="Display"/> to duplicate.</param>
     protected AbstractScreenCapture(Display display)
     {
         this.Display = display;
@@ -36,6 +46,7 @@ protected AbstractScreenCapture(Display display)
 
     #region Methods
 
+    /// <inheritdoc />
     public virtual bool CaptureScreen()
     {
         if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
@@ -67,10 +78,23 @@ public virtual bool CaptureScreen()
         return result;
     }
 
+    /// <summary>
+    /// Performs the actual screen capture.
+    /// </summary>
+    /// <returns><c>true</c> if the screen was captured sucessfully; otherwise, <c>false</c>.</returns>
     protected abstract bool PerformScreenCapture();
 
+    /// <summary>
+    /// Performs an update of the given capture zone.
+    /// </summary>
+    /// <param name="captureZone">The capture zone to update.</param>
+    /// <param name="buffer">The buffer containing the current pixel-data of the capture zone.</param>
     protected abstract void PerformCaptureZoneUpdate(CaptureZone<TColor> captureZone, in Span<byte> buffer);
 
+    /// <summary>
+    /// Raises the <see cref="Updated"/>-event.
+    /// </summary>
+    /// <param name="result">A bool indicating whether the update was successful or not.</param>
     protected virtual void OnUpdated(bool result)
     {
         try
@@ -80,7 +104,10 @@ protected virtual void OnUpdated(bool result)
         catch { /**/ }
     }
 
+    /// <inheritdoc />
     ICaptureZone IScreenCapture.RegisterCaptureZone(int x, int y, int width, int height, int downscaleLevel) => RegisterCaptureZone(x, y, width, height, downscaleLevel);
+
+    /// <inheritdoc cref="IScreenCapture.RegisterCaptureZone" />
     public virtual CaptureZone<TColor> RegisterCaptureZone(int x, int y, int width, int height, int downscaleLevel = 0)
     {
         if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
@@ -100,6 +127,15 @@ public virtual CaptureZone<TColor> RegisterCaptureZone(int x, int y, int width,
         }
     }
 
+    /// <summary>
+    /// Validates the given values of a capture zone.
+    /// </summary>
+    /// <param name="x">The X-location of the zone.</param>
+    /// <param name="y">The Y-location of the zone.</param>
+    /// <param name="width">The width of the zone.</param>
+    /// <param name="height">The height of the zone.</param>
+    /// <param name="downscaleLevel">The downscale-level of the zone.</param>
+    /// <exception cref="ArgumentException">Throws if some of the provided data is not valid.</exception>
     protected virtual void ValidateCaptureZoneAndThrow(int x, int y, int width, int height, int downscaleLevel)
     {
         if (x < 0) throw new ArgumentException("x < 0");
@@ -110,6 +146,13 @@ protected virtual void ValidateCaptureZoneAndThrow(int x, int y, int width, int
         if ((y + height) > Display.Height) throw new ArgumentException("y + height > Display height");
     }
 
+    /// <summary>
+    /// Calculates the actual size when downscaling is used.
+    /// </summary>
+    /// <param name="width">The original width.</param>
+    /// <param name="height">The original height.</param>
+    /// <param name="downscaleLevel">The level of downscaling to be used.</param>
+    /// <returns>A tuple containing the scaled width, the scaled height and the downscale-level used. (This can be smaller then the one provided if the image is not big enough to scale down that often.)</returns>
     protected virtual (int width, int height, int downscaleLevel) CalculateScaledSize(int width, int height, int downscaleLevel)
     {
         if (downscaleLevel > 0)
@@ -131,16 +174,22 @@ protected virtual (int width, int height, int downscaleLevel) CalculateScaledSiz
         return (width, height, downscaleLevel);
     }
 
+    /// <inheritdoc />
     bool IScreenCapture.UnregisterCaptureZone(ICaptureZone captureZone) => UnregisterCaptureZone(captureZone as CaptureZone<TColor> ?? throw new ArgumentException("Invalid capture-zone."));
+
+    /// <inheritdoc cref="IScreenCapture.UnregisterCaptureZone" />
     public virtual bool UnregisterCaptureZone(CaptureZone<TColor> captureZone)
     {
         if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
 
         return CaptureZones.Remove(captureZone);
     }
 
+    /// <inheritdoc />
     void IScreenCapture.UpdateCaptureZone(ICaptureZone captureZone, int? x, int? y, int? width, int? height, int? downscaleLevel)
         => UpdateCaptureZone(captureZone as CaptureZone<TColor> ?? throw new ArgumentException("Invalid capture-zone."), x, y, width, height, downscaleLevel);
+
+    /// <inheritdoc cref="IScreenCapture.UpdateCaptureZone" />
     public virtual void UpdateCaptureZone(CaptureZone<TColor> captureZone, int? x = null, int? y = null, int? width = null, int? height = null, int? downscaleLevel = null)
     {
         if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
@@ -169,6 +218,7 @@ public virtual void UpdateCaptureZone(CaptureZone<TColor> captureZone, int? x =
         }
     }
 
+    /// <inheritdoc />
     public virtual void Restart()
     {
         if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
@@ -190,6 +240,7 @@ public void Dispose()
         _isDisposed = true;
     }
 
+    /// <inheritdoc cref="Dispose" />
     protected virtual void Dispose(bool disposing) { }
 
     #endregion