{-# language CPP #-}
-- No documentation found for Chapter "ImageType"
module Vulkan.Core10.Enums.ImageType  (ImageType( IMAGE_TYPE_1D
                                                , IMAGE_TYPE_2D
                                                , IMAGE_TYPE_3D
                                                , ..
                                                )) where

import Vulkan.Internal.Utils (enumReadPrec)
import Vulkan.Internal.Utils (enumShowsPrec)
import GHC.Show (showsPrec)
import Vulkan.Zero (Zero)
import Foreign.Storable (Storable)
import Data.Int (Int32)
import GHC.Read (Read(readPrec))
import GHC.Show (Show(showsPrec))

-- | VkImageType - Specifies the type of an image object
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_VERSION_1_0 VK_VERSION_1_0>,
-- 'Vulkan.Core10.Image.ImageCreateInfo',
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceImageFormatInfo2',
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceSparseImageFormatInfo2',
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VkVideoFormatPropertiesKHR VkVideoFormatPropertiesKHR>,
-- 'Vulkan.Extensions.VK_NV_external_memory_capabilities.getPhysicalDeviceExternalImageFormatPropertiesNV',
-- 'Vulkan.Core10.DeviceInitialization.getPhysicalDeviceImageFormatProperties',
-- 'Vulkan.Core10.SparseResourceMemoryManagement.getPhysicalDeviceSparseImageFormatProperties'
newtype ImageType = ImageType Int32
  deriving newtype (ImageType -> ImageType -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ImageType -> ImageType -> Bool
$c/= :: ImageType -> ImageType -> Bool
== :: ImageType -> ImageType -> Bool
$c== :: ImageType -> ImageType -> Bool
Eq, Eq ImageType
ImageType -> ImageType -> Bool
ImageType -> ImageType -> Ordering
ImageType -> ImageType -> ImageType
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: ImageType -> ImageType -> ImageType
$cmin :: ImageType -> ImageType -> ImageType
max :: ImageType -> ImageType -> ImageType
$cmax :: ImageType -> ImageType -> ImageType
>= :: ImageType -> ImageType -> Bool
$c>= :: ImageType -> ImageType -> Bool
> :: ImageType -> ImageType -> Bool
$c> :: ImageType -> ImageType -> Bool
<= :: ImageType -> ImageType -> Bool
$c<= :: ImageType -> ImageType -> Bool
< :: ImageType -> ImageType -> Bool
$c< :: ImageType -> ImageType -> Bool
compare :: ImageType -> ImageType -> Ordering
$ccompare :: ImageType -> ImageType -> Ordering
Ord, Ptr ImageType -> IO ImageType
Ptr ImageType -> Int -> IO ImageType
Ptr ImageType -> Int -> ImageType -> IO ()
Ptr ImageType -> ImageType -> IO ()
ImageType -> Int
forall b. Ptr b -> Int -> IO ImageType
forall b. Ptr b -> Int -> ImageType -> IO ()
forall a.
(a -> Int)
-> (a -> Int)
-> (Ptr a -> Int -> IO a)
-> (Ptr a -> Int -> a -> IO ())
-> (forall b. Ptr b -> Int -> IO a)
-> (forall b. Ptr b -> Int -> a -> IO ())
-> (Ptr a -> IO a)
-> (Ptr a -> a -> IO ())
-> Storable a
poke :: Ptr ImageType -> ImageType -> IO ()
$cpoke :: Ptr ImageType -> ImageType -> IO ()
peek :: Ptr ImageType -> IO ImageType
$cpeek :: Ptr ImageType -> IO ImageType
pokeByteOff :: forall b. Ptr b -> Int -> ImageType -> IO ()
$cpokeByteOff :: forall b. Ptr b -> Int -> ImageType -> IO ()
peekByteOff :: forall b. Ptr b -> Int -> IO ImageType
$cpeekByteOff :: forall b. Ptr b -> Int -> IO ImageType
pokeElemOff :: Ptr ImageType -> Int -> ImageType -> IO ()
$cpokeElemOff :: Ptr ImageType -> Int -> ImageType -> IO ()
peekElemOff :: Ptr ImageType -> Int -> IO ImageType
$cpeekElemOff :: Ptr ImageType -> Int -> IO ImageType
alignment :: ImageType -> Int
$calignment :: ImageType -> Int
sizeOf :: ImageType -> Int
$csizeOf :: ImageType -> Int
Storable, ImageType
forall a. a -> Zero a
zero :: ImageType
$czero :: ImageType
Zero)

-- | 'IMAGE_TYPE_1D' specifies a one-dimensional image.
pattern $bIMAGE_TYPE_1D :: ImageType
$mIMAGE_TYPE_1D :: forall {r}. ImageType -> ((# #) -> r) -> ((# #) -> r) -> r
IMAGE_TYPE_1D = ImageType 0

-- | 'IMAGE_TYPE_2D' specifies a two-dimensional image.
pattern $bIMAGE_TYPE_2D :: ImageType
$mIMAGE_TYPE_2D :: forall {r}. ImageType -> ((# #) -> r) -> ((# #) -> r) -> r
IMAGE_TYPE_2D = ImageType 1

-- | 'IMAGE_TYPE_3D' specifies a three-dimensional image.
pattern $bIMAGE_TYPE_3D :: ImageType
$mIMAGE_TYPE_3D :: forall {r}. ImageType -> ((# #) -> r) -> ((# #) -> r) -> r
IMAGE_TYPE_3D = ImageType 2

{-# COMPLETE
  IMAGE_TYPE_1D
  , IMAGE_TYPE_2D
  , IMAGE_TYPE_3D ::
    ImageType
  #-}

conNameImageType :: String
conNameImageType :: String
conNameImageType = String
"ImageType"

enumPrefixImageType :: String
enumPrefixImageType :: String
enumPrefixImageType = String
"IMAGE_TYPE_"

showTableImageType :: [(ImageType, String)]
showTableImageType :: [(ImageType, String)]
showTableImageType =
  [ (ImageType
IMAGE_TYPE_1D, String
"1D")
  , (ImageType
IMAGE_TYPE_2D, String
"2D")
  , (ImageType
IMAGE_TYPE_3D, String
"3D")
  ]

instance Show ImageType where
  showsPrec :: Int -> ImageType -> ShowS
showsPrec =
    forall a i.
Eq a =>
String
-> [(a, String)]
-> String
-> (a -> i)
-> (i -> ShowS)
-> Int
-> a
-> ShowS
enumShowsPrec
      String
enumPrefixImageType
      [(ImageType, String)]
showTableImageType
      String
conNameImageType
      (\(ImageType Int32
x) -> Int32
x)
      (forall a. Show a => Int -> a -> ShowS
showsPrec Int
11)

instance Read ImageType where
  readPrec :: ReadPrec ImageType
readPrec =
    forall i a.
Read i =>
String -> [(a, String)] -> String -> (i -> a) -> ReadPrec a
enumReadPrec
      String
enumPrefixImageType
      [(ImageType, String)]
showTableImageType
      String
conNameImageType
      Int32 -> ImageType
ImageType