Skip to content

Commit 8b9687f

Browse files
MathiasMagnuscharles-lunarg
authored andcommitted
docs: Document filtering env var usage
1 parent 65e5428 commit 8b9687f

File tree

1 file changed

+76
-1
lines changed

1 file changed

+76
-1
lines changed

docs/LoaderInterfaceArchitecture.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,12 @@ environment variable.
557557
This is useful if you disable all layers/drivers with the intent of only
558558
enabling a smaller subset of specific layers/drivers for issue triaging.
559559

560+
### Multiple Filtering
561+
562+
When multiple `VK_LOADER_<DEVICE|VENDOR|DRIVER>_ID_FILTER`s are provided, they
563+
apply cummulatively. Only devices matching all of the filters will be presented
564+
to the application.
565+
560566
## Table of Debug Environment Variables
561567

562568
The following are all the Debug Environment Variables available for use with the
@@ -767,7 +773,7 @@ discovery.
767773
other devices in the return order of <i>vkGetPhysicalDevices<i> and
768774
<i>vkGetPhysicalDeviceGroups<i> functions.<br/>
769775
The value should be "<hex vendor id>:<hex device id>".<br/>
770-
<b>NOTE:</b> This DOES NOT REMOVE devices from the list on reorders them.
776+
<b>NOTE:</b> This DOES NOT REMOVE devices from the list, only reorders them.
771777
</small></td>
772778
<td><small>
773779
<b>Linux Only</b>
@@ -986,6 +992,75 @@ discovery.
986992
&nbsp;&nbsp;VK_LOADER_DISABLE_DYNAMIC_LIBRARY_UNLOADING=1<br/><br/>
987993
</small></td>
988994
</tr>
995+
<tr>
996+
<td><small>
997+
<i>VK_LOADER_DEVICE_ID_FILTER</i>
998+
</small></td>
999+
<td><small>
1000+
If set, causes the loader to only enumerate physical devices matching the
1001+
filter. The filter is a comma-delimited list of device ids or device id
1002+
ranges, where ids may be provided as decimal or hexadecimal values and ranges
1003+
are colon-delimited. A device passes if any one of the filters match its
1004+
device id as provided by <i>VkPhysicalDeviceProperties::deviceID<i>.
1005+
</small></td>
1006+
<td><small>
1007+
This functionality is only available with Loaders built with version
1008+
1.4.326 of the Vulkan headers and later.
1009+
</small></td>
1010+
<td><small>
1011+
export<br/>
1012+
&nbsp;&nbsp;VK_LOADER_DEVICE_ID_FILTER=0x7460:0x747e,29827<br/>
1013+
<br/>
1014+
set<br/>
1015+
&nbsp;&nbsp;VK_LOADER_DEVICE_ID_FILTER=0x7460:0x747e,29827<br/><br/>
1016+
</small></td>
1017+
</tr>
1018+
<tr>
1019+
<td><small>
1020+
<i>VK_LOADER_VENDOR_ID_FILTER</i>
1021+
</small></td>
1022+
<td><small>
1023+
If set, causes the loader to only enumerate physical devices matching the
1024+
filter. The filter is a comma-delimited list of vendor ids or vendor id
1025+
ranges, where ids may be provided as decimal or hexadecimal values and ranges
1026+
are colon-delimited. A device passes if any one of the filters match its
1027+
vendor id as provided by <i>VkPhysicalDeviceProperties::vendorID<i>.
1028+
</small></td>
1029+
<td><small>
1030+
This functionality is only available with Loaders built with version
1031+
1.4.326 of the Vulkan headers and later.
1032+
</small></td>
1033+
<td><small>
1034+
export<br/>
1035+
&nbsp;&nbsp;VK_LOADER_VENDOR_ID_FILTER=65541<br/>
1036+
<br/>
1037+
set<br/>
1038+
&nbsp;&nbsp;VK_LOADER_VENDOR_ID_FILTER=65541<br/><br/>
1039+
</small></td>
1040+
</tr>
1041+
<tr>
1042+
<td><small>
1043+
<i>VK_LOADER_DRIVER_ID_FILTER</i>
1044+
</small></td>
1045+
<td><small>
1046+
If set, causes the loader to only enumerate physical devices matching the
1047+
filter. The filter is a comma-delimited list of driver ids or driver id
1048+
ranges, where ids may be provided as decimal or hexadecimal values and ranges
1049+
are colon-delimited. A device passes if any one of the filters match its
1050+
driver id as provided by <i>VkPhysicalDeviceDriverProperties::driverID<i>.
1051+
</small></td>
1052+
<td><small>
1053+
This functionality is only available with Loaders built with version
1054+
1.4.326 of the Vulkan headers and later.
1055+
</small></td>
1056+
<td><small>
1057+
export<br/>
1058+
&nbsp;&nbsp;VK_LOADER_DRIVER_ID_FILTER=1-3:13<br/>
1059+
<br/>
1060+
set<br/>
1061+
&nbsp;&nbsp;VK_LOADER_DRIVER_ID_FILTER=1-3:13<br/><br/>
1062+
</small></td>
1063+
</tr>
9891064
</table>
9901065

9911066
<br/>

0 commit comments

Comments
 (0)