Refactor: rename dds_data -> tex_data

And move it out into a tex_data.h header. This is in preparation
for getting mipmaps out of EXR files, where read_dds_data for
that would be a bit confusing.

renderdoc/CMakeLists.txt

@@ -132,6 +132,7 @@ set(sources
     common/result.h
     common/shader_cache.h
     common/jobsystem.cpp
+    common/tex_data.h
     common/threading.h
     common/timing.h
     common/wrapped_pool.h

renderdoc/common/dds_readwrite.cpp

@@ -673,7 +673,7 @@ DXGI_FORMAT ResourceFormat2DXGIFormat(ResourceFormat format)
   return DXGI_FORMAT_UNKNOWN;
 }
 
-RDResult write_dds_to_file(FILE *f, const write_dds_data &data)
+RDResult write_dds_to_file(FILE *f, const write_tex_data &data)
 {
   if(!f)
     return RDResult(ResultCode::InvalidParameter, "Missing file handle writing DDS file");
@@ -961,7 +961,7 @@ bool is_dds_file(byte *headerBuffer, size_t size)
   return memcmp(headerBuffer, &dds_fourcc, 4) == 0;
 }
 
-RDResult load_dds_from_file(StreamReader *reader, read_dds_data &ret)
+RDResult load_dds_from_file(StreamReader *reader, read_tex_data &ret)
 {
   uint64_t fileSize = reader->GetSize();
 

renderdoc/common/dds_readwrite.h

@@ -25,36 +25,9 @@
 #pragma once
 
 #include <stdio.h>
-#include "api/replay/data_types.h"
 #include "serialise/streamio.h"
-
-struct dds_data
-{
-  uint32_t width;
-  uint32_t height;
-  uint32_t depth;
-
-  uint32_t mips;
-  uint32_t slices;
-
-  bool cubemap;
-
-  ResourceFormat format;
-};
-
-struct read_dds_data : public dds_data
-{
-  bytebuf buffer;
-
-  // pairs of {offset, size} into above data buffer
-  rdcarray<rdcpair<size_t, size_t>> subresources;
-};
-
-struct write_dds_data : public dds_data
-{
-  rdcarray<byte *> subresources;
-};
+#include "tex_data.h"
 
 extern bool is_dds_file(byte *headerBuffer, size_t size);
-extern RDResult load_dds_from_file(StreamReader *reader, read_dds_data &data);
-extern RDResult write_dds_to_file(FILE *f, const write_dds_data &data);
+extern RDResult load_dds_from_file(StreamReader *reader, read_tex_data &data);
+extern RDResult write_dds_to_file(FILE *f, const write_tex_data &data);

renderdoc/common/tex_data.h

@@ -0,0 +1,57 @@
+/******************************************************************************
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019-2024 Baldur Karlsson
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ ******************************************************************************/
+
+#pragma once
+
+#include "api/replay/data_types.h"
+
+// Texture data for file reading/writing. Used in more complex cases
+// than just a single image, e.g. DDS (can have arrays, mips) or EXR
+// (can have mips).
+struct tex_data
+{
+  uint32_t width;
+  uint32_t height;
+  uint32_t depth;
+
+  uint32_t mips;
+  uint32_t slices;
+
+  bool cubemap;
+
+  ResourceFormat format;
+};
+
+struct read_tex_data : public tex_data
+{
+  bytebuf buffer;
+
+  // pairs of {offset, size} into above data buffer
+  rdcarray<rdcpair<size_t, size_t>> subresources;
+};
+
+struct write_tex_data : public tex_data
+{
+  rdcarray<byte *> subresources;
+};

renderdoc/core/image_viewer.cpp

@@ -395,7 +395,7 @@ public:
   void FileChanged() { RefreshFile(); }
 private:
   void RefreshFile();
-  void CreateProxyTexture(TextureDescription &texDetails, read_dds_data &read_data);
+  void CreateProxyTexture(TextureDescription &texDetails, read_tex_data &read_data);
 
   APIProperties m_Props;
   FrameRecord m_FrameRecord;
@@ -515,7 +515,7 @@ RDResult IMG_CreateReplayDevice(RDCFile *rdc, IReplayDriver **driver)
   {
     FileIO::fseek64(f, 0, SEEK_SET);
     StreamReader reader(f);
-    read_dds_data read_data = {};
+    read_tex_data read_data = {};
     RDResult res = load_dds_from_file(&reader, read_data);
     f = NULL;
 
@@ -899,7 +899,7 @@ void ImageViewer::RefreshFile()
   m_FrameRecord.frameInfo.persistentSize = 0;
   m_FrameRecord.frameInfo.uncompressedFileSize = datasize;
 
-  read_dds_data read_data = {};
+  read_tex_data read_data = {};
 
   if(dds)
   {
@@ -1003,7 +1003,7 @@ void ImageViewer::RefreshFile()
     FileIO::fclose(f);
 }
 
-void ImageViewer::CreateProxyTexture(TextureDescription &texDetails, read_dds_data &read_data)
+void ImageViewer::CreateProxyTexture(TextureDescription &texDetails, read_tex_data &read_data)
 {
   if(m_Proxy->IsTextureSupported(texDetails))
   {

renderdoc/os/win32/win32_shellext.cpp

@@ -54,7 +54,7 @@ struct RDCThumbnailProvider : public IThumbnailProvider, IInitializeWithStream
   unsigned int m_iRefcount;
   bool m_Inited;
   RDCThumb m_Thumb;
-  read_dds_data m_ddsData;
+  read_tex_data m_ddsData;
 
   RDCThumbnailProvider() : m_iRefcount(1), m_Inited(false) { InterlockedIncrement(&numProviders); }
   virtual ~RDCThumbnailProvider() { InterlockedDecrement(&numProviders); }

renderdoc/renderdoc.vcxproj

@@ -202,6 +202,7 @@
     <ClInclude Include="common\globalconfig.h" />
     <ClInclude Include="common\result.h" />
     <ClInclude Include="common\shader_cache.h" />
+    <ClInclude Include="common\tex_data.h" />
     <ClInclude Include="common\threading.h" />
     <ClInclude Include="common\timing.h" />
     <ClInclude Include="common\wrapped_pool.h" />

renderdoc/renderdoc.vcxproj.filters

@@ -570,6 +570,9 @@
     <ClInclude Include="replay\common\var_dispatch_helpers.h">
       <Filter>Replay\Common</Filter>
     </ClInclude>
+    <ClInclude Include="common\tex_data.h">
+      <Filter>Common\File Formats</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="maths\camera.cpp">

renderdoc/replay/replay_controller.cpp

@@ -1226,7 +1226,7 @@ ResultDetails ReplayController::SaveTexture(const TextureSave &saveData, const r
   {
     if(sd.destType == FileType::DDS)
     {
-      write_dds_data ddsData;
+      write_tex_data ddsData;
 
       ResourceFormat saveFmt = td.format;
       // use typeCast to inform typeless saving, otherwise it will get lost