{-# LINE 2 "./Graphics/UI/Gtk/Gdk/Pixmap.chs" #-}
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Pixmap
--
-- Author : Armin Groesslinger
--
-- Created: 05 July 2005
--
-- Copyright (C) 2005 Armin Groesslinger
--
-- This library 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 2.1 of the License, or (at your option) any later version.
--
-- This library 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.
--
-- TODO
--
-- add methods
--
-- |
-- Maintainer : gtk2hs-users@lists.sourceforge.net
-- Stability : provisional
-- Portability : portable (depends on GHC)
--
-- Pixmaps -- Offscreen drawables
--
module Graphics.UI.Gtk.Gdk.Pixmap (
-- * Detail
-- Pixmaps are offscreen drawables. They can be drawn upon with the
-- standard drawing primitives, then copied to another drawable
-- with 'drawDrawable'.

-- * Class Hierarchy
-- |
-- @
-- | 'GObject'
-- | +----'Drawable'
-- | +----Pixmap
-- @

-- * Types
  Pixmap, PixmapClass,
  Bitmap,

-- * Constructors
  pixmapNew
  ) where

import Data.Maybe
import System.Glib.FFI
import System.Glib.GObject (wrapNewGObject)
import Graphics.UI.Gtk.Types
{-# LINE 58 "./Graphics/UI/Gtk/Gdk/Pixmap.chs" #-}
import Graphics.UI.Gtk.Gdk.Drawable (Drawable, DrawableClass(..))


{-# LINE 61 "./Graphics/UI/Gtk/Gdk/Pixmap.chs" #-}

-- | A 'Bitmap' is a special 'Pixmap' in that the number of bits per pixel
-- is one, that is, a pixel is either set or unset. Whenever a function
-- expects a 'Bitmap', a 'Pixmap' of depth one must be supplied.
type Bitmap = Pixmap

-- | Create a new pixmap.
--
-- If @drawable@ is @Nothing@, the depth of the pixmap is taken from the
-- @depth@ parameter, otherwise the pixmap has the same depth as the
-- 'Drawable' specified by @drawable@. Therefore, at least one of @drawable@
-- and @depth@ must not be @Nothing@.
--
-- * Note that in Gtk+ 2.0 the @drawable@ can only be a 'DrawWindow', not an
-- arbitary 'Drawable'.
--

pixmapNew :: DrawableClass drawable
 => Maybe drawable -- ^ @drawable@ - drawable supplying default values for the
                   --pixmap
 -> Int -- ^ @width@ - width of the pixmap
 -> Int -- ^ @height@ - height of the pixmap
 -> Maybe Int -- ^ @depth@ - depth of the pixmap
 -> IO Pixmap
pixmapNew mbDrawable width height depth =
    wrapNewGObject mkPixmap $
    (\(Drawable arg1) arg2 arg3 arg4 -> withForeignPtr arg1 $ \argPtr1 ->gdk_pixmap_new argPtr1 arg2 arg3 arg4)
{-# LINE 88 "./Graphics/UI/Gtk/Gdk/Pixmap.chs" #-}
      (maybe (Drawable nullForeignPtr) toDrawable mbDrawable)
      (fromIntegral width) (fromIntegral height)
      (fromIntegral $ fromMaybe (negate 1) depth)

foreign import ccall unsafe "gdk_pixmap_new"
  gdk_pixmap_new :: ((Ptr Drawable) -> (CInt -> (CInt -> (CInt -> (IO (Ptr Pixmap))))))