Merge pull request #1 from d2phap/feature/hybrid-graphics

Add support for drawing hybrid graphics by `IGraphics` interface

Author: d2phap

README.md

@@ -1,6 +1,6 @@
 # D2Phap.DXControl
 
-- A WinForms hybrid control that supports Direct2D and GDI+ drawing thanks to [DirectN](https://github.com/smourier/DirectN) and [WicNet](https://github.com/smourier/WicNet).
+- A WinForms hybrid control that supports both Direct2D and GDI+ drawing thanks to [WicNet](https://github.com/smourier/WicNet).
 - This control is used in [ImageGlass](https://github.com/d2phap/ImageGlass) software since version 9.0.
 
 ![Nuget](https://img.shields.io/nuget/dt/D2Phap.DXControl?color=%2300a8d6&logo=nuget)
@@ -30,18 +30,19 @@ Install-Package D2Phap.DXControl
 
 
 ## Example
-Draw 2 rectangles by Direct2D and GDI+ graphics, then animate it to the right side.
 
-<img src="https://user-images.githubusercontent.com/3154213/181906424-27418cfd-5f41-4380-8ae9-0ea577c91b16.png" width="500" />
 
+<img src="https://user-images.githubusercontent.com/3154213/185740243-6a3cb1b6-13e6-4888-8c57-ce8ac9998c6e.png" width="500" />
+
+Draws a rectangle, then moves it to the right side.
 
 ```cs
 using D2Phap;
 
 // create a WinForms custom control that extends from DXControl
 public class DXCanvas : DXControl
 {
-    private D2D_RECT_F animatableRectangle = new(100f, 100f, new(400, 200));
+    private RectangleF animatableRectangle = new(100, 100, 400, 200);
 
     public DXCanvas()
     {
@@ -51,21 +52,11 @@ public class DXCanvas : DXControl
         UseHardwareAcceleration = true;
     }
 
-    // use Direct2D graphics
-    protected override void OnDirect2DRender(DXGraphics g)
-    {
-        // draw a yellow rectangle with green border
-        g.FillRectangle(rectText, _D3DCOLORVALUE.FromCOLORREF(_D3DCOLORVALUE.Yellow.Int32Value, 100));
-        g.DrawRectangle(rectText, _D3DCOLORVALUE.Green);
-    }
-
-
-    // Use GDI+ graphics
-    protected override void OnGdiPlusRender(Graphics g)
+    protected override void OnRender(IGraphics g)
     {
         // draw a yellow rectangle with green border
-        using var pen = new Pen(Color.Red, 5);
-        g.DrawRectangle(pen, new Rectangle((int)rectText.left, (int)rectText.top - 50, (int)rectText.Width, (int)rectText.Height));
+        g.FillRectangle(rectText, Color.FromArgb(100, Yellow));
+        g.DrawRectangle(rectText, Color.Green);
     }
 
 

Source/DXControl/D2Phap.DXControl.csproj

@@ -20,7 +20,7 @@
     <IncludeSymbols>True</IncludeSymbols>
     <PackageReleaseNotes></PackageReleaseNotes>
     <Authors>Duong Dieu Phap</Authors>
-    <VersionPrefix>1.1.0</VersionPrefix>
+    <VersionPrefix>2.0.0</VersionPrefix>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
       <PublishRepositoryUrl>true</PublishRepositoryUrl>
       <EmbedUntrackedSources>true</EmbedUntrackedSources>

Source/DXControl/DXControl.cs

@@ -27,7 +27,8 @@ public class DXControl : Control
     private readonly IComObject<IDWriteFactory> _dWriteFactory = DWriteFunctions.DWriteCreateFactory(DWRITE_FACTORY_TYPE.DWRITE_FACTORY_TYPE_SHARED);
     private ID2D1HwndRenderTarget? _renderTarget;
     private ID2D1DeviceContext? _device;
-    private DXGraphics? _graphics;
+    private D2DGraphics? _graphicsD2d;
+    private GdipGraphics? _graphicsGdi;
 
 
     private bool _useHardwardAcceleration = true;
@@ -86,10 +87,10 @@ public ID2D1DeviceContext Device
 
 
     /// <summary>
-    /// Gets the <see cref='DXGraphics'/> object used to draw in <see cref="OnDirect2DRender(DXGraphics)"/>.
+    /// Gets the <see cref='D2DGraphics'/> object used to draw in <see cref="Render"/>.
     /// </summary>
     [Browsable(false)]
-    public DXGraphics? D2Graphics => _graphics;
+    public D2DGraphics? D2Graphics => _graphicsD2d;
 
 
     /// <summary>
@@ -189,15 +190,9 @@ public bool EnableAnimation
 
 
     /// <summary>
-    /// Occurs when the control is being rendered by Direct2D <see cref="DXGraphics"/>.
+    /// Occurs when the control is being rendered by <see cref="IGraphics"/>.
     /// </summary>
-    public event EventHandler<RenderByDirect2DEventArgs>? RenderByDirect2D;
-
-
-    /// <summary>
-    /// Occurs when the control is being rendered by GDI+ <see cref="Graphics"/>.
-    /// </summary>
-    public event EventHandler<RenderByGdiPlusEventArgs>? RenderByGdiPLus;
+    public event EventHandler<RenderEventArgs>? Render;
 
 
     /// <summary>
@@ -259,8 +254,8 @@ protected override void Dispose(bool disposing)
         _ticker.Stop(1000);
         _ticker.Tick -= Ticker_Tick;
 
-        _graphics?.Dispose();
-        _graphics = null;
+        _graphicsD2d?.Dispose();
+        _graphicsD2d = null;
 
         // '_device' must be disposed in DestroyHandle()
     }
@@ -359,9 +354,8 @@ protected override void OnPaintBackground(PaintEventArgs e)
 
 
     /// <summary>
-    /// <b>Do use</b> <see cref="OnDirect2DRender(DXGraphics)"/> if you want to draw on the control.
+    /// <b>Do use</b> <see cref="OnRender(IGraphics)"/> if you want to draw on the control.
     /// </summary>
-    /// <param name="e"></param>
     protected override void OnPaint(PaintEventArgs e)
     {
         if (DesignMode)
@@ -382,18 +376,29 @@ protected override void OnPaint(PaintEventArgs e)
         {
             DoubleBuffered = false;
 
-            _graphics ??= new DXGraphics(_device, _dWriteFactory);
+            _graphicsD2d ??= new D2DGraphics(_device, _dWriteFactory);
 
             _device.BeginDraw();
             _device.Clear(_D3DCOLORVALUE.FromColor(BackColor));
-            OnDirect2DRender(_graphics);
+            OnRender(_graphicsD2d);
             _device.EndDraw();
         }
+
         // use GDI+ graphics
         else
         {
             DoubleBuffered = true;
-            OnGdiPlusRender(e.Graphics);
+
+            if (_graphicsGdi == null)
+            {
+                _graphicsGdi = new GdipGraphics(e.Graphics);
+            }
+            else
+            {
+                _graphicsGdi.Graphics = e.Graphics;
+            }
+
+            OnRender(_graphicsGdi);
         }
 
 
@@ -428,29 +433,17 @@ protected override void OnPaint(PaintEventArgs e)
     #region New / Virtual functions
 
     /// <summary>
-    /// Draws control by Direct2D <see cref="D2Graphics"/> object.
-    /// </summary>
-    protected virtual void OnDirect2DRender(DXGraphics g)
-    {
-        if (!IsReady) return;
-
-        RenderByDirect2D?.Invoke(this, new(g));
-    }
-
-
-    /// <summary>
-    /// Draws control by GDI+ <see cref="Graphics"/> object.
+    /// Triggers <see cref="Render"/> event to paint the control.
     /// </summary>
-    protected virtual void OnGdiPlusRender(Graphics g)
+    protected virtual void OnRender(IGraphics g)
     {
         if (!IsReady) return;
-
-        RenderByGdiPLus?.Invoke(this, new(g));
+        Render?.Invoke(this, new(g));
     }
 
 
     /// <summary>
-    /// Process animation logic when frame changes
+    /// Triggers <see cref="Frame"/> event to process animation logic when frame changes.
     /// </summary>
     protected virtual void OnFrame(FrameEventArgs e)
     {
@@ -461,7 +454,7 @@ protected virtual void OnFrame(FrameEventArgs e)
 
 
     /// <summary>
-    /// Happens when control is ready.
+    /// Triggers <see cref="Loaded"/> event when the control is ready.
     /// </summary>
     protected virtual void OnLoaded()
     {
@@ -532,7 +525,7 @@ public void CreateDevice()
         _renderTarget.Resize(new((uint)ClientSize.Width, (uint)ClientSize.Height));
 
         _device = (ID2D1DeviceContext)_renderTarget;
-        _graphics = new DXGraphics(_device, _dWriteFactory);
+        _graphicsD2d = new D2DGraphics(_device, _dWriteFactory);
     }
 
 

Source/DXControl/DXHelper.cs

@@ -4,6 +4,8 @@ MIT License
 Project & license info: https://github.com/d2phap/DXControl
 */
 using DirectN;
+using System.Runtime.InteropServices;
+using WicNet;
 
 namespace D2Phap;
 
@@ -35,10 +37,10 @@ public static _D3DCOLORVALUE FromColor(Color color, byte? alpha = null)
     public static D2D_RECT_F ToD2DRectF(Rectangle rect)
     {
         return new D2D_RECT_F(
-            (float)rect.Left,
-            (float)rect.Top,
-            (float)rect.Right,
-            (float)rect.Bottom);
+            rect.Left,
+            rect.Top,
+            rect.Right,
+            rect.Bottom);
     }
 
 
@@ -63,4 +65,84 @@ public static D2D_RECT_F ToD2DRectF(float x, float y, float width, float height)
         return new D2D_RECT_F(x, y, x + width, y + height);
     }
 
+
+    /// <summary>
+    /// Converts <see cref="D2D_RECT_F"/> to <see cref="RectangleF"/>
+    /// </summary>
+    public static RectangleF ToRectangle(D2D_RECT_F rect)
+    {
+        return new RectangleF(rect.left, rect.top, rect.Width, rect.Height);
+    }
+
+
+    /// <summary>
+    /// Converts <see cref="D2D_SIZE_F"/> to <see cref="SizeF"/>
+    /// </summary>
+    public static SizeF ToSize(D2D_SIZE_F size)
+    {
+        return new SizeF(size.width, size.height);
+    }
+
+
+    /// <summary>
+    /// Converts <see cref="D2D_POINT_2F"/> to <see cref="PointF"/>
+    /// </summary>
+    public static PointF ToPoint(D2D_POINT_2F point)
+    {
+        return new PointF(point.x, point.y);
+    }
+
+
+    /// <summary>
+    /// Creates default <see cref="D2D1_BITMAP_PROPERTIES"/>.
+    /// </summary>
+    public static D2D1_BITMAP_PROPERTIES CreateDefaultBitmapProps()
+    {
+        return new D2D1_BITMAP_PROPERTIES()
+        {
+            pixelFormat = new D2D1_PIXEL_FORMAT()
+            {
+                alphaMode = D2D1_ALPHA_MODE.D2D1_ALPHA_MODE_PREMULTIPLIED,
+                format = DXGI_FORMAT.DXGI_FORMAT_B8G8R8A8_UNORM,
+            },
+            dpiX = 96.0f,
+            dpiY = 96.0f,
+        };
+    }
+
+
+
+    /// <summary>
+    /// Converts <see cref="WicBitmapSource"/> to <see cref="ID2D1Bitmap"/> COM object.
+    /// </summary>
+    public static ComObject<ID2D1Bitmap>? ToD2D1Bitmap(ID2D1DeviceContext? dc, WicBitmapSource? wicSrc)
+    {
+        if (dc == null || wicSrc == null)
+        {
+            return null;
+        }
+
+        wicSrc.ConvertTo(WicPixelFormat.GUID_WICPixelFormat32bppPBGRA);
+
+        // create D2D1Bitmap from WICBitmapSource
+        var bitmapPropsPtr = new D2D1_BITMAP_PROPERTIES()
+        {
+            pixelFormat = new D2D1_PIXEL_FORMAT()
+            {
+                alphaMode = D2D1_ALPHA_MODE.D2D1_ALPHA_MODE_PREMULTIPLIED,
+                format = DXGI_FORMAT.DXGI_FORMAT_B8G8R8A8_UNORM,
+            },
+            dpiX = 96.0f,
+            dpiY = 96.0f,
+        }.StructureToPtr();
+
+        _ = dc.CreateBitmapFromWicBitmap(wicSrc.ComObject.Object, bitmapPropsPtr, out ID2D1Bitmap? bmp).ThrowOnError();
+
+        var comBmp = new ComObject<ID2D1Bitmap>(bmp);
+
+        Marshal.FreeHGlobal(bitmapPropsPtr);
+
+        return comBmp;
+    }
+
 }

Source/DXControl/DirectN/DirectWrite/Generated/D2D1_BITMAP_BRUSH_PROPERTIES.cs

@@ -0,0 +1,16 @@
+// c:\program files (x86)\windows kits\10\include\10.0.22000.0\um\d2d1.h(329,9)
+using System.Runtime.InteropServices;
+
+namespace DirectN
+{
+    /// <summary>
+    /// Describes the extend modes and the interpolation mode of an ID2D1BitmapBrush.
+    /// </summary>
+    [StructLayout(LayoutKind.Sequential)]
+    public partial struct D2D1_BITMAP_BRUSH_PROPERTIES
+    {
+        public D2D1_EXTEND_MODE extendModeX;
+        public D2D1_EXTEND_MODE extendModeY;
+        public D2D1_BITMAP_INTERPOLATION_MODE interpolationMode;
+    }
+}

Source/DXControl/DirectN/DirectWrite/Generated/D2D1_BITMAP_BRUSH_PROPERTIES1.cs

@@ -0,0 +1,16 @@
+// c:\program files (x86)\windows kits\10\include\10.0.22000.0\um\d2d1_1.h(506,9)
+using System.Runtime.InteropServices;
+
+namespace DirectN
+{
+    /// <summary>
+    /// Describes the extend modes and the interpolation mode of an ID2D1BitmapBrush.
+    /// </summary>
+    [StructLayout(LayoutKind.Sequential)]
+    public partial struct D2D1_BITMAP_BRUSH_PROPERTIES1
+    {
+        public D2D1_EXTEND_MODE extendModeX;
+        public D2D1_EXTEND_MODE extendModeY;
+        public D2D1_INTERPOLATION_MODE interpolationMode;
+    }
+}