QSurface.hs

-- This file is part of Qtah.
--
-- Copyright 2015-2023 The Qtah Authors.
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Lesser General Public License as published by
-- the Free Software Foundation, either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU Lesser General Public License for more details.
--
-- You should have received a copy of the GNU Lesser General Public License
-- along with this program.  If not, see <http://www.gnu.org/licenses/>.

module Graphics.UI.Qtah.Generator.Interface.Gui.QSurface (
  aModule,
  c_QSurface,
  e_SurfaceType,
  ) where

import Foreign.Hoppy.Generator.Spec (
  addReqIncludes,
  classSetEntityPrefix,
  ident,
  ident1,
  includeStd,
  makeClass,
  mkConstMethod,
  np,
  )
import Foreign.Hoppy.Generator.Types (boolT, enumT, objT)
import Foreign.Hoppy.Generator.Version (collect, just, test)
import Graphics.UI.Qtah.Generator.Config (qtVersion)
import Graphics.UI.Qtah.Generator.Interface.Core.QSize (c_QSize)
import Graphics.UI.Qtah.Generator.Module (AModule (AQtModule), makeQtModuleWithVersionBounds)
import Graphics.UI.Qtah.Generator.Types

{-# ANN module "HLint: ignore Use camelCase" #-}

minVersion = [5, 0]

aModule =
  AQtModule $
  makeQtModuleWithVersionBounds ["Gui", "QSurface"] (Just minVersion) Nothing
  [ qtExport c_QSurface
  , qtExport e_SurfaceClass
  , qtExport e_SurfaceType
  ]

c_QSurface =
  addReqIncludes [includeStd "QSurface"] $
  classSetEntityPrefix "" $
  makeClass (ident "QSurface") Nothing [] $
  collect
  [ -- TODO mkConstMethod "surfaceFormat" $ objT c_QSurfaceFormat
    just $ mkConstMethod "size" np $ objT c_QSize
  , test (qtVersion >= [5, 3]) $ mkConstMethod "supportsOpenGL" np boolT
  , just $ mkConstMethod "surfaceClass" np $ enumT e_SurfaceClass
    -- TODO mkConstMethod "surfaceHandle" np $ ptrT $ objT c_QPlatformSurface
  , just $ mkConstMethod "surfaceType" np $ enumT e_SurfaceType
  ]

e_SurfaceClass =
  makeQtEnum (ident1 "QSurface" "SurfaceClass") [includeStd "QSurface"]
  [ "Window"
  , "Offscreen"
  ]

e_SurfaceType =
  makeQtEnum (ident1 "QSurface" "SurfaceType") [includeStd "QSurface"]
  [ "RasterSurface"
  , "OpenGLSurface"
  , "RasterGLSurface"
    -- TODO OpenVGSurface, VulkanSurface.  Since when?
  ]