module Engine.Vulkan.Capabilities ( Capabilities(..) , probe , hasExtension , anisotropyLimit , sampleShading , logCapabilities ) where import RIO import Data.Typeable (cast) import RIO.Map qualified as Map import RIO.Set qualified as Set import RIO.Text qualified as Text import RIO.Vector qualified as Vector import Vulkan.Core10 qualified as Vk import Vulkan.Core11 (PhysicalDeviceProperties2(..), getPhysicalDeviceProperties2) import Vulkan.Core12 (PhysicalDeviceVulkan11Features, PhysicalDeviceVulkan11Properties, PhysicalDeviceVulkan12Features, PhysicalDeviceVulkan12Properties(..)) import Vulkan.Core13 (PhysicalDeviceVulkan13Features, PhysicalDeviceVulkan13Properties) import Vulkan.CStruct.Extends (Extendss, PeekChain, PokeChain, SomeStruct) import Vulkan.Extensions.VK_EXT_attachment_feedback_loop_layout (PhysicalDeviceAttachmentFeedbackLoopLayoutFeaturesEXT) import Vulkan.Extensions.VK_EXT_conditional_rendering (PhysicalDeviceConditionalRenderingFeaturesEXT) import Vulkan.Extensions.VK_EXT_custom_border_color (PhysicalDeviceCustomBorderColorFeaturesEXT, PhysicalDeviceCustomBorderColorPropertiesEXT, pattern EXT_CUSTOM_BORDER_COLOR_EXTENSION_NAME) import Vulkan.Extensions.VK_EXT_depth_clip_control (PhysicalDeviceDepthClipControlFeaturesEXT) import Vulkan.Extensions.VK_EXT_depth_clip_enable (PhysicalDeviceDepthClipEnableFeaturesEXT) import Vulkan.Extensions.VK_EXT_dynamic_rendering_unused_attachments (PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT) import Vulkan.Extensions.VK_EXT_extended_dynamic_state3 (PhysicalDeviceExtendedDynamicState3FeaturesEXT, PhysicalDeviceExtendedDynamicState3PropertiesEXT, pattern EXT_EXTENDED_DYNAMIC_STATE_3_EXTENSION_NAME) import Vulkan.Extensions.VK_EXT_external_memory_host (PhysicalDeviceExternalMemoryHostPropertiesEXT, pattern EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME) import Vulkan.Extensions.VK_EXT_fragment_shader_interlock (PhysicalDeviceFragmentShaderInterlockFeaturesEXT) import Vulkan.Extensions.VK_EXT_graphics_pipeline_library (PhysicalDeviceGraphicsPipelineLibraryFeaturesEXT, PhysicalDeviceGraphicsPipelineLibraryPropertiesEXT, pattern EXT_GRAPHICS_PIPELINE_LIBRARY_EXTENSION_NAME) import Vulkan.Extensions.VK_EXT_image_view_min_lod (PhysicalDeviceImageViewMinLodFeaturesEXT) import Vulkan.Extensions.VK_EXT_line_rasterization (pattern EXT_LINE_RASTERIZATION_EXTENSION_NAME) import Vulkan.Extensions.VK_EXT_mutable_descriptor_type (PhysicalDeviceMutableDescriptorTypeFeaturesEXT) import Vulkan.Extensions.VK_EXT_non_seamless_cube_map (PhysicalDeviceNonSeamlessCubeMapFeaturesEXT) import Vulkan.Extensions.VK_EXT_primitive_topology_list_restart (PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT) import Vulkan.Extensions.VK_EXT_robustness2 (PhysicalDeviceRobustness2FeaturesEXT, PhysicalDeviceRobustness2PropertiesEXT, pattern EXT_ROBUSTNESS_2_EXTENSION_NAME) import Vulkan.Extensions.VK_EXT_sample_locations (PhysicalDeviceSampleLocationsPropertiesEXT, pattern EXT_SAMPLE_LOCATIONS_EXTENSION_NAME) import Vulkan.Extensions.VK_EXT_shader_atomic_float (PhysicalDeviceShaderAtomicFloatFeaturesEXT) import Vulkan.Extensions.VK_EXT_transform_feedback (PhysicalDeviceTransformFeedbackFeaturesEXT, PhysicalDeviceTransformFeedbackPropertiesEXT, pattern EXT_TRANSFORM_FEEDBACK_EXTENSION_NAME) import Vulkan.Extensions.VK_EXT_vertex_input_dynamic_state (PhysicalDeviceVertexInputDynamicStateFeaturesEXT) import Vulkan.Extensions.VK_KHR_global_priority (PhysicalDeviceGlobalPriorityQueryFeaturesKHR) import Vulkan.Extensions.VK_KHR_index_type_uint8 (PhysicalDeviceIndexTypeUint8FeaturesKHR) import Vulkan.Extensions.VK_KHR_line_rasterization (PhysicalDeviceLineRasterizationFeaturesKHR, PhysicalDeviceLineRasterizationPropertiesKHR) import Vulkan.Extensions.VK_KHR_maintenance5 (PhysicalDeviceMaintenance5FeaturesKHR, PhysicalDeviceMaintenance5PropertiesKHR, pattern KHR_MAINTENANCE_5_EXTENSION_NAME) import Vulkan.Extensions.VK_KHR_push_descriptor (PhysicalDevicePushDescriptorPropertiesKHR, pattern KHR_PUSH_DESCRIPTOR_EXTENSION_NAME) import Vulkan.Extensions.VK_KHR_vertex_attribute_divisor (PhysicalDeviceVertexAttributeDivisorFeaturesKHR, PhysicalDeviceVertexAttributeDivisorPropertiesKHR, pattern KHR_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME) import Vulkan.Requirement (DeviceRequirement(..)) import Vulkan.Utils.Requirements (RequirementResult(..), checkDeviceRequirements, prettyRequirementResult) import Vulkan.Version (_API_VERSION_MAJOR, _API_VERSION_MINOR, _API_VERSION_PATCH) import Vulkan.Zero (Zero, zero) data Capabilities = Capabilities { capsFeatures :: Vk.PhysicalDeviceFeatures , capsFeatures11 :: PhysicalDeviceVulkan11Features , capsFeatures12 :: PhysicalDeviceVulkan12Features , capsFeatures13 :: PhysicalDeviceVulkan13Features , capsExtensions :: Set ByteString , capsMaintenance5 :: PhysicalDeviceMaintenance5FeaturesKHR , capsGlobalPriorityQuery :: PhysicalDeviceGlobalPriorityQueryFeaturesKHR , capsVertexAttributeDivisor :: PhysicalDeviceVertexAttributeDivisorFeaturesKHR , capsIndexTypeUint8 :: PhysicalDeviceIndexTypeUint8FeaturesKHR , capsLineRasterization :: PhysicalDeviceLineRasterizationFeaturesKHR , capsRobustness2 :: PhysicalDeviceRobustness2FeaturesEXT , capsShaderAtomicFloat :: PhysicalDeviceShaderAtomicFloatFeaturesEXT , capsMutableDescriptorType :: PhysicalDeviceMutableDescriptorTypeFeaturesEXT , capsDepthClipControl :: PhysicalDeviceDepthClipControlFeaturesEXT , capsDepthClipEnable :: PhysicalDeviceDepthClipEnableFeaturesEXT , capsCustomBorderColor :: PhysicalDeviceCustomBorderColorFeaturesEXT , capsImageViewMinLod :: PhysicalDeviceImageViewMinLodFeaturesEXT , capsNonSeamlessCubeMap :: PhysicalDeviceNonSeamlessCubeMapFeaturesEXT , capsPrimitiveTopologyListRestart :: PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT , capsFragmentShaderInterlock :: PhysicalDeviceFragmentShaderInterlockFeaturesEXT , capsConditionalRendering :: PhysicalDeviceConditionalRenderingFeaturesEXT , capsTransformFeedback :: PhysicalDeviceTransformFeedbackFeaturesEXT , capsAttachmentFeedbackLoopLayout :: PhysicalDeviceAttachmentFeedbackLoopLayoutFeaturesEXT , capsDynamicRenderingUnusedAttachments :: PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT , capsVertexInputDynamicState :: PhysicalDeviceVertexInputDynamicStateFeaturesEXT , capsGraphicsPipelineLibrary :: PhysicalDeviceGraphicsPipelineLibraryFeaturesEXT , capsExtendedDynamicState3 :: PhysicalDeviceExtendedDynamicState3FeaturesEXT , capsProperties :: Vk.PhysicalDeviceProperties , capsProperties11 :: PhysicalDeviceVulkan11Properties , capsProperties12 :: PhysicalDeviceVulkan12Properties , capsProperties13 :: PhysicalDeviceVulkan13Properties , capsPushDescriptorProperties :: Maybe PhysicalDevicePushDescriptorPropertiesKHR , capsRobustness2Properties :: Maybe PhysicalDeviceRobustness2PropertiesEXT , capsLineRasterizationProperties :: Maybe PhysicalDeviceLineRasterizationPropertiesKHR , capsVertexAttributeDivisorProperties :: Maybe PhysicalDeviceVertexAttributeDivisorPropertiesKHR , capsExtendedDynamicState3Properties :: Maybe PhysicalDeviceExtendedDynamicState3PropertiesEXT , capsGraphicsPipelineLibraryProperties :: Maybe PhysicalDeviceGraphicsPipelineLibraryPropertiesEXT , capsTransformFeedbackProperties :: Maybe PhysicalDeviceTransformFeedbackPropertiesEXT , capsCustomBorderColorProperties :: Maybe PhysicalDeviceCustomBorderColorPropertiesEXT , capsSampleLocationsProperties :: Maybe PhysicalDeviceSampleLocationsPropertiesEXT , capsExternalMemoryHostProperties :: Maybe PhysicalDeviceExternalMemoryHostPropertiesEXT , capsMaintenance5Properties :: Maybe PhysicalDeviceMaintenance5PropertiesKHR , capsMemory :: Vk.PhysicalDeviceMemoryProperties , capsQueueFamilies :: Vector Vk.QueueFamilyProperties , capsDenied :: [Text] } deriving (Show) probe :: MonadIO m => [DeviceRequirement] -> [[DeviceRequirement]] -> Vk.PhysicalDevice -> Vk.DeviceCreateInfo '[] -> m (Either [Text] (Capabilities, SomeStruct Vk.DeviceCreateInfo)) probe required optionalGroups phys baseCreateInfo = do (_, availableExtensions) <- Vk.enumerateDeviceExtensionProperties phys Nothing let extensionVersions = Map.fromList [ (extensionName, specVersion) | Vk.ExtensionProperties extensionName specVersion <- toList availableExtensions ] (optionals, skipped) = foldMap (gateGroup extensionVersions) optionalGroups (createInfo, requiredResults, optionalResults) <- checkDeviceRequirements required optionals phys baseCreateInfo case createInfo of Nothing -> pure . Left $ unmet requiredResults Just deviceCreateInfo -> do let granted = required <> [ requirement | (requirement, Satisfied) <- zip optionals optionalResults ] caps <- collect phys granted (unmet optionalResults <> skipped) pure $ Right (caps, deviceCreateInfo) where unmet results = [ fromString $ prettyRequirementResult result | result <- results , result /= Satisfied ] gateGroup :: Map ByteString Word32 -> [DeviceRequirement] -> ([DeviceRequirement], [Text]) gateGroup extensionVersions group | all extensionAvailable group = (group, []) | otherwise = ( filter (isNothing . extensionDependentName) group , [ "Skipped " <> decodeUtf8Lenient name <> " without its extension" | Just name <- map extensionDependentName group ] ) where extensionAvailable = \case RequireDeviceExtension{deviceExtensionName, deviceExtensionMinVersion} -> maybe False (>= deviceExtensionMinVersion) $ Map.lookup deviceExtensionName extensionVersions _ -> True extensionDependentName :: DeviceRequirement -> Maybe ByteString extensionDependentName = \case RequireDeviceFeature{featureName} -> Just featureName RequireDeviceProperty{propertyName} -> Just propertyName _ -> Nothing collect :: MonadIO m => Vk.PhysicalDevice -> [DeviceRequirement] -> [Text] -> m Capabilities collect phys granted denied = do PhysicalDeviceProperties2{properties = coreProperties, next = (properties11, (properties12, (properties13, ())))} <- getPhysicalDeviceProperties2 @'[PhysicalDeviceVulkan11Properties, PhysicalDeviceVulkan12Properties, PhysicalDeviceVulkan13Properties] phys pushDescriptor <- grantedProperties @PhysicalDevicePushDescriptorPropertiesKHR extensions phys KHR_PUSH_DESCRIPTOR_EXTENSION_NAME robustness2 <- grantedProperties @PhysicalDeviceRobustness2PropertiesEXT extensions phys EXT_ROBUSTNESS_2_EXTENSION_NAME lineRasterization <- grantedProperties @PhysicalDeviceLineRasterizationPropertiesKHR extensions phys EXT_LINE_RASTERIZATION_EXTENSION_NAME vertexAttributeDivisor <- grantedProperties @PhysicalDeviceVertexAttributeDivisorPropertiesKHR extensions phys KHR_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME extendedDynamicState3 <- grantedProperties @PhysicalDeviceExtendedDynamicState3PropertiesEXT extensions phys EXT_EXTENDED_DYNAMIC_STATE_3_EXTENSION_NAME graphicsPipelineLibrary <- grantedProperties @PhysicalDeviceGraphicsPipelineLibraryPropertiesEXT extensions phys EXT_GRAPHICS_PIPELINE_LIBRARY_EXTENSION_NAME transformFeedback <- grantedProperties @PhysicalDeviceTransformFeedbackPropertiesEXT extensions phys EXT_TRANSFORM_FEEDBACK_EXTENSION_NAME customBorderColor <- grantedProperties @PhysicalDeviceCustomBorderColorPropertiesEXT extensions phys EXT_CUSTOM_BORDER_COLOR_EXTENSION_NAME sampleLocations <- grantedProperties @PhysicalDeviceSampleLocationsPropertiesEXT extensions phys EXT_SAMPLE_LOCATIONS_EXTENSION_NAME externalMemoryHost <- grantedProperties @PhysicalDeviceExternalMemoryHostPropertiesEXT extensions phys EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME maintenance5 <- grantedProperties @PhysicalDeviceMaintenance5PropertiesKHR extensions phys KHR_MAINTENANCE_5_EXTENSION_NAME memory <- trimMemory <$> Vk.getPhysicalDeviceMemoryProperties phys queueFamilies <- Vk.getPhysicalDeviceQueueFamilyProperties phys pure Capabilities { capsFeatures = grantedStruct granted , capsFeatures11 = grantedStruct granted , capsFeatures12 = grantedStruct granted , capsFeatures13 = grantedStruct granted , capsExtensions = extensions , capsMaintenance5 = grantedStruct granted , capsGlobalPriorityQuery = grantedStruct granted , capsVertexAttributeDivisor = grantedStruct granted , capsIndexTypeUint8 = grantedStruct granted , capsLineRasterization = grantedStruct granted , capsRobustness2 = grantedStruct granted , capsShaderAtomicFloat = grantedStruct granted , capsMutableDescriptorType = grantedStruct granted , capsDepthClipControl = grantedStruct granted , capsDepthClipEnable = grantedStruct granted , capsCustomBorderColor = grantedStruct granted , capsImageViewMinLod = grantedStruct granted , capsNonSeamlessCubeMap = grantedStruct granted , capsPrimitiveTopologyListRestart = grantedStruct granted , capsFragmentShaderInterlock = grantedStruct granted , capsConditionalRendering = grantedStruct granted , capsTransformFeedback = grantedStruct granted , capsAttachmentFeedbackLoopLayout = grantedStruct granted , capsDynamicRenderingUnusedAttachments = grantedStruct granted , capsVertexInputDynamicState = grantedStruct granted , capsGraphicsPipelineLibrary = grantedStruct granted , capsExtendedDynamicState3 = grantedStruct granted , capsProperties = coreProperties , capsProperties11 = properties11 , capsProperties12 = properties12 , capsProperties13 = properties13 , capsPushDescriptorProperties = pushDescriptor , capsRobustness2Properties = robustness2 , capsLineRasterizationProperties = lineRasterization , capsVertexAttributeDivisorProperties = vertexAttributeDivisor , capsExtendedDynamicState3Properties = extendedDynamicState3 , capsGraphicsPipelineLibraryProperties = graphicsPipelineLibrary , capsTransformFeedbackProperties = transformFeedback , capsCustomBorderColorProperties = customBorderColor , capsSampleLocationsProperties = sampleLocations , capsExternalMemoryHostProperties = externalMemoryHost , capsMaintenance5Properties = maintenance5 , capsMemory = memory , capsQueueFamilies = queueFamilies , capsDenied = denied } where extensions = Set.fromList [ deviceExtensionName | RequireDeviceExtension{deviceExtensionName} <- granted ] grantedStruct :: (Typeable struct, Zero struct) => [DeviceRequirement] -> struct grantedStruct = foldl' enable zero where enable acc = \case RequireDeviceFeature{enableFeature} -> maybe acc ($ acc) (cast enableFeature) _ -> acc grantedProperties :: forall struct m . ( MonadIO m , Extendss PhysicalDeviceProperties2 '[struct] , PokeChain '[struct] , PeekChain '[struct] ) => Set ByteString -> Vk.PhysicalDevice -> ByteString -> m (Maybe struct) grantedProperties extensions phys extensionName | Set.member extensionName extensions = do PhysicalDeviceProperties2{next = (extensionProperties, ())} <- getPhysicalDeviceProperties2 @'[struct] phys pure $ Just extensionProperties | otherwise = pure Nothing trimMemory :: Vk.PhysicalDeviceMemoryProperties -> Vk.PhysicalDeviceMemoryProperties trimMemory (Vk.PhysicalDeviceMemoryProperties typeCount types heapCount heaps) = Vk.PhysicalDeviceMemoryProperties typeCount (Vector.take (fromIntegral typeCount) types) heapCount (Vector.take (fromIntegral heapCount) heaps) hasExtension :: ByteString -> Capabilities -> Bool hasExtension extensionName caps = Set.member extensionName caps.capsExtensions anisotropyLimit :: Capabilities -> Float anisotropyLimit caps = if caps.capsFeatures.samplerAnisotropy then caps.capsProperties.limits.maxSamplerAnisotropy else 1 sampleShading :: Capabilities -> Bool sampleShading caps = caps.capsFeatures.sampleRateShading logCapabilities :: ( MonadIO m , MonadReader env m , HasLogFunc env ) => Capabilities -> m () logCapabilities caps = do logInfo $ mconcat [ "Device API " , display (_API_VERSION_MAJOR apiVersion) , "." , display (_API_VERSION_MINOR apiVersion) , "." , display (_API_VERSION_PATCH apiVersion) , ", driver " , display (decodeUtf8Lenient caps.capsProperties12.driverName) , " " , display (decodeUtf8Lenient caps.capsProperties12.driverInfo) , ", " , display (Set.size caps.capsExtensions) , " extensions granted, " , display (length caps.capsDenied) , " optional requirements denied" ] logDebug $ "Granted extensions: " <> display (Text.intercalate ", " . map decodeUtf8Lenient $ Set.toAscList caps.capsExtensions) for_ caps.capsDenied \denied -> logDebug $ "Denied: " <> display denied where apiVersion = caps.capsProperties.apiVersion