gi-gdkpixbuf-2.0.19: GI/GdkPixbuf/Objects/Pixbuf.hs
{- |
Copyright : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License : LGPL-2.1
Maintainer : Iñaki García Etxebarria (inaki@blueleaf.cc)
This is the main structure in the gdk-pixbuf library. It is
used to represent images. It contains information about the
image\'s pixel data, its color space, bits per sample, width and
height, and the rowstride (the number of bytes between the start of
one row and the start of the next).
-}
#define ENABLE_OVERLOADING (MIN_VERSION_haskell_gi_overloading(1,0,0) \
&& !defined(__HADDOCK_VERSION__))
module GI.GdkPixbuf.Objects.Pixbuf
(
#if ENABLE_OVERLOADING
PixbufGetOptionsMethodInfo ,
#endif
-- * Exported types
Pixbuf(..) ,
IsPixbuf ,
toPixbuf ,
noPixbuf ,
-- * Methods
-- ** addAlpha #method:addAlpha#
#if ENABLE_OVERLOADING
PixbufAddAlphaMethodInfo ,
#endif
pixbufAddAlpha ,
-- ** applyEmbeddedOrientation #method:applyEmbeddedOrientation#
#if ENABLE_OVERLOADING
PixbufApplyEmbeddedOrientationMethodInfo,
#endif
pixbufApplyEmbeddedOrientation ,
-- ** calculateRowstride #method:calculateRowstride#
pixbufCalculateRowstride ,
-- ** composite #method:composite#
#if ENABLE_OVERLOADING
PixbufCompositeMethodInfo ,
#endif
pixbufComposite ,
-- ** compositeColor #method:compositeColor#
#if ENABLE_OVERLOADING
PixbufCompositeColorMethodInfo ,
#endif
pixbufCompositeColor ,
-- ** compositeColorSimple #method:compositeColorSimple#
#if ENABLE_OVERLOADING
PixbufCompositeColorSimpleMethodInfo ,
#endif
pixbufCompositeColorSimple ,
-- ** copy #method:copy#
#if ENABLE_OVERLOADING
PixbufCopyMethodInfo ,
#endif
pixbufCopy ,
-- ** copyArea #method:copyArea#
#if ENABLE_OVERLOADING
PixbufCopyAreaMethodInfo ,
#endif
pixbufCopyArea ,
-- ** copyOptions #method:copyOptions#
#if ENABLE_OVERLOADING
PixbufCopyOptionsMethodInfo ,
#endif
pixbufCopyOptions ,
-- ** fill #method:fill#
#if ENABLE_OVERLOADING
PixbufFillMethodInfo ,
#endif
pixbufFill ,
-- ** flip #method:flip#
#if ENABLE_OVERLOADING
PixbufFlipMethodInfo ,
#endif
pixbufFlip ,
-- ** getBitsPerSample #method:getBitsPerSample#
#if ENABLE_OVERLOADING
PixbufGetBitsPerSampleMethodInfo ,
#endif
pixbufGetBitsPerSample ,
-- ** getByteLength #method:getByteLength#
#if ENABLE_OVERLOADING
PixbufGetByteLengthMethodInfo ,
#endif
pixbufGetByteLength ,
-- ** getColorspace #method:getColorspace#
#if ENABLE_OVERLOADING
PixbufGetColorspaceMethodInfo ,
#endif
pixbufGetColorspace ,
-- ** getFileInfo #method:getFileInfo#
pixbufGetFileInfo ,
-- ** getFileInfoAsync #method:getFileInfoAsync#
pixbufGetFileInfoAsync ,
-- ** getFileInfoFinish #method:getFileInfoFinish#
pixbufGetFileInfoFinish ,
-- ** getFormats #method:getFormats#
pixbufGetFormats ,
-- ** getHasAlpha #method:getHasAlpha#
#if ENABLE_OVERLOADING
PixbufGetHasAlphaMethodInfo ,
#endif
pixbufGetHasAlpha ,
-- ** getHeight #method:getHeight#
#if ENABLE_OVERLOADING
PixbufGetHeightMethodInfo ,
#endif
pixbufGetHeight ,
-- ** getNChannels #method:getNChannels#
#if ENABLE_OVERLOADING
PixbufGetNChannelsMethodInfo ,
#endif
pixbufGetNChannels ,
-- ** getOption #method:getOption#
#if ENABLE_OVERLOADING
PixbufGetOptionMethodInfo ,
#endif
pixbufGetOption ,
-- ** getPixels #method:getPixels#
#if ENABLE_OVERLOADING
PixbufGetPixelsMethodInfo ,
#endif
pixbufGetPixels ,
-- ** getRowstride #method:getRowstride#
#if ENABLE_OVERLOADING
PixbufGetRowstrideMethodInfo ,
#endif
pixbufGetRowstride ,
-- ** getWidth #method:getWidth#
#if ENABLE_OVERLOADING
PixbufGetWidthMethodInfo ,
#endif
pixbufGetWidth ,
-- ** new #method:new#
pixbufNew ,
-- ** newFromBytes #method:newFromBytes#
pixbufNewFromBytes ,
-- ** newFromData #method:newFromData#
pixbufNewFromData ,
-- ** newFromFile #method:newFromFile#
pixbufNewFromFile ,
-- ** newFromFileAtScale #method:newFromFileAtScale#
pixbufNewFromFileAtScale ,
-- ** newFromFileAtSize #method:newFromFileAtSize#
pixbufNewFromFileAtSize ,
-- ** newFromInline #method:newFromInline#
pixbufNewFromInline ,
-- ** newFromResource #method:newFromResource#
pixbufNewFromResource ,
-- ** newFromResourceAtScale #method:newFromResourceAtScale#
pixbufNewFromResourceAtScale ,
-- ** newFromStream #method:newFromStream#
pixbufNewFromStream ,
-- ** newFromStreamAsync #method:newFromStreamAsync#
pixbufNewFromStreamAsync ,
-- ** newFromStreamAtScale #method:newFromStreamAtScale#
pixbufNewFromStreamAtScale ,
-- ** newFromStreamAtScaleAsync #method:newFromStreamAtScaleAsync#
pixbufNewFromStreamAtScaleAsync ,
-- ** newFromStreamFinish #method:newFromStreamFinish#
pixbufNewFromStreamFinish ,
-- ** newFromXpmData #method:newFromXpmData#
pixbufNewFromXpmData ,
-- ** newSubpixbuf #method:newSubpixbuf#
#if ENABLE_OVERLOADING
PixbufNewSubpixbufMethodInfo ,
#endif
pixbufNewSubpixbuf ,
-- ** readPixelBytes #method:readPixelBytes#
#if ENABLE_OVERLOADING
PixbufReadPixelBytesMethodInfo ,
#endif
pixbufReadPixelBytes ,
-- ** readPixels #method:readPixels#
#if ENABLE_OVERLOADING
PixbufReadPixelsMethodInfo ,
#endif
pixbufReadPixels ,
-- ** removeOption #method:removeOption#
#if ENABLE_OVERLOADING
PixbufRemoveOptionMethodInfo ,
#endif
pixbufRemoveOption ,
-- ** rotateSimple #method:rotateSimple#
#if ENABLE_OVERLOADING
PixbufRotateSimpleMethodInfo ,
#endif
pixbufRotateSimple ,
-- ** saturateAndPixelate #method:saturateAndPixelate#
#if ENABLE_OVERLOADING
PixbufSaturateAndPixelateMethodInfo ,
#endif
pixbufSaturateAndPixelate ,
-- ** saveToBufferv #method:saveToBufferv#
#if ENABLE_OVERLOADING
PixbufSaveToBuffervMethodInfo ,
#endif
pixbufSaveToBufferv ,
-- ** saveToCallbackv #method:saveToCallbackv#
#if ENABLE_OVERLOADING
PixbufSaveToCallbackvMethodInfo ,
#endif
pixbufSaveToCallbackv ,
-- ** saveToStreamFinish #method:saveToStreamFinish#
pixbufSaveToStreamFinish ,
-- ** saveToStreamv #method:saveToStreamv#
#if ENABLE_OVERLOADING
PixbufSaveToStreamvMethodInfo ,
#endif
pixbufSaveToStreamv ,
-- ** saveToStreamvAsync #method:saveToStreamvAsync#
#if ENABLE_OVERLOADING
PixbufSaveToStreamvAsyncMethodInfo ,
#endif
pixbufSaveToStreamvAsync ,
-- ** savev #method:savev#
#if ENABLE_OVERLOADING
PixbufSavevMethodInfo ,
#endif
pixbufSavev ,
-- ** scale #method:scale#
#if ENABLE_OVERLOADING
PixbufScaleMethodInfo ,
#endif
pixbufScale ,
-- ** scaleSimple #method:scaleSimple#
#if ENABLE_OVERLOADING
PixbufScaleSimpleMethodInfo ,
#endif
pixbufScaleSimple ,
-- ** setOption #method:setOption#
#if ENABLE_OVERLOADING
PixbufSetOptionMethodInfo ,
#endif
pixbufSetOption ,
-- * Properties
-- ** bitsPerSample #attr:bitsPerSample#
{- | The number of bits per sample.
Currently only 8 bit per sample are supported.
-}
#if ENABLE_OVERLOADING
PixbufBitsPerSamplePropertyInfo ,
#endif
constructPixbufBitsPerSample ,
getPixbufBitsPerSample ,
#if ENABLE_OVERLOADING
pixbufBitsPerSample ,
#endif
-- ** colorspace #attr:colorspace#
{- | /No description available in the introspection data./
-}
#if ENABLE_OVERLOADING
PixbufColorspacePropertyInfo ,
#endif
constructPixbufColorspace ,
getPixbufColorspace ,
#if ENABLE_OVERLOADING
pixbufColorspace ,
#endif
-- ** hasAlpha #attr:hasAlpha#
{- | /No description available in the introspection data./
-}
#if ENABLE_OVERLOADING
PixbufHasAlphaPropertyInfo ,
#endif
constructPixbufHasAlpha ,
getPixbufHasAlpha ,
#if ENABLE_OVERLOADING
pixbufHasAlpha ,
#endif
-- ** height #attr:height#
{- | /No description available in the introspection data./
-}
#if ENABLE_OVERLOADING
PixbufHeightPropertyInfo ,
#endif
constructPixbufHeight ,
getPixbufHeight ,
#if ENABLE_OVERLOADING
pixbufHeight ,
#endif
-- ** nChannels #attr:nChannels#
{- | The number of samples per pixel.
Currently, only 3 or 4 samples per pixel are supported.
-}
#if ENABLE_OVERLOADING
PixbufNChannelsPropertyInfo ,
#endif
constructPixbufNChannels ,
getPixbufNChannels ,
#if ENABLE_OVERLOADING
pixbufNChannels ,
#endif
-- ** pixelBytes #attr:pixelBytes#
{- | /No description available in the introspection data./
-}
#if ENABLE_OVERLOADING
PixbufPixelBytesPropertyInfo ,
#endif
constructPixbufPixelBytes ,
getPixbufPixelBytes ,
#if ENABLE_OVERLOADING
pixbufPixelBytes ,
#endif
-- ** pixels #attr:pixels#
{- | /No description available in the introspection data./
-}
#if ENABLE_OVERLOADING
PixbufPixelsPropertyInfo ,
#endif
constructPixbufPixels ,
getPixbufPixels ,
#if ENABLE_OVERLOADING
pixbufPixels ,
#endif
-- ** rowstride #attr:rowstride#
{- | The number of bytes between the start of a row and
the start of the next row. This number must (obviously)
be at least as large as the width of the pixbuf.
-}
#if ENABLE_OVERLOADING
PixbufRowstridePropertyInfo ,
#endif
constructPixbufRowstride ,
getPixbufRowstride ,
#if ENABLE_OVERLOADING
pixbufRowstride ,
#endif
-- ** width #attr:width#
{- | /No description available in the introspection data./
-}
#if ENABLE_OVERLOADING
PixbufWidthPropertyInfo ,
#endif
constructPixbufWidth ,
getPixbufWidth ,
#if ENABLE_OVERLOADING
pixbufWidth ,
#endif
) where
import Data.GI.Base.ShortPrelude
import qualified Data.GI.Base.ShortPrelude as SP
import qualified Data.GI.Base.Overloading as O
import qualified Prelude as P
import qualified Data.GI.Base.Attributes as GI.Attributes
import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GValue as B.GValue
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
import qualified Data.GI.Base.Properties as B.Properties
import qualified Data.Text as T
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import qualified Foreign.Ptr as FP
import qualified GHC.OverloadedLabels as OL
import qualified GI.GLib.Structs.Bytes as GLib.Bytes
import qualified GI.GObject.Objects.Object as GObject.Object
import qualified GI.GdkPixbuf.Callbacks as GdkPixbuf.Callbacks
import {-# SOURCE #-} qualified GI.GdkPixbuf.Enums as GdkPixbuf.Enums
import {-# SOURCE #-} qualified GI.GdkPixbuf.Structs.PixbufFormat as GdkPixbuf.PixbufFormat
import qualified GI.Gio.Callbacks as Gio.Callbacks
import qualified GI.Gio.Interfaces.AsyncResult as Gio.AsyncResult
import qualified GI.Gio.Interfaces.Icon as Gio.Icon
import qualified GI.Gio.Interfaces.LoadableIcon as Gio.LoadableIcon
import qualified GI.Gio.Objects.Cancellable as Gio.Cancellable
import qualified GI.Gio.Objects.InputStream as Gio.InputStream
import qualified GI.Gio.Objects.OutputStream as Gio.OutputStream
-- | Memory-managed wrapper type.
newtype Pixbuf = Pixbuf (ManagedPtr Pixbuf)
foreign import ccall "gdk_pixbuf_get_type"
c_gdk_pixbuf_get_type :: IO GType
instance GObject Pixbuf where
gobjectType = c_gdk_pixbuf_get_type
-- | Type class for types which can be safely cast to `Pixbuf`, for instance with `toPixbuf`.
class (GObject o, O.IsDescendantOf Pixbuf o) => IsPixbuf o
instance (GObject o, O.IsDescendantOf Pixbuf o) => IsPixbuf o
instance O.HasParentTypes Pixbuf
type instance O.ParentTypes Pixbuf = '[GObject.Object.Object, Gio.Icon.Icon, Gio.LoadableIcon.LoadableIcon]
-- | Cast to `Pixbuf`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toPixbuf :: (MonadIO m, IsPixbuf o) => o -> m Pixbuf
toPixbuf = liftIO . unsafeCastTo Pixbuf
-- | A convenience alias for `Nothing` :: `Maybe` `Pixbuf`.
noPixbuf :: Maybe Pixbuf
noPixbuf = Nothing
#if ENABLE_OVERLOADING
type family ResolvePixbufMethod (t :: Symbol) (o :: *) :: * where
ResolvePixbufMethod "addAlpha" o = PixbufAddAlphaMethodInfo
ResolvePixbufMethod "applyEmbeddedOrientation" o = PixbufApplyEmbeddedOrientationMethodInfo
ResolvePixbufMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
ResolvePixbufMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
ResolvePixbufMethod "composite" o = PixbufCompositeMethodInfo
ResolvePixbufMethod "compositeColor" o = PixbufCompositeColorMethodInfo
ResolvePixbufMethod "compositeColorSimple" o = PixbufCompositeColorSimpleMethodInfo
ResolvePixbufMethod "copy" o = PixbufCopyMethodInfo
ResolvePixbufMethod "copyArea" o = PixbufCopyAreaMethodInfo
ResolvePixbufMethod "copyOptions" o = PixbufCopyOptionsMethodInfo
ResolvePixbufMethod "equal" o = Gio.Icon.IconEqualMethodInfo
ResolvePixbufMethod "fill" o = PixbufFillMethodInfo
ResolvePixbufMethod "flip" o = PixbufFlipMethodInfo
ResolvePixbufMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
ResolvePixbufMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
ResolvePixbufMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
ResolvePixbufMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
ResolvePixbufMethod "load" o = Gio.LoadableIcon.LoadableIconLoadMethodInfo
ResolvePixbufMethod "loadAsync" o = Gio.LoadableIcon.LoadableIconLoadAsyncMethodInfo
ResolvePixbufMethod "loadFinish" o = Gio.LoadableIcon.LoadableIconLoadFinishMethodInfo
ResolvePixbufMethod "newSubpixbuf" o = PixbufNewSubpixbufMethodInfo
ResolvePixbufMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
ResolvePixbufMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
ResolvePixbufMethod "readPixelBytes" o = PixbufReadPixelBytesMethodInfo
ResolvePixbufMethod "readPixels" o = PixbufReadPixelsMethodInfo
ResolvePixbufMethod "ref" o = GObject.Object.ObjectRefMethodInfo
ResolvePixbufMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
ResolvePixbufMethod "removeOption" o = PixbufRemoveOptionMethodInfo
ResolvePixbufMethod "rotateSimple" o = PixbufRotateSimpleMethodInfo
ResolvePixbufMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
ResolvePixbufMethod "saturateAndPixelate" o = PixbufSaturateAndPixelateMethodInfo
ResolvePixbufMethod "saveToBufferv" o = PixbufSaveToBuffervMethodInfo
ResolvePixbufMethod "saveToCallbackv" o = PixbufSaveToCallbackvMethodInfo
ResolvePixbufMethod "saveToStreamv" o = PixbufSaveToStreamvMethodInfo
ResolvePixbufMethod "saveToStreamvAsync" o = PixbufSaveToStreamvAsyncMethodInfo
ResolvePixbufMethod "savev" o = PixbufSavevMethodInfo
ResolvePixbufMethod "scale" o = PixbufScaleMethodInfo
ResolvePixbufMethod "scaleSimple" o = PixbufScaleSimpleMethodInfo
ResolvePixbufMethod "serialize" o = Gio.Icon.IconSerializeMethodInfo
ResolvePixbufMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
ResolvePixbufMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
ResolvePixbufMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
ResolvePixbufMethod "toString" o = Gio.Icon.IconToStringMethodInfo
ResolvePixbufMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
ResolvePixbufMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
ResolvePixbufMethod "getBitsPerSample" o = PixbufGetBitsPerSampleMethodInfo
ResolvePixbufMethod "getByteLength" o = PixbufGetByteLengthMethodInfo
ResolvePixbufMethod "getColorspace" o = PixbufGetColorspaceMethodInfo
ResolvePixbufMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
ResolvePixbufMethod "getHasAlpha" o = PixbufGetHasAlphaMethodInfo
ResolvePixbufMethod "getHeight" o = PixbufGetHeightMethodInfo
ResolvePixbufMethod "getNChannels" o = PixbufGetNChannelsMethodInfo
ResolvePixbufMethod "getOption" o = PixbufGetOptionMethodInfo
ResolvePixbufMethod "getOptions" o = PixbufGetOptionsMethodInfo
ResolvePixbufMethod "getPixels" o = PixbufGetPixelsMethodInfo
ResolvePixbufMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
ResolvePixbufMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
ResolvePixbufMethod "getRowstride" o = PixbufGetRowstrideMethodInfo
ResolvePixbufMethod "getWidth" o = PixbufGetWidthMethodInfo
ResolvePixbufMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
ResolvePixbufMethod "setOption" o = PixbufSetOptionMethodInfo
ResolvePixbufMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
ResolvePixbufMethod l o = O.MethodResolutionFailed l o
instance (info ~ ResolvePixbufMethod t Pixbuf, O.MethodInfo info Pixbuf p) => OL.IsLabel t (Pixbuf -> p) where
#if MIN_VERSION_base(4,10,0)
fromLabel = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#else
fromLabel _ = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#endif
#endif
-- VVV Prop "bits-per-sample"
-- Type: TBasicType TInt
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Just False,Nothing)
{- |
Get the value of the “@bits-per-sample@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #bitsPerSample
@
-}
getPixbufBitsPerSample :: (MonadIO m, IsPixbuf o) => o -> m Int32
getPixbufBitsPerSample obj = liftIO $ B.Properties.getObjectPropertyInt32 obj "bits-per-sample"
{- |
Construct a `GValueConstruct` with valid value for the “@bits-per-sample@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufBitsPerSample :: (IsPixbuf o) => Int32 -> IO (GValueConstruct o)
constructPixbufBitsPerSample val = B.Properties.constructObjectPropertyInt32 "bits-per-sample" val
#if ENABLE_OVERLOADING
data PixbufBitsPerSamplePropertyInfo
instance AttrInfo PixbufBitsPerSamplePropertyInfo where
type AttrAllowedOps PixbufBitsPerSamplePropertyInfo = '[ 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint PixbufBitsPerSamplePropertyInfo = (~) Int32
type AttrBaseTypeConstraint PixbufBitsPerSamplePropertyInfo = IsPixbuf
type AttrGetType PixbufBitsPerSamplePropertyInfo = Int32
type AttrLabel PixbufBitsPerSamplePropertyInfo = "bits-per-sample"
type AttrOrigin PixbufBitsPerSamplePropertyInfo = Pixbuf
attrGet _ = getPixbufBitsPerSample
attrSet _ = undefined
attrConstruct _ = constructPixbufBitsPerSample
attrClear _ = undefined
#endif
-- VVV Prop "colorspace"
-- Type: TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"})
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Just False,Nothing)
{- |
Get the value of the “@colorspace@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #colorspace
@
-}
getPixbufColorspace :: (MonadIO m, IsPixbuf o) => o -> m GdkPixbuf.Enums.Colorspace
getPixbufColorspace obj = liftIO $ B.Properties.getObjectPropertyEnum obj "colorspace"
{- |
Construct a `GValueConstruct` with valid value for the “@colorspace@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufColorspace :: (IsPixbuf o) => GdkPixbuf.Enums.Colorspace -> IO (GValueConstruct o)
constructPixbufColorspace val = B.Properties.constructObjectPropertyEnum "colorspace" val
#if ENABLE_OVERLOADING
data PixbufColorspacePropertyInfo
instance AttrInfo PixbufColorspacePropertyInfo where
type AttrAllowedOps PixbufColorspacePropertyInfo = '[ 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint PixbufColorspacePropertyInfo = (~) GdkPixbuf.Enums.Colorspace
type AttrBaseTypeConstraint PixbufColorspacePropertyInfo = IsPixbuf
type AttrGetType PixbufColorspacePropertyInfo = GdkPixbuf.Enums.Colorspace
type AttrLabel PixbufColorspacePropertyInfo = "colorspace"
type AttrOrigin PixbufColorspacePropertyInfo = Pixbuf
attrGet _ = getPixbufColorspace
attrSet _ = undefined
attrConstruct _ = constructPixbufColorspace
attrClear _ = undefined
#endif
-- VVV Prop "has-alpha"
-- Type: TBasicType TBoolean
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Just False,Nothing)
{- |
Get the value of the “@has-alpha@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #hasAlpha
@
-}
getPixbufHasAlpha :: (MonadIO m, IsPixbuf o) => o -> m Bool
getPixbufHasAlpha obj = liftIO $ B.Properties.getObjectPropertyBool obj "has-alpha"
{- |
Construct a `GValueConstruct` with valid value for the “@has-alpha@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufHasAlpha :: (IsPixbuf o) => Bool -> IO (GValueConstruct o)
constructPixbufHasAlpha val = B.Properties.constructObjectPropertyBool "has-alpha" val
#if ENABLE_OVERLOADING
data PixbufHasAlphaPropertyInfo
instance AttrInfo PixbufHasAlphaPropertyInfo where
type AttrAllowedOps PixbufHasAlphaPropertyInfo = '[ 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint PixbufHasAlphaPropertyInfo = (~) Bool
type AttrBaseTypeConstraint PixbufHasAlphaPropertyInfo = IsPixbuf
type AttrGetType PixbufHasAlphaPropertyInfo = Bool
type AttrLabel PixbufHasAlphaPropertyInfo = "has-alpha"
type AttrOrigin PixbufHasAlphaPropertyInfo = Pixbuf
attrGet _ = getPixbufHasAlpha
attrSet _ = undefined
attrConstruct _ = constructPixbufHasAlpha
attrClear _ = undefined
#endif
-- VVV Prop "height"
-- Type: TBasicType TInt
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Just False,Nothing)
{- |
Get the value of the “@height@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #height
@
-}
getPixbufHeight :: (MonadIO m, IsPixbuf o) => o -> m Int32
getPixbufHeight obj = liftIO $ B.Properties.getObjectPropertyInt32 obj "height"
{- |
Construct a `GValueConstruct` with valid value for the “@height@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufHeight :: (IsPixbuf o) => Int32 -> IO (GValueConstruct o)
constructPixbufHeight val = B.Properties.constructObjectPropertyInt32 "height" val
#if ENABLE_OVERLOADING
data PixbufHeightPropertyInfo
instance AttrInfo PixbufHeightPropertyInfo where
type AttrAllowedOps PixbufHeightPropertyInfo = '[ 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint PixbufHeightPropertyInfo = (~) Int32
type AttrBaseTypeConstraint PixbufHeightPropertyInfo = IsPixbuf
type AttrGetType PixbufHeightPropertyInfo = Int32
type AttrLabel PixbufHeightPropertyInfo = "height"
type AttrOrigin PixbufHeightPropertyInfo = Pixbuf
attrGet _ = getPixbufHeight
attrSet _ = undefined
attrConstruct _ = constructPixbufHeight
attrClear _ = undefined
#endif
-- VVV Prop "n-channels"
-- Type: TBasicType TInt
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Just False,Nothing)
{- |
Get the value of the “@n-channels@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #nChannels
@
-}
getPixbufNChannels :: (MonadIO m, IsPixbuf o) => o -> m Int32
getPixbufNChannels obj = liftIO $ B.Properties.getObjectPropertyInt32 obj "n-channels"
{- |
Construct a `GValueConstruct` with valid value for the “@n-channels@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufNChannels :: (IsPixbuf o) => Int32 -> IO (GValueConstruct o)
constructPixbufNChannels val = B.Properties.constructObjectPropertyInt32 "n-channels" val
#if ENABLE_OVERLOADING
data PixbufNChannelsPropertyInfo
instance AttrInfo PixbufNChannelsPropertyInfo where
type AttrAllowedOps PixbufNChannelsPropertyInfo = '[ 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint PixbufNChannelsPropertyInfo = (~) Int32
type AttrBaseTypeConstraint PixbufNChannelsPropertyInfo = IsPixbuf
type AttrGetType PixbufNChannelsPropertyInfo = Int32
type AttrLabel PixbufNChannelsPropertyInfo = "n-channels"
type AttrOrigin PixbufNChannelsPropertyInfo = Pixbuf
attrGet _ = getPixbufNChannels
attrSet _ = undefined
attrConstruct _ = constructPixbufNChannels
attrClear _ = undefined
#endif
-- VVV Prop "pixel-bytes"
-- Type: TInterface (Name {namespace = "GLib", name = "Bytes"})
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Nothing,Nothing)
{- |
Get the value of the “@pixel-bytes@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #pixelBytes
@
-}
getPixbufPixelBytes :: (MonadIO m, IsPixbuf o) => o -> m (Maybe GLib.Bytes.Bytes)
getPixbufPixelBytes obj = liftIO $ B.Properties.getObjectPropertyBoxed obj "pixel-bytes" GLib.Bytes.Bytes
{- |
Construct a `GValueConstruct` with valid value for the “@pixel-bytes@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufPixelBytes :: (IsPixbuf o) => GLib.Bytes.Bytes -> IO (GValueConstruct o)
constructPixbufPixelBytes val = B.Properties.constructObjectPropertyBoxed "pixel-bytes" (Just val)
#if ENABLE_OVERLOADING
data PixbufPixelBytesPropertyInfo
instance AttrInfo PixbufPixelBytesPropertyInfo where
type AttrAllowedOps PixbufPixelBytesPropertyInfo = '[ 'AttrConstruct, 'AttrGet, 'AttrClear]
type AttrSetTypeConstraint PixbufPixelBytesPropertyInfo = (~) GLib.Bytes.Bytes
type AttrBaseTypeConstraint PixbufPixelBytesPropertyInfo = IsPixbuf
type AttrGetType PixbufPixelBytesPropertyInfo = (Maybe GLib.Bytes.Bytes)
type AttrLabel PixbufPixelBytesPropertyInfo = "pixel-bytes"
type AttrOrigin PixbufPixelBytesPropertyInfo = Pixbuf
attrGet _ = getPixbufPixelBytes
attrSet _ = undefined
attrConstruct _ = constructPixbufPixelBytes
attrClear _ = undefined
#endif
-- VVV Prop "pixels"
-- Type: TBasicType TPtr
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Nothing,Nothing)
{- |
Get the value of the “@pixels@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #pixels
@
-}
getPixbufPixels :: (MonadIO m, IsPixbuf o) => o -> m (Ptr ())
getPixbufPixels obj = liftIO $ B.Properties.getObjectPropertyPtr obj "pixels"
{- |
Construct a `GValueConstruct` with valid value for the “@pixels@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufPixels :: (IsPixbuf o) => Ptr () -> IO (GValueConstruct o)
constructPixbufPixels val = B.Properties.constructObjectPropertyPtr "pixels" val
#if ENABLE_OVERLOADING
data PixbufPixelsPropertyInfo
instance AttrInfo PixbufPixelsPropertyInfo where
type AttrAllowedOps PixbufPixelsPropertyInfo = '[ 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint PixbufPixelsPropertyInfo = (~) (Ptr ())
type AttrBaseTypeConstraint PixbufPixelsPropertyInfo = IsPixbuf
type AttrGetType PixbufPixelsPropertyInfo = (Ptr ())
type AttrLabel PixbufPixelsPropertyInfo = "pixels"
type AttrOrigin PixbufPixelsPropertyInfo = Pixbuf
attrGet _ = getPixbufPixels
attrSet _ = undefined
attrConstruct _ = constructPixbufPixels
attrClear _ = undefined
#endif
-- VVV Prop "rowstride"
-- Type: TBasicType TInt
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Just False,Nothing)
{- |
Get the value of the “@rowstride@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #rowstride
@
-}
getPixbufRowstride :: (MonadIO m, IsPixbuf o) => o -> m Int32
getPixbufRowstride obj = liftIO $ B.Properties.getObjectPropertyInt32 obj "rowstride"
{- |
Construct a `GValueConstruct` with valid value for the “@rowstride@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufRowstride :: (IsPixbuf o) => Int32 -> IO (GValueConstruct o)
constructPixbufRowstride val = B.Properties.constructObjectPropertyInt32 "rowstride" val
#if ENABLE_OVERLOADING
data PixbufRowstridePropertyInfo
instance AttrInfo PixbufRowstridePropertyInfo where
type AttrAllowedOps PixbufRowstridePropertyInfo = '[ 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint PixbufRowstridePropertyInfo = (~) Int32
type AttrBaseTypeConstraint PixbufRowstridePropertyInfo = IsPixbuf
type AttrGetType PixbufRowstridePropertyInfo = Int32
type AttrLabel PixbufRowstridePropertyInfo = "rowstride"
type AttrOrigin PixbufRowstridePropertyInfo = Pixbuf
attrGet _ = getPixbufRowstride
attrSet _ = undefined
attrConstruct _ = constructPixbufRowstride
attrClear _ = undefined
#endif
-- VVV Prop "width"
-- Type: TBasicType TInt
-- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
-- Nullable: (Just False,Nothing)
{- |
Get the value of the “@width@” property.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' pixbuf #width
@
-}
getPixbufWidth :: (MonadIO m, IsPixbuf o) => o -> m Int32
getPixbufWidth obj = liftIO $ B.Properties.getObjectPropertyInt32 obj "width"
{- |
Construct a `GValueConstruct` with valid value for the “@width@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructPixbufWidth :: (IsPixbuf o) => Int32 -> IO (GValueConstruct o)
constructPixbufWidth val = B.Properties.constructObjectPropertyInt32 "width" val
#if ENABLE_OVERLOADING
data PixbufWidthPropertyInfo
instance AttrInfo PixbufWidthPropertyInfo where
type AttrAllowedOps PixbufWidthPropertyInfo = '[ 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint PixbufWidthPropertyInfo = (~) Int32
type AttrBaseTypeConstraint PixbufWidthPropertyInfo = IsPixbuf
type AttrGetType PixbufWidthPropertyInfo = Int32
type AttrLabel PixbufWidthPropertyInfo = "width"
type AttrOrigin PixbufWidthPropertyInfo = Pixbuf
attrGet _ = getPixbufWidth
attrSet _ = undefined
attrConstruct _ = constructPixbufWidth
attrClear _ = undefined
#endif
#if ENABLE_OVERLOADING
instance O.HasAttributeList Pixbuf
type instance O.AttributeList Pixbuf = PixbufAttributeList
type PixbufAttributeList = ('[ '("bitsPerSample", PixbufBitsPerSamplePropertyInfo), '("colorspace", PixbufColorspacePropertyInfo), '("hasAlpha", PixbufHasAlphaPropertyInfo), '("height", PixbufHeightPropertyInfo), '("nChannels", PixbufNChannelsPropertyInfo), '("pixelBytes", PixbufPixelBytesPropertyInfo), '("pixels", PixbufPixelsPropertyInfo), '("rowstride", PixbufRowstridePropertyInfo), '("width", PixbufWidthPropertyInfo)] :: [(Symbol, *)])
#endif
#if ENABLE_OVERLOADING
pixbufBitsPerSample :: AttrLabelProxy "bitsPerSample"
pixbufBitsPerSample = AttrLabelProxy
pixbufColorspace :: AttrLabelProxy "colorspace"
pixbufColorspace = AttrLabelProxy
pixbufHasAlpha :: AttrLabelProxy "hasAlpha"
pixbufHasAlpha = AttrLabelProxy
pixbufHeight :: AttrLabelProxy "height"
pixbufHeight = AttrLabelProxy
pixbufNChannels :: AttrLabelProxy "nChannels"
pixbufNChannels = AttrLabelProxy
pixbufPixelBytes :: AttrLabelProxy "pixelBytes"
pixbufPixelBytes = AttrLabelProxy
pixbufPixels :: AttrLabelProxy "pixels"
pixbufPixels = AttrLabelProxy
pixbufRowstride :: AttrLabelProxy "rowstride"
pixbufRowstride = AttrLabelProxy
pixbufWidth :: AttrLabelProxy "width"
pixbufWidth = AttrLabelProxy
#endif
#if ENABLE_OVERLOADING
type instance O.SignalList Pixbuf = PixbufSignalList
type PixbufSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, *)])
#endif
-- method Pixbuf::new
-- method type : Constructor
-- Args : [Arg {argCName = "colorspace", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Color space for image", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "has_alpha", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Whether the image should have transparency information", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "bits_per_sample", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Number of bits per color sample", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Width of image in pixels, must be > 0", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Height of image in pixels, must be > 0", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_new" gdk_pixbuf_new ::
CUInt -> -- colorspace : TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"})
CInt -> -- has_alpha : TBasicType TBoolean
Int32 -> -- bits_per_sample : TBasicType TInt
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
IO (Ptr Pixbuf)
{- |
Creates a new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' structure and allocates a buffer for it. The
buffer has an optimal rowstride. Note that the buffer is not cleared;
you will have to fill it completely yourself.
-}
pixbufNew ::
(B.CallStack.HasCallStack, MonadIO m) =>
GdkPixbuf.Enums.Colorspace
{- ^ /@colorspace@/: Color space for image -}
-> Bool
{- ^ /@hasAlpha@/: Whether the image should have transparency information -}
-> Int32
{- ^ /@bitsPerSample@/: Number of bits per color sample -}
-> Int32
{- ^ /@width@/: Width of image in pixels, must be > 0 -}
-> Int32
{- ^ /@height@/: Height of image in pixels, must be > 0 -}
-> m (Maybe Pixbuf)
{- ^ __Returns:__ A newly-created 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' with a reference count of 1, or
'Nothing' if not enough memory could be allocated for the image buffer. -}
pixbufNew colorspace hasAlpha bitsPerSample width height = liftIO $ do
let colorspace' = (fromIntegral . fromEnum) colorspace
let hasAlpha' = (fromIntegral . fromEnum) hasAlpha
result <- gdk_pixbuf_new colorspace' hasAlpha' bitsPerSample width height
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (wrapObject Pixbuf) result'
return result''
return maybeResult
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_bytes
-- method type : Constructor
-- Args : [Arg {argCName = "data", argType = TInterface (Name {namespace = "GLib", name = "Bytes"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Image data in 8-bit/sample packed format inside a #GBytes", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "colorspace", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Colorspace for the image data", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "has_alpha", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Whether the data has an opacity channel", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "bits_per_sample", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Number of bits per sample", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Width of the image in pixels, must be > 0", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Height of the image in pixels, must be > 0", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "rowstride", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Distance in bytes between row starts", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_bytes" gdk_pixbuf_new_from_bytes ::
Ptr GLib.Bytes.Bytes -> -- data : TInterface (Name {namespace = "GLib", name = "Bytes"})
CUInt -> -- colorspace : TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"})
CInt -> -- has_alpha : TBasicType TBoolean
Int32 -> -- bits_per_sample : TBasicType TInt
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
Int32 -> -- rowstride : TBasicType TInt
IO (Ptr Pixbuf)
{- |
Creates a new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' out of in-memory readonly image data.
Currently only RGB images with 8 bits per sample are supported.
This is the 'GI.GLib.Structs.Bytes.Bytes' variant of 'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewFromData'.
/Since: 2.32/
-}
pixbufNewFromBytes ::
(B.CallStack.HasCallStack, MonadIO m) =>
GLib.Bytes.Bytes
{- ^ /@data@/: Image data in 8-bit\/sample packed format inside a 'GI.GLib.Structs.Bytes.Bytes' -}
-> GdkPixbuf.Enums.Colorspace
{- ^ /@colorspace@/: Colorspace for the image data -}
-> Bool
{- ^ /@hasAlpha@/: Whether the data has an opacity channel -}
-> Int32
{- ^ /@bitsPerSample@/: Number of bits per sample -}
-> Int32
{- ^ /@width@/: Width of the image in pixels, must be > 0 -}
-> Int32
{- ^ /@height@/: Height of the image in pixels, must be > 0 -}
-> Int32
{- ^ /@rowstride@/: Distance in bytes between row starts -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' structure with a reference count of 1. -}
pixbufNewFromBytes data_ colorspace hasAlpha bitsPerSample width height rowstride = liftIO $ do
data_' <- unsafeManagedPtrGetPtr data_
let colorspace' = (fromIntegral . fromEnum) colorspace
let hasAlpha' = (fromIntegral . fromEnum) hasAlpha
result <- gdk_pixbuf_new_from_bytes data_' colorspace' hasAlpha' bitsPerSample width height rowstride
checkUnexpectedReturnNULL "pixbufNewFromBytes" result
result' <- (wrapObject Pixbuf) result
touchManagedPtr data_
return result'
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_data
-- method type : Constructor
-- Args : [Arg {argCName = "data", argType = TCArray False (-1) (-1) (TBasicType TUInt8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Image data in 8-bit/sample packed format", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "colorspace", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Colorspace for the image data", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "has_alpha", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Whether the data has an opacity channel", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "bits_per_sample", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Number of bits per sample", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Width of the image in pixels, must be > 0", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Height of the image in pixels, must be > 0", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "rowstride", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Distance in bytes between row starts", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "destroy_fn", argType = TInterface (Name {namespace = "GdkPixbuf", name = "PixbufDestroyNotify"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "Function used to free the data when the pixbuf's reference count\ndrops to zero, or %NULL if the data should not be freed", sinceVersion = Nothing}, argScope = ScopeTypeAsync, argClosure = 8, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "destroy_fn_data", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "Closure data to pass to the destroy notification function", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_data" gdk_pixbuf_new_from_data ::
Ptr Word8 -> -- data : TCArray False (-1) (-1) (TBasicType TUInt8)
CUInt -> -- colorspace : TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"})
CInt -> -- has_alpha : TBasicType TBoolean
Int32 -> -- bits_per_sample : TBasicType TInt
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
Int32 -> -- rowstride : TBasicType TInt
FunPtr GdkPixbuf.Callbacks.C_PixbufDestroyNotify -> -- destroy_fn : TInterface (Name {namespace = "GdkPixbuf", name = "PixbufDestroyNotify"})
Ptr () -> -- destroy_fn_data : TBasicType TPtr
IO (Ptr Pixbuf)
{- |
Creates a new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' out of in-memory image data. Currently only RGB
images with 8 bits per sample are supported.
Since you are providing a pre-allocated pixel buffer, you must also
specify a way to free that data. This is done with a function of
type 'GI.GdkPixbuf.Callbacks.PixbufDestroyNotify'. When a pixbuf created with is
finalized, your destroy notification function will be called, and
it is its responsibility to free the pixel array.
See also 'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewFromBytes'.
-}
pixbufNewFromData ::
(B.CallStack.HasCallStack, MonadIO m) =>
Ptr Word8
{- ^ /@data@/: Image data in 8-bit\/sample packed format -}
-> GdkPixbuf.Enums.Colorspace
{- ^ /@colorspace@/: Colorspace for the image data -}
-> Bool
{- ^ /@hasAlpha@/: Whether the data has an opacity channel -}
-> Int32
{- ^ /@bitsPerSample@/: Number of bits per sample -}
-> Int32
{- ^ /@width@/: Width of the image in pixels, must be > 0 -}
-> Int32
{- ^ /@height@/: Height of the image in pixels, must be > 0 -}
-> Int32
{- ^ /@rowstride@/: Distance in bytes between row starts -}
-> Maybe (GdkPixbuf.Callbacks.PixbufDestroyNotify)
{- ^ /@destroyFn@/: Function used to free the data when the pixbuf\'s reference count
drops to zero, or 'Nothing' if the data should not be freed -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' structure with a reference count of 1. -}
pixbufNewFromData data_ colorspace hasAlpha bitsPerSample width height rowstride destroyFn = liftIO $ do
let colorspace' = (fromIntegral . fromEnum) colorspace
let hasAlpha' = (fromIntegral . fromEnum) hasAlpha
maybeDestroyFn <- case destroyFn of
Nothing -> return (castPtrToFunPtr nullPtr)
Just jDestroyFn -> do
ptrdestroyFn <- callocMem :: IO (Ptr (FunPtr GdkPixbuf.Callbacks.C_PixbufDestroyNotify))
jDestroyFn' <- GdkPixbuf.Callbacks.mk_PixbufDestroyNotify (GdkPixbuf.Callbacks.wrap_PixbufDestroyNotify (Just ptrdestroyFn) (GdkPixbuf.Callbacks.drop_closures_PixbufDestroyNotify jDestroyFn))
poke ptrdestroyFn jDestroyFn'
return jDestroyFn'
let destroyFnData = nullPtr
result <- gdk_pixbuf_new_from_data data_ colorspace' hasAlpha' bitsPerSample width height rowstride maybeDestroyFn destroyFnData
checkUnexpectedReturnNULL "pixbufNewFromData" result
result' <- (wrapObject Pixbuf) result
return result'
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_file
-- method type : Constructor
-- Args : [Arg {argCName = "filename", argType = TBasicType TFileName, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Name of file to load, in the GLib file\n name encoding", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_file" gdk_pixbuf_new_from_file ::
CString -> -- filename : TBasicType TFileName
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf by loading an image from a file. The file format is
detected automatically. If 'Nothing' is returned, then /@error@/ will be set.
Possible errors are in the @/GDK_PIXBUF_ERROR/@ and @/G_FILE_ERROR/@ domains.
-}
pixbufNewFromFile ::
(B.CallStack.HasCallStack, MonadIO m) =>
[Char]
{- ^ /@filename@/: Name of file to load, in the GLib file
name encoding -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf with a reference count of 1, or 'Nothing' if
any of several error conditions occurred: the file could not be opened,
there was no loader for the file\'s format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromFile filename = liftIO $ do
filename' <- stringToCString filename
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_file filename'
checkUnexpectedReturnNULL "pixbufNewFromFile" result
result' <- (wrapObject Pixbuf) result
freeMem filename'
return result'
) (do
freeMem filename'
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_file_at_scale
-- method type : Constructor
-- Args : [Arg {argCName = "filename", argType = TBasicType TFileName, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Name of file to load, in the GLib file\n name encoding", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The width the image should have or -1 to not constrain the width", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The height the image should have or -1 to not constrain the height", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "preserve_aspect_ratio", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "%TRUE to preserve the image's aspect ratio", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_file_at_scale" gdk_pixbuf_new_from_file_at_scale ::
CString -> -- filename : TBasicType TFileName
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
CInt -> -- preserve_aspect_ratio : TBasicType TBoolean
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf by loading an image from a file. The file format is
detected automatically. If 'Nothing' is returned, then /@error@/ will be set.
Possible errors are in the @/GDK_PIXBUF_ERROR/@ and @/G_FILE_ERROR/@ domains.
The image will be scaled to fit in the requested size, optionally preserving
the image\'s aspect ratio.
When preserving the aspect ratio, a /@width@/ of -1 will cause the image
to be scaled to the exact given height, and a /@height@/ of -1 will cause
the image to be scaled to the exact given width. When not preserving
aspect ratio, a /@width@/ or /@height@/ of -1 means to not scale the image
at all in that dimension. Negative values for /@width@/ and /@height@/ are
allowed since 2.8.
/Since: 2.6/
-}
pixbufNewFromFileAtScale ::
(B.CallStack.HasCallStack, MonadIO m) =>
[Char]
{- ^ /@filename@/: Name of file to load, in the GLib file
name encoding -}
-> Int32
{- ^ /@width@/: The width the image should have or -1 to not constrain the width -}
-> Int32
{- ^ /@height@/: The height the image should have or -1 to not constrain the height -}
-> Bool
{- ^ /@preserveAspectRatio@/: 'True' to preserve the image\'s aspect ratio -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf with a reference count of 1, or 'Nothing'
if any of several error conditions occurred: the file could not be opened,
there was no loader for the file\'s format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromFileAtScale filename width height preserveAspectRatio = liftIO $ do
filename' <- stringToCString filename
let preserveAspectRatio' = (fromIntegral . fromEnum) preserveAspectRatio
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_file_at_scale filename' width height preserveAspectRatio'
checkUnexpectedReturnNULL "pixbufNewFromFileAtScale" result
result' <- (wrapObject Pixbuf) result
freeMem filename'
return result'
) (do
freeMem filename'
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_file_at_size
-- method type : Constructor
-- Args : [Arg {argCName = "filename", argType = TBasicType TFileName, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Name of file to load, in the GLib file\n name encoding", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The width the image should have or -1 to not constrain the width", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The height the image should have or -1 to not constrain the height", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_file_at_size" gdk_pixbuf_new_from_file_at_size ::
CString -> -- filename : TBasicType TFileName
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf by loading an image from a file.
The file format is detected automatically. If 'Nothing' is returned, then
/@error@/ will be set. Possible errors are in the @/GDK_PIXBUF_ERROR/@ and
@/G_FILE_ERROR/@ domains.
The image will be scaled to fit in the requested size, preserving
the image\'s aspect ratio. Note that the returned pixbuf may be smaller
than /@width@/ x /@height@/, if the aspect ratio requires it. To load
and image at the requested size, regardless of aspect ratio, use
'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewFromFileAtScale'.
/Since: 2.4/
-}
pixbufNewFromFileAtSize ::
(B.CallStack.HasCallStack, MonadIO m) =>
[Char]
{- ^ /@filename@/: Name of file to load, in the GLib file
name encoding -}
-> Int32
{- ^ /@width@/: The width the image should have or -1 to not constrain the width -}
-> Int32
{- ^ /@height@/: The height the image should have or -1 to not constrain the height -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf with a reference count of 1, or
'Nothing' if any of several error conditions occurred: the file could not
be opened, there was no loader for the file\'s format, there was not
enough memory to allocate the image buffer, or the image file contained
invalid data. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromFileAtSize filename width height = liftIO $ do
filename' <- stringToCString filename
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_file_at_size filename' width height
checkUnexpectedReturnNULL "pixbufNewFromFileAtSize" result
result' <- (wrapObject Pixbuf) result
freeMem filename'
return result'
) (do
freeMem filename'
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_inline
-- method type : Constructor
-- Args : [Arg {argCName = "data_length", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Length in bytes of the @data argument or -1 to\n disable length checks", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "data", argType = TCArray False (-1) 0 (TBasicType TUInt8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Byte data containing a\n serialized #GdkPixdata structure", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "copy_pixels", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Whether to copy the pixel data, or use direct pointers\n @data for the resulting pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : [Arg {argCName = "data_length", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Length in bytes of the @data argument or -1 to\n disable length checks", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_inline" gdk_pixbuf_new_from_inline ::
Int32 -> -- data_length : TBasicType TInt
Ptr Word8 -> -- data : TCArray False (-1) 0 (TBasicType TUInt8)
CInt -> -- copy_pixels : TBasicType TBoolean
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{-# DEPRECATED pixbufNewFromInline ["(Since version 2.32)","Use 'GI.Gio.Structs.Resource.Resource' instead."] #-}
{- |
Create a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' from a flat representation that is suitable for
storing as inline data in a program. This is useful if you want to
ship a program with images, but don\'t want to depend on any
external files.
gdk-pixbuf ships with a program called [gdk-pixbuf-csource][gdk-pixbuf-csource],
which allows for conversion of @/GdkPixbufs/@ into such a inline representation.
In almost all cases, you should pass the @--raw@ option to
@gdk-pixbuf-csource@. A sample invocation would be:
>
> gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
For the typical case where the inline pixbuf is read-only static data,
you don\'t need to copy the pixel data unless you intend to write to
it, so you can pass 'False' for /@copyPixels@/. (If you pass @--rle@ to
@gdk-pixbuf-csource@, a copy will be made even if /@copyPixels@/ is 'False',
so using this option is generally a bad idea.)
If you create a pixbuf from const inline data compiled into your
program, it\'s probably safe to ignore errors and disable length checks,
since things will always succeed:
>
>pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);
For non-const inline data, you could get out of memory. For untrusted
inline data located at runtime, you could have corrupt inline data in
addition.
-}
pixbufNewFromInline ::
(B.CallStack.HasCallStack, MonadIO m) =>
ByteString
{- ^ /@data@/: Byte data containing a
serialized @/GdkPixdata/@ structure -}
-> Bool
{- ^ /@copyPixels@/: Whether to copy the pixel data, or use direct pointers
/@data@/ for the resulting pixbuf -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' structure with a reference,
count of 1, or 'Nothing' if an error occurred. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromInline data_ copyPixels = liftIO $ do
let dataLength = fromIntegral $ B.length data_
data_' <- packByteString data_
let copyPixels' = (fromIntegral . fromEnum) copyPixels
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_inline dataLength data_' copyPixels'
checkUnexpectedReturnNULL "pixbufNewFromInline" result
result' <- (wrapObject Pixbuf) result
freeMem data_'
return result'
) (do
freeMem data_'
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_resource
-- method type : Constructor
-- Args : [Arg {argCName = "resource_path", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the path of the resource file", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_resource" gdk_pixbuf_new_from_resource ::
CString -> -- resource_path : TBasicType TUTF8
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf by loading an image from an resource.
The file format is detected automatically. If 'Nothing' is returned, then
/@error@/ will be set.
/Since: 2.26/
-}
pixbufNewFromResource ::
(B.CallStack.HasCallStack, MonadIO m) =>
T.Text
{- ^ /@resourcePath@/: the path of the resource file -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf, or 'Nothing' if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromResource resourcePath = liftIO $ do
resourcePath' <- textToCString resourcePath
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_resource resourcePath'
checkUnexpectedReturnNULL "pixbufNewFromResource" result
result' <- (wrapObject Pixbuf) result
freeMem resourcePath'
return result'
) (do
freeMem resourcePath'
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_resource_at_scale
-- method type : Constructor
-- Args : [Arg {argCName = "resource_path", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the path of the resource file", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The width the image should have or -1 to not constrain the width", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The height the image should have or -1 to not constrain the height", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "preserve_aspect_ratio", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "%TRUE to preserve the image's aspect ratio", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_resource_at_scale" gdk_pixbuf_new_from_resource_at_scale ::
CString -> -- resource_path : TBasicType TUTF8
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
CInt -> -- preserve_aspect_ratio : TBasicType TBoolean
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf by loading an image from an resource.
The file format is detected automatically. If 'Nothing' is returned, then
/@error@/ will be set.
The image will be scaled to fit in the requested size, optionally
preserving the image\'s aspect ratio. When preserving the aspect ratio,
a /@width@/ of -1 will cause the image to be scaled to the exact given
height, and a /@height@/ of -1 will cause the image to be scaled to the
exact given width. When not preserving aspect ratio, a /@width@/ or
/@height@/ of -1 means to not scale the image at all in that dimension.
The stream is not closed.
/Since: 2.26/
-}
pixbufNewFromResourceAtScale ::
(B.CallStack.HasCallStack, MonadIO m) =>
T.Text
{- ^ /@resourcePath@/: the path of the resource file -}
-> Int32
{- ^ /@width@/: The width the image should have or -1 to not constrain the width -}
-> Int32
{- ^ /@height@/: The height the image should have or -1 to not constrain the height -}
-> Bool
{- ^ /@preserveAspectRatio@/: 'True' to preserve the image\'s aspect ratio -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf, or 'Nothing' if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromResourceAtScale resourcePath width height preserveAspectRatio = liftIO $ do
resourcePath' <- textToCString resourcePath
let preserveAspectRatio' = (fromIntegral . fromEnum) preserveAspectRatio
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_resource_at_scale resourcePath' width height preserveAspectRatio'
checkUnexpectedReturnNULL "pixbufNewFromResourceAtScale" result
result' <- (wrapObject Pixbuf) result
freeMem resourcePath'
return result'
) (do
freeMem resourcePath'
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_stream
-- method type : Constructor
-- Args : [Arg {argCName = "stream", argType = TInterface (Name {namespace = "Gio", name = "InputStream"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GInputStream to load the pixbuf from", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "cancellable", argType = TInterface (Name {namespace = "Gio", name = "Cancellable"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "optional #GCancellable object, %NULL to ignore", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_stream" gdk_pixbuf_new_from_stream ::
Ptr Gio.InputStream.InputStream -> -- stream : TInterface (Name {namespace = "Gio", name = "InputStream"})
Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"})
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf by loading an image from an input stream.
The file format is detected automatically. If 'Nothing' is returned, then
/@error@/ will be set. The /@cancellable@/ can be used to abort the operation
from another thread. If the operation was cancelled, the error
'GI.Gio.Enums.IOErrorEnumCancelled' will be returned. Other possible errors are in
the @/GDK_PIXBUF_ERROR/@ and @/G_IO_ERROR/@ domains.
The stream is not closed.
/Since: 2.14/
-}
pixbufNewFromStream ::
(B.CallStack.HasCallStack, MonadIO m, Gio.InputStream.IsInputStream a, Gio.Cancellable.IsCancellable b) =>
a
{- ^ /@stream@/: a 'GI.Gio.Objects.InputStream.InputStream' to load the pixbuf from -}
-> Maybe (b)
{- ^ /@cancellable@/: optional 'GI.Gio.Objects.Cancellable.Cancellable' object, 'Nothing' to ignore -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf, or 'Nothing' if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromStream stream cancellable = liftIO $ do
stream' <- unsafeManagedPtrCastPtr stream
maybeCancellable <- case cancellable of
Nothing -> return nullPtr
Just jCancellable -> do
jCancellable' <- unsafeManagedPtrCastPtr jCancellable
return jCancellable'
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_stream stream' maybeCancellable
checkUnexpectedReturnNULL "pixbufNewFromStream" result
result' <- (wrapObject Pixbuf) result
touchManagedPtr stream
whenJust cancellable touchManagedPtr
return result'
) (do
return ()
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_stream_at_scale
-- method type : Constructor
-- Args : [Arg {argCName = "stream", argType = TInterface (Name {namespace = "Gio", name = "InputStream"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GInputStream to load the pixbuf from", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The width the image should have or -1 to not constrain the width", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The height the image should have or -1 to not constrain the height", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "preserve_aspect_ratio", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "%TRUE to preserve the image's aspect ratio", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "cancellable", argType = TInterface (Name {namespace = "Gio", name = "Cancellable"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "optional #GCancellable object, %NULL to ignore", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_stream_at_scale" gdk_pixbuf_new_from_stream_at_scale ::
Ptr Gio.InputStream.InputStream -> -- stream : TInterface (Name {namespace = "Gio", name = "InputStream"})
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
CInt -> -- preserve_aspect_ratio : TBasicType TBoolean
Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"})
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf by loading an image from an input stream.
The file format is detected automatically. If 'Nothing' is returned, then
/@error@/ will be set. The /@cancellable@/ can be used to abort the operation
from another thread. If the operation was cancelled, the error
'GI.Gio.Enums.IOErrorEnumCancelled' will be returned. Other possible errors are in
the @/GDK_PIXBUF_ERROR/@ and @/G_IO_ERROR/@ domains.
The image will be scaled to fit in the requested size, optionally
preserving the image\'s aspect ratio.
When preserving the aspect ratio, a /@width@/ of -1 will cause the image to be
scaled to the exact given height, and a /@height@/ of -1 will cause the image
to be scaled to the exact given width. If both /@width@/ and /@height@/ are
given, this function will behave as if the smaller of the two values
is passed as -1.
When not preserving aspect ratio, a /@width@/ or /@height@/ of -1 means to not
scale the image at all in that dimension.
The stream is not closed.
/Since: 2.14/
-}
pixbufNewFromStreamAtScale ::
(B.CallStack.HasCallStack, MonadIO m, Gio.InputStream.IsInputStream a, Gio.Cancellable.IsCancellable b) =>
a
{- ^ /@stream@/: a 'GI.Gio.Objects.InputStream.InputStream' to load the pixbuf from -}
-> Int32
{- ^ /@width@/: The width the image should have or -1 to not constrain the width -}
-> Int32
{- ^ /@height@/: The height the image should have or -1 to not constrain the height -}
-> Bool
{- ^ /@preserveAspectRatio@/: 'True' to preserve the image\'s aspect ratio -}
-> Maybe (b)
{- ^ /@cancellable@/: optional 'GI.Gio.Objects.Cancellable.Cancellable' object, 'Nothing' to ignore -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf, or 'Nothing' if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromStreamAtScale stream width height preserveAspectRatio cancellable = liftIO $ do
stream' <- unsafeManagedPtrCastPtr stream
let preserveAspectRatio' = (fromIntegral . fromEnum) preserveAspectRatio
maybeCancellable <- case cancellable of
Nothing -> return nullPtr
Just jCancellable -> do
jCancellable' <- unsafeManagedPtrCastPtr jCancellable
return jCancellable'
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_stream_at_scale stream' width height preserveAspectRatio' maybeCancellable
checkUnexpectedReturnNULL "pixbufNewFromStreamAtScale" result
result' <- (wrapObject Pixbuf) result
touchManagedPtr stream
whenJust cancellable touchManagedPtr
return result'
) (do
return ()
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_stream_finish
-- method type : Constructor
-- Args : [Arg {argCName = "async_result", argType = TInterface (Name {namespace = "Gio", name = "AsyncResult"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GAsyncResult", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_stream_finish" gdk_pixbuf_new_from_stream_finish ::
Ptr Gio.AsyncResult.AsyncResult -> -- async_result : TInterface (Name {namespace = "Gio", name = "AsyncResult"})
Ptr (Ptr GError) -> -- error
IO (Ptr Pixbuf)
{- |
Finishes an asynchronous pixbuf creation operation started with
'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewFromStreamAsync'.
/Since: 2.24/
-}
pixbufNewFromStreamFinish ::
(B.CallStack.HasCallStack, MonadIO m, Gio.AsyncResult.IsAsyncResult a) =>
a
{- ^ /@asyncResult@/: a 'GI.Gio.Interfaces.AsyncResult.AsyncResult' -}
-> m Pixbuf
{- ^ __Returns:__ a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' or 'Nothing' on error. Free the returned
object with 'GI.GObject.Objects.Object.objectUnref'. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufNewFromStreamFinish asyncResult = liftIO $ do
asyncResult' <- unsafeManagedPtrCastPtr asyncResult
onException (do
result <- propagateGError $ gdk_pixbuf_new_from_stream_finish asyncResult'
checkUnexpectedReturnNULL "pixbufNewFromStreamFinish" result
result' <- (wrapObject Pixbuf) result
touchManagedPtr asyncResult
return result'
) (do
return ()
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_xpm_data
-- method type : Constructor
-- Args : [Arg {argCName = "data", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Pointer to inline XPM data.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_xpm_data" gdk_pixbuf_new_from_xpm_data ::
Ptr CString -> -- data : TCArray True (-1) (-1) (TBasicType TUTF8)
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf by parsing XPM data in memory. This data is commonly
the result of including an XPM file into a program\'s C source.
-}
pixbufNewFromXpmData ::
(B.CallStack.HasCallStack, MonadIO m) =>
[T.Text]
{- ^ /@data@/: Pointer to inline XPM data. -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf with a reference count of 1. -}
pixbufNewFromXpmData data_ = liftIO $ do
data_' <- packZeroTerminatedUTF8CArray data_
result <- gdk_pixbuf_new_from_xpm_data data_'
checkUnexpectedReturnNULL "pixbufNewFromXpmData" result
result' <- (wrapObject Pixbuf) result
mapZeroTerminatedCArray freeMem data_'
freeMem data_'
return result'
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::add_alpha
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A #GdkPixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "substitute_color", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Whether to set a color to zero opacity. If this\nis %FALSE, then the (@r, @g, @b) arguments will be ignored.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "r", argType = TBasicType TUInt8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Red value to substitute.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "g", argType = TBasicType TUInt8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Green value to substitute.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "b", argType = TBasicType TUInt8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Blue value to substitute.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_add_alpha" gdk_pixbuf_add_alpha ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
CInt -> -- substitute_color : TBasicType TBoolean
Word8 -> -- r : TBasicType TUInt8
Word8 -> -- g : TBasicType TUInt8
Word8 -> -- b : TBasicType TUInt8
IO (Ptr Pixbuf)
{- |
Takes an existing pixbuf and adds an alpha channel to it.
If the existing pixbuf already had an alpha channel, the channel
values are copied from the original; otherwise, the alpha channel
is initialized to 255 (full opacity).
If /@substituteColor@/ is 'True', then the color specified by (/@r@/, /@g@/, /@b@/) will be
assigned zero opacity. That is, if you pass (255, 255, 255) for the
substitute color, all white pixels will become fully transparent.
-}
pixbufAddAlpha ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf'. -}
-> Bool
{- ^ /@substituteColor@/: Whether to set a color to zero opacity. If this
is 'False', then the (/@r@/, /@g@/, /@b@/) arguments will be ignored. -}
-> Word8
{- ^ /@r@/: Red value to substitute. -}
-> Word8
{- ^ /@g@/: Green value to substitute. -}
-> Word8
{- ^ /@b@/: Blue value to substitute. -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf with a reference count of 1. -}
pixbufAddAlpha pixbuf substituteColor r g b = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
let substituteColor' = (fromIntegral . fromEnum) substituteColor
result <- gdk_pixbuf_add_alpha pixbuf' substituteColor' r g b
checkUnexpectedReturnNULL "pixbufAddAlpha" result
result' <- (wrapObject Pixbuf) result
touchManagedPtr pixbuf
return result'
#if ENABLE_OVERLOADING
data PixbufAddAlphaMethodInfo
instance (signature ~ (Bool -> Word8 -> Word8 -> Word8 -> m Pixbuf), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufAddAlphaMethodInfo a signature where
overloadedMethod _ = pixbufAddAlpha
#endif
-- method Pixbuf::apply_embedded_orientation
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A #GdkPixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_apply_embedded_orientation" gdk_pixbuf_apply_embedded_orientation ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO (Ptr Pixbuf)
{- |
Takes an existing pixbuf and checks for the presence of an
associated \"orientation\" option, which may be provided by the
jpeg loader (which reads the exif orientation tag) or the
tiff loader (which reads the tiff orientation tag, and
compensates it for the partial transforms performed by
libtiff). If an orientation option\/tag is present, the
appropriate transform will be performed so that the pixbuf
is oriented correctly.
/Since: 2.12/
-}
pixbufApplyEmbeddedOrientation ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@src@/: A 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf'. -}
-> m Pixbuf
{- ^ __Returns:__ A newly-created pixbuf, 'Nothing' if
not enough memory could be allocated for it, or a reference to the
input pixbuf (with an increased reference count). -}
pixbufApplyEmbeddedOrientation src = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
result <- gdk_pixbuf_apply_embedded_orientation src'
checkUnexpectedReturnNULL "pixbufApplyEmbeddedOrientation" result
result' <- (wrapObject Pixbuf) result
touchManagedPtr src
return result'
#if ENABLE_OVERLOADING
data PixbufApplyEmbeddedOrientationMethodInfo
instance (signature ~ (m Pixbuf), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufApplyEmbeddedOrientationMethodInfo a signature where
overloadedMethod _ = pixbufApplyEmbeddedOrientation
#endif
-- method Pixbuf::composite
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the #GdkPixbuf into which to render the results", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_x", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the left coordinate for region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_y", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the top coordinate for region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the width of the region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the height of the region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "offset_x", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the offset in the X direction (currently rounded to an integer)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "offset_y", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the offset in the Y direction (currently rounded to an integer)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "scale_x", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the scale factor in the X direction", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "scale_y", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the scale factor in the Y direction", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "interp_type", argType = TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the interpolation type for the transformation.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "overall_alpha", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "overall alpha for source image (0..255)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_composite" gdk_pixbuf_composite ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr Pixbuf -> -- dest : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Int32 -> -- dest_x : TBasicType TInt
Int32 -> -- dest_y : TBasicType TInt
Int32 -> -- dest_width : TBasicType TInt
Int32 -> -- dest_height : TBasicType TInt
CDouble -> -- offset_x : TBasicType TDouble
CDouble -> -- offset_y : TBasicType TDouble
CDouble -> -- scale_x : TBasicType TDouble
CDouble -> -- scale_y : TBasicType TDouble
CUInt -> -- interp_type : TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"})
Int32 -> -- overall_alpha : TBasicType TInt
IO ()
{- |
Creates a transformation of the source image /@src@/ by scaling by
/@scaleX@/ and /@scaleY@/ then translating by /@offsetX@/ and /@offsetY@/.
This gives an image in the coordinates of the destination pixbuf.
The rectangle (/@destX@/, /@destY@/, /@destWidth@/, /@destHeight@/)
is then alpha blended onto the corresponding rectangle of the
original destination image.
When the destination rectangle contains parts not in the source
image, the data at the edges of the source image is replicated
to infinity.
<<http://developer.gnome.org/gdkpixbuf/stable/composite.png>>
-}
pixbufComposite ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) =>
a
{- ^ /@src@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> b
{- ^ /@dest@/: the 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' into which to render the results -}
-> Int32
{- ^ /@destX@/: the left coordinate for region to render -}
-> Int32
{- ^ /@destY@/: the top coordinate for region to render -}
-> Int32
{- ^ /@destWidth@/: the width of the region to render -}
-> Int32
{- ^ /@destHeight@/: the height of the region to render -}
-> Double
{- ^ /@offsetX@/: the offset in the X direction (currently rounded to an integer) -}
-> Double
{- ^ /@offsetY@/: the offset in the Y direction (currently rounded to an integer) -}
-> Double
{- ^ /@scaleX@/: the scale factor in the X direction -}
-> Double
{- ^ /@scaleY@/: the scale factor in the Y direction -}
-> GdkPixbuf.Enums.InterpType
{- ^ /@interpType@/: the interpolation type for the transformation. -}
-> Int32
{- ^ /@overallAlpha@/: overall alpha for source image (0..255) -}
-> m ()
pixbufComposite src dest destX destY destWidth destHeight offsetX offsetY scaleX scaleY interpType overallAlpha = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
dest' <- unsafeManagedPtrCastPtr dest
let offsetX' = realToFrac offsetX
let offsetY' = realToFrac offsetY
let scaleX' = realToFrac scaleX
let scaleY' = realToFrac scaleY
let interpType' = (fromIntegral . fromEnum) interpType
gdk_pixbuf_composite src' dest' destX destY destWidth destHeight offsetX' offsetY' scaleX' scaleY' interpType' overallAlpha
touchManagedPtr src
touchManagedPtr dest
return ()
#if ENABLE_OVERLOADING
data PixbufCompositeMethodInfo
instance (signature ~ (b -> Int32 -> Int32 -> Int32 -> Int32 -> Double -> Double -> Double -> Double -> GdkPixbuf.Enums.InterpType -> Int32 -> m ()), MonadIO m, IsPixbuf a, IsPixbuf b) => O.MethodInfo PixbufCompositeMethodInfo a signature where
overloadedMethod _ = pixbufComposite
#endif
-- method Pixbuf::composite_color
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the #GdkPixbuf into which to render the results", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_x", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the left coordinate for region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_y", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the top coordinate for region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the width of the region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the height of the region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "offset_x", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the offset in the X direction (currently rounded to an integer)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "offset_y", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the offset in the Y direction (currently rounded to an integer)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "scale_x", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the scale factor in the X direction", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "scale_y", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the scale factor in the Y direction", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "interp_type", argType = TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the interpolation type for the transformation.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "overall_alpha", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "overall alpha for source image (0..255)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "check_x", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the X offset for the checkboard (origin of checkboard is at -@check_x, -@check_y)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "check_y", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the Y offset for the checkboard", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "check_size", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the size of checks in the checkboard (must be a power of two)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "color1", argType = TBasicType TUInt32, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the color of check at upper left", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "color2", argType = TBasicType TUInt32, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the color of the other check", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_composite_color" gdk_pixbuf_composite_color ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr Pixbuf -> -- dest : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Int32 -> -- dest_x : TBasicType TInt
Int32 -> -- dest_y : TBasicType TInt
Int32 -> -- dest_width : TBasicType TInt
Int32 -> -- dest_height : TBasicType TInt
CDouble -> -- offset_x : TBasicType TDouble
CDouble -> -- offset_y : TBasicType TDouble
CDouble -> -- scale_x : TBasicType TDouble
CDouble -> -- scale_y : TBasicType TDouble
CUInt -> -- interp_type : TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"})
Int32 -> -- overall_alpha : TBasicType TInt
Int32 -> -- check_x : TBasicType TInt
Int32 -> -- check_y : TBasicType TInt
Int32 -> -- check_size : TBasicType TInt
Word32 -> -- color1 : TBasicType TUInt32
Word32 -> -- color2 : TBasicType TUInt32
IO ()
{- |
Creates a transformation of the source image /@src@/ by scaling by
/@scaleX@/ and /@scaleY@/ then translating by /@offsetX@/ and /@offsetY@/,
then alpha blends the rectangle (/@destX@/ ,/@destY@/, /@destWidth@/,
/@destHeight@/) of the resulting image with a checkboard of the
colors /@color1@/ and /@color2@/ and renders it onto the destination
image.
If the source image has no alpha channel, and /@overallAlpha@/ is 255, a fast
path is used which omits the alpha blending and just performs the scaling.
See 'GI.GdkPixbuf.Objects.Pixbuf.pixbufCompositeColorSimple' for a simpler variant of this
function suitable for many tasks.
-}
pixbufCompositeColor ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) =>
a
{- ^ /@src@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> b
{- ^ /@dest@/: the 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' into which to render the results -}
-> Int32
{- ^ /@destX@/: the left coordinate for region to render -}
-> Int32
{- ^ /@destY@/: the top coordinate for region to render -}
-> Int32
{- ^ /@destWidth@/: the width of the region to render -}
-> Int32
{- ^ /@destHeight@/: the height of the region to render -}
-> Double
{- ^ /@offsetX@/: the offset in the X direction (currently rounded to an integer) -}
-> Double
{- ^ /@offsetY@/: the offset in the Y direction (currently rounded to an integer) -}
-> Double
{- ^ /@scaleX@/: the scale factor in the X direction -}
-> Double
{- ^ /@scaleY@/: the scale factor in the Y direction -}
-> GdkPixbuf.Enums.InterpType
{- ^ /@interpType@/: the interpolation type for the transformation. -}
-> Int32
{- ^ /@overallAlpha@/: overall alpha for source image (0..255) -}
-> Int32
{- ^ /@checkX@/: the X offset for the checkboard (origin of checkboard is at -/@checkX@/, -/@checkY@/) -}
-> Int32
{- ^ /@checkY@/: the Y offset for the checkboard -}
-> Int32
{- ^ /@checkSize@/: the size of checks in the checkboard (must be a power of two) -}
-> Word32
{- ^ /@color1@/: the color of check at upper left -}
-> Word32
{- ^ /@color2@/: the color of the other check -}
-> m ()
pixbufCompositeColor src dest destX destY destWidth destHeight offsetX offsetY scaleX scaleY interpType overallAlpha checkX checkY checkSize color1 color2 = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
dest' <- unsafeManagedPtrCastPtr dest
let offsetX' = realToFrac offsetX
let offsetY' = realToFrac offsetY
let scaleX' = realToFrac scaleX
let scaleY' = realToFrac scaleY
let interpType' = (fromIntegral . fromEnum) interpType
gdk_pixbuf_composite_color src' dest' destX destY destWidth destHeight offsetX' offsetY' scaleX' scaleY' interpType' overallAlpha checkX checkY checkSize color1 color2
touchManagedPtr src
touchManagedPtr dest
return ()
#if ENABLE_OVERLOADING
data PixbufCompositeColorMethodInfo
instance (signature ~ (b -> Int32 -> Int32 -> Int32 -> Int32 -> Double -> Double -> Double -> Double -> GdkPixbuf.Enums.InterpType -> Int32 -> Int32 -> Int32 -> Int32 -> Word32 -> Word32 -> m ()), MonadIO m, IsPixbuf a, IsPixbuf b) => O.MethodInfo PixbufCompositeColorMethodInfo a signature where
overloadedMethod _ = pixbufCompositeColor
#endif
-- method Pixbuf::composite_color_simple
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the width of destination image", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the height of destination image", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "interp_type", argType = TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the interpolation type for the transformation.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "overall_alpha", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "overall alpha for source image (0..255)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "check_size", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the size of checks in the checkboard (must be a power of two)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "color1", argType = TBasicType TUInt32, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the color of check at upper left", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "color2", argType = TBasicType TUInt32, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the color of the other check", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_composite_color_simple" gdk_pixbuf_composite_color_simple ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Int32 -> -- dest_width : TBasicType TInt
Int32 -> -- dest_height : TBasicType TInt
CUInt -> -- interp_type : TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"})
Int32 -> -- overall_alpha : TBasicType TInt
Int32 -> -- check_size : TBasicType TInt
Word32 -> -- color1 : TBasicType TUInt32
Word32 -> -- color2 : TBasicType TUInt32
IO (Ptr Pixbuf)
{- |
Creates a new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' by scaling /@src@/ to /@destWidth@/ x
/@destHeight@/ and alpha blending the result with a checkboard of colors
/@color1@/ and /@color2@/.
-}
pixbufCompositeColorSimple ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@src@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> Int32
{- ^ /@destWidth@/: the width of destination image -}
-> Int32
{- ^ /@destHeight@/: the height of destination image -}
-> GdkPixbuf.Enums.InterpType
{- ^ /@interpType@/: the interpolation type for the transformation. -}
-> Int32
{- ^ /@overallAlpha@/: overall alpha for source image (0..255) -}
-> Int32
{- ^ /@checkSize@/: the size of checks in the checkboard (must be a power of two) -}
-> Word32
{- ^ /@color1@/: the color of check at upper left -}
-> Word32
{- ^ /@color2@/: the color of the other check -}
-> m (Maybe Pixbuf)
{- ^ __Returns:__ the new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf', or 'Nothing' if not enough memory could be
allocated for it. -}
pixbufCompositeColorSimple src destWidth destHeight interpType overallAlpha checkSize color1 color2 = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
let interpType' = (fromIntegral . fromEnum) interpType
result <- gdk_pixbuf_composite_color_simple src' destWidth destHeight interpType' overallAlpha checkSize color1 color2
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (wrapObject Pixbuf) result'
return result''
touchManagedPtr src
return maybeResult
#if ENABLE_OVERLOADING
data PixbufCompositeColorSimpleMethodInfo
instance (signature ~ (Int32 -> Int32 -> GdkPixbuf.Enums.InterpType -> Int32 -> Int32 -> Word32 -> Word32 -> m (Maybe Pixbuf)), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufCompositeColorSimpleMethodInfo a signature where
overloadedMethod _ = pixbufCompositeColorSimple
#endif
-- method Pixbuf::copy
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_copy" gdk_pixbuf_copy ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO (Ptr Pixbuf)
{- |
Creates a new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' with a copy of the information in the specified
/@pixbuf@/. Note that this does not copy the options set on the original 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf',
use 'GI.GdkPixbuf.Objects.Pixbuf.pixbufCopyOptions' for this.
-}
pixbufCopy ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m (Maybe Pixbuf)
{- ^ __Returns:__ A newly-created pixbuf with a reference count of 1, or 'Nothing' if
not enough memory could be allocated. -}
pixbufCopy pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_copy pixbuf'
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (wrapObject Pixbuf) result'
return result''
touchManagedPtr pixbuf
return maybeResult
#if ENABLE_OVERLOADING
data PixbufCopyMethodInfo
instance (signature ~ (m (Maybe Pixbuf)), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufCopyMethodInfo a signature where
overloadedMethod _ = pixbufCopy
#endif
-- method Pixbuf::copy_area
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src_pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Source pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "src_x", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Source X coordinate within @src_pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "src_y", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Source Y coordinate within @src_pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Width of the area to copy.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Height of the area to copy.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Destination pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_x", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "X coordinate within @dest_pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_y", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Y coordinate within @dest_pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_copy_area" gdk_pixbuf_copy_area ::
Ptr Pixbuf -> -- src_pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Int32 -> -- src_x : TBasicType TInt
Int32 -> -- src_y : TBasicType TInt
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
Ptr Pixbuf -> -- dest_pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Int32 -> -- dest_x : TBasicType TInt
Int32 -> -- dest_y : TBasicType TInt
IO ()
{- |
Copies a rectangular area from /@srcPixbuf@/ to /@destPixbuf@/. Conversion of
pixbuf formats is done automatically.
If the source rectangle overlaps the destination rectangle on the
same pixbuf, it will be overwritten during the copy operation.
Therefore, you can not use this function to scroll a pixbuf.
-}
pixbufCopyArea ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) =>
a
{- ^ /@srcPixbuf@/: Source pixbuf. -}
-> Int32
{- ^ /@srcX@/: Source X coordinate within /@srcPixbuf@/. -}
-> Int32
{- ^ /@srcY@/: Source Y coordinate within /@srcPixbuf@/. -}
-> Int32
{- ^ /@width@/: Width of the area to copy. -}
-> Int32
{- ^ /@height@/: Height of the area to copy. -}
-> b
{- ^ /@destPixbuf@/: Destination pixbuf. -}
-> Int32
{- ^ /@destX@/: X coordinate within /@destPixbuf@/. -}
-> Int32
{- ^ /@destY@/: Y coordinate within /@destPixbuf@/. -}
-> m ()
pixbufCopyArea srcPixbuf srcX srcY width height destPixbuf destX destY = liftIO $ do
srcPixbuf' <- unsafeManagedPtrCastPtr srcPixbuf
destPixbuf' <- unsafeManagedPtrCastPtr destPixbuf
gdk_pixbuf_copy_area srcPixbuf' srcX srcY width height destPixbuf' destX destY
touchManagedPtr srcPixbuf
touchManagedPtr destPixbuf
return ()
#if ENABLE_OVERLOADING
data PixbufCopyAreaMethodInfo
instance (signature ~ (Int32 -> Int32 -> Int32 -> Int32 -> b -> Int32 -> Int32 -> m ()), MonadIO m, IsPixbuf a, IsPixbuf b) => O.MethodInfo PixbufCopyAreaMethodInfo a signature where
overloadedMethod _ = pixbufCopyArea
#endif
-- method Pixbuf::copy_options
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src_pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf to copy options from", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the #GdkPixbuf to copy options to", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_copy_options" gdk_pixbuf_copy_options ::
Ptr Pixbuf -> -- src_pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr Pixbuf -> -- dest_pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO CInt
{- |
Copy the key\/value pair options attached to a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' to another.
This is useful to keep original metadata after having manipulated
a file. However be careful to remove metadata which you\'ve already
applied, such as the \"orientation\" option after rotating the image.
/Since: 2.36/
-}
pixbufCopyOptions ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) =>
a
{- ^ /@srcPixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' to copy options from -}
-> b
{- ^ /@destPixbuf@/: the 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' to copy options to -}
-> m Bool
{- ^ __Returns:__ 'True' on success. -}
pixbufCopyOptions srcPixbuf destPixbuf = liftIO $ do
srcPixbuf' <- unsafeManagedPtrCastPtr srcPixbuf
destPixbuf' <- unsafeManagedPtrCastPtr destPixbuf
result <- gdk_pixbuf_copy_options srcPixbuf' destPixbuf'
let result' = (/= 0) result
touchManagedPtr srcPixbuf
touchManagedPtr destPixbuf
return result'
#if ENABLE_OVERLOADING
data PixbufCopyOptionsMethodInfo
instance (signature ~ (b -> m Bool), MonadIO m, IsPixbuf a, IsPixbuf b) => O.MethodInfo PixbufCopyOptionsMethodInfo a signature where
overloadedMethod _ = pixbufCopyOptions
#endif
-- method Pixbuf::fill
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "pixel", argType = TBasicType TUInt32, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "RGBA pixel to clear to\n (0xffffffff is opaque white, 0x00000000 transparent black)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_fill" gdk_pixbuf_fill ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Word32 -> -- pixel : TBasicType TUInt32
IO ()
{- |
Clears a pixbuf to the given RGBA value, converting the RGBA value into
the pixbuf\'s pixel format. The alpha will be ignored if the pixbuf
doesn\'t have an alpha channel.
-}
pixbufFill ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> Word32
{- ^ /@pixel@/: RGBA pixel to clear to
(0xffffffff is opaque white, 0x00000000 transparent black) -}
-> m ()
pixbufFill pixbuf pixel = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
gdk_pixbuf_fill pixbuf' pixel
touchManagedPtr pixbuf
return ()
#if ENABLE_OVERLOADING
data PixbufFillMethodInfo
instance (signature ~ (Word32 -> m ()), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufFillMethodInfo a signature where
overloadedMethod _ = pixbufFill
#endif
-- method Pixbuf::flip
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "horizontal", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "%TRUE to flip horizontally, %FALSE to flip vertically", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_flip" gdk_pixbuf_flip ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
CInt -> -- horizontal : TBasicType TBoolean
IO (Ptr Pixbuf)
{- |
Flips a pixbuf horizontally or vertically and returns the
result in a new pixbuf.
/Since: 2.6/
-}
pixbufFlip ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@src@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> Bool
{- ^ /@horizontal@/: 'True' to flip horizontally, 'False' to flip vertically -}
-> m (Maybe Pixbuf)
{- ^ __Returns:__ the new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf', or 'Nothing'
if not enough memory could be allocated for it. -}
pixbufFlip src horizontal = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
let horizontal' = (fromIntegral . fromEnum) horizontal
result <- gdk_pixbuf_flip src' horizontal'
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (wrapObject Pixbuf) result'
return result''
touchManagedPtr src
return maybeResult
#if ENABLE_OVERLOADING
data PixbufFlipMethodInfo
instance (signature ~ (Bool -> m (Maybe Pixbuf)), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufFlipMethodInfo a signature where
overloadedMethod _ = pixbufFlip
#endif
-- method Pixbuf::get_bits_per_sample
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_bits_per_sample" gdk_pixbuf_get_bits_per_sample ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO Int32
{- |
Queries the number of bits per color sample in a pixbuf.
-}
pixbufGetBitsPerSample ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m Int32
{- ^ __Returns:__ Number of bits per color sample. -}
pixbufGetBitsPerSample pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_get_bits_per_sample pixbuf'
touchManagedPtr pixbuf
return result
#if ENABLE_OVERLOADING
data PixbufGetBitsPerSampleMethodInfo
instance (signature ~ (m Int32), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetBitsPerSampleMethodInfo a signature where
overloadedMethod _ = pixbufGetBitsPerSample
#endif
-- method Pixbuf::get_byte_length
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt64)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_byte_length" gdk_pixbuf_get_byte_length ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO Word64
{- |
Returns the length of the pixel data, in bytes.
/Since: 2.26/
-}
pixbufGetByteLength ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf -}
-> m Word64
{- ^ __Returns:__ The length of the pixel data. -}
pixbufGetByteLength pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_get_byte_length pixbuf'
touchManagedPtr pixbuf
return result
#if ENABLE_OVERLOADING
data PixbufGetByteLengthMethodInfo
instance (signature ~ (m Word64), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetByteLengthMethodInfo a signature where
overloadedMethod _ = pixbufGetByteLength
#endif
-- method Pixbuf::get_colorspace
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_colorspace" gdk_pixbuf_get_colorspace ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO CUInt
{- |
Queries the color space of a pixbuf.
-}
pixbufGetColorspace ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m GdkPixbuf.Enums.Colorspace
{- ^ __Returns:__ Color space. -}
pixbufGetColorspace pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_get_colorspace pixbuf'
let result' = (toEnum . fromIntegral) result
touchManagedPtr pixbuf
return result'
#if ENABLE_OVERLOADING
data PixbufGetColorspaceMethodInfo
instance (signature ~ (m GdkPixbuf.Enums.Colorspace), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetColorspaceMethodInfo a signature where
overloadedMethod _ = pixbufGetColorspace
#endif
-- method Pixbuf::get_has_alpha
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_has_alpha" gdk_pixbuf_get_has_alpha ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO CInt
{- |
Queries whether a pixbuf has an alpha channel (opacity information).
-}
pixbufGetHasAlpha ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m Bool
{- ^ __Returns:__ 'True' if it has an alpha channel, 'False' otherwise. -}
pixbufGetHasAlpha pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_get_has_alpha pixbuf'
let result' = (/= 0) result
touchManagedPtr pixbuf
return result'
#if ENABLE_OVERLOADING
data PixbufGetHasAlphaMethodInfo
instance (signature ~ (m Bool), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetHasAlphaMethodInfo a signature where
overloadedMethod _ = pixbufGetHasAlpha
#endif
-- method Pixbuf::get_height
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_height" gdk_pixbuf_get_height ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO Int32
{- |
Queries the height of a pixbuf.
-}
pixbufGetHeight ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m Int32
{- ^ __Returns:__ Height in pixels. -}
pixbufGetHeight pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_get_height pixbuf'
touchManagedPtr pixbuf
return result
#if ENABLE_OVERLOADING
data PixbufGetHeightMethodInfo
instance (signature ~ (m Int32), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetHeightMethodInfo a signature where
overloadedMethod _ = pixbufGetHeight
#endif
-- method Pixbuf::get_n_channels
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_n_channels" gdk_pixbuf_get_n_channels ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO Int32
{- |
Queries the number of channels of a pixbuf.
-}
pixbufGetNChannels ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m Int32
{- ^ __Returns:__ Number of channels. -}
pixbufGetNChannels pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_get_n_channels pixbuf'
touchManagedPtr pixbuf
return result
#if ENABLE_OVERLOADING
data PixbufGetNChannelsMethodInfo
instance (signature ~ (m Int32), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetNChannelsMethodInfo a signature where
overloadedMethod _ = pixbufGetNChannels
#endif
-- method Pixbuf::get_option
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "key", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a nul-terminated string.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUTF8)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_option" gdk_pixbuf_get_option ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
CString -> -- key : TBasicType TUTF8
IO CString
{- |
Looks up /@key@/ in the list of options that may have been attached to the
/@pixbuf@/ when it was loaded, or that may have been attached by another
function using 'GI.GdkPixbuf.Objects.Pixbuf.pixbufSetOption'.
For instance, the ANI loader provides \"Title\" and \"Artist\" options.
The ICO, XBM, and XPM loaders provide \"x_hot\" and \"y_hot\" hot-spot
options for cursor definitions. The PNG loader provides the tEXt ancillary
chunk key\/value pairs as options. Since 2.12, the TIFF and JPEG loaders
return an \"orientation\" option string that corresponds to the embedded
TIFF\/Exif orientation tag (if present). Since 2.32, the TIFF loader sets
the \"multipage\" option string to \"yes\" when a multi-page TIFF is loaded.
Since 2.32 the JPEG and PNG loaders set \"x-dpi\" and \"y-dpi\" if the file
contains image density information in dots per inch.
Since 2.36.6, the JPEG loader sets the \"comment\" option with the comment
EXIF tag.
-}
pixbufGetOption ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> T.Text
{- ^ /@key@/: a nul-terminated string. -}
-> m T.Text
{- ^ __Returns:__ the value associated with /@key@/. This is a nul-terminated
string that should not be freed or 'Nothing' if /@key@/ was not found. -}
pixbufGetOption pixbuf key = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
key' <- textToCString key
result <- gdk_pixbuf_get_option pixbuf' key'
checkUnexpectedReturnNULL "pixbufGetOption" result
result' <- cstringToText result
touchManagedPtr pixbuf
freeMem key'
return result'
#if ENABLE_OVERLOADING
data PixbufGetOptionMethodInfo
instance (signature ~ (T.Text -> m T.Text), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetOptionMethodInfo a signature where
overloadedMethod _ = pixbufGetOption
#endif
-- XXX Could not generate method Pixbuf::get_options
-- Error was : Not implemented: "Hash table argument with transfer = Container? result"
#if ENABLE_OVERLOADING
-- XXX: Dummy instance, since code generation failed.
-- Please file a bug at http://github.com/haskell-gi/haskell-gi.
data PixbufGetOptionsMethodInfo
instance (p ~ (), o ~ O.MethodResolutionFailed "getOptions" Pixbuf) => O.MethodInfo PixbufGetOptionsMethodInfo o p where
overloadedMethod _ = undefined
#endif
-- method Pixbuf::get_pixels
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "length", argType = TBasicType TUInt, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The length of the binary data.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything}]
-- Lengths : [Arg {argCName = "length", argType = TBasicType TUInt, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The length of the binary data.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything}]
-- returnType : Just (TCArray False (-1) 1 (TBasicType TUInt8))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_pixels_with_length" gdk_pixbuf_get_pixels_with_length ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr Word32 -> -- length : TBasicType TUInt
IO (Ptr Word8)
{- |
Queries a pointer to the pixel data of a pixbuf.
/Since: 2.26/
-}
pixbufGetPixels ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m ByteString
{- ^ __Returns:__ A pointer to the pixbuf\'s
pixel data. Please see the section on [image data][image-data]
for information about how the pixel data is stored in memory.
This function will cause an implicit copy of the pixbuf data if the
pixbuf was created from read-only data. -}
pixbufGetPixels pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
length_ <- allocMem :: IO (Ptr Word32)
result <- gdk_pixbuf_get_pixels_with_length pixbuf' length_
length_' <- peek length_
checkUnexpectedReturnNULL "pixbufGetPixels" result
result' <- (unpackByteStringWithLength length_') result
touchManagedPtr pixbuf
freeMem length_
return result'
#if ENABLE_OVERLOADING
data PixbufGetPixelsMethodInfo
instance (signature ~ (m ByteString), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetPixelsMethodInfo a signature where
overloadedMethod _ = pixbufGetPixels
#endif
-- method Pixbuf::get_rowstride
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_rowstride" gdk_pixbuf_get_rowstride ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO Int32
{- |
Queries the rowstride of a pixbuf, which is the number of bytes between
the start of a row and the start of the next row.
-}
pixbufGetRowstride ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m Int32
{- ^ __Returns:__ Distance between row starts. -}
pixbufGetRowstride pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_get_rowstride pixbuf'
touchManagedPtr pixbuf
return result
#if ENABLE_OVERLOADING
data PixbufGetRowstrideMethodInfo
instance (signature ~ (m Int32), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetRowstrideMethodInfo a signature where
overloadedMethod _ = pixbufGetRowstride
#endif
-- method Pixbuf::get_width
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_width" gdk_pixbuf_get_width ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO Int32
{- |
Queries the width of a pixbuf.
-}
pixbufGetWidth ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf. -}
-> m Int32
{- ^ __Returns:__ Width in pixels. -}
pixbufGetWidth pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_get_width pixbuf'
touchManagedPtr pixbuf
return result
#if ENABLE_OVERLOADING
data PixbufGetWidthMethodInfo
instance (signature ~ (m Int32), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufGetWidthMethodInfo a signature where
overloadedMethod _ = pixbufGetWidth
#endif
-- method Pixbuf::new_subpixbuf
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src_pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "src_x", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "X coord in @src_pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "src_y", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Y coord in @src_pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "width of region in @src_pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "height of region in @src_pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_subpixbuf" gdk_pixbuf_new_subpixbuf ::
Ptr Pixbuf -> -- src_pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Int32 -> -- src_x : TBasicType TInt
Int32 -> -- src_y : TBasicType TInt
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
IO (Ptr Pixbuf)
{- |
Creates a new pixbuf which represents a sub-region of /@srcPixbuf@/.
The new pixbuf shares its pixels with the original pixbuf, so
writing to one affects both. The new pixbuf holds a reference to
/@srcPixbuf@/, so /@srcPixbuf@/ will not be finalized until the new
pixbuf is finalized.
Note that if /@srcPixbuf@/ is read-only, this function will force it
to be mutable.
-}
pixbufNewSubpixbuf ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@srcPixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> Int32
{- ^ /@srcX@/: X coord in /@srcPixbuf@/ -}
-> Int32
{- ^ /@srcY@/: Y coord in /@srcPixbuf@/ -}
-> Int32
{- ^ /@width@/: width of region in /@srcPixbuf@/ -}
-> Int32
{- ^ /@height@/: height of region in /@srcPixbuf@/ -}
-> m Pixbuf
{- ^ __Returns:__ a new pixbuf -}
pixbufNewSubpixbuf srcPixbuf srcX srcY width height = liftIO $ do
srcPixbuf' <- unsafeManagedPtrCastPtr srcPixbuf
result <- gdk_pixbuf_new_subpixbuf srcPixbuf' srcX srcY width height
checkUnexpectedReturnNULL "pixbufNewSubpixbuf" result
result' <- (wrapObject Pixbuf) result
touchManagedPtr srcPixbuf
return result'
#if ENABLE_OVERLOADING
data PixbufNewSubpixbufMethodInfo
instance (signature ~ (Int32 -> Int32 -> Int32 -> Int32 -> m Pixbuf), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufNewSubpixbufMethodInfo a signature where
overloadedMethod _ = pixbufNewSubpixbuf
#endif
-- method Pixbuf::read_pixel_bytes
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GLib", name = "Bytes"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_read_pixel_bytes" gdk_pixbuf_read_pixel_bytes ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO (Ptr GLib.Bytes.Bytes)
{- |
Provides a 'GI.GLib.Structs.Bytes.Bytes' buffer containing the raw pixel data; the data
must not be modified. This function allows skipping the implicit
copy that must be made if @/gdk_pixbuf_get_pixels()/@ is called on a
read-only pixbuf.
/Since: 2.32/
-}
pixbufReadPixelBytes ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf -}
-> m GLib.Bytes.Bytes
{- ^ __Returns:__ A new reference to a read-only copy of
the pixel data. Note that for mutable pixbufs, this function will
incur a one-time copy of the pixel data for conversion into the
returned 'GI.GLib.Structs.Bytes.Bytes'. -}
pixbufReadPixelBytes pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_read_pixel_bytes pixbuf'
checkUnexpectedReturnNULL "pixbufReadPixelBytes" result
result' <- (wrapBoxed GLib.Bytes.Bytes) result
touchManagedPtr pixbuf
return result'
#if ENABLE_OVERLOADING
data PixbufReadPixelBytesMethodInfo
instance (signature ~ (m GLib.Bytes.Bytes), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufReadPixelBytesMethodInfo a signature where
overloadedMethod _ = pixbufReadPixelBytes
#endif
-- method Pixbuf::read_pixels
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "A pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt8)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_read_pixels" gdk_pixbuf_read_pixels ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
IO Word8
{- |
Provides a read-only pointer to the raw pixel data; must not be
modified. This function allows skipping the implicit copy that
must be made if @/gdk_pixbuf_get_pixels()/@ is called on a read-only
pixbuf.
/Since: 2.32/
-}
pixbufReadPixels ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: A pixbuf -}
-> m Word8
{- ^ __Returns:__ a read-only pointer to the raw pixel data -}
pixbufReadPixels pixbuf = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
result <- gdk_pixbuf_read_pixels pixbuf'
touchManagedPtr pixbuf
return result
#if ENABLE_OVERLOADING
data PixbufReadPixelsMethodInfo
instance (signature ~ (m Word8), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufReadPixelsMethodInfo a signature where
overloadedMethod _ = pixbufReadPixels
#endif
-- method Pixbuf::remove_option
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "key", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a nul-terminated string representing the key to remove.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_remove_option" gdk_pixbuf_remove_option ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
CString -> -- key : TBasicType TUTF8
IO CInt
{- |
Remove the key\/value pair option attached to a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf'.
/Since: 2.36/
-}
pixbufRemoveOption ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> T.Text
{- ^ /@key@/: a nul-terminated string representing the key to remove. -}
-> m Bool
{- ^ __Returns:__ 'True' if an option was removed, 'False' if not. -}
pixbufRemoveOption pixbuf key = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
key' <- textToCString key
result <- gdk_pixbuf_remove_option pixbuf' key'
let result' = (/= 0) result
touchManagedPtr pixbuf
freeMem key'
return result'
#if ENABLE_OVERLOADING
data PixbufRemoveOptionMethodInfo
instance (signature ~ (T.Text -> m Bool), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufRemoveOptionMethodInfo a signature where
overloadedMethod _ = pixbufRemoveOption
#endif
-- method Pixbuf::rotate_simple
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "angle", argType = TInterface (Name {namespace = "GdkPixbuf", name = "PixbufRotation"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the angle to rotate by", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_rotate_simple" gdk_pixbuf_rotate_simple ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
CUInt -> -- angle : TInterface (Name {namespace = "GdkPixbuf", name = "PixbufRotation"})
IO (Ptr Pixbuf)
{- |
Rotates a pixbuf by a multiple of 90 degrees, and returns the
result in a new pixbuf.
If /@angle@/ is 0, a copy of /@src@/ is returned, avoiding any rotation.
/Since: 2.6/
-}
pixbufRotateSimple ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@src@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> GdkPixbuf.Enums.PixbufRotation
{- ^ /@angle@/: the angle to rotate by -}
-> m (Maybe Pixbuf)
{- ^ __Returns:__ the new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf', or 'Nothing'
if not enough memory could be allocated for it. -}
pixbufRotateSimple src angle = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
let angle' = (fromIntegral . fromEnum) angle
result <- gdk_pixbuf_rotate_simple src' angle'
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (wrapObject Pixbuf) result'
return result''
touchManagedPtr src
return maybeResult
#if ENABLE_OVERLOADING
data PixbufRotateSimpleMethodInfo
instance (signature ~ (GdkPixbuf.Enums.PixbufRotation -> m (Maybe Pixbuf)), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufRotateSimpleMethodInfo a signature where
overloadedMethod _ = pixbufRotateSimple
#endif
-- method Pixbuf::saturate_and_pixelate
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "source image", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "place to write modified version of @src", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "saturation", argType = TBasicType TFloat, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "saturation factor", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "pixelate", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "whether to pixelate", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_saturate_and_pixelate" gdk_pixbuf_saturate_and_pixelate ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr Pixbuf -> -- dest : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
CFloat -> -- saturation : TBasicType TFloat
CInt -> -- pixelate : TBasicType TBoolean
IO ()
{- |
Modifies saturation and optionally pixelates /@src@/, placing the result in
/@dest@/. /@src@/ and /@dest@/ may be the same pixbuf with no ill effects. If
/@saturation@/ is 1.0 then saturation is not changed. If it\'s less than 1.0,
saturation is reduced (the image turns toward grayscale); if greater than
1.0, saturation is increased (the image gets more vivid colors). If /@pixelate@/
is 'True', then pixels are faded in a checkerboard pattern to create a
pixelated image. /@src@/ and /@dest@/ must have the same image format, size, and
rowstride.
-}
pixbufSaturateAndPixelate ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) =>
a
{- ^ /@src@/: source image -}
-> b
{- ^ /@dest@/: place to write modified version of /@src@/ -}
-> Float
{- ^ /@saturation@/: saturation factor -}
-> Bool
{- ^ /@pixelate@/: whether to pixelate -}
-> m ()
pixbufSaturateAndPixelate src dest saturation pixelate = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
dest' <- unsafeManagedPtrCastPtr dest
let saturation' = realToFrac saturation
let pixelate' = (fromIntegral . fromEnum) pixelate
gdk_pixbuf_saturate_and_pixelate src' dest' saturation' pixelate'
touchManagedPtr src
touchManagedPtr dest
return ()
#if ENABLE_OVERLOADING
data PixbufSaturateAndPixelateMethodInfo
instance (signature ~ (b -> Float -> Bool -> m ()), MonadIO m, IsPixbuf a, IsPixbuf b) => O.MethodInfo PixbufSaturateAndPixelateMethodInfo a signature where
overloadedMethod _ = pixbufSaturateAndPixelate
#endif
-- method Pixbuf::save_to_bufferv
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "buffer", argType = TCArray False (-1) 2 (TBasicType TUInt8), direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "\n location to receive a pointer to the new buffer.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything},Arg {argCName = "buffer_size", argType = TBasicType TUInt64, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "location to receive the size of the new buffer.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything},Arg {argCName = "type", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of file format.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_keys", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of options to set, %NULL-terminated", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_values", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "values for named options", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : [Arg {argCName = "buffer_size", argType = TBasicType TUInt64, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "location to receive the size of the new buffer.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything}]
-- returnType : Just (TBasicType TBoolean)
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_save_to_bufferv" gdk_pixbuf_save_to_bufferv ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr (Ptr Word8) -> -- buffer : TCArray False (-1) 2 (TBasicType TUInt8)
Ptr Word64 -> -- buffer_size : TBasicType TUInt64
CString -> -- type : TBasicType TUTF8
Ptr CString -> -- option_keys : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr CString -> -- option_values : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr (Ptr GError) -> -- error
IO CInt
{- |
Saves pixbuf to a new buffer in format /@type@/, which is currently \"jpeg\",
\"tiff\", \"png\", \"ico\" or \"bmp\". See @/gdk_pixbuf_save_to_buffer()/@
for more details.
/Since: 2.4/
-}
pixbufSaveToBufferv ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf'. -}
-> T.Text
{- ^ /@type@/: name of file format. -}
-> [T.Text]
{- ^ /@optionKeys@/: name of options to set, 'Nothing'-terminated -}
-> [T.Text]
{- ^ /@optionValues@/: values for named options -}
-> m (ByteString)
{- ^ /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufSaveToBufferv pixbuf type_ optionKeys optionValues = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
buffer <- allocMem :: IO (Ptr (Ptr Word8))
bufferSize <- allocMem :: IO (Ptr Word64)
type_' <- textToCString type_
optionKeys' <- packZeroTerminatedUTF8CArray optionKeys
optionValues' <- packZeroTerminatedUTF8CArray optionValues
onException (do
_ <- propagateGError $ gdk_pixbuf_save_to_bufferv pixbuf' buffer bufferSize type_' optionKeys' optionValues'
bufferSize' <- peek bufferSize
buffer' <- peek buffer
buffer'' <- (unpackByteStringWithLength bufferSize') buffer'
freeMem buffer'
touchManagedPtr pixbuf
freeMem buffer
freeMem bufferSize
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
return buffer''
) (do
freeMem buffer
freeMem bufferSize
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
)
#if ENABLE_OVERLOADING
data PixbufSaveToBuffervMethodInfo
instance (signature ~ (T.Text -> [T.Text] -> [T.Text] -> m (ByteString)), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufSaveToBuffervMethodInfo a signature where
overloadedMethod _ = pixbufSaveToBufferv
#endif
-- method Pixbuf::save_to_callbackv
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "save_func", argType = TInterface (Name {namespace = "GdkPixbuf", name = "PixbufSaveFunc"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a function that is called to save each block of data that\n the save routine generates.", sinceVersion = Nothing}, argScope = ScopeTypeCall, argClosure = 2, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "user_data", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "user data to pass to the save function.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "type", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of file format.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_keys", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of options to set, %NULL-terminated", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_values", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "values for named options", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_save_to_callbackv" gdk_pixbuf_save_to_callbackv ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
FunPtr GdkPixbuf.Callbacks.C_PixbufSaveFunc -> -- save_func : TInterface (Name {namespace = "GdkPixbuf", name = "PixbufSaveFunc"})
Ptr () -> -- user_data : TBasicType TPtr
CString -> -- type : TBasicType TUTF8
Ptr CString -> -- option_keys : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr CString -> -- option_values : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr (Ptr GError) -> -- error
IO CInt
{- |
Saves pixbuf to a callback in format /@type@/, which is currently \"jpeg\",
\"png\", \"tiff\", \"ico\" or \"bmp\". If /@error@/ is set, 'False' will be returned. See
gdk_pixbuf_save_to_callback () for more details.
/Since: 2.4/
-}
pixbufSaveToCallbackv ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf'. -}
-> GdkPixbuf.Callbacks.PixbufSaveFunc
{- ^ /@saveFunc@/: a function that is called to save each block of data that
the save routine generates. -}
-> T.Text
{- ^ /@type@/: name of file format. -}
-> [T.Text]
{- ^ /@optionKeys@/: name of options to set, 'Nothing'-terminated -}
-> [T.Text]
{- ^ /@optionValues@/: values for named options -}
-> m ()
{- ^ /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufSaveToCallbackv pixbuf saveFunc type_ optionKeys optionValues = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
saveFunc' <- GdkPixbuf.Callbacks.mk_PixbufSaveFunc (GdkPixbuf.Callbacks.wrap_PixbufSaveFunc Nothing (GdkPixbuf.Callbacks.drop_closures_PixbufSaveFunc saveFunc))
type_' <- textToCString type_
optionKeys' <- packZeroTerminatedUTF8CArray optionKeys
optionValues' <- packZeroTerminatedUTF8CArray optionValues
let userData = nullPtr
onException (do
_ <- propagateGError $ gdk_pixbuf_save_to_callbackv pixbuf' saveFunc' userData type_' optionKeys' optionValues'
safeFreeFunPtr $ castFunPtrToPtr saveFunc'
touchManagedPtr pixbuf
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
return ()
) (do
safeFreeFunPtr $ castFunPtrToPtr saveFunc'
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
)
#if ENABLE_OVERLOADING
data PixbufSaveToCallbackvMethodInfo
instance (signature ~ (GdkPixbuf.Callbacks.PixbufSaveFunc -> T.Text -> [T.Text] -> [T.Text] -> m ()), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufSaveToCallbackvMethodInfo a signature where
overloadedMethod _ = pixbufSaveToCallbackv
#endif
-- method Pixbuf::save_to_streamv
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "stream", argType = TInterface (Name {namespace = "Gio", name = "OutputStream"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GOutputStream to save the pixbuf to", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "type", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of file format", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_keys", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of options to set, %NULL-terminated", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_values", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "values for named options", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "cancellable", argType = TInterface (Name {namespace = "Gio", name = "Cancellable"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "optional #GCancellable object, %NULL to ignore", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_save_to_streamv" gdk_pixbuf_save_to_streamv ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr Gio.OutputStream.OutputStream -> -- stream : TInterface (Name {namespace = "Gio", name = "OutputStream"})
CString -> -- type : TBasicType TUTF8
Ptr CString -> -- option_keys : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr CString -> -- option_values : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"})
Ptr (Ptr GError) -> -- error
IO CInt
{- |
Saves /@pixbuf@/ to an output stream.
Supported file formats are currently \"jpeg\", \"tiff\", \"png\", \"ico\" or
\"bmp\". See @/gdk_pixbuf_save_to_stream()/@ for more details.
/Since: 2.36/
-}
pixbufSaveToStreamv ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a, Gio.OutputStream.IsOutputStream b, Gio.Cancellable.IsCancellable c) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> b
{- ^ /@stream@/: a 'GI.Gio.Objects.OutputStream.OutputStream' to save the pixbuf to -}
-> T.Text
{- ^ /@type@/: name of file format -}
-> [T.Text]
{- ^ /@optionKeys@/: name of options to set, 'Nothing'-terminated -}
-> [T.Text]
{- ^ /@optionValues@/: values for named options -}
-> Maybe (c)
{- ^ /@cancellable@/: optional 'GI.Gio.Objects.Cancellable.Cancellable' object, 'Nothing' to ignore -}
-> m ()
{- ^ /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufSaveToStreamv pixbuf stream type_ optionKeys optionValues cancellable = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
stream' <- unsafeManagedPtrCastPtr stream
type_' <- textToCString type_
optionKeys' <- packZeroTerminatedUTF8CArray optionKeys
optionValues' <- packZeroTerminatedUTF8CArray optionValues
maybeCancellable <- case cancellable of
Nothing -> return nullPtr
Just jCancellable -> do
jCancellable' <- unsafeManagedPtrCastPtr jCancellable
return jCancellable'
onException (do
_ <- propagateGError $ gdk_pixbuf_save_to_streamv pixbuf' stream' type_' optionKeys' optionValues' maybeCancellable
touchManagedPtr pixbuf
touchManagedPtr stream
whenJust cancellable touchManagedPtr
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
return ()
) (do
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
)
#if ENABLE_OVERLOADING
data PixbufSaveToStreamvMethodInfo
instance (signature ~ (b -> T.Text -> [T.Text] -> [T.Text] -> Maybe (c) -> m ()), MonadIO m, IsPixbuf a, Gio.OutputStream.IsOutputStream b, Gio.Cancellable.IsCancellable c) => O.MethodInfo PixbufSaveToStreamvMethodInfo a signature where
overloadedMethod _ = pixbufSaveToStreamv
#endif
-- method Pixbuf::save_to_streamv_async
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "stream", argType = TInterface (Name {namespace = "Gio", name = "OutputStream"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GOutputStream to which to save the pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "type", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of file format", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_keys", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of options to set, %NULL-terminated", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_values", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "values for named options", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "cancellable", argType = TInterface (Name {namespace = "Gio", name = "Cancellable"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "optional #GCancellable object, %NULL to ignore", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "callback", argType = TInterface (Name {namespace = "Gio", name = "AsyncReadyCallback"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "a #GAsyncReadyCallback to call when the pixbuf is saved", sinceVersion = Nothing}, argScope = ScopeTypeAsync, argClosure = 7, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "user_data", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "the data to pass to the callback function", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_save_to_streamv_async" gdk_pixbuf_save_to_streamv_async ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr Gio.OutputStream.OutputStream -> -- stream : TInterface (Name {namespace = "Gio", name = "OutputStream"})
CString -> -- type : TBasicType TUTF8
Ptr CString -> -- option_keys : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr CString -> -- option_values : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"})
FunPtr Gio.Callbacks.C_AsyncReadyCallback -> -- callback : TInterface (Name {namespace = "Gio", name = "AsyncReadyCallback"})
Ptr () -> -- user_data : TBasicType TPtr
IO ()
{- |
Saves /@pixbuf@/ to an output stream asynchronously.
For more details see 'GI.GdkPixbuf.Objects.Pixbuf.pixbufSaveToStreamv', which is the synchronous
version of this function.
When the operation is finished, /@callback@/ will be called in the main thread.
You can then call 'GI.GdkPixbuf.Objects.Pixbuf.pixbufSaveToStreamFinish' to get the result of the operation.
/Since: 2.36/
-}
pixbufSaveToStreamvAsync ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a, Gio.OutputStream.IsOutputStream b, Gio.Cancellable.IsCancellable c) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> b
{- ^ /@stream@/: a 'GI.Gio.Objects.OutputStream.OutputStream' to which to save the pixbuf -}
-> T.Text
{- ^ /@type@/: name of file format -}
-> [T.Text]
{- ^ /@optionKeys@/: name of options to set, 'Nothing'-terminated -}
-> [T.Text]
{- ^ /@optionValues@/: values for named options -}
-> Maybe (c)
{- ^ /@cancellable@/: optional 'GI.Gio.Objects.Cancellable.Cancellable' object, 'Nothing' to ignore -}
-> Maybe (Gio.Callbacks.AsyncReadyCallback)
{- ^ /@callback@/: a 'GI.Gio.Callbacks.AsyncReadyCallback' to call when the pixbuf is saved -}
-> m ()
pixbufSaveToStreamvAsync pixbuf stream type_ optionKeys optionValues cancellable callback = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
stream' <- unsafeManagedPtrCastPtr stream
type_' <- textToCString type_
optionKeys' <- packZeroTerminatedUTF8CArray optionKeys
optionValues' <- packZeroTerminatedUTF8CArray optionValues
maybeCancellable <- case cancellable of
Nothing -> return nullPtr
Just jCancellable -> do
jCancellable' <- unsafeManagedPtrCastPtr jCancellable
return jCancellable'
maybeCallback <- case callback of
Nothing -> return (castPtrToFunPtr nullPtr)
Just jCallback -> do
ptrcallback <- callocMem :: IO (Ptr (FunPtr Gio.Callbacks.C_AsyncReadyCallback))
jCallback' <- Gio.Callbacks.mk_AsyncReadyCallback (Gio.Callbacks.wrap_AsyncReadyCallback (Just ptrcallback) (Gio.Callbacks.drop_closures_AsyncReadyCallback jCallback))
poke ptrcallback jCallback'
return jCallback'
let userData = nullPtr
gdk_pixbuf_save_to_streamv_async pixbuf' stream' type_' optionKeys' optionValues' maybeCancellable maybeCallback userData
touchManagedPtr pixbuf
touchManagedPtr stream
whenJust cancellable touchManagedPtr
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
return ()
#if ENABLE_OVERLOADING
data PixbufSaveToStreamvAsyncMethodInfo
instance (signature ~ (b -> T.Text -> [T.Text] -> [T.Text] -> Maybe (c) -> Maybe (Gio.Callbacks.AsyncReadyCallback) -> m ()), MonadIO m, IsPixbuf a, Gio.OutputStream.IsOutputStream b, Gio.Cancellable.IsCancellable c) => O.MethodInfo PixbufSaveToStreamvAsyncMethodInfo a signature where
overloadedMethod _ = pixbufSaveToStreamvAsync
#endif
-- method Pixbuf::savev
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "filename", argType = TBasicType TFileName, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of file to save.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "type", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of file format.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_keys", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of options to set, %NULL-terminated", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "option_values", argType = TCArray True (-1) (-1) (TBasicType TUTF8), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "values for named options", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_savev" gdk_pixbuf_savev ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
CString -> -- filename : TBasicType TFileName
CString -> -- type : TBasicType TUTF8
Ptr CString -> -- option_keys : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr CString -> -- option_values : TCArray True (-1) (-1) (TBasicType TUTF8)
Ptr (Ptr GError) -> -- error
IO CInt
{- |
Saves pixbuf to a file in /@type@/, which is currently \"jpeg\", \"png\", \"tiff\", \"ico\" or \"bmp\".
If /@error@/ is set, 'False' will be returned.
See gdk_pixbuf_save () for more details.
-}
pixbufSavev ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf'. -}
-> [Char]
{- ^ /@filename@/: name of file to save. -}
-> T.Text
{- ^ /@type@/: name of file format. -}
-> [T.Text]
{- ^ /@optionKeys@/: name of options to set, 'Nothing'-terminated -}
-> [T.Text]
{- ^ /@optionValues@/: values for named options -}
-> m ()
{- ^ /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufSavev pixbuf filename type_ optionKeys optionValues = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
filename' <- stringToCString filename
type_' <- textToCString type_
optionKeys' <- packZeroTerminatedUTF8CArray optionKeys
optionValues' <- packZeroTerminatedUTF8CArray optionValues
onException (do
_ <- propagateGError $ gdk_pixbuf_savev pixbuf' filename' type_' optionKeys' optionValues'
touchManagedPtr pixbuf
freeMem filename'
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
return ()
) (do
freeMem filename'
freeMem type_'
mapZeroTerminatedCArray freeMem optionKeys'
freeMem optionKeys'
mapZeroTerminatedCArray freeMem optionValues'
freeMem optionValues'
)
#if ENABLE_OVERLOADING
data PixbufSavevMethodInfo
instance (signature ~ ([Char] -> T.Text -> [T.Text] -> [T.Text] -> m ()), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufSavevMethodInfo a signature where
overloadedMethod _ = pixbufSavev
#endif
-- method Pixbuf::scale
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the #GdkPixbuf into which to render the results", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_x", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the left coordinate for region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_y", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the top coordinate for region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the width of the region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the height of the region to render", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "offset_x", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the offset in the X direction (currently rounded to an integer)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "offset_y", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the offset in the Y direction (currently rounded to an integer)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "scale_x", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the scale factor in the X direction", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "scale_y", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the scale factor in the Y direction", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "interp_type", argType = TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the interpolation type for the transformation.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_scale" gdk_pixbuf_scale ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Ptr Pixbuf -> -- dest : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Int32 -> -- dest_x : TBasicType TInt
Int32 -> -- dest_y : TBasicType TInt
Int32 -> -- dest_width : TBasicType TInt
Int32 -> -- dest_height : TBasicType TInt
CDouble -> -- offset_x : TBasicType TDouble
CDouble -> -- offset_y : TBasicType TDouble
CDouble -> -- scale_x : TBasicType TDouble
CDouble -> -- scale_y : TBasicType TDouble
CUInt -> -- interp_type : TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"})
IO ()
{- |
Creates a transformation of the source image /@src@/ by scaling by
/@scaleX@/ and /@scaleY@/ then translating by /@offsetX@/ and /@offsetY@/,
then renders the rectangle (/@destX@/, /@destY@/, /@destWidth@/,
/@destHeight@/) of the resulting image onto the destination image
replacing the previous contents.
Try to use 'GI.GdkPixbuf.Objects.Pixbuf.pixbufScaleSimple' first, this function is
the industrial-strength power tool you can fall back to if
'GI.GdkPixbuf.Objects.Pixbuf.pixbufScaleSimple' isn\'t powerful enough.
If the source rectangle overlaps the destination rectangle on the
same pixbuf, it will be overwritten during the scaling which
results in rendering artifacts.
-}
pixbufScale ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) =>
a
{- ^ /@src@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> b
{- ^ /@dest@/: the 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' into which to render the results -}
-> Int32
{- ^ /@destX@/: the left coordinate for region to render -}
-> Int32
{- ^ /@destY@/: the top coordinate for region to render -}
-> Int32
{- ^ /@destWidth@/: the width of the region to render -}
-> Int32
{- ^ /@destHeight@/: the height of the region to render -}
-> Double
{- ^ /@offsetX@/: the offset in the X direction (currently rounded to an integer) -}
-> Double
{- ^ /@offsetY@/: the offset in the Y direction (currently rounded to an integer) -}
-> Double
{- ^ /@scaleX@/: the scale factor in the X direction -}
-> Double
{- ^ /@scaleY@/: the scale factor in the Y direction -}
-> GdkPixbuf.Enums.InterpType
{- ^ /@interpType@/: the interpolation type for the transformation. -}
-> m ()
pixbufScale src dest destX destY destWidth destHeight offsetX offsetY scaleX scaleY interpType = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
dest' <- unsafeManagedPtrCastPtr dest
let offsetX' = realToFrac offsetX
let offsetY' = realToFrac offsetY
let scaleX' = realToFrac scaleX
let scaleY' = realToFrac scaleY
let interpType' = (fromIntegral . fromEnum) interpType
gdk_pixbuf_scale src' dest' destX destY destWidth destHeight offsetX' offsetY' scaleX' scaleY' interpType'
touchManagedPtr src
touchManagedPtr dest
return ()
#if ENABLE_OVERLOADING
data PixbufScaleMethodInfo
instance (signature ~ (b -> Int32 -> Int32 -> Int32 -> Int32 -> Double -> Double -> Double -> Double -> GdkPixbuf.Enums.InterpType -> m ()), MonadIO m, IsPixbuf a, IsPixbuf b) => O.MethodInfo PixbufScaleMethodInfo a signature where
overloadedMethod _ = pixbufScale
#endif
-- method Pixbuf::scale_simple
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "src", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the width of destination image", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest_height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the height of destination image", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "interp_type", argType = TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the interpolation type for the transformation.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_scale_simple" gdk_pixbuf_scale_simple ::
Ptr Pixbuf -> -- src : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
Int32 -> -- dest_width : TBasicType TInt
Int32 -> -- dest_height : TBasicType TInt
CUInt -> -- interp_type : TInterface (Name {namespace = "GdkPixbuf", name = "InterpType"})
IO (Ptr Pixbuf)
{- |
Create a new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' containing a copy of /@src@/ scaled to
/@destWidth@/ x /@destHeight@/. Leaves /@src@/ unaffected. /@interpType@/
should be @/GDK_INTERP_NEAREST/@ if you want maximum speed (but when
scaling down @/GDK_INTERP_NEAREST/@ is usually unusably ugly). The
default /@interpType@/ should be @/GDK_INTERP_BILINEAR/@ which offers
reasonable quality and speed.
You can scale a sub-portion of /@src@/ by creating a sub-pixbuf
pointing into /@src@/; see 'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewSubpixbuf'.
If /@destWidth@/ and /@destHeight@/ are equal to the /@src@/ width and height, a
copy of /@src@/ is returned, avoiding any scaling.
For more complicated scaling\/alpha blending see 'GI.GdkPixbuf.Objects.Pixbuf.pixbufScale'
and 'GI.GdkPixbuf.Objects.Pixbuf.pixbufComposite'.
-}
pixbufScaleSimple ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@src@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> Int32
{- ^ /@destWidth@/: the width of destination image -}
-> Int32
{- ^ /@destHeight@/: the height of destination image -}
-> GdkPixbuf.Enums.InterpType
{- ^ /@interpType@/: the interpolation type for the transformation. -}
-> m (Maybe Pixbuf)
{- ^ __Returns:__ the new 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf', or 'Nothing' if not enough memory could be
allocated for it. -}
pixbufScaleSimple src destWidth destHeight interpType = liftIO $ do
src' <- unsafeManagedPtrCastPtr src
let interpType' = (fromIntegral . fromEnum) interpType
result <- gdk_pixbuf_scale_simple src' destWidth destHeight interpType'
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (wrapObject Pixbuf) result'
return result''
touchManagedPtr src
return maybeResult
#if ENABLE_OVERLOADING
data PixbufScaleSimpleMethodInfo
instance (signature ~ (Int32 -> Int32 -> GdkPixbuf.Enums.InterpType -> m (Maybe Pixbuf)), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufScaleSimpleMethodInfo a signature where
overloadedMethod _ = pixbufScaleSimple
#endif
-- method Pixbuf::set_option
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "pixbuf", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GdkPixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "key", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a nul-terminated string.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "value", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a nul-terminated string.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_set_option" gdk_pixbuf_set_option ::
Ptr Pixbuf -> -- pixbuf : TInterface (Name {namespace = "GdkPixbuf", name = "Pixbuf"})
CString -> -- key : TBasicType TUTF8
CString -> -- value : TBasicType TUTF8
IO CInt
{- |
Attaches a key\/value pair as an option to a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf'. If /@key@/ already
exists in the list of options attached to /@pixbuf@/, the new value is
ignored and 'False' is returned.
/Since: 2.2/
-}
pixbufSetOption ::
(B.CallStack.HasCallStack, MonadIO m, IsPixbuf a) =>
a
{- ^ /@pixbuf@/: a 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' -}
-> T.Text
{- ^ /@key@/: a nul-terminated string. -}
-> T.Text
{- ^ /@value@/: a nul-terminated string. -}
-> m Bool
{- ^ __Returns:__ 'True' on success. -}
pixbufSetOption pixbuf key value = liftIO $ do
pixbuf' <- unsafeManagedPtrCastPtr pixbuf
key' <- textToCString key
value' <- textToCString value
result <- gdk_pixbuf_set_option pixbuf' key' value'
let result' = (/= 0) result
touchManagedPtr pixbuf
freeMem key'
freeMem value'
return result'
#if ENABLE_OVERLOADING
data PixbufSetOptionMethodInfo
instance (signature ~ (T.Text -> T.Text -> m Bool), MonadIO m, IsPixbuf a) => O.MethodInfo PixbufSetOptionMethodInfo a signature where
overloadedMethod _ = pixbufSetOption
#endif
-- method Pixbuf::calculate_rowstride
-- method type : MemberFunction
-- Args : [Arg {argCName = "colorspace", argType = TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Color space for image", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "has_alpha", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Whether the image should have transparency information", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "bits_per_sample", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Number of bits per color sample", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Width of image in pixels, must be > 0", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Height of image in pixels, must be > 0", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_calculate_rowstride" gdk_pixbuf_calculate_rowstride ::
CUInt -> -- colorspace : TInterface (Name {namespace = "GdkPixbuf", name = "Colorspace"})
CInt -> -- has_alpha : TBasicType TBoolean
Int32 -> -- bits_per_sample : TBasicType TInt
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
IO Int32
{- |
Calculates the rowstride that an image created with those values would
have. This is useful for front-ends and backends that want to sanity
check image values without needing to create them.
/Since: 2.36.8/
-}
pixbufCalculateRowstride ::
(B.CallStack.HasCallStack, MonadIO m) =>
GdkPixbuf.Enums.Colorspace
{- ^ /@colorspace@/: Color space for image -}
-> Bool
{- ^ /@hasAlpha@/: Whether the image should have transparency information -}
-> Int32
{- ^ /@bitsPerSample@/: Number of bits per color sample -}
-> Int32
{- ^ /@width@/: Width of image in pixels, must be > 0 -}
-> Int32
{- ^ /@height@/: Height of image in pixels, must be > 0 -}
-> m Int32
{- ^ __Returns:__ the rowstride for the given values, or -1 in case of error. -}
pixbufCalculateRowstride colorspace hasAlpha bitsPerSample width height = liftIO $ do
let colorspace' = (fromIntegral . fromEnum) colorspace
let hasAlpha' = (fromIntegral . fromEnum) hasAlpha
result <- gdk_pixbuf_calculate_rowstride colorspace' hasAlpha' bitsPerSample width height
return result
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::get_file_info
-- method type : MemberFunction
-- Args : [Arg {argCName = "filename", argType = TBasicType TFileName, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The name of the file to identify.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Return location for the width of the\n image, or %NULL", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Return location for the height of the\n image, or %NULL", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "PixbufFormat"}))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_file_info" gdk_pixbuf_get_file_info ::
CString -> -- filename : TBasicType TFileName
Ptr Int32 -> -- width : TBasicType TInt
Ptr Int32 -> -- height : TBasicType TInt
IO (Ptr GdkPixbuf.PixbufFormat.PixbufFormat)
{- |
Parses an image file far enough to determine its format and size.
/Since: 2.4/
-}
pixbufGetFileInfo ::
(B.CallStack.HasCallStack, MonadIO m) =>
[Char]
{- ^ /@filename@/: The name of the file to identify. -}
-> m ((Maybe GdkPixbuf.PixbufFormat.PixbufFormat, Int32, Int32))
{- ^ __Returns:__ A 'GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat' describing
the image format of the file or 'Nothing' if the image format wasn\'t
recognized. The return value is owned by 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' and should
not be freed. -}
pixbufGetFileInfo filename = liftIO $ do
filename' <- stringToCString filename
width <- allocMem :: IO (Ptr Int32)
height <- allocMem :: IO (Ptr Int32)
result <- gdk_pixbuf_get_file_info filename' width height
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (newBoxed GdkPixbuf.PixbufFormat.PixbufFormat) result'
return result''
width' <- peek width
height' <- peek height
freeMem filename'
freeMem width
freeMem height
return (maybeResult, width', height')
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::get_file_info_async
-- method type : MemberFunction
-- Args : [Arg {argCName = "filename", argType = TBasicType TFileName, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "The name of the file to identify", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "cancellable", argType = TInterface (Name {namespace = "Gio", name = "Cancellable"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "optional #GCancellable object, %NULL to ignore", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "callback", argType = TInterface (Name {namespace = "Gio", name = "AsyncReadyCallback"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "a #GAsyncReadyCallback to call when the file info is available", sinceVersion = Nothing}, argScope = ScopeTypeAsync, argClosure = 3, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "user_data", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "the data to pass to the callback function", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_file_info_async" gdk_pixbuf_get_file_info_async ::
CString -> -- filename : TBasicType TFileName
Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"})
FunPtr Gio.Callbacks.C_AsyncReadyCallback -> -- callback : TInterface (Name {namespace = "Gio", name = "AsyncReadyCallback"})
Ptr () -> -- user_data : TBasicType TPtr
IO ()
{- |
Asynchronously parses an image file far enough to determine its
format and size.
For more details see 'GI.GdkPixbuf.Objects.Pixbuf.pixbufGetFileInfo', which is the synchronous
version of this function.
When the operation is finished, /@callback@/ will be called in the
main thread. You can then call 'GI.GdkPixbuf.Objects.Pixbuf.pixbufGetFileInfoFinish' to
get the result of the operation.
/Since: 2.32/
-}
pixbufGetFileInfoAsync ::
(B.CallStack.HasCallStack, MonadIO m, Gio.Cancellable.IsCancellable a) =>
[Char]
{- ^ /@filename@/: The name of the file to identify -}
-> Maybe (a)
{- ^ /@cancellable@/: optional 'GI.Gio.Objects.Cancellable.Cancellable' object, 'Nothing' to ignore -}
-> Maybe (Gio.Callbacks.AsyncReadyCallback)
{- ^ /@callback@/: a 'GI.Gio.Callbacks.AsyncReadyCallback' to call when the file info is available -}
-> m ()
pixbufGetFileInfoAsync filename cancellable callback = liftIO $ do
filename' <- stringToCString filename
maybeCancellable <- case cancellable of
Nothing -> return nullPtr
Just jCancellable -> do
jCancellable' <- unsafeManagedPtrCastPtr jCancellable
return jCancellable'
maybeCallback <- case callback of
Nothing -> return (castPtrToFunPtr nullPtr)
Just jCallback -> do
ptrcallback <- callocMem :: IO (Ptr (FunPtr Gio.Callbacks.C_AsyncReadyCallback))
jCallback' <- Gio.Callbacks.mk_AsyncReadyCallback (Gio.Callbacks.wrap_AsyncReadyCallback (Just ptrcallback) (Gio.Callbacks.drop_closures_AsyncReadyCallback jCallback))
poke ptrcallback jCallback'
return jCallback'
let userData = nullPtr
gdk_pixbuf_get_file_info_async filename' maybeCancellable maybeCallback userData
whenJust cancellable touchManagedPtr
freeMem filename'
return ()
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::get_file_info_finish
-- method type : MemberFunction
-- Args : [Arg {argCName = "async_result", argType = TInterface (Name {namespace = "Gio", name = "AsyncResult"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GAsyncResult", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Return location for the width of the image, or %NULL", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "Return location for the height of the image, or %NULL", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "GdkPixbuf", name = "PixbufFormat"}))
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_file_info_finish" gdk_pixbuf_get_file_info_finish ::
Ptr Gio.AsyncResult.AsyncResult -> -- async_result : TInterface (Name {namespace = "Gio", name = "AsyncResult"})
Ptr Int32 -> -- width : TBasicType TInt
Ptr Int32 -> -- height : TBasicType TInt
Ptr (Ptr GError) -> -- error
IO (Ptr GdkPixbuf.PixbufFormat.PixbufFormat)
{- |
Finishes an asynchronous pixbuf parsing operation started with
'GI.GdkPixbuf.Objects.Pixbuf.pixbufGetFileInfoAsync'.
/Since: 2.32/
-}
pixbufGetFileInfoFinish ::
(B.CallStack.HasCallStack, MonadIO m, Gio.AsyncResult.IsAsyncResult a) =>
a
{- ^ /@asyncResult@/: a 'GI.Gio.Interfaces.AsyncResult.AsyncResult' -}
-> m ((GdkPixbuf.PixbufFormat.PixbufFormat, Int32, Int32))
{- ^ __Returns:__ A 'GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat' describing the image
format of the file or 'Nothing' if the image format wasn\'t
recognized. The return value is owned by GdkPixbuf and should
not be freed. /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufGetFileInfoFinish asyncResult = liftIO $ do
asyncResult' <- unsafeManagedPtrCastPtr asyncResult
width <- allocMem :: IO (Ptr Int32)
height <- allocMem :: IO (Ptr Int32)
onException (do
result <- propagateGError $ gdk_pixbuf_get_file_info_finish asyncResult' width height
checkUnexpectedReturnNULL "pixbufGetFileInfoFinish" result
result' <- (newBoxed GdkPixbuf.PixbufFormat.PixbufFormat) result
width' <- peek width
height' <- peek height
touchManagedPtr asyncResult
freeMem width
freeMem height
return (result', width', height')
) (do
freeMem width
freeMem height
)
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::get_formats
-- method type : MemberFunction
-- Args : []
-- Lengths : []
-- returnType : Just (TGSList (TInterface (Name {namespace = "GdkPixbuf", name = "PixbufFormat"})))
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_get_formats" gdk_pixbuf_get_formats ::
IO (Ptr (GSList (Ptr GdkPixbuf.PixbufFormat.PixbufFormat)))
{- |
Obtains the available information about the image formats supported
by GdkPixbuf.
/Since: 2.2/
-}
pixbufGetFormats ::
(B.CallStack.HasCallStack, MonadIO m) =>
m [GdkPixbuf.PixbufFormat.PixbufFormat]
{- ^ __Returns:__ A list of
@/GdkPixbufFormats/@ describing the supported image formats. The list should
be freed when it is no longer needed, but the structures themselves are
owned by 'GI.GdkPixbuf.Objects.Pixbuf.Pixbuf' and should not be freed. -}
pixbufGetFormats = liftIO $ do
result <- gdk_pixbuf_get_formats
result' <- unpackGSList result
result'' <- mapM (newBoxed GdkPixbuf.PixbufFormat.PixbufFormat) result'
g_slist_free result
return result''
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_stream_async
-- method type : MemberFunction
-- Args : [Arg {argCName = "stream", argType = TInterface (Name {namespace = "Gio", name = "InputStream"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GInputStream from which to load the pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "cancellable", argType = TInterface (Name {namespace = "Gio", name = "Cancellable"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "optional #GCancellable object, %NULL to ignore", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "callback", argType = TInterface (Name {namespace = "Gio", name = "AsyncReadyCallback"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "a #GAsyncReadyCallback to call when the pixbuf is loaded", sinceVersion = Nothing}, argScope = ScopeTypeAsync, argClosure = 3, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "user_data", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "the data to pass to the callback function", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_stream_async" gdk_pixbuf_new_from_stream_async ::
Ptr Gio.InputStream.InputStream -> -- stream : TInterface (Name {namespace = "Gio", name = "InputStream"})
Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"})
FunPtr Gio.Callbacks.C_AsyncReadyCallback -> -- callback : TInterface (Name {namespace = "Gio", name = "AsyncReadyCallback"})
Ptr () -> -- user_data : TBasicType TPtr
IO ()
{- |
Creates a new pixbuf by asynchronously loading an image from an input stream.
For more details see 'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewFromStream', which is the synchronous
version of this function.
When the operation is finished, /@callback@/ will be called in the main thread.
You can then call 'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewFromStreamFinish' to get the result of the operation.
/Since: 2.24/
-}
pixbufNewFromStreamAsync ::
(B.CallStack.HasCallStack, MonadIO m, Gio.InputStream.IsInputStream a, Gio.Cancellable.IsCancellable b) =>
a
{- ^ /@stream@/: a 'GI.Gio.Objects.InputStream.InputStream' from which to load the pixbuf -}
-> Maybe (b)
{- ^ /@cancellable@/: optional 'GI.Gio.Objects.Cancellable.Cancellable' object, 'Nothing' to ignore -}
-> Maybe (Gio.Callbacks.AsyncReadyCallback)
{- ^ /@callback@/: a 'GI.Gio.Callbacks.AsyncReadyCallback' to call when the pixbuf is loaded -}
-> m ()
pixbufNewFromStreamAsync stream cancellable callback = liftIO $ do
stream' <- unsafeManagedPtrCastPtr stream
maybeCancellable <- case cancellable of
Nothing -> return nullPtr
Just jCancellable -> do
jCancellable' <- unsafeManagedPtrCastPtr jCancellable
return jCancellable'
maybeCallback <- case callback of
Nothing -> return (castPtrToFunPtr nullPtr)
Just jCallback -> do
ptrcallback <- callocMem :: IO (Ptr (FunPtr Gio.Callbacks.C_AsyncReadyCallback))
jCallback' <- Gio.Callbacks.mk_AsyncReadyCallback (Gio.Callbacks.wrap_AsyncReadyCallback (Just ptrcallback) (Gio.Callbacks.drop_closures_AsyncReadyCallback jCallback))
poke ptrcallback jCallback'
return jCallback'
let userData = nullPtr
gdk_pixbuf_new_from_stream_async stream' maybeCancellable maybeCallback userData
touchManagedPtr stream
whenJust cancellable touchManagedPtr
return ()
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::new_from_stream_at_scale_async
-- method type : MemberFunction
-- Args : [Arg {argCName = "stream", argType = TInterface (Name {namespace = "Gio", name = "InputStream"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GInputStream from which to load the pixbuf", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "width", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the width the image should have or -1 to not constrain the width", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "height", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the height the image should have or -1 to not constrain the height", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "preserve_aspect_ratio", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "%TRUE to preserve the image's aspect ratio", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "cancellable", argType = TInterface (Name {namespace = "Gio", name = "Cancellable"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "optional #GCancellable object, %NULL to ignore", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "callback", argType = TInterface (Name {namespace = "Gio", name = "AsyncReadyCallback"}), direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "a #GAsyncReadyCallback to call when the pixbuf is loaded", sinceVersion = Nothing}, argScope = ScopeTypeAsync, argClosure = 6, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "user_data", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "the data to pass to the callback function", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gdk_pixbuf_new_from_stream_at_scale_async" gdk_pixbuf_new_from_stream_at_scale_async ::
Ptr Gio.InputStream.InputStream -> -- stream : TInterface (Name {namespace = "Gio", name = "InputStream"})
Int32 -> -- width : TBasicType TInt
Int32 -> -- height : TBasicType TInt
CInt -> -- preserve_aspect_ratio : TBasicType TBoolean
Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"})
FunPtr Gio.Callbacks.C_AsyncReadyCallback -> -- callback : TInterface (Name {namespace = "Gio", name = "AsyncReadyCallback"})
Ptr () -> -- user_data : TBasicType TPtr
IO ()
{- |
Creates a new pixbuf by asynchronously loading an image from an input stream.
For more details see 'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewFromStreamAtScale', which is the synchronous
version of this function.
When the operation is finished, /@callback@/ will be called in the main thread.
You can then call 'GI.GdkPixbuf.Objects.Pixbuf.pixbufNewFromStreamFinish' to get the result of the operation.
/Since: 2.24/
-}
pixbufNewFromStreamAtScaleAsync ::
(B.CallStack.HasCallStack, MonadIO m, Gio.InputStream.IsInputStream a, Gio.Cancellable.IsCancellable b) =>
a
{- ^ /@stream@/: a 'GI.Gio.Objects.InputStream.InputStream' from which to load the pixbuf -}
-> Int32
{- ^ /@width@/: the width the image should have or -1 to not constrain the width -}
-> Int32
{- ^ /@height@/: the height the image should have or -1 to not constrain the height -}
-> Bool
{- ^ /@preserveAspectRatio@/: 'True' to preserve the image\'s aspect ratio -}
-> Maybe (b)
{- ^ /@cancellable@/: optional 'GI.Gio.Objects.Cancellable.Cancellable' object, 'Nothing' to ignore -}
-> Maybe (Gio.Callbacks.AsyncReadyCallback)
{- ^ /@callback@/: a 'GI.Gio.Callbacks.AsyncReadyCallback' to call when the pixbuf is loaded -}
-> m ()
pixbufNewFromStreamAtScaleAsync stream width height preserveAspectRatio cancellable callback = liftIO $ do
stream' <- unsafeManagedPtrCastPtr stream
let preserveAspectRatio' = (fromIntegral . fromEnum) preserveAspectRatio
maybeCancellable <- case cancellable of
Nothing -> return nullPtr
Just jCancellable -> do
jCancellable' <- unsafeManagedPtrCastPtr jCancellable
return jCancellable'
maybeCallback <- case callback of
Nothing -> return (castPtrToFunPtr nullPtr)
Just jCallback -> do
ptrcallback <- callocMem :: IO (Ptr (FunPtr Gio.Callbacks.C_AsyncReadyCallback))
jCallback' <- Gio.Callbacks.mk_AsyncReadyCallback (Gio.Callbacks.wrap_AsyncReadyCallback (Just ptrcallback) (Gio.Callbacks.drop_closures_AsyncReadyCallback jCallback))
poke ptrcallback jCallback'
return jCallback'
let userData = nullPtr
gdk_pixbuf_new_from_stream_at_scale_async stream' width height preserveAspectRatio' maybeCancellable maybeCallback userData
touchManagedPtr stream
whenJust cancellable touchManagedPtr
return ()
#if ENABLE_OVERLOADING
#endif
-- method Pixbuf::save_to_stream_finish
-- method type : MemberFunction
-- Args : [Arg {argCName = "async_result", argType = TInterface (Name {namespace = "Gio", name = "AsyncResult"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GAsyncResult", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : True
-- Skip return : False
foreign import ccall "gdk_pixbuf_save_to_stream_finish" gdk_pixbuf_save_to_stream_finish ::
Ptr Gio.AsyncResult.AsyncResult -> -- async_result : TInterface (Name {namespace = "Gio", name = "AsyncResult"})
Ptr (Ptr GError) -> -- error
IO CInt
{- |
Finishes an asynchronous pixbuf save operation started with
@/gdk_pixbuf_save_to_stream_async()/@.
/Since: 2.24/
-}
pixbufSaveToStreamFinish ::
(B.CallStack.HasCallStack, MonadIO m, Gio.AsyncResult.IsAsyncResult a) =>
a
{- ^ /@asyncResult@/: a 'GI.Gio.Interfaces.AsyncResult.AsyncResult' -}
-> m ()
{- ^ /(Can throw 'Data.GI.Base.GError.GError')/ -}
pixbufSaveToStreamFinish asyncResult = liftIO $ do
asyncResult' <- unsafeManagedPtrCastPtr asyncResult
onException (do
_ <- propagateGError $ gdk_pixbuf_save_to_stream_finish asyncResult'
touchManagedPtr asyncResult
return ()
) (do
return ()
)
#if ENABLE_OVERLOADING
#endif