# Vulkan Info

`vulkaninfo` is a program provided in the SDK which outputs various types of Vulkan information such as:

- device properties of identified GPUs
- Vulkan extensions supported by each GPU
- recognized layers
- supported image formats and format properties.

## Running Vulkan Info

After downloading and installing the SDK and setting up the runtime environment (see the Getting Started documentation) you will be able to run the `vulkaninfo` program from a command prompt.

    vulkaninfo

Running `vulkaninfo` without specifying the type of output will default to human-readable output to the console.

    vulkaninfo --html

To organize output in a convenient HTML format use the `--html` flag. Running `vulkaninfo` with the `--html` option produces a file called `vulkaninfo.html` and can be found in your build directory.

    vulkaninfo --json

Use the `--json` flag to produce DevSim-schema-compatible JSON output for your device. Additionally, JSON output can be specified with the `-j` flag and for multi-GPU systems, a single GPU can be targeted using the `--json=``GPU-number` flag where the `GPU-number` indicates the GPU of interest (e.g., `--json=0`). To determine the GPU number corresponding to a particular GPU, run `vulkaninfo` with the `--html` flag (or none at all) first; doing so will summarize all GPUs in the system.

The generated configuration information can be used as input for the `VK_LAYER_LUNARG_device_simulation` layer.

### Windows

`vulkaninfo` can also be found as a shortcut under the Start Menu.

- `Start Menu -> Vulkan SDK` `version``-> vulkaninfo`

Note: In order to review and/or save the output produced when using Visual Studio to run `vulkaninfo` with the JSON option, you will have to redirect output to a file by modifying the command line arguments in the debug options.