SampleCountFlagBits.hs

{-# language CPP #-}
-- No documentation found for Chapter "SampleCountFlagBits"
module Vulkan.Core10.Enums.SampleCountFlagBits  ( SampleCountFlags
                                                , 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
                                                                     , ..
                                                                     )
                                                ) where

import Data.Bits (Bits)
import Data.Bits (FiniteBits)
import Vulkan.Internal.Utils (enumReadPrec)
import Vulkan.Internal.Utils (enumShowsPrec)
import GHC.Show (showString)
import Numeric (showHex)
import Vulkan.Zero (Zero)
import Foreign.Storable (Storable)
import GHC.Read (Read(readPrec))
import GHC.Show (Show(showsPrec))
import Vulkan.Core10.FundamentalTypes (Flags)
type SampleCountFlags = SampleCountFlagBits

-- | VkSampleCountFlagBits - Bitmask specifying sample counts supported for
-- an image used for storage operations
--
-- = Description
--
-- -   'SAMPLE_COUNT_1_BIT' specifies an image with one sample per pixel.
--
-- -   'SAMPLE_COUNT_2_BIT' specifies an image with 2 samples per pixel.
--
-- -   'SAMPLE_COUNT_4_BIT' specifies an image with 4 samples per pixel.
--
-- -   'SAMPLE_COUNT_8_BIT' specifies an image with 8 samples per pixel.
--
-- -   'SAMPLE_COUNT_16_BIT' specifies an image with 16 samples per pixel.
--
-- -   'SAMPLE_COUNT_32_BIT' specifies an image with 32 samples per pixel.
--
-- -   'SAMPLE_COUNT_64_BIT' specifies an image with 64 samples per pixel.
--
-- = 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.Pass.AttachmentDescription',
-- 'Vulkan.Core12.Promoted_From_VK_KHR_create_renderpass2.AttachmentDescription2',
-- 'Vulkan.Extensions.VK_AMD_mixed_attachment_samples.AttachmentSampleCountInfoAMD',
-- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.CommandBufferInheritanceRenderingInfo',
-- 'Vulkan.Extensions.VK_NV_coverage_reduction_mode.FramebufferMixedSamplesCombinationNV',
-- 'Vulkan.Core10.Image.ImageCreateInfo',
-- 'Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled.MultisampledRenderToSingleSampledInfoEXT',
-- 'Vulkan.Extensions.VK_NV_fragment_shading_rate_enums.PhysicalDeviceFragmentShadingRateEnumsPropertiesNV',
-- 'Vulkan.Extensions.VK_KHR_fragment_shading_rate.PhysicalDeviceFragmentShadingRatePropertiesKHR',
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceSparseImageFormatInfo2',
-- 'Vulkan.Core10.GraphicsPipeline.PipelineMultisampleStateCreateInfo',
-- 'SampleCountFlags',
-- 'Vulkan.Extensions.VK_EXT_sample_locations.SampleLocationsInfoEXT',
-- 'Vulkan.Extensions.VK_EXT_extended_dynamic_state3.cmdSetRasterizationSamplesEXT',
-- 'Vulkan.Extensions.VK_EXT_extended_dynamic_state3.cmdSetSampleMaskEXT',
-- 'Vulkan.Extensions.VK_EXT_sample_locations.getPhysicalDeviceMultisamplePropertiesEXT',
-- 'Vulkan.Core10.SparseResourceMemoryManagement.getPhysicalDeviceSparseImageFormatProperties'
newtype SampleCountFlagBits = SampleCountFlagBits Flags
  deriving newtype (Eq, Ord, Storable, Zero, Bits, FiniteBits)

-- No documentation found for Nested "VkSampleCountFlagBits" "VK_SAMPLE_COUNT_1_BIT"
pattern SAMPLE_COUNT_1_BIT = SampleCountFlagBits 0x00000001

-- No documentation found for Nested "VkSampleCountFlagBits" "VK_SAMPLE_COUNT_2_BIT"
pattern SAMPLE_COUNT_2_BIT = SampleCountFlagBits 0x00000002

-- No documentation found for Nested "VkSampleCountFlagBits" "VK_SAMPLE_COUNT_4_BIT"
pattern SAMPLE_COUNT_4_BIT = SampleCountFlagBits 0x00000004

-- No documentation found for Nested "VkSampleCountFlagBits" "VK_SAMPLE_COUNT_8_BIT"
pattern SAMPLE_COUNT_8_BIT = SampleCountFlagBits 0x00000008

-- No documentation found for Nested "VkSampleCountFlagBits" "VK_SAMPLE_COUNT_16_BIT"
pattern SAMPLE_COUNT_16_BIT = SampleCountFlagBits 0x00000010

-- No documentation found for Nested "VkSampleCountFlagBits" "VK_SAMPLE_COUNT_32_BIT"
pattern SAMPLE_COUNT_32_BIT = SampleCountFlagBits 0x00000020

-- No documentation found for Nested "VkSampleCountFlagBits" "VK_SAMPLE_COUNT_64_BIT"
pattern SAMPLE_COUNT_64_BIT = SampleCountFlagBits 0x00000040

conNameSampleCountFlagBits :: String
conNameSampleCountFlagBits = "SampleCountFlagBits"

enumPrefixSampleCountFlagBits :: String
enumPrefixSampleCountFlagBits = "SAMPLE_COUNT_"

showTableSampleCountFlagBits :: [(SampleCountFlagBits, String)]
showTableSampleCountFlagBits =
  [ (SAMPLE_COUNT_1_BIT, "1_BIT")
  , (SAMPLE_COUNT_2_BIT, "2_BIT")
  , (SAMPLE_COUNT_4_BIT, "4_BIT")
  , (SAMPLE_COUNT_8_BIT, "8_BIT")
  , (SAMPLE_COUNT_16_BIT, "16_BIT")
  , (SAMPLE_COUNT_32_BIT, "32_BIT")
  , (SAMPLE_COUNT_64_BIT, "64_BIT")
  ]

instance Show SampleCountFlagBits where
  showsPrec =
    enumShowsPrec
      enumPrefixSampleCountFlagBits
      showTableSampleCountFlagBits
      conNameSampleCountFlagBits
      (\(SampleCountFlagBits x) -> x)
      (\x -> showString "0x" . showHex x)

instance Read SampleCountFlagBits where
  readPrec =
    enumReadPrec
      enumPrefixSampleCountFlagBits
      showTableSampleCountFlagBits
      conNameSampleCountFlagBits
      SampleCountFlagBits