SampleCountFlagBits.hs

{-# language CPP #-}
module Vulkan.Core10.Enums.SampleCountFlagBits  ( SampleCountFlagBits( SAMPLE_COUNT_1_BIT
                                                                     , SAMPLE_COUNT_2_BIT
                                                                     , SAMPLE_COUNT_4_BIT
                                                                     , SAMPLE_COUNT_8_BIT
                                                                     , SAMPLE_COUNT_16_BIT
                                                                     , SAMPLE_COUNT_32_BIT
                                                                     , SAMPLE_COUNT_64_BIT
                                                                     , ..
                                                                     )
                                                , SampleCountFlags
                                                ) where

import GHC.Read (choose)
import GHC.Read (expectP)
import GHC.Read (parens)
import GHC.Show (showParen)
import GHC.Show (showString)
import Numeric (showHex)
import Text.ParserCombinators.ReadPrec ((+++))
import Text.ParserCombinators.ReadPrec (prec)
import Text.ParserCombinators.ReadPrec (step)
import Data.Bits (Bits)
import Foreign.Storable (Storable)
import GHC.Read (Read(readPrec))
import Text.Read.Lex (Lexeme(Ident))
import Vulkan.Core10.FundamentalTypes (Flags)
import Vulkan.Zero (Zero)
-- | VkSampleCountFlagBits - Bitmask specifying sample counts supported for
-- an image used for storage operations
--
-- = See Also
--
-- 'Vulkan.Core10.Pass.AttachmentDescription',
-- 'Vulkan.Core12.Promoted_From_VK_KHR_create_renderpass2.AttachmentDescription2',
-- 'Vulkan.Extensions.VK_NV_coverage_reduction_mode.FramebufferMixedSamplesCombinationNV',
-- 'Vulkan.Core10.Image.ImageCreateInfo',
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceSparseImageFormatInfo2',
-- 'Vulkan.Core10.Pipeline.PipelineMultisampleStateCreateInfo',
-- 'SampleCountFlags',
-- 'Vulkan.Extensions.VK_EXT_sample_locations.SampleLocationsInfoEXT',
-- 'Vulkan.Extensions.VK_EXT_sample_locations.getPhysicalDeviceMultisamplePropertiesEXT',
-- 'Vulkan.Core10.SparseResourceMemoryManagement.getPhysicalDeviceSparseImageFormatProperties'
newtype SampleCountFlagBits = SampleCountFlagBits Flags
  deriving newtype (Eq, Ord, Storable, Zero, Bits)

-- | 'SAMPLE_COUNT_1_BIT' specifies an image with one sample per pixel.
pattern SAMPLE_COUNT_1_BIT = SampleCountFlagBits 0x00000001
-- | 'SAMPLE_COUNT_2_BIT' specifies an image with 2 samples per pixel.
pattern SAMPLE_COUNT_2_BIT = SampleCountFlagBits 0x00000002
-- | 'SAMPLE_COUNT_4_BIT' specifies an image with 4 samples per pixel.
pattern SAMPLE_COUNT_4_BIT = SampleCountFlagBits 0x00000004
-- | 'SAMPLE_COUNT_8_BIT' specifies an image with 8 samples per pixel.
pattern SAMPLE_COUNT_8_BIT = SampleCountFlagBits 0x00000008
-- | 'SAMPLE_COUNT_16_BIT' specifies an image with 16 samples per pixel.
pattern SAMPLE_COUNT_16_BIT = SampleCountFlagBits 0x00000010
-- | 'SAMPLE_COUNT_32_BIT' specifies an image with 32 samples per pixel.
pattern SAMPLE_COUNT_32_BIT = SampleCountFlagBits 0x00000020
-- | 'SAMPLE_COUNT_64_BIT' specifies an image with 64 samples per pixel.
pattern SAMPLE_COUNT_64_BIT = SampleCountFlagBits 0x00000040

type SampleCountFlags = SampleCountFlagBits

instance Show SampleCountFlagBits where
  showsPrec p = \case
    SAMPLE_COUNT_1_BIT -> showString "SAMPLE_COUNT_1_BIT"
    SAMPLE_COUNT_2_BIT -> showString "SAMPLE_COUNT_2_BIT"
    SAMPLE_COUNT_4_BIT -> showString "SAMPLE_COUNT_4_BIT"
    SAMPLE_COUNT_8_BIT -> showString "SAMPLE_COUNT_8_BIT"
    SAMPLE_COUNT_16_BIT -> showString "SAMPLE_COUNT_16_BIT"
    SAMPLE_COUNT_32_BIT -> showString "SAMPLE_COUNT_32_BIT"
    SAMPLE_COUNT_64_BIT -> showString "SAMPLE_COUNT_64_BIT"
    SampleCountFlagBits x -> showParen (p >= 11) (showString "SampleCountFlagBits 0x" . showHex x)

instance Read SampleCountFlagBits where
  readPrec = parens (choose [("SAMPLE_COUNT_1_BIT", pure SAMPLE_COUNT_1_BIT)
                            , ("SAMPLE_COUNT_2_BIT", pure SAMPLE_COUNT_2_BIT)
                            , ("SAMPLE_COUNT_4_BIT", pure SAMPLE_COUNT_4_BIT)
                            , ("SAMPLE_COUNT_8_BIT", pure SAMPLE_COUNT_8_BIT)
                            , ("SAMPLE_COUNT_16_BIT", pure SAMPLE_COUNT_16_BIT)
                            , ("SAMPLE_COUNT_32_BIT", pure SAMPLE_COUNT_32_BIT)
                            , ("SAMPLE_COUNT_64_BIT", pure SAMPLE_COUNT_64_BIT)]
                     +++
                     prec 10 (do
                       expectP (Ident "SampleCountFlagBits")
                       v <- step readPrec
                       pure (SampleCountFlagBits v)))