Share graphics API layer between tests/examples (#603)

The `render-test` project has an in-progress graphics API abstraction layer, and it makes sense to share this code with our examples rather than write a bunch of redundant code between examples and tests.

Most of this change is just moving files from `tools/render-test/*` to a new library project at `tools/slang-graphics/`. The most complicated code change there is renaming from `render_test` to `slang_graphics`.

The existing `hello` example was ported to use the graphics API layer instead of raw D3D11 API calls. It is still hard-coded to use the D3D11 back-end and the `SLANG_DXBC` target, so more work is needed if we want to actually support multiple APIs in the examples.

I also went ahead and implemented an extremely rudimentary set of APIs to abstract over the Windows platform calls that were being made in the example, so that we could potentially run that same example on other platforms. I did *not* port `render-test` to use those APIs, and I also did not implement them for anything but Windows (my assumption is that for most other platforms we would just use SDL2, and require people to ensure it is installed to their machine before building Slang examples).

1 files changed, 0 insertions, 421 deletions

diff --git a/tools/render-test/vk-swap-chain.cpp b/tools/render-test/vk-swap-chain.cpp
deleted file mode 100644
index 7b8b6221c..000000000
--- a/tools/render-test/vk-swap-chain.cpp
+++ /dev/null
@@ -1,421 +0,0 @@
-// vk-swap-chain.cpp
-#include "vk-swap-chain.h"
-
-#include "vk-util.h"
-
-#include "../../source/core/list.h"
-
-#include <stdlib.h>
-#include <stdio.h>
-
-namespace renderer_test {
-using namespace Slang;
-
-static int _indexOf(List<VkSurfaceFormatKHR>& formatsIn, VkFormat format)
-{
-    const int numFormats = int(formatsIn.Count());
-    const VkSurfaceFormatKHR* formats = formatsIn.Buffer();
-
-    for (int i = 0; i < numFormats; ++i)
-    {
-        if (formats[i].format == format)
-        {
-            return i;
-        }
-    }
-    return -1;
-}
-
-SlangResult VulkanSwapChain::init(VulkanDeviceQueue* deviceQueue, const Desc& descIn, const PlatformDesc* platformDescIn)
-{
-    assert(platformDescIn);
-
-    m_deviceQueue = deviceQueue;
-    m_api = deviceQueue->getApi();
-    
-    // Make sure it's not set initially
-    m_format = VK_FORMAT_UNDEFINED;
-
-    Desc desc(descIn);
-
-#if SLANG_WINDOWS_FAMILY
-    const WinPlatformDesc* platformDesc = static_cast<const WinPlatformDesc*>(platformDescIn);
-    _setPlatformDesc(*platformDesc);
-
-    VkWin32SurfaceCreateInfoKHR surfaceCreateInfo = {};
-    surfaceCreateInfo.sType = VK_STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR;
-    surfaceCreateInfo.hinstance = platformDesc->m_hinstance;
-    surfaceCreateInfo.hwnd = platformDesc->m_hwnd;
-
-    SLANG_VK_RETURN_ON_FAIL(m_api->vkCreateWin32SurfaceKHR(m_api->m_instance, &surfaceCreateInfo, nullptr, &m_surface));
-#else
-    const XPlatformDesc* platformDesc = static_cast<const XPlatformDesc*>(platformDescIn);
-    _setPlatformDesc(*platformDesc);
-
-    VkXlibSurfaceCreateInfoKHR surfaceCreateInfo = {};
-    surfaceCreateInfo.sType = VK_STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR;
-    surfaceCreateInfo.dpy = platformDesc->m_display; 
-    surfaceCreateInfo.window = platformDesc->m_window;
-    
-    SLANG_VK_RETURN_ON_FAIL(m_api->vkCreateXlibSurfaceKHR(m_api->m_instance, &surfaceCreateInfo, nullptr, &m_surface));
-#endif
-
-    VkBool32 supported = false;
-    m_api->vkGetPhysicalDeviceSurfaceSupportKHR(m_api->m_physicalDevice, deviceQueue->getQueueIndex(), m_surface, &supported);
-
-    uint32_t numSurfaceFormats = 0;
-    List<VkSurfaceFormatKHR> surfaceFormats;
-    m_api->vkGetPhysicalDeviceSurfaceFormatsKHR(m_api->m_physicalDevice, m_surface, &numSurfaceFormats, nullptr);
-    surfaceFormats.SetSize(int(numSurfaceFormats));
-    m_api->vkGetPhysicalDeviceSurfaceFormatsKHR(m_api->m_physicalDevice, m_surface, &numSurfaceFormats, surfaceFormats.Buffer());
-
-    // Look for a suitable format
-    List<VkFormat> formats;
-    formats.Add(VulkanUtil::getVkFormat(desc.m_format));
-    // HACK! To check for a different format if couldn't be found
-    if (descIn.m_format == Format::RGBA_Unorm_UInt8)
-    {
-        formats.Add(VK_FORMAT_B8G8R8A8_UNORM);
-    }
-
-    for(int i = 0; i < int(formats.Count()); ++i)
-    {
-        VkFormat format = formats[i];
-        if (_indexOf(surfaceFormats, format) >= 0)
-        {
-            m_format =  format;
-        }
-    }
-
-    if (m_format == VK_FORMAT_UNDEFINED)
-    {
-        return SLANG_FAIL;
-    }
-
-    // Save the desc
-    m_desc = desc;
-
-    SLANG_RETURN_ON_FAIL(_createSwapChain());
-
-    m_desc = desc;
-    return SLANG_OK;
-}
-
-void VulkanSwapChain::getWindowSize(int* widthOut, int* heightOut) const
-{
-#if SLANG_WINDOWS_FAMILY
-    auto platformDesc = _getPlatformDesc<WinPlatformDesc>();
-
-    RECT rc;
-    ::GetClientRect(platformDesc->m_hwnd, &rc);
-    *widthOut = rc.right - rc.left;
-    *heightOut = rc.bottom - rc.top;
-#else
-    auto platformDesc = _getPlatformDesc<XPlatformDesc>();
-
-    XWindowAttributes winAttr = {}; 
-    XGetWindowAttributes(platformDesc->m_display, platformDesc->m_window, &winAttr);
-
-    *widthOut = winAttr.width;
-    *heightOut = winAttr.height;
-#endif
-}
-
-SlangResult VulkanSwapChain::_createFrameBuffers(VkRenderPass renderPass)
-{
-    assert(renderPass != VK_NULL_HANDLE);
-
-    for (int i = 0; i < int(m_images.Count()); ++i)
-    {
-        Image& image = m_images[i];
-        VkImageView attachments[] = 
-        {
-            image.m_imageView
-        };
-
-        VkFramebufferCreateInfo framebufferInfo = {};
-        framebufferInfo.sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO;
-        framebufferInfo.renderPass = renderPass;
-        framebufferInfo.attachmentCount = 1;
-        framebufferInfo.pAttachments = attachments;
-        framebufferInfo.width = m_width;
-        framebufferInfo.height = m_height;
-        framebufferInfo.layers = 1;
-
-        SLANG_VK_RETURN_ON_FAIL(m_api->vkCreateFramebuffer(m_api->m_device, &framebufferInfo, nullptr, &image.m_frameBuffer));
-    }
-
-    return SLANG_OK;
-}
-
-void VulkanSwapChain::_destroyFrameBuffers()
-{
-    for (int i = 0; i < int(m_images.Count()); ++i)
-    {
-        Image& image = m_images[i];
-        if (image.m_frameBuffer != VK_NULL_HANDLE)
-        {
-            m_api->vkDestroyFramebuffer(m_api->m_device, image.m_frameBuffer, nullptr);
-            image.m_frameBuffer = VK_NULL_HANDLE;
-        }
-    }
-}
-
-SlangResult VulkanSwapChain::createFrameBuffers(VkRenderPass renderPass)
-{
-    if (m_renderPass != VK_NULL_HANDLE)
-    {
-        _destroyFrameBuffers();
-        m_renderPass = VK_NULL_HANDLE;
-    }
-    if (renderPass != VK_NULL_HANDLE)
-    {
-        SLANG_RETURN_ON_FAIL(_createFrameBuffers(renderPass));
-    }
-    m_renderPass = renderPass;
-    return SLANG_OK;
-}
-
-SlangResult VulkanSwapChain::_createSwapChain()
-{
-    if (hasValidSwapChain())
-    {
-        return SLANG_OK;
-    }
-
-    int width, height; 
-    getWindowSize(&width, &height);
-
-    VkExtent2D imageExtent = {};
-    imageExtent.width = width;
-    imageExtent.height = height;
-
-    m_width = width;
-    m_height = height;
-
-    // catch this before throwing error
-    if (m_width == 0 || m_height == 0)
-    {
-        return SLANG_FAIL;
-    }
-
-    // It is necessary to query the caps -> otherwise the LunarG verification layer will issue an error
-    {
-        VkSurfaceCapabilitiesKHR surfaceCaps;
-
-        SLANG_VK_RETURN_ON_FAIL(m_api->vkGetPhysicalDeviceSurfaceCapabilitiesKHR(m_api->m_physicalDevice, m_surface, &surfaceCaps));
-    }
-
-    List<VkPresentModeKHR> presentModes;
-    uint32_t numPresentModes = 0;
-    m_api->vkGetPhysicalDeviceSurfacePresentModesKHR(m_api->m_physicalDevice, m_surface, &numPresentModes, nullptr);
-    presentModes.SetSize(numPresentModes);
-    m_api->vkGetPhysicalDeviceSurfacePresentModesKHR(m_api->m_physicalDevice, m_surface, &numPresentModes, presentModes.Buffer());
-
-    {
-        int numCheckPresentOptions = 3;
-        VkPresentModeKHR presentOptions[] = { VK_PRESENT_MODE_IMMEDIATE_KHR, VK_PRESENT_MODE_MAILBOX_KHR, VK_PRESENT_MODE_FIFO_KHR };
-        if (m_vsync)
-        {
-            presentOptions[0] = VK_PRESENT_MODE_FIFO_KHR;
-            presentOptions[1] = VK_PRESENT_MODE_IMMEDIATE_KHR;
-            presentOptions[2] = VK_PRESENT_MODE_MAILBOX_KHR;
-        }
-
-        m_presentMode = VK_PRESENT_MODE_MAX_ENUM_KHR;       // Invalid
-
-        // Find the first option that's available on the device
-        for (int j = 0; j < numCheckPresentOptions; j++)
-        {
-            if (presentModes.IndexOf(presentOptions[j]) != UInt(-1))
-            {
-                m_presentMode = presentOptions[j];
-                break;
-            } 
-        } 
-
-        if (m_presentMode == VK_PRESENT_MODE_MAX_ENUM_KHR)
-        {
-            return SLANG_FAIL;
-        }
-    }
-
-    VkSwapchainKHR oldSwapchain = VK_NULL_HANDLE;
-
-    VkSwapchainCreateInfoKHR swapchainDesc = {};
-    swapchainDesc.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR;
-    swapchainDesc.surface = m_surface;
-    swapchainDesc.minImageCount = 3;
-    swapchainDesc.imageFormat = m_format;
-    swapchainDesc.imageColorSpace = VK_COLOR_SPACE_SRGB_NONLINEAR_KHR;
-    swapchainDesc.imageExtent = imageExtent;
-    swapchainDesc.imageArrayLayers = 1;
-    swapchainDesc.imageUsage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT;
-    swapchainDesc.imageSharingMode = VK_SHARING_MODE_EXCLUSIVE;
-    swapchainDesc.preTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
-    swapchainDesc.compositeAlpha = VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR;
-    swapchainDesc.presentMode = m_presentMode;
-    swapchainDesc.clipped = VK_TRUE;
-    swapchainDesc.oldSwapchain = oldSwapchain;
-
-    SLANG_VK_RETURN_ON_FAIL(m_api->vkCreateSwapchainKHR(m_api->m_device, &swapchainDesc, nullptr, &m_swapChain));
-
-    uint32_t numSwapChainImages = 0;
-    m_api->vkGetSwapchainImagesKHR(m_api->m_device, m_swapChain, &numSwapChainImages, nullptr);
-    
-    {
-        List<VkImage> images;
-        images.SetSize(numSwapChainImages);
-
-        m_api->vkGetSwapchainImagesKHR(m_api->m_device, m_swapChain, &numSwapChainImages, images.Buffer());
-    
-        m_images.SetSize(numSwapChainImages);
-        for (int i = 0; i < int(numSwapChainImages); ++i)
-        {
-            Image& dstImage = m_images[i];
-            dstImage.m_image = images[i];
-         
-        }
-    }
-
-    {
-        VkImageViewCreateInfo createInfo = {};
-        createInfo.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
-        
-        createInfo.viewType = VK_IMAGE_VIEW_TYPE_2D;
-        createInfo.format = m_format;
-        
-        createInfo.components.r = VK_COMPONENT_SWIZZLE_IDENTITY;
-        createInfo.components.g = VK_COMPONENT_SWIZZLE_IDENTITY;
-        createInfo.components.b = VK_COMPONENT_SWIZZLE_IDENTITY;
-        createInfo.components.a = VK_COMPONENT_SWIZZLE_IDENTITY;
-
-        createInfo.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
-        createInfo.subresourceRange.baseMipLevel = 0;
-        createInfo.subresourceRange.levelCount = 1;
-        createInfo.subresourceRange.baseArrayLayer = 0;
-        createInfo.subresourceRange.layerCount = 1;
-
-        for (int i = 0; i < int(numSwapChainImages); ++i)
-        {
-            Image& image = m_images[i];
-
-            createInfo.image = image.m_image;
-      
-            SLANG_VK_RETURN_ON_FAIL(m_api->vkCreateImageView(m_api->m_device, &createInfo, nullptr, &image.m_imageView));
-        }
-    }
-
-    if (m_renderPass != VK_NULL_HANDLE)
-    {
-        _createFrameBuffers(m_renderPass);
-    }
-
-    return SLANG_OK;
-}
-
-void VulkanSwapChain::_destroySwapChain()
-{
-    if (!hasValidSwapChain())
-    {
-        return;   
-    }
-
-    m_deviceQueue->waitForIdle();
-
-    if (m_renderPass != VK_NULL_HANDLE)
-    {
-        _destroyFrameBuffers();
-    }
-
-    for (int i = 0; i < int(m_images.Count()); ++i)
-    {
-        Image& image = m_images[i];
-
-        if (image.m_imageView != VK_NULL_HANDLE)
-        {
-            m_api->vkDestroyImageView(m_api->m_device, image.m_imageView, nullptr);
-        }
-    }
-
-    if (m_swapChain != VK_NULL_HANDLE)
-    {
-        m_api->vkDestroySwapchainKHR(m_api->m_device, m_swapChain, nullptr);
-        m_swapChain = VK_NULL_HANDLE;
-    }
-
-    // Mark that it is no longer used
-    m_images.Clear();
-}
-
-VulkanSwapChain::~VulkanSwapChain()
-{
-    _destroySwapChain();
-   
-    if (m_surface)
-    {
-        m_api->vkDestroySurfaceKHR(m_api->m_instance, m_surface, nullptr);
-        m_surface = VK_NULL_HANDLE;
-    }
-}
-
-int VulkanSwapChain::nextFrontImageIndex()
-{
-    if (!hasValidSwapChain())
-    {
-        if (SLANG_FAILED(_createSwapChain()))
-        {
-            return -1;
-        }
-    }
-
-    VkSemaphore beginFrameSemaphore = m_deviceQueue->makeCurrent(VulkanDeviceQueue::EventType::BeginFrame);
-    
-    uint32_t swapChainIndex = 0;
-    VkResult result = m_api->vkAcquireNextImageKHR(m_api->m_device, m_swapChain, UINT64_MAX, beginFrameSemaphore, VK_NULL_HANDLE, &swapChainIndex);
-
-    if (result != VK_SUCCESS)
-    {
-        _destroySwapChain();
-        return -1;
-    }
-    m_currentSwapChainIndex = int(swapChainIndex);
-    return swapChainIndex;
-}
-
-void VulkanSwapChain::present(bool vsync)
-{
-    if (!hasValidSwapChain())
-    {
-        m_deviceQueue->flush();
-        return;
-    }
-
-    VkSemaphore endFrameSemaphore = m_deviceQueue->makeCurrent(VulkanDeviceQueue::EventType::EndFrame);
-    
-    m_deviceQueue->flushStepA();
-    
-    uint32_t swapChainIndices[] = { uint32_t(m_currentSwapChainIndex) };
-
-    VkPresentInfoKHR presentInfo = {};
-    presentInfo.sType = VK_STRUCTURE_TYPE_PRESENT_INFO_KHR;
-    presentInfo.swapchainCount = 1;
-    presentInfo.pSwapchains = &m_swapChain; 
-    presentInfo.pImageIndices = swapChainIndices;
-    presentInfo.waitSemaphoreCount = 1;
-    presentInfo.pWaitSemaphores = &endFrameSemaphore;
-
-    VkResult result = m_api->vkQueuePresentKHR(m_deviceQueue->getQueue(), &presentInfo);
-
-    m_deviceQueue->makeCompleted(VulkanDeviceQueue::EventType::EndFrame);
-    
-    m_deviceQueue->flushStepB();
-    
-    if (result != VK_SUCCESS || m_vsync != vsync)
-    {
-        m_vsync = vsync;
-        _destroySwapChain();
-    }
-}
-
-} // renderer_test