{-# language CPP #-}
-- No documentation found for Chapter "FormFactor"
module OpenXR.Core10.Enums.FormFactor  (FormFactor( FORM_FACTOR_HEAD_MOUNTED_DISPLAY
                                                  , FORM_FACTOR_HANDHELD_DISPLAY
                                                  , ..
                                                  )) where

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

-- | XrFormFactor - Supported form factors
--
-- = Description
--
-- The predefined form factors which /may/ be supported by OpenXR runtimes
-- are:
--
-- == Enumerant Descriptions
--
-- = See Also
--
-- 'OpenXR.Core10.APIConstants.NULL_SYSTEM_ID',
-- 'OpenXR.Core10.Device.SystemGetInfo',
-- <https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId >,
-- 'OpenXR.Core10.Device.getSystem'
newtype FormFactor = FormFactor Int32
  deriving newtype (FormFactor -> FormFactor -> Bool
(FormFactor -> FormFactor -> Bool)
-> (FormFactor -> FormFactor -> Bool) -> Eq FormFactor
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FormFactor -> FormFactor -> Bool
$c/= :: FormFactor -> FormFactor -> Bool
== :: FormFactor -> FormFactor -> Bool
$c== :: FormFactor -> FormFactor -> Bool
Eq, Eq FormFactor
Eq FormFactor =>
(FormFactor -> FormFactor -> Ordering)
-> (FormFactor -> FormFactor -> Bool)
-> (FormFactor -> FormFactor -> Bool)
-> (FormFactor -> FormFactor -> Bool)
-> (FormFactor -> FormFactor -> Bool)
-> (FormFactor -> FormFactor -> FormFactor)
-> (FormFactor -> FormFactor -> FormFactor)
-> Ord FormFactor
FormFactor -> FormFactor -> Bool
FormFactor -> FormFactor -> Ordering
FormFactor -> FormFactor -> FormFactor
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 :: FormFactor -> FormFactor -> FormFactor
$cmin :: FormFactor -> FormFactor -> FormFactor
max :: FormFactor -> FormFactor -> FormFactor
$cmax :: FormFactor -> FormFactor -> FormFactor
>= :: FormFactor -> FormFactor -> Bool
$c>= :: FormFactor -> FormFactor -> Bool
> :: FormFactor -> FormFactor -> Bool
$c> :: FormFactor -> FormFactor -> Bool
<= :: FormFactor -> FormFactor -> Bool
$c<= :: FormFactor -> FormFactor -> Bool
< :: FormFactor -> FormFactor -> Bool
$c< :: FormFactor -> FormFactor -> Bool
compare :: FormFactor -> FormFactor -> Ordering
$ccompare :: FormFactor -> FormFactor -> Ordering
$cp1Ord :: Eq FormFactor
Ord, Ptr b -> Int -> IO FormFactor
Ptr b -> Int -> FormFactor -> IO ()
Ptr FormFactor -> IO FormFactor
Ptr FormFactor -> Int -> IO FormFactor
Ptr FormFactor -> Int -> FormFactor -> IO ()
Ptr FormFactor -> FormFactor -> IO ()
FormFactor -> Int
(FormFactor -> Int)
-> (FormFactor -> Int)
-> (Ptr FormFactor -> Int -> IO FormFactor)
-> (Ptr FormFactor -> Int -> FormFactor -> IO ())
-> (forall b. Ptr b -> Int -> IO FormFactor)
-> (forall b. Ptr b -> Int -> FormFactor -> IO ())
-> (Ptr FormFactor -> IO FormFactor)
-> (Ptr FormFactor -> FormFactor -> IO ())
-> Storable FormFactor
forall b. Ptr b -> Int -> IO FormFactor
forall b. Ptr b -> Int -> FormFactor -> 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 FormFactor -> FormFactor -> IO ()
$cpoke :: Ptr FormFactor -> FormFactor -> IO ()
peek :: Ptr FormFactor -> IO FormFactor
$cpeek :: Ptr FormFactor -> IO FormFactor
pokeByteOff :: Ptr b -> Int -> FormFactor -> IO ()
$cpokeByteOff :: forall b. Ptr b -> Int -> FormFactor -> IO ()
peekByteOff :: Ptr b -> Int -> IO FormFactor
$cpeekByteOff :: forall b. Ptr b -> Int -> IO FormFactor
pokeElemOff :: Ptr FormFactor -> Int -> FormFactor -> IO ()
$cpokeElemOff :: Ptr FormFactor -> Int -> FormFactor -> IO ()
peekElemOff :: Ptr FormFactor -> Int -> IO FormFactor
$cpeekElemOff :: Ptr FormFactor -> Int -> IO FormFactor
alignment :: FormFactor -> Int
$calignment :: FormFactor -> Int
sizeOf :: FormFactor -> Int
$csizeOf :: FormFactor -> Int
Storable, FormFactor
FormFactor -> Zero FormFactor
forall a. a -> Zero a
zero :: FormFactor
$czero :: FormFactor
Zero)
-- Note that the zero instance does not produce a valid value, passing 'zero' to Vulkan will result in an error

-- | 'FORM_FACTOR_HEAD_MOUNTED_DISPLAY'. The tracked display is attached to
-- the user’s head. The user cannot touch the display itself. A VR headset
-- would be an example of this form factor.
pattern $bFORM_FACTOR_HEAD_MOUNTED_DISPLAY :: FormFactor
$mFORM_FACTOR_HEAD_MOUNTED_DISPLAY :: forall r. FormFactor -> (Void# -> r) -> (Void# -> r) -> r
FORM_FACTOR_HEAD_MOUNTED_DISPLAY = FormFactor 1
-- | 'FORM_FACTOR_HANDHELD_DISPLAY'. The tracked display is held in the
-- user’s hand, independent from the user’s head. The user /may/ be able to
-- touch the display, allowing for screen-space UI. A mobile phone running
-- an AR experience using pass-through video would be an example of this
-- form factor.
pattern $bFORM_FACTOR_HANDHELD_DISPLAY :: FormFactor
$mFORM_FACTOR_HANDHELD_DISPLAY :: forall r. FormFactor -> (Void# -> r) -> (Void# -> r) -> r
FORM_FACTOR_HANDHELD_DISPLAY     = FormFactor 2
{-# complete FORM_FACTOR_HEAD_MOUNTED_DISPLAY,
             FORM_FACTOR_HANDHELD_DISPLAY :: FormFactor #-}

conNameFormFactor :: String
conNameFormFactor :: String
conNameFormFactor = "FormFactor"

enumPrefixFormFactor :: String
enumPrefixFormFactor :: String
enumPrefixFormFactor = "FORM_FACTOR_H"

showTableFormFactor :: [(FormFactor, String)]
showTableFormFactor :: [(FormFactor, String)]
showTableFormFactor =
  [(FormFactor
FORM_FACTOR_HEAD_MOUNTED_DISPLAY, "EAD_MOUNTED_DISPLAY"), (FormFactor
FORM_FACTOR_HANDHELD_DISPLAY, "ANDHELD_DISPLAY")]

instance Show FormFactor where
  showsPrec :: Int -> FormFactor -> ShowS
showsPrec =
    String
-> [(FormFactor, String)]
-> String
-> (FormFactor -> Int32)
-> (Int32 -> ShowS)
-> Int
-> FormFactor
-> ShowS
forall a i.
Eq a =>
String
-> [(a, String)]
-> String
-> (a -> i)
-> (i -> ShowS)
-> Int
-> a
-> ShowS
enumShowsPrec String
enumPrefixFormFactor [(FormFactor, String)]
showTableFormFactor String
conNameFormFactor (\(FormFactor x :: Int32
x) -> Int32
x) (Int -> Int32 -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec 11)

instance Read FormFactor where
  readPrec :: ReadPrec FormFactor
readPrec = String
-> [(FormFactor, String)]
-> String
-> (Int32 -> FormFactor)
-> ReadPrec FormFactor
forall i a.
Read i =>
String -> [(a, String)] -> String -> (i -> a) -> ReadPrec a
enumReadPrec String
enumPrefixFormFactor [(FormFactor, String)]
showTableFormFactor String
conNameFormFactor Int32 -> FormFactor
FormFactor