fit wip

Author: Soreepeong

Dalamud/ImGuiScene/Helpers/D3D11RectangleDrawer.cs

@@ -1,6 +1,7 @@
 using System.Runtime.CompilerServices;
 
 using Dalamud.Interface.Internal;
+using Dalamud.Interface.Textures.TextureWraps;
 
 using ImGuiNET;
 
@@ -18,6 +19,9 @@ internal interface IImGuiRenderer : IDisposable
     /// <param name="drawCmd">The relevant draw command.</param>
     public delegate void DrawCmdUserCallbackDelegate(ImDrawDataPtr drawData, ImDrawCmdPtr drawCmd);
 
+    /// <summary>Gets the texture manager.</summary>
+    ISceneTextureManager TextureManager { get; }
+
     /// <summary>
     /// Notifies that the window is about to be resized.
     /// </summary>
@@ -70,22 +74,4 @@ internal interface IImGuiRenderer : IDisposable
     /// </summary>
     /// <param name="delegate">The delegate.</param>
     void RemoveDrawCmdUserCallback(DrawCmdUserCallbackDelegate @delegate);
-
-    /// <summary>
-    /// Load an image from a span of bytes of specified format.
-    /// </summary>
-    /// <param name="data">The data to load.</param>
-    /// <param name="pitch">The pitch(stride) in bytes.</param>
-    /// <param name="width">The width in pixels.</param>
-    /// <param name="height">The height in pixels.</param>
-    /// <param name="format">Format of the texture.</param>
-    /// <param name="debugName">Name for debugging.</param>
-    /// <returns>A texture, ready to use in ImGui.</returns>
-    IDalamudTextureWrap LoadTexture(
-        ReadOnlySpan<byte> data,
-        int pitch,
-        int width,
-        int height,
-        int format,
-        [CallerMemberName] string debugName = "");
 }

Dalamud/ImGuiScene/IImGuiRenderer.cs

@@ -1,6 +1,8 @@
-using System.Runtime.CompilerServices;
+using System.Diagnostics.CodeAnalysis;
+using System.Runtime.CompilerServices;
 
 using Dalamud.Interface.Internal;
+using Dalamud.Interface.Textures.TextureWraps;
 
 namespace Dalamud.ImGuiScene;
 
@@ -40,19 +42,22 @@ internal interface IImGuiScene : IDisposable
     event NewRenderFrameDelegate? NewRenderFrame;
 
     /// <summary>
-    /// Gets or sets a value indicating whether or not the cursor should be overridden with the ImGui cursor.
+    /// Gets or sets a value indicating whether the cursor should be overridden with the ImGui cursor.
     /// </summary>
-    public bool UpdateCursor { get; set; }
+    bool UpdateCursor { get; set; }
 
     /// <summary>
     /// Gets or sets the path of ImGui configuration .ini file.
     /// </summary>
-    public string? IniPath { get; set; }
+    string? IniPath { get; set; }
 
     /// <summary>
     /// Gets the device handle.
     /// </summary>
-    public nint DeviceHandle { get; }
+    nint DeviceHandle { get; }
+
+    /// <summary>Gets the texture manager.</summary>
+    ISceneTextureManager TextureManager { get; }
 
     /// <summary>
     /// Perform a render cycle.
@@ -77,47 +82,6 @@ internal interface IImGuiScene : IDisposable
     /// <remarks>Call this while handling <see cref="NewRenderFrame"/>.</remarks>
     void InvalidateFonts();
 
-    /// <summary>
-    /// Check whether the current backend supports the given texture format.
-    /// </summary>
-    /// <param name="format">DXGI format to check.</param>
-    /// <returns>Whether it is supported.</returns>
-    public bool SupportsTextureFormat(int format);
-
-    /// <summary>
-    /// Loads an image from a file.
-    /// </summary>
-    /// <param name="path">The path to file.</param>
-    /// <param name="debugName">The debug name.</param>
-    /// <returns>The loaded image.</returns>
-    IDalamudTextureWrap CreateTexture2DFromFile(string path, [CallerMemberName] string debugName = "");
-
-    /// <summary>
-    /// Loads an image from memory. The image must be in a contained format, such as .png, .jpg, and etc.
-    /// </summary>
-    /// <param name="data">The data of the image.</param>
-    /// <param name="debugName">The debug name.</param>
-    /// <returns>The loaded image.</returns>
-    IDalamudTextureWrap CreateTexture2DFromBytes(ReadOnlySpan<byte> data, [CallerMemberName] string debugName = "");
-
-    /// <summary>
-    /// Load an image from a span of bytes of specified format.
-    /// </summary>
-    /// <param name="data">The data to load.</param>
-    /// <param name="pitch">The pitch(stride) in bytes.</param>
-    /// <param name="width">The width in pixels.</param>
-    /// <param name="height">The height in pixels.</param>
-    /// <param name="format">Format of the texture.</param>
-    /// <param name="debugName">The debug name.</param>
-    /// <returns>A texture, ready to use in ImGui.</returns>
-    IDalamudTextureWrap CreateTexture2DFromRaw(
-        ReadOnlySpan<byte> data,
-        int pitch,
-        int width,
-        int height,
-        int format,
-        [CallerMemberName] string debugName = "");
-
     /// <inheritdoc cref="IImGuiRenderer.SetTexturePipeline"/>
     void SetTexturePipeline(IDalamudTextureWrap textureHandle, ITexturePipelineWrap? pipelineHandle);
 
@@ -129,18 +93,18 @@ IDalamudTextureWrap CreateTexture2DFromRaw(
     /// </summary>
     /// <param name="cursorHandle">The cursor.</param>
     /// <returns>Whether it is the case.</returns>
-    public bool IsImGuiCursor(nint cursorHandle);
+    bool IsImGuiCursor(nint cursorHandle);
 
     /// <summary>
     /// Determines if this instance of <see cref="IImGuiScene"/> is rendering to <paramref name="targetHandle"/>.
     /// </summary>
     /// <param name="targetHandle">The present target handle.</param>
     /// <returns>Whether it is the case.</returns>
-    public bool IsAttachedToPresentationTarget(nint targetHandle);
+    bool IsAttachedToPresentationTarget(nint targetHandle);
 
     /// <summary>
     /// Determines if the main viewport is full screen.
     /// </summary>
     /// <returns>Whether it is the case.</returns>
-    public bool IsMainViewportFullScreen();
+    bool IsMainViewportFullScreen();
 }

Dalamud/ImGuiScene/IImGuiScene.cs

@@ -0,0 +1,90 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+using Dalamud.Interface.Internal;
+using Dalamud.Interface.Textures;
+using Dalamud.Interface.Textures.TextureWraps;
+using Dalamud.Plugin.Internal.Types;
+
+namespace Dalamud.ImGuiScene;
+
+internal interface ISceneTextureManager
+{
+    /// <summary>Creates a texture.</summary>
+    /// <param name="data">Optional data to initialize the texture with.</param>
+    /// <param name="specs">Texture specifications.</param>
+    /// <param name="cpuRead">Whether to support reading from CPU, while disabling reading from GPU.</param>
+    /// <param name="cpuWrite">Whether to support writing from CPU, while disabling writing from GPU.</param>
+    /// <param name="immutable">Whether the texture should be immutable.</param>
+    /// <param name="debugName">Name for debug display purposes.</param>
+    /// <returns>A new empty texture.</returns>
+    IDalamudTextureWrap Create(
+        ReadOnlySpan<byte> data,
+        RawImageSpecification specs,
+        bool cpuRead,
+        bool cpuWrite,
+        bool immutable,
+        string? debugName = null);
+
+    /// <summary>Creates a texture from the given existing texture, cropping and converting pixel format as needed.
+    /// </summary>
+    /// <param name="wrap">The source texture wrap. The passed value may be disposed once this function returns,
+    ///     without having to wait for the completion of the returned <see cref="Task{TResult}"/>.</param>
+    /// <param name="args">The texture modification arguments.</param>
+    /// <param name="debugName">Name for debug display purposes.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A <see cref="Task{TResult}"/> containing the copied texture on success. Dispose after use.</returns>
+    /// <remarks><para>This function may throw an exception.</para></remarks>
+    Task<IDalamudTextureWrap> CreateFromExistingTextureAsync(
+        IDalamudTextureWrap wrap,
+        TextureModificationArgs args = default,
+        string? debugName = null,
+        CancellationToken cancellationToken = default);
+
+    /// <summary>Creates a texture from an ImGui viewport.</summary>
+    /// <param name="args">The arguments for creating a texture.</param>
+    /// <param name="ownerPlugin">Plugin that called the function.</param>
+    /// <param name="debugName">Name for debug display purposes.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A <see cref="Task{TResult}"/> containing the copied texture on success. Dispose after use.</returns>
+    /// <remarks>
+    /// <para>Use <c>ImGui.GetMainViewport().ID</c> to capture the game screen with Dalamud rendered.</para>
+    /// <para>This function may throw an exception.</para>
+    /// </remarks>
+    Task<IDalamudTextureWrap> CreateFromImGuiViewportAsync(
+        ImGuiViewportTextureArgs args,
+        LocalPlugin? ownerPlugin,
+        string? debugName = null,
+        CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Determines whether the system supports the given DXGI format.
+    /// For use with <see cref="RawImageSpecification.DxgiFormat"/>.
+    /// </summary>
+    /// <param name="dxgiFormat">The DXGI format.</param>
+    /// <returns><c>true</c> if supported.</returns>
+    /// <remarks><para>This function does not throw exceptions.</para></remarks>
+    bool IsDxgiFormatSupported(int dxgiFormat);
+
+    /// <summary>Determines whether the system supports the given DXGI format for use with
+    /// <see cref="CreateFromExistingTextureAsync"/>.</summary>
+    /// <param name="dxgiFormat">The DXGI format.</param>
+    /// <returns><c>true</c> if supported.</returns>
+    /// <remarks><para>This function does not throw exceptions.</para></remarks>
+    bool IsDxgiFormatSupportedForCreateFromExistingTextureAsync(int dxgiFormat);
+
+    /// <summary>Gets the raw data of a texture wrap.</summary>
+    /// <param name="wrap">The source texture wrap.</param>
+    /// <param name="args">The texture modification arguments.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>The raw data and its specifications.</returns>
+    /// <remarks>
+    /// <para>The length of the returned <c>RawData</c> may not match
+    /// <see cref="RawImageSpecification.Height"/> * <see cref="RawImageSpecification.Pitch"/>.</para>
+    /// <para>This function may throw an exception.</para>
+    /// </remarks>
+    Task<(RawImageSpecification Specification, byte[] RawData)> GetRawImageAsync(
+        IDalamudTextureWrap wrap,
+        TextureModificationArgs args = default,
+        CancellationToken cancellationToken = default);
+}

Dalamud/ImGuiScene/ISceneTextureManager.cs

@@ -3,7 +3,7 @@
 using System.Runtime.InteropServices;
 
 using Dalamud.ImGuiScene.Helpers;
-using Dalamud.Interface.Internal;
+using Dalamud.Interface.Textures.TextureWraps;
 
 using TerraFX.Interop;
 using TerraFX.Interop.DirectX;
@@ -27,21 +27,31 @@ private class TextureData : ManagedComObjectBase<TextureData>, INativeGuid
         public static readonly Guid MyGuid =
             new(0x72fe3f82, 0x3ffc, 0x4be9, 0xb0, 0x08, 0x4a, 0xef, 0x7a, 0x94, 0x2f, 0x55);
 
+        private ComPtr<ID3D11Texture2D> tex;
         private ComPtr<ID3D11ShaderResourceView> srv;
         private TexturePipeline? customPipeline;
 
-        public TextureData(ID3D11ShaderResourceView* srv, int width, int height)
+        public TextureData(
+            ComPtr<ID3D11Texture2D> tex,
+            ComPtr<ID3D11ShaderResourceView> srv,
+            int width,
+            int height,
+            DXGI_FORMAT format)
         {
-            this.srv = new(srv);
+            this.tex = tex;
+            this.srv = srv;
             this.Width = width;
             this.Height = height;
+            this.Format = format;
         }
 
         public static Guid* NativeGuid => (Guid*)Unsafe.AsPointer(ref Unsafe.AsRef(in MyGuid));
 
-        public int Width { get; private init; }
+        public int Width { get; }
 
-        public int Height { get; private init; }
+        public int Height { get; }
+
+        public DXGI_FORMAT Format { get; }
 
         public TexturePipeline? CustomPipeline
         {
@@ -55,13 +65,16 @@ public TexturePipeline? CustomPipeline
             }
         }
 
-        public ID3D11ShaderResourceView* ShaderResourceView => this.srv;
+        public ComPtr<ID3D11Texture2D> Texture2D => this.tex;
+
+        public ComPtr<ID3D11ShaderResourceView> ShaderResourceView => this.srv;
 
         protected override void* DynamicCast(in Guid iid) =>
             iid == MyGuid ? this.AsComInterface() : base.DynamicCast(iid);
 
         protected override void FinalRelease()
         {
+            this.tex.Reset();
             this.srv.Reset();
             this.customPipeline?.Dispose();
             this.customPipeline = null;
@@ -86,6 +99,8 @@ private class TextureWrap : IDalamudTextureWrap, ICloneable
 
         public int Height => this.Data.Height;
 
+        public int DxgiFormat => (int)this.Data.Format;
+
         public static TextureWrap TakeOwnership(TextureData data) => new(data);
 
         public static TextureWrap NewReference(TextureData data) => new(data.CloneRef());