OpenXR 程式開發：簡單的顯示架構（part 1）

在 createSession() 這個函式裡面，基本上是要建立出 XrSession 這個管理 OpenXR 工作階段的物件、m_xrSession；函式的內容如下：

bool createSession()
{
  // Graphics requirements
  XrGraphicsRequirementsOpenGLKHR reqOpenGL{ XR_TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR };
  // Magic code block....
  // link error if call xrGetOpenGLGraphicsRequirementsKHR() directlly
  PFN_xrGetOpenGLGraphicsRequirementsKHR func;
  if (check(xrGetInstanceProcAddr(m_xrInstance, "xrGetOpenGLGraphicsRequirementsKHR", (PFN_xrVoidFunction*)&func),"xrGetInstanceProcAddr"))
  {
    if (check(func(m_xrInstance, m_xrSystem, &reqOpenGL),"PFN_xrGetOpenGLGraphicsRequirementsKHR"))
    {
      XrGraphicsBindingOpenGLWin32KHR gbOpenGL{ XR_TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR , nullptr, wglGetCurrentDC(), wglGetCurrentContext() };
      XrSessionCreateInfo infoSession{ XR_TYPE_SESSION_CREATE_INFO, &gbOpenGL, 0, m_xrSystem };
      return check(xrCreateSession(m_xrInstance, &infoSession, &m_xrSession),"xrCreateSession");
    }
  }
  return false;
}

這邊比較麻煩的，是在建立 XrSession 的時候，除了要知道既有的 XrInstance 外，也需要準備好 XrSessionCreateInfo 的資料（官方文件）；而其中，他的 next 會需要是 OpenXR 所定義的 graphics binging 的物件指標。

根據所使用的環境、圖形 API 的不同，他會視不同的型別。在這邊因為是要使用 Windows + OpenGL，所以需要的是 XrGraphicsBindingOpenGLWin32KHR（官方文件），而如果是使用 Linux 的 X11 的話，則可以使用 XrGraphicsBindingOpenGLXcbKHR 或 XrGraphicsBindingOpenGLXlibKHR；其他像是要使用 Direct3D 或 Vulkan 的話，也各有各自的型別…

而在定義 XrGraphicsBindingOpenGLWin32KHR 時，也還需要 Windows 的硬體裝置 handle（HDC）以及 Windows 的 OpenGL context（HGLRC）；這邊都可以透過 wgl 的函式來取得。

不過個人覺得比較麻煩的，是這邊還需要先設定 XrGraphicsRequirementsOpenGLKHR（官方文件）；如果沒有進行這一部分的話，session 的建立是會失敗的。

在處理的時候，這邊會需要呼叫 xrGetOpenGLGraphicsRequirementsKHR() 這個函式；但是這個函式雖然定義在 openxr_platform.h 這個檔案裡，但是卻沒有實體、沒辦法直接連結到。

所以要使用的時候，變成需要手動透過 xrGetInstanceProcAddr()（官方文件）來取得這個函式的 function pointer、才能拿來呼叫。

接下來，則是 createReferenceSpace() 的部分。

這部分算是相對單純，就是先準備 XrReferenceSpaceCreateInfo（官方文件）、來讓 xrCreateReferenceSpace() 使用、然後建立出參考空間 m_xrSpace。

bool createReferenceSpace()
{
  XrReferenceSpaceCreateInfo infoRefSpace{ XR_TYPE_REFERENCE_SPACE_CREATE_INFO, nullptr, XR_REFERENCE_SPACE_TYPE_LOCAL };
  infoRefSpace.poseInReferenceSpace.orientation = { 0,0,0,-1 };
  infoRefSpace.poseInReferenceSpace.position = { 0,0,0 };
  return check(xrCreateReferenceSpace(m_xrSession, &infoRefSpace, &m_xrSpace), "xrCreateReferenceSpace");
}

而這邊要注意的是，他的型別會是 XR_REFERENCE_SPACE_TYPE_LOCAL，然後要指定 poseInReferenceSpace 作為建立出來的空間原點的參考。

在 checkViewConfiguration() 的部分，算是之前提過的內容。

而由於這邊僅針對 XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO 做處理，所以就可以略過之前 xrEnumerateViewConfigurations() 的部分。

理論上由於是兩眼的立體顯示，所以會有兩個 view。

而為了方便後續的資料管理，這裡定義了一個 SViewData 的結構，用來保存兩眼各自的資料：

struct SViewData
{
  XrSwapchain  m_xrSwapChain;
  GLuint    m_glFrameBuffer = 0;
  std::vector<XrSwapchainImageOpenGLKHR>  m_vSwapchainImages;
};

在 createSwapChain() 這個函式中，主要是針對左右眼的兩個 view、各自去產生 XrSwapchain、並取得對應的 swapchain image。

下面就是這個函式的內容：

bool createSwapChain()
{
  XrSwapchainCreateInfo infoSwapchain;
  infoSwapchain.type = XR_TYPE_SWAPCHAIN_CREATE_INFO;
  infoSwapchain.next = nullptr;
  infoSwapchain.createFlags = 0;
  infoSwapchain.usageFlags = XR_SWAPCHAIN_USAGE_TRANSFER_DST_BIT;
  infoSwapchain.format = (int64_t)GL_SRGB8_ALPHA8;
  infoSwapchain.sampleCount = 1;
  infoSwapchain.width = m_vViews[0].recommendedImageRectWidth;
  infoSwapchain.height = m_vViews[0].recommendedImageRectHeight;
  infoSwapchain.faceCount = 1;
  infoSwapchain.arraySize = 1;
  infoSwapchain.mipCount = 1;
  bool bOK = true;
  for (auto& rVData : m_vViewDatas)
  {
    if (check(xrCreateSwapchain(m_xrSession, &infoSwapchain, &rVData.m_xrSwapChain),"xrCreateSwapchain"))
    {
      uint32_t uSwapchainNum = 0;
      if (check(xrEnumerateSwapchainImages(rVData.m_xrSwapChain, uSwapchainNum, &uSwapchainNum, nullptr),"xrEnumerateSwapchainImages-1") && uSwapchainNum > 0)
      {
        rVData.m_vSwapchainImages.resize(uSwapchainNum, { XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR });
        if (!check(xrEnumerateSwapchainImages(rVData.m_xrSwapChain, uSwapchainNum, &uSwapchainNum, (XrSwapchainImageBaseHeader*)rVData.m_vSwapchainImages.data()),"xrEnumerateSwapchainImages-2"))
          {
            bOK = false;
            break;
          }
      }
      else
      {
        bOK = false;
        break;
      }
    }
    else
    {
      bOK = false;
      break;
    }
  }
  return bOK;
}

這邊是會先建立一個 XrSwapchainCreateInfo 的物件 infoSwapchain、代表要產生的 swapchain 的資料；由於左右兩眼基本上會一致，所以這邊就共用了。

之後，則是針對兩眼的 SViewData、各自使用 xrCreateSwapchain() 來建立 XrSwapchain，然後再呼叫 xrEnumerateSwapchainImages()、列舉出對應的 swapchain image。

要注意的是，由於這邊是使用 OpenGL，所以實際上的 swapchain image 的型別是 XrSwapchainImageOpenGLKHR；而如果是使用 Direct3D 或 Vulkan 的話，也都必須把型別改掉。

但是為了統一介面，xrEnumerateSwapchainImages() 需要的是 XrSwapchainImageBaseHeader，所以在乎叫的時候會需要做型別的轉換。

OpenXR 初始化的最後，則是要準備 composition layer 的資訊，告訴 OpenXR 要怎麼處理畫面。

bool prepareCompositionLayer()
{
  m_vProjectionLayerViews.resize(m_vViewDatas.size());
  for (int i = 0; i < m_vViewDatas.size(); ++i)
  {
    m_vProjectionLayerViews[i].type = XR_TYPE_COMPOSITION_LAYER_PROJECTION;
    m_vProjectionLayerViews[i].next = nullptr;
    m_vProjectionLayerViews[i].subImage.imageArrayIndex = 0;
    m_vProjectionLayerViews[i].subImage.swapchain = m_vViewDatas[i].m_xrSwapChain;
    m_vProjectionLayerViews[i].subImage.imageRect.extent = { (int32_t)m_vViews[0].recommendedImageRectWidth, (int32_t)m_vViews[0].recommendedImageRectHeight };
  }
  XrCompositionLayerProjection* pProjectionLayer = new XrCompositionLayerProjection{ XR_TYPE_COMPOSITION_LAYER_PROJECTION, nullptr, 0, m_xrSpace,(uint32_t) m_vProjectionLayerViews.size(), m_vProjectionLayerViews.data() };
  m_vLayersPointers.push_back((XrCompositionLayerBaseHeader*)pProjectionLayer);
  return true;
}

這邊要先準備一個 XrCompositionLayerProjectionView 的陣列 m_vProjectionLayerViews、然後填入對應的資料（要指定對應的 swapchain）。

之後，則是要建立 XrCompositionLayerProjection 的物件，然後放到 XrCompositionLayerBaseHeader 的陣列（m_vLayersPointers），在之後繪製的時候會用到。

這邊由於是雙眼的投影畫面，所以型別都是 XR_TYPE_COMPOSITION_LAYER_PROJECTION；而如果 OpenXR runtime 有支援的話，OpenXR 其實也支援 XR_TYPE_COMPOSITION_LAYER_QUAD 這種，在空間中插入一個平面的 layer，如果拿來做圖形介面、可能就可以考慮了。