{-# language CPP #-}
-- | = Name
--
-- VK_QCOM_cooperative_matrix_conversion - device extension
--
-- = VK_QCOM_cooperative_matrix_conversion
--
-- [__Name String__]
--     @VK_QCOM_cooperative_matrix_conversion@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     173
--
-- [__Revision__]
--     1
--
-- [__Ratification Status__]
--     Not ratified
--
-- [__Extension and Version Dependencies__]
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_cooperative_matrix VK_KHR_cooperative_matrix>
--
-- [__SPIR-V Dependencies__]
--
--     -   <https://htmlpreview.github.io/?https://github.com/KhronosGroup/SPIRV-Registry/blob/master/extensions/QCOM/SPV_QCOM_cooperative_matrix_conversion.html SPV_QCOM_cooperative_matrix_conversion>
--
-- [__Contact__]
--
--     -   Matthew Netsch
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_QCOM_cooperative_matrix_conversion] @mnetsch%0A*Here describe the issue or question you have about the VK_QCOM_cooperative_matrix_conversion extension* >
--
-- [__Extension Proposal__]
--     <https://github.com/KhronosGroup/Vulkan-Docs/tree/main/proposals/VK_QCOM_cooperative_matrix_conversion.adoc VK_QCOM_cooperative_matrix_conversion>
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2026-01-28
--
-- [__Interactions and External Dependencies__]
--
--     -   This extension provides API support for
--         <https://github.com/KhronosGroup/GLSL/blob/main/extensions/qcom/GLSL_QCOM_cooperative_matrix_conversion.txt GLSL_QCOM_cooperative_matrix_conversion>
--
-- [__Contributors__]
--
--     -   Matthew Netsch, Qualcomm Technologies, Inc
--
--     -   Elina Kamenetskaya, Qualcomm Technologies, Inc
--
--     -   Alex Bourd, Qualcomm Technologies, Inc
--
--     -   Ruihao Zhang, Qualcomm Technologies, Inc
--
--     -   Wooyoung Kim, Qualcomm Technologies, Inc
--
-- == Description
--
-- This extension adds support for new SPIR-V shader instructions that
-- allow loading and storing a cooperative matrix without needing to stage
-- through shared memory and to allow bit casting arrays.
--
-- These instructions are defined by the
-- <https://htmlpreview.github.io/?https://github.com/KhronosGroup/SPIRV-Registry/blob/master/extensions/QCOM/SPV_QCOM_cooperative_matrix_conversion.html SPV_QCOM_cooperative_matrix_conversion>
-- SPIR-V extension and can be used with the
-- <https://github.com/KhronosGroup/GLSL/blob/main/extensions/qcom/GLSL_QCOM_cooperative_matrix_conversion.txt GLSL_QCOM_cooperative_matrix_conversion>
-- GLSL extension.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM'
--
-- == New Enum Constants
--
-- -   'QCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME'
--
-- -   'QCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_CONVERSION_FEATURES_QCOM'
--
-- == New SPIR-V Capabilities
--
-- -   <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#spirvenv-capabilities-table-CooperativeMatrixConversionQCOM CooperativeMatrixConversionQCOM>
--
-- == Version History
--
-- -   Revision 1, 2026-01-28 (Matthew Netsch)
--
--     -   Initial draft
--
-- == See Also
--
-- No cross-references are available
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VK_QCOM_cooperative_matrix_conversion Vulkan Specification>.
--
-- This page is a generated document. Fixes and changes should be made to
-- the generator scripts, not directly.
module Vulkan.Extensions.VK_QCOM_cooperative_matrix_conversion  ( PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM(..)
                                                                , QCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION
                                                                , pattern QCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION
                                                                , QCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME
                                                                , pattern QCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME
                                                                ) where

import Foreign.Marshal.Alloc (allocaBytes)
import Foreign.Ptr (nullPtr)
import Foreign.Ptr (plusPtr)
import Vulkan.CStruct (FromCStruct)
import Vulkan.CStruct (FromCStruct(..))
import Vulkan.CStruct (ToCStruct)
import Vulkan.CStruct (ToCStruct(..))
import Vulkan.Zero (Zero(..))
import Data.String (IsString)
import Data.Typeable (Typeable)
import Foreign.Storable (Storable)
import Foreign.Storable (Storable(peek))
import Foreign.Storable (Storable(poke))
import qualified Foreign.Storable (Storable(..))
import GHC.Generics (Generic)
import Foreign.Ptr (Ptr)
import Data.Kind (Type)
import Vulkan.Core10.FundamentalTypes (bool32ToBool)
import Vulkan.Core10.FundamentalTypes (boolToBool32)
import Vulkan.Core10.FundamentalTypes (Bool32)
import Vulkan.Core10.Enums.StructureType (StructureType)
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_CONVERSION_FEATURES_QCOM))
-- | VkPhysicalDeviceCooperativeMatrixConversionFeaturesQCOM - Structure
-- describing cooperative matrix conversion features that can be supported
-- by an implementation
--
-- = Members
--
-- This structure describes the following features:
--
-- = Description
--
-- If the 'PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM' structure
-- is included in the @pNext@ chain of the
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2'
-- structure passed to
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.getPhysicalDeviceFeatures2',
-- it is filled in to indicate whether each corresponding feature is
-- supported. If the application wishes to use a
-- 'Vulkan.Core10.Handles.Device' with any features described by
-- 'PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM', it /must/ add
-- an instance of the structure, with the desired feature members set to
-- 'Vulkan.Core10.FundamentalTypes.TRUE', to the @pNext@ chain of
-- 'Vulkan.Core10.Device.DeviceCreateInfo' when creating the
-- 'Vulkan.Core10.Handles.Device'.
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_QCOM_cooperative_matrix_conversion VK_QCOM_cooperative_matrix_conversion>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM = PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
  { -- | #features-cooperativeMatrixConversion# @cooperativeMatrixConversion@
    -- indicates that the implementation supports the
    -- @CooperativeMatrixConversionQCOM@ SPIR-V capability.
    PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool
cooperativeMatrixConversion :: Bool }
  deriving (Typeable, PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool
(PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
 -> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool)
-> (PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
    -> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool)
-> Eq PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool
== :: PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool
$c/= :: PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool
/= :: PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM)
#endif
deriving instance Show PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM

instance ToCStruct PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM where
  withCStruct :: forall b.
PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> (Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
    -> IO b)
-> IO b
withCStruct PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
x Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> IO b
f = Int
-> (Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
    -> IO b)
-> IO b
forall a b. Int -> (Ptr a -> IO b) -> IO b
allocaBytes Int
24 ((Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
  -> IO b)
 -> IO b)
-> (Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
    -> IO b)
-> IO b
forall a b. (a -> b) -> a -> b
$ \Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p -> Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO b
-> IO b
forall b.
Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO b
-> IO b
forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
x (Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> IO b
f Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p)
  pokeCStruct :: forall b.
Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO b
-> IO b
pokeCStruct Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM{Bool
cooperativeMatrixConversion :: PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Bool
cooperativeMatrixConversion :: Bool
..} IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_CONVERSION_FEATURES_QCOM)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Bool32 -> Bool32 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
cooperativeMatrixConversion))
    IO b
f
  cStructSize :: Int
cStructSize = Int
24
  cStructAlignment :: Int
cStructAlignment = Int
8
  pokeZeroCStruct :: forall b.
Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO b -> IO b
pokeZeroCStruct Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_CONVERSION_FEATURES_QCOM)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Bool32 -> Bool32 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
forall a. Zero a => a
zero))
    IO b
f

instance FromCStruct PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM where
  peekCStruct :: Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
peekCStruct Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p = do
    cooperativeMatrixConversion <- forall a. Storable a => Ptr a -> IO a
peek @Bool32 ((Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
p Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr Bool32))
    pure $ PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
             (bool32ToBool cooperativeMatrixConversion)

instance Storable PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM where
  sizeOf :: PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Int
sizeOf ~PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
_ = Int
24
  alignment :: PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> Int
alignment ~PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
_ = Int
8
  peek :: Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
peek = Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
forall a. FromCStruct a => Ptr a -> IO a
peekCStruct
  poke :: Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM -> IO ()
poke Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
poked = Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO ()
-> IO ()
forall b.
Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
-> IO b
-> IO b
forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
ptr PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
poked (() -> IO ()
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure ())

instance Zero PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM where
  zero :: PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
zero = Bool -> PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
PhysicalDeviceCooperativeMatrixConversionFeaturesQCOM
           Bool
forall a. Zero a => a
zero


type QCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_QCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION"
pattern QCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION :: forall a . Integral a => a
pattern $mQCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
$bQCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION :: forall a. Integral a => a
QCOM_COOPERATIVE_MATRIX_CONVERSION_SPEC_VERSION = 1


type QCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME = "VK_QCOM_cooperative_matrix_conversion"

-- No documentation found for TopLevel "VK_QCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME"
pattern QCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $mQCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
$bQCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
QCOM_COOPERATIVE_MATRIX_CONVERSION_EXTENSION_NAME = "VK_QCOM_cooperative_matrix_conversion"