{-# language CPP #-} module Vulkan.Core10.ExtensionDiscovery ( enumerateInstanceExtensionProperties , enumerateDeviceExtensionProperties , ExtensionProperties(..) ) where import Vulkan.CStruct.Utils (FixedArray) import Control.Exception.Base (bracket) import Control.Monad (unless) import Control.Monad.IO.Class (liftIO) import Foreign.Marshal.Alloc (allocaBytesAligned) import Foreign.Marshal.Alloc (callocBytes) import Foreign.Marshal.Alloc (free) import GHC.Base (when) import GHC.IO (throwIO) import Foreign.Ptr (castFunPtr) import GHC.Ptr (nullFunPtr) import Foreign.Ptr (nullPtr) import Foreign.Ptr (plusPtr) import Data.ByteString (packCString) import Data.ByteString (useAsCString) import Control.Monad.Trans.Class (lift) import Control.Monad.Trans.Cont (evalContT) import Data.Vector (generateM) import Foreign.C.Types (CChar(..)) import Control.Monad.IO.Class (MonadIO) import Data.Typeable (Typeable) import Foreign.C.Types (CChar) import Foreign.Storable (Storable) import Foreign.Storable (Storable(peek)) import Foreign.Storable (Storable(poke)) import qualified Foreign.Storable (Storable(..)) import GHC.Generics (Generic) import GHC.IO.Exception (IOErrorType(..)) import GHC.IO.Exception (IOException(..)) import Foreign.Ptr (FunPtr) import Foreign.Ptr (Ptr) import GHC.Ptr (Ptr(Ptr)) import Data.Word (Word32) import Data.ByteString (ByteString) import Data.Kind (Type) import Control.Monad.Trans.Cont (ContT(..)) import Data.Vector (Vector) import Vulkan.CStruct.Utils (advancePtrBytes) import Vulkan.Dynamic (getInstanceProcAddr') import Vulkan.CStruct.Utils (lowerArrayPtr) import Vulkan.CStruct.Utils (pokeFixedLengthNullTerminatedByteString) import Vulkan.NamedType ((:::)) import Vulkan.CStruct (FromCStruct) import Vulkan.CStruct (FromCStruct(..)) import Vulkan.Dynamic (InstanceCmds(pVkEnumerateDeviceExtensionProperties)) import Vulkan.Core10.APIConstants (MAX_EXTENSION_NAME_SIZE) import Vulkan.Core10.Handles (PhysicalDevice) import Vulkan.Core10.Handles (PhysicalDevice(..)) import Vulkan.Core10.Handles (PhysicalDevice_T) import Vulkan.Core10.Enums.Result (Result) import Vulkan.Core10.Enums.Result (Result(..)) import Vulkan.CStruct (ToCStruct) import Vulkan.CStruct (ToCStruct(..)) import Vulkan.Exception (VulkanException(..)) import Vulkan.Zero (Zero(..)) import Vulkan.Core10.Enums.Result (Result(SUCCESS)) foreign import ccall #if !defined(SAFE_FOREIGN_CALLS) unsafe #endif "dynamic" mkVkEnumerateInstanceExtensionProperties :: FunPtr (Ptr CChar -> Ptr Word32 -> Ptr ExtensionProperties -> IO Result) -> Ptr CChar -> Ptr Word32 -> Ptr ExtensionProperties -> IO Result -- | vkEnumerateInstanceExtensionProperties - Returns up to requested number -- of global extension properties -- -- = Description -- -- When @pLayerName@ parameter is @NULL@, only extensions provided by the -- Vulkan implementation or by implicitly enabled layers are returned. When -- @pLayerName@ is the name of a layer, the instance extensions provided by -- that layer are returned. -- -- If @pProperties@ is @NULL@, then the number of extensions properties -- available is returned in @pPropertyCount@. Otherwise, @pPropertyCount@ -- /must/ point to a variable set by the user to the number of elements in -- the @pProperties@ array, and on return the variable is overwritten with -- the number of structures actually written to @pProperties@. If -- @pPropertyCount@ is less than the number of extension properties -- available, at most @pPropertyCount@ structures will be written. If -- @pPropertyCount@ is smaller than the number of extensions available, -- 'Vulkan.Core10.Enums.Result.INCOMPLETE' will be returned instead of -- 'Vulkan.Core10.Enums.Result.SUCCESS', to indicate that not all the -- available properties were returned. -- -- Because the list of available layers may change externally between calls -- to 'enumerateInstanceExtensionProperties', two calls may retrieve -- different results if a @pLayerName@ is available in one call but not in -- another. The extensions supported by a layer may also change between two -- calls, e.g. if the layer implementation is replaced by a different -- version between those calls. -- -- Implementations /must/ not advertise any pair of extensions that cannot -- be enabled together due to behavioral differences, or any extension that -- cannot be enabled against the advertised version. -- -- == Valid Usage (Implicit) -- -- - If @pLayerName@ is not @NULL@, @pLayerName@ /must/ be a -- null-terminated UTF-8 string -- -- - @pPropertyCount@ /must/ be a valid pointer to a @uint32_t@ value -- -- - If the value referenced by @pPropertyCount@ is not @0@, and -- @pProperties@ is not @NULL@, @pProperties@ /must/ be a valid pointer -- to an array of @pPropertyCount@ 'ExtensionProperties' structures -- -- == Return Codes -- -- [] -- -- - 'Vulkan.Core10.Enums.Result.SUCCESS' -- -- - 'Vulkan.Core10.Enums.Result.INCOMPLETE' -- -- [] -- -- - 'Vulkan.Core10.Enums.Result.ERROR_OUT_OF_HOST_MEMORY' -- -- - 'Vulkan.Core10.Enums.Result.ERROR_OUT_OF_DEVICE_MEMORY' -- -- - 'Vulkan.Core10.Enums.Result.ERROR_LAYER_NOT_PRESENT' -- -- = See Also -- -- 'ExtensionProperties' enumerateInstanceExtensionProperties :: forall io . (MonadIO io) => -- | @pLayerName@ is either @NULL@ or a pointer to a null-terminated UTF-8 -- string naming the layer to retrieve extensions from. ("layerName" ::: Maybe ByteString) -> io (Result, ("properties" ::: Vector ExtensionProperties)) enumerateInstanceExtensionProperties layerName = liftIO . evalContT $ do vkEnumerateInstanceExtensionPropertiesPtr <- lift $ castFunPtr @_ @(("pLayerName" ::: Ptr CChar) -> ("pPropertyCount" ::: Ptr Word32) -> ("pProperties" ::: Ptr ExtensionProperties) -> IO Result) <$> getInstanceProcAddr' nullPtr (Ptr "vkEnumerateInstanceExtensionProperties"#) lift $ unless (vkEnumerateInstanceExtensionPropertiesPtr /= nullFunPtr) $ throwIO $ IOError Nothing InvalidArgument "" "The function pointer for vkEnumerateInstanceExtensionProperties is null" Nothing Nothing let vkEnumerateInstanceExtensionProperties' = mkVkEnumerateInstanceExtensionProperties vkEnumerateInstanceExtensionPropertiesPtr pLayerName <- case (layerName) of Nothing -> pure nullPtr Just j -> ContT $ useAsCString (j) pPPropertyCount <- ContT $ bracket (callocBytes @Word32 4) free r <- lift $ vkEnumerateInstanceExtensionProperties' pLayerName (pPPropertyCount) (nullPtr) lift $ when (r < SUCCESS) (throwIO (VulkanException r)) pPropertyCount <- lift $ peek @Word32 pPPropertyCount pPProperties <- ContT $ bracket (callocBytes @ExtensionProperties ((fromIntegral (pPropertyCount)) * 260)) free _ <- traverse (\i -> ContT $ pokeZeroCStruct (pPProperties `advancePtrBytes` (i * 260) :: Ptr ExtensionProperties) . ($ ())) [0..(fromIntegral (pPropertyCount)) - 1] r' <- lift $ vkEnumerateInstanceExtensionProperties' pLayerName (pPPropertyCount) ((pPProperties)) lift $ when (r' < SUCCESS) (throwIO (VulkanException r')) pPropertyCount' <- lift $ peek @Word32 pPPropertyCount pProperties' <- lift $ generateM (fromIntegral (pPropertyCount')) (\i -> peekCStruct @ExtensionProperties (((pPProperties) `advancePtrBytes` (260 * (i)) :: Ptr ExtensionProperties))) pure $ ((r'), pProperties') foreign import ccall #if !defined(SAFE_FOREIGN_CALLS) unsafe #endif "dynamic" mkVkEnumerateDeviceExtensionProperties :: FunPtr (Ptr PhysicalDevice_T -> Ptr CChar -> Ptr Word32 -> Ptr ExtensionProperties -> IO Result) -> Ptr PhysicalDevice_T -> Ptr CChar -> Ptr Word32 -> Ptr ExtensionProperties -> IO Result -- | vkEnumerateDeviceExtensionProperties - Returns properties of available -- physical device extensions -- -- = Description -- -- When @pLayerName@ parameter is @NULL@, only extensions provided by the -- Vulkan implementation or by implicitly enabled layers are returned. When -- @pLayerName@ is the name of a layer, the device extensions provided by -- that layer are returned. -- -- Implementations /must/ not advertise any pair of extensions that cannot -- be enabled together due to behavioral differences, or any extension that -- cannot be enabled against the advertised version. -- -- == Valid Usage (Implicit) -- -- - @physicalDevice@ /must/ be a valid -- 'Vulkan.Core10.Handles.PhysicalDevice' handle -- -- - If @pLayerName@ is not @NULL@, @pLayerName@ /must/ be a -- null-terminated UTF-8 string -- -- - @pPropertyCount@ /must/ be a valid pointer to a @uint32_t@ value -- -- - If the value referenced by @pPropertyCount@ is not @0@, and -- @pProperties@ is not @NULL@, @pProperties@ /must/ be a valid pointer -- to an array of @pPropertyCount@ 'ExtensionProperties' structures -- -- == Return Codes -- -- [] -- -- - 'Vulkan.Core10.Enums.Result.SUCCESS' -- -- - 'Vulkan.Core10.Enums.Result.INCOMPLETE' -- -- [] -- -- - 'Vulkan.Core10.Enums.Result.ERROR_OUT_OF_HOST_MEMORY' -- -- - 'Vulkan.Core10.Enums.Result.ERROR_OUT_OF_DEVICE_MEMORY' -- -- - 'Vulkan.Core10.Enums.Result.ERROR_LAYER_NOT_PRESENT' -- -- = See Also -- -- 'ExtensionProperties', 'Vulkan.Core10.Handles.PhysicalDevice' enumerateDeviceExtensionProperties :: forall io . (MonadIO io) => -- | @physicalDevice@ is the physical device that will be queried. PhysicalDevice -> -- | @pLayerName@ is either @NULL@ or a pointer to a null-terminated UTF-8 -- string naming the layer to retrieve extensions from. ("layerName" ::: Maybe ByteString) -> io (Result, ("properties" ::: Vector ExtensionProperties)) enumerateDeviceExtensionProperties physicalDevice layerName = liftIO . evalContT $ do let vkEnumerateDeviceExtensionPropertiesPtr = pVkEnumerateDeviceExtensionProperties (instanceCmds (physicalDevice :: PhysicalDevice)) lift $ unless (vkEnumerateDeviceExtensionPropertiesPtr /= nullFunPtr) $ throwIO $ IOError Nothing InvalidArgument "" "The function pointer for vkEnumerateDeviceExtensionProperties is null" Nothing Nothing let vkEnumerateDeviceExtensionProperties' = mkVkEnumerateDeviceExtensionProperties vkEnumerateDeviceExtensionPropertiesPtr let physicalDevice' = physicalDeviceHandle (physicalDevice) pLayerName <- case (layerName) of Nothing -> pure nullPtr Just j -> ContT $ useAsCString (j) pPPropertyCount <- ContT $ bracket (callocBytes @Word32 4) free r <- lift $ vkEnumerateDeviceExtensionProperties' physicalDevice' pLayerName (pPPropertyCount) (nullPtr) lift $ when (r < SUCCESS) (throwIO (VulkanException r)) pPropertyCount <- lift $ peek @Word32 pPPropertyCount pPProperties <- ContT $ bracket (callocBytes @ExtensionProperties ((fromIntegral (pPropertyCount)) * 260)) free _ <- traverse (\i -> ContT $ pokeZeroCStruct (pPProperties `advancePtrBytes` (i * 260) :: Ptr ExtensionProperties) . ($ ())) [0..(fromIntegral (pPropertyCount)) - 1] r' <- lift $ vkEnumerateDeviceExtensionProperties' physicalDevice' pLayerName (pPPropertyCount) ((pPProperties)) lift $ when (r' < SUCCESS) (throwIO (VulkanException r')) pPropertyCount' <- lift $ peek @Word32 pPPropertyCount pProperties' <- lift $ generateM (fromIntegral (pPropertyCount')) (\i -> peekCStruct @ExtensionProperties (((pPProperties) `advancePtrBytes` (260 * (i)) :: Ptr ExtensionProperties))) pure $ ((r'), pProperties') -- | VkExtensionProperties - Structure specifying an extension properties -- -- = See Also -- -- 'enumerateDeviceExtensionProperties', -- 'enumerateInstanceExtensionProperties' data ExtensionProperties = ExtensionProperties { -- | @extensionName@ is an array of -- 'Vulkan.Core10.APIConstants.MAX_EXTENSION_NAME_SIZE' @char@ containing a -- null-terminated UTF-8 string which is the name of the extension. extensionName :: ByteString , -- | @specVersion@ is the version of this extension. It is an integer, -- incremented with backward compatible changes. specVersion :: Word32 } deriving (Typeable) #if defined(GENERIC_INSTANCES) deriving instance Generic (ExtensionProperties) #endif deriving instance Show ExtensionProperties instance ToCStruct ExtensionProperties where withCStruct x f = allocaBytesAligned 260 4 $ \p -> pokeCStruct p x (f p) pokeCStruct p ExtensionProperties{..} f = do pokeFixedLengthNullTerminatedByteString ((p `plusPtr` 0 :: Ptr (FixedArray MAX_EXTENSION_NAME_SIZE CChar))) (extensionName) poke ((p `plusPtr` 256 :: Ptr Word32)) (specVersion) f cStructSize = 260 cStructAlignment = 4 pokeZeroCStruct p f = do pokeFixedLengthNullTerminatedByteString ((p `plusPtr` 0 :: Ptr (FixedArray MAX_EXTENSION_NAME_SIZE CChar))) (mempty) poke ((p `plusPtr` 256 :: Ptr Word32)) (zero) f instance FromCStruct ExtensionProperties where peekCStruct p = do extensionName <- packCString (lowerArrayPtr ((p `plusPtr` 0 :: Ptr (FixedArray MAX_EXTENSION_NAME_SIZE CChar)))) specVersion <- peek @Word32 ((p `plusPtr` 256 :: Ptr Word32)) pure $ ExtensionProperties extensionName specVersion instance Storable ExtensionProperties where sizeOf ~_ = 260 alignment ~_ = 4 peek = peekCStruct poke ptr poked = pokeCStruct ptr poked (pure ()) instance Zero ExtensionProperties where zero = ExtensionProperties mempty zero