Add imiv docs and Vulkan capture support

Add comprehensive documentation for the new imiv viewer (user, developer, and test-suite guides) and wire imiv into the docs index and CMake manpage generation. Update Doxygen config to focus on public headers, adjust include paths, and disable HTML/LaTeX/clang-assisted parsing for this build. Implement Vulkan capture helper in imiv_capture.cpp (add <cstdio> and capture_swapchain_region_rgba8_from_layout) and apply small supporting changes to Vulkan setup and imiv test/OCIO helper scripts to support live/update regression and tooling.

Author: ssh4net

src/doc/CMakeLists.txt

@@ -26,6 +26,10 @@ if (UNIX AND TXT2MAN AND Python3_Interpreter_FOUND)
     message (STATUS "Unix man page documentation will be generated")
     set (cli_tools oiiotool iinfo maketx idiff igrep iconvert)
 
+    if (TARGET imiv)
+        list (APPEND cli_tools imiv)
+    endif()
+
     if (TARGET iv)
         list (APPEND cli_tools iv)
     endif()

src/doc/Doxyfile

@@ -829,7 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../../src
+INPUT                  = ../../src/include/OpenImageIO
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -854,51 +854,11 @@ INPUT_ENCODING         = UTF-8
 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
 
-FILE_PATTERNS          = *.c \
-                         *.cc \
-                         *.cxx \
-                         *.cpp \
-                         *.c++ \
-                         *.java \
-                         *.ii \
-                         *.ixx \
-                         *.ipp \
-                         *.i++ \
-                         *.inl \
-                         *.idl \
-                         *.ddl \
-                         *.odl \
-                         *.h \
+FILE_PATTERNS          = *.h \
                          *.hh \
                          *.hxx \
                          *.hpp \
-                         *.h++ \
-                         *.cs \
-                         *.d \
-                         *.php \
-                         *.php4 \
-                         *.php5 \
-                         *.phtml \
-                         *.inc \
-                         *.m \
-                         *.markdown \
-                         *.md \
-                         *.mm \
-                         *.dox \
-                         *.py \
-                         *.pyw \
-                         *.f90 \
-                         *.f95 \
-                         *.f03 \
-                         *.f08 \
-                         *.f \
-                         *.for \
-                         *.tcl \
-                         *.vhd \
-                         *.vhdl \
-                         *.ucf \
-                         *.qsf \
-                         *.ice
+                         *.h++
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -1158,7 +1118,7 @@ IGNORE_PREFIX          =
 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
 # The default value is: YES.
 
-GENERATE_HTML          = YES
+GENERATE_HTML          = NO
 
 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -1713,7 +1673,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -2157,7 +2117,8 @@ SEARCH_INCLUDES        = YES
 # preprocessor.
 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
 
-INCLUDE_PATH           = ../../src
+INCLUDE_PATH           = ../../src/include \
+                         ../../build/include
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -2587,4 +2548,4 @@ GENERATE_LEGEND        = YES
 
 DOT_CLEANUP            = YES
 
-CLANG_ASSISTED_PARSING = YES
+CLANG_ASSISTED_PARSING = NO

src/doc/imiv.rst

@@ -0,0 +1,58 @@
+..
+  Copyright Contributors to the OpenImageIO project.
+  SPDX-License-Identifier: CC-BY-4.0
+
+
+.. _chap-imiv:
+
+`imiv`: ImGui Image Viewer
+################################
+
+.. highlight:: bash
+
+
+Overview
+========
+
+The :program:`imiv` program is an in-progress Dear ImGui-based replacement
+for the legacy :program:`iv` image viewer. It uses GLFW for windowing and
+currently supports renderer backends built around Vulkan, Metal, or OpenGL.
+
+ImIv port is still under active development, and several of the most
+valuable workflows are developer-facing:
+
+* understanding the shared app/viewer/UI architecture;
+* keeping behavior aligned across multiple renderer backends;
+* extending the automated GUI regression suite built on Dear ImGui Test
+  Engine.
+
+
+Current status
+==============
+
+:program:`imiv` already covers the core image-viewing loop, OCIO display
+controls, backend selection, persistent preferences, and a growing automated
+regression suite. But it does **not** yet claim full parity with
+:program:`iv`.
+
+In particular:
+
+* Vulkan is currently the reference backend for renderer-side feature work.
+* Metal and OpenGL are active development backends with some backend-specific
+  gaps and validation still in progress.
+* Some legacy :program:`iv` workflows are still intentionally marked as
+  incomplete or behaviorally different.
+
+For that reason, this chapter is organized into a compact user guide and
+deeper developer/testing guides.
+
+
+Documentation map
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   imiv_user
+   imiv_dev
+   imiv_tests