Skip to content

README.md

Latest commit

 

History

History
41 lines (26 loc) · 3.7 KB

README.md

File metadata and controls

41 lines (26 loc) · 3.7 KB
Raw

Vulkan SC Emulation ICD

This directory contains the Vulkan SC Emulation ICD that enables running Vulkan SC applications on top of a Vulkan implementation.

Introduction

The Vulkan SC Emulation ICD is focused on enabling developers to create and test Vulkan SC applications on any platform with a Vulkan driver.

Using the Vulkan SC Emulation ICD

To enable using the Vulkan SC Emulation ICD, make sure to install it to any of the locations the Vulkan SC Loader uses to search for available ICDs or set the VK_ICD_FILENAMES, VK_DRIVER_FILES, or VK_ADD_DRIVER_FILES to point to the JSON manifest of the Vulkan SC Emulation ICD (vksconvk.json).

In addition, the Vulkan SC Emulation ICD must be on the system-specific library loading path.

On Linux, this can be achieved e.g. by configuring the following environment variables:

export LD_LIBRARY_PATH=<install_dir>/lib
export VK_DRIVER_FILES=<install_dir>/share/vulkansc/icd.d/vksconvk.json

On Windows, this can be achieved e.g. by configuring the following environment variables:

set PATH=<install_dir>\bin;%PATH%
set VK_DRIVER_FILES=<install_dir>\bin\vksconvk.json

Loader environment variable handling

Both the Vulkan SC Loader and the Vulkan Loader use the same set of environment variable names for their configuration. As using the Vulkan SC Emulation ICD means that both the Vulkan SC and Vulkan Loader are part of the system (as the emulation ICD loads the Vulkan API per usual), the default environment variable names will only be applied for the Vulkan SC driver. If the user needs to configure any of the environment variables to be used by the Vulkan Loader instead of the Vulkan SC Loader (e.g. for development purposes), then the user should set an environment variable with the VKSC_EMU_ prefix instead (e.g. VKSC_EMU_VK_LAYER_PATH).

Configuration environment variables

The behavior of the Vulkan SC Emulation ICD can be controlled with the following environment variables:

  • VKSC_EMULATION_DEBUG works similarly to the loader environment variable VK_LOADER_DEBUG and enables different levels of debug output to be generated to stderr and/or to API debug callbacks. The variable can be set to a comma-delimited list of log level options (available options: error, warn, info, debug).
  • VKSC_EMULATION_RECYCLE_PIPELINE_MEMORY controls whether the ICD reports support for the recyclePipelineMemory Vulkan SC 1.0 device property. If set to 0, then the ICD will report recyclePipelineMemory as VK_FALSE, otherwise (by default) as VK_TRUE.
  • VKSC_EMULATION_MAX_LOGICAL_DEVICES can be used to set the maximum number of logical devices that can be createad for a single physical device. The default limit is 65536. Setting this to 1 can be used to emulate implementations that only support creating a single VkDevice in a single VkInstance. Note that this limit applies per VkInstance, therefore creating more logical devices across multiple VkInstance objects is still allowed.
  • VKSC_EMULATION_DISPLAYS controls the number of VkDisplayKHR objects to emulate using Win32/X11 windows on supported platforms and implementations. Setting the variable to 0 disables VkDisplayKHR emulation. The default value is 4.
  • VKSC_EMULATION_DISPLAY_CONFIG can be used to specify a JSON configuration to source for the number and properties of the VkDisplayKHR objects to emulate using Win32/X11 windows on supported platforms and implementations. If specified, the JSON configuration overrides the default emulated display parameters and any value specified through the VKSC_EMULATION_DISPLAYS environment variable. An example display configuration file can be found in sample_display_config.json.