Get information about the Vulkan driver. More...

#include <driver_info_vk.h>

Public Member Functions
	DriverInfoVK (const vk::PhysicalDevice &device)

	~DriverInfoVK ()

	DriverInfoVK (const DriverInfoVK &)=delete

DriverInfoVK &	operator= (const DriverInfoVK &)=delete

const Version &	GetAPIVersion () const
	Gets the Vulkan API version. Should be at or above Vulkan 1.1 which is the Impeller baseline.

const VendorVK &	GetVendor () const
	Get the vendor of the Vulkan implementation. This is a broad check and includes multiple drivers and platforms.

const DeviceTypeVK &	GetDeviceType () const
	Get the device type. Typical use might be to check if the device is a CPU implementation.

const std::string &	GetDriverName () const
	Get the self-reported name of the graphics driver.

void	DumpToLog () const
	Dumps the current driver info to the log.

bool	IsEmulator () const
	Determines if the driver represents an emulator. There is no definitive way to tell if a driver is an emulator and drivers don't self identify as emulators. So take this information with a pinch of salt.

Detailed Description

Get information about the Vulkan driver.

Warning: Be extremely cautious about the information reported here. This is self-reported information (by the driver) and may be inaccurate and or inconsistent.

Before gating features behind any of the information reported by the driver, consider alternatives (extensions checks perhaps) and try to get a reviewer buddy to convince you to avoid using this.

Definition at line 69 of file driver_info_vk.h.

Constructor & Destructor Documentation

◆ DriverInfoVK() [1/2]

impeller::DriverInfoVK::DriverInfoVK ( const vk::PhysicalDevice & device )

explicit

Definition at line 108 of file driver_info_vk.cc.

                                                         {
  auto props = device.getProperties();
  api_version_ = Version{VK_API_VERSION_MAJOR(props.apiVersion),
                         VK_API_VERSION_MINOR(props.apiVersion),
                         VK_API_VERSION_PATCH(props.apiVersion)};
  vendor_ = IdentifyVendor(props.vendorID);
  if (vendor_ == VendorVK::kUnknown) {
    FML_LOG(WARNING) << "Unknown GPU Driver Vendor: " << props.vendorID
                     << ". This is not an error.";
  }
  type_ = ToDeviceType(props.deviceType);
  if (props.deviceName.data() != nullptr) {
    driver_name_ = props.deviceName.data();
  }
}

◆ ~DriverInfoVK()

impeller::DriverInfoVK::~DriverInfoVK ( )

default

◆ DriverInfoVK() [2/2]

impeller::DriverInfoVK::DriverInfoVK ( const DriverInfoVK & )

delete

Member Function Documentation

◆ DumpToLog()

void impeller::DriverInfoVK::DumpToLog ( ) const

Dumps the current driver info to the log.

Definition at line 142 of file driver_info_vk.cc.

                                   {
  std::vector<std::pair<std::string, std::string>> items;
  items.emplace_back("Name", driver_name_);
  items.emplace_back("API Version", api_version_.ToString());
  items.emplace_back("Vendor", VendorToString(vendor_));
  items.emplace_back("Device Type", DeviceTypeToString(type_));
  items.emplace_back("Is Emulator", std::to_string(IsEmulator()));
 
  size_t padding = 0;
 
  for (const auto& item : items) {
    padding = std::max(padding, item.first.size());
  }
 
  padding += 1;
 
  std::stringstream stream;
 
  stream << std::endl;
 
  stream << "--- Driver Information ------------------------------------------";
 
  stream << std::endl;
 
  for (const auto& item : items) {
    stream << "| " << std::setw(static_cast<int>(padding)) << item.first
           << std::setw(0) << ": " << item.second << std::endl;
  }
 
  stream << "-----------------------------------------------------------------";
 
  FML_LOG(IMPORTANT) << stream.str();
}

◆ GetAPIVersion()

const Version & impeller::DriverInfoVK::GetAPIVersion ( ) const

Gets the Vulkan API version. Should be at or above Vulkan 1.1 which is the Impeller baseline.

Returns: The Vulkan API version.

Definition at line 126 of file driver_info_vk.cc.

                                                 {
  return api_version_;
}

◆ GetDeviceType()

const DeviceTypeVK & impeller::DriverInfoVK::GetDeviceType ( ) const

Get the device type. Typical use might be to check if the device is a CPU implementation.

Returns: The device type.

Definition at line 134 of file driver_info_vk.cc.

                                                      {
  return type_;
}

◆ GetDriverName()

const std::string & impeller::DriverInfoVK::GetDriverName ( ) const

Get the self-reported name of the graphics driver.

Returns: The driver name.

Definition at line 138 of file driver_info_vk.cc.

                                                   {
  return driver_name_;
}

◆ GetVendor()

const VendorVK & impeller::DriverInfoVK::GetVendor ( ) const

Get the vendor of the Vulkan implementation. This is a broad check and includes multiple drivers and platforms.

Returns: The vendor.

Definition at line 130 of file driver_info_vk.cc.

                                              {
  return vendor_;
}

◆ IsEmulator()

bool impeller::DriverInfoVK::IsEmulator ( ) const

Determines if the driver represents an emulator. There is no definitive way to tell if a driver is an emulator and drivers don't self identify as emulators. So take this information with a pinch of salt.

Returns: True if emulator, False otherwise.

Definition at line 176 of file driver_info_vk.cc.

                                    {
#if FML_OS_ANDROID
  // Google SwiftShader on Android.
  if (type_ == DeviceTypeVK::kCPU && vendor_ == VendorVK::kGoogle &&
      driver_name_.find("SwiftShader") != std::string::npos) {
    return true;
  }
#endif  // FML_OS_ANDROID
  return false;
}

◆ operator=()

DriverInfoVK & impeller::DriverInfoVK::operator= ( const DriverInfoVK & )