-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | GdkPixbuf bindings
--   
--   Bindings for GdkPixbuf, autogenerated by haskell-gi.
@package gi-gdkpixbuf
@version 2.0.32

-- | Build time configuration used during code generation.
module GI.GdkPixbuf.Config

-- | Overrides used when generating these bindings.
overrides :: Text

-- | Modules in this package
modules :: [Text]

module GI.GdkPixbuf.Constants

-- | Contains the full version of GdkPixbuf as a string.
--   
--   This is the version being compiled against; contrast with
--   gdk_pixbuf_version.
pattern PIXBUF_VERSION :: Text

-- | Minor version of gdk-pixbuf library, that is the "8" in "0.8.2" for
--   example.
pattern PIXBUF_MINOR :: Int32

-- | Micro version of gdk-pixbuf library, that is the "2" in "0.8.2" for
--   example.
pattern PIXBUF_MICRO :: Int32

-- | Major version of gdk-pixbuf library, that is the "0" in "0.8.2" for
--   example.
pattern PIXBUF_MAJOR :: Int32

module GI.GdkPixbuf.Enums

-- | This enumeration defines the color spaces that are supported by the
--   gdk-pixbuf library.
--   
--   Currently only RGB is supported.
data Colorspace

-- | Indicates a red/green/blue additive color space.
ColorspaceRgb :: Colorspace

-- | Catch-all for unknown values
AnotherColorspace :: Int -> Colorspace

-- | Interpolation modes for scaling functions.
--   
--   The GDK_INTERP_NEAREST mode is the fastest scaling method,
--   but has horrible quality when scaling down;
--   GDK_INTERP_BILINEAR is the best choice if you aren't sure
--   what to choose, it has a good speed/quality balance.
--   
--   Note: Cubic filtering is missing from the list; hyperbolic
--   interpolation is just as fast and results in higher quality.
data InterpType

-- | Nearest neighbor sampling; this is the fastest and lowest quality
--   mode. Quality is normally unacceptable when scaling down, but may be
--   OK when scaling up.
InterpTypeNearest :: InterpType

-- | This is an accurate simulation of the PostScript image operator
--   without any interpolation enabled. Each pixel is rendered as a tiny
--   parallelogram of solid color, the edges of which are implemented with
--   antialiasing. It resembles nearest neighbor for enlargement, and
--   bilinear for reduction.
InterpTypeTiles :: InterpType

-- | Best quality/speed balance; use this mode by default. Bilinear
--   interpolation. For enlargement, it is equivalent to point-sampling the
--   ideal bilinear-interpolated image. For reduction, it is equivalent to
--   laying down small tiles and integrating over the coverage area.
InterpTypeBilinear :: InterpType

-- | This is the slowest and highest quality reconstruction function. It is
--   derived from the hyperbolic filters in Wolberg's "Digital Image
--   Warping", and is formally defined as the hyperbolic-filter sampling
--   the ideal hyperbolic-filter interpolated image (the filter is designed
--   to be idempotent for 1:1 pixel mapping). Deprecated: this
--   interpolation filter is deprecated, as in reality it has a lower
--   quality than the gDKINTERPBILINEAR filter (Since:
--   2.38)
InterpTypeHyper :: InterpType

-- | Catch-all for unknown values
AnotherInterpType :: Int -> InterpType

-- | Control the alpha channel for drawables.
--   
--   These values can be passed to
--   gdk_pixbuf_xlib_render_to_drawable_alpha() in
--   gdk-pixbuf-xlib to control how the alpha channel of an image should be
--   handled.
--   
--   This function can create a bilevel clipping mask (black and white) and
--   use it while painting the image.
--   
--   In the future, when the X Window System gets an alpha channel
--   extension, it will be possible to do full alpha compositing onto
--   arbitrary drawables. For now both cases fall back to a bilevel
--   clipping mask.

-- | Deprecated: (Since version 2.42)There is no user of
--   GdkPixbufAlphaMode in GdkPixbuf,and the Xlib utility functions have
--   been split out to their ownlibrary, gdk-pixbuf-xlib
data PixbufAlphaMode

-- | A bilevel clipping mask (black and white) will be created and used to
--   draw the image. Pixels below 0.5 opacity will be considered fully
--   transparent, and all others will be considered fully opaque.
PixbufAlphaModeBilevel :: PixbufAlphaMode

-- | For now falls back to GDK_PIXBUF_ALPHA_BILEVEL. In the
--   future it will do full alpha compositing.
PixbufAlphaModeFull :: PixbufAlphaMode

-- | Catch-all for unknown values
AnotherPixbufAlphaMode :: Int -> PixbufAlphaMode

-- | An error code in the GDK_PIXBUF_ERROR domain.
--   
--   Many gdk-pixbuf operations can cause errors in this domain, or in the
--   G_FILE_ERROR domain.
data PixbufError

-- | An image file was broken somehow.
PixbufErrorCorruptImage :: PixbufError

-- | Not enough memory.
PixbufErrorInsufficientMemory :: PixbufError

-- | A bad option was passed to a pixbuf save module.
PixbufErrorBadOption :: PixbufError

-- | Unknown image type.
PixbufErrorUnknownType :: PixbufError

-- | Don't know how to perform the given operation on the type of image at
--   hand.
PixbufErrorUnsupportedOperation :: PixbufError

-- | Generic failure code, something went wrong.
PixbufErrorFailed :: PixbufError

-- | Only part of the animation was loaded.
PixbufErrorIncompleteAnimation :: PixbufError

-- | Catch-all for unknown values
AnotherPixbufError :: Int -> PixbufError

-- | Catch exceptions of type PixbufError. This is a specialized
--   version of catchGErrorJustDomain.
catchPixbufError :: IO a -> (PixbufError -> GErrorMessage -> IO a) -> IO a

-- | Handle exceptions of type PixbufError. This is a specialized
--   version of handleGErrorJustDomain.
handlePixbufError :: (PixbufError -> GErrorMessage -> IO a) -> IO a -> IO a

-- | The possible rotations which can be passed to
--   pixbufRotateSimple.
--   
--   To make them easier to use, their numerical values are the actual
--   degrees.
data PixbufRotation

-- | No rotation.
PixbufRotationNone :: PixbufRotation

-- | Rotate by 90 degrees.
PixbufRotationCounterclockwise :: PixbufRotation

-- | Rotate by 180 degrees.
PixbufRotationUpsidedown :: PixbufRotation

-- | Rotate by 270 degrees.
PixbufRotationClockwise :: PixbufRotation

-- | Catch-all for unknown values
AnotherPixbufRotation :: Int -> PixbufRotation
instance Data.GI.Base.BasicTypes.BoxedEnum GI.GdkPixbuf.Enums.Colorspace
instance Data.GI.Base.BasicTypes.BoxedEnum GI.GdkPixbuf.Enums.InterpType
instance Data.GI.Base.BasicTypes.BoxedEnum GI.GdkPixbuf.Enums.PixbufAlphaMode
instance Data.GI.Base.BasicTypes.BoxedEnum GI.GdkPixbuf.Enums.PixbufError
instance Data.GI.Base.BasicTypes.BoxedEnum GI.GdkPixbuf.Enums.PixbufRotation
instance GHC.Internal.Enum.Enum GI.GdkPixbuf.Enums.Colorspace
instance GHC.Internal.Enum.Enum GI.GdkPixbuf.Enums.InterpType
instance GHC.Internal.Enum.Enum GI.GdkPixbuf.Enums.PixbufAlphaMode
instance GHC.Internal.Enum.Enum GI.GdkPixbuf.Enums.PixbufError
instance GHC.Internal.Enum.Enum GI.GdkPixbuf.Enums.PixbufRotation
instance GHC.Classes.Eq GI.GdkPixbuf.Enums.Colorspace
instance GHC.Classes.Eq GI.GdkPixbuf.Enums.InterpType
instance GHC.Classes.Eq GI.GdkPixbuf.Enums.PixbufAlphaMode
instance GHC.Classes.Eq GI.GdkPixbuf.Enums.PixbufError
instance GHC.Classes.Eq GI.GdkPixbuf.Enums.PixbufRotation
instance Data.GI.Base.GError.GErrorClass GI.GdkPixbuf.Enums.PixbufError
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Enums.Colorspace
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Enums.InterpType
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Enums.PixbufAlphaMode
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Enums.PixbufError
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Enums.PixbufRotation
instance GHC.Classes.Ord GI.GdkPixbuf.Enums.Colorspace
instance GHC.Classes.Ord GI.GdkPixbuf.Enums.InterpType
instance GHC.Classes.Ord GI.GdkPixbuf.Enums.PixbufAlphaMode
instance GHC.Classes.Ord GI.GdkPixbuf.Enums.PixbufError
instance GHC.Classes.Ord GI.GdkPixbuf.Enums.PixbufRotation
instance GHC.Internal.Show.Show GI.GdkPixbuf.Enums.Colorspace
instance GHC.Internal.Show.Show GI.GdkPixbuf.Enums.InterpType
instance GHC.Internal.Show.Show GI.GdkPixbuf.Enums.PixbufAlphaMode
instance GHC.Internal.Show.Show GI.GdkPixbuf.Enums.PixbufError
instance GHC.Internal.Show.Show GI.GdkPixbuf.Enums.PixbufRotation
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Enums.Colorspace
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Enums.InterpType
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Enums.PixbufAlphaMode
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Enums.PixbufError
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Enums.PixbufRotation

module GI.GdkPixbuf.Flags

-- | Flags which allow a module to specify further details about the
--   supported operations.
--   
--   Since: 2.2
data PixbufFormatFlags

-- | the module can write out images in the format.
PixbufFormatFlagsWritable :: PixbufFormatFlags

-- | the image format is scalable
PixbufFormatFlagsScalable :: PixbufFormatFlags

-- | the module is threadsafe. gdk-pixbuf ignores modules that are not
--   marked as threadsafe. (Since 2.28).
PixbufFormatFlagsThreadsafe :: PixbufFormatFlags

-- | Catch-all for unknown values
AnotherPixbufFormatFlags :: Int -> PixbufFormatFlags
instance GHC.Internal.Enum.Enum GI.GdkPixbuf.Flags.PixbufFormatFlags
instance GHC.Classes.Eq GI.GdkPixbuf.Flags.PixbufFormatFlags
instance Data.GI.Base.BasicTypes.IsGFlag GI.GdkPixbuf.Flags.PixbufFormatFlags
instance GHC.Classes.Ord GI.GdkPixbuf.Flags.PixbufFormatFlags
instance GHC.Internal.Show.Show GI.GdkPixbuf.Flags.PixbufFormatFlags

-- | The signature prefix for a module.
--   
--   The signature of a module is a set of prefixes. Prefixes are encoded
--   as pairs of ordinary strings, where the second string, called the
--   mask, if not NULL, must be of the same length as the first
--   one and may contain ' ', '!', 'x', 'z', and 'n' to indicate bytes that
--   must be matched, not matched, "don't-care"-bytes, zeros and non-zeros,
--   respectively.
--   
--   Each prefix has an associated integer that describes the relevance of
--   the prefix, with 0 meaning a mismatch and 100 a "perfect match".
--   
--   Starting with gdk-pixbuf 2.8, the first byte of the mask may be '*',
--   indicating an unanchored pattern that matches not only at the
--   beginning, but also in the middle. Versions prior to 2.8 will
--   interpret the '*' like an 'x'.
--   
--   The signature of a module is stored as an array of
--   GdkPixbufModulePatterns. The array is terminated by a pattern
--   where the prefix is NULL.
--   
--   
c code
--   
--   
--   GdkPixbufModulePattern *signature[] = {
--     { "abcdx", " !x z", 100 },
--     { "bla", NULL,  90 },
--     { NULL, NULL, 0 }
--   };
--   
--   
--   In the example above, the signature matches e.g. "auud\0" with
--   relevance 100, and "blau" with relevance 90.
--   
--   Since: 2.2
module GI.GdkPixbuf.Structs.PixbufModulePattern

-- | Memory-managed wrapper type.
newtype PixbufModulePattern
PixbufModulePattern :: ManagedPtr PixbufModulePattern -> PixbufModulePattern

-- | Construct a PixbufModulePattern struct initialized to zero.
newZeroPixbufModulePattern :: MonadIO m => m PixbufModulePattern

-- | Set the value of the “mask” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #mask
--   
clearPixbufModulePatternMask :: MonadIO m => PixbufModulePattern -> m ()

-- | Get the value of the “mask” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get pixbufModulePattern #mask
--   
getPixbufModulePatternMask :: MonadIO m => PixbufModulePattern -> m (Maybe Text)

-- | Set the value of the “mask” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set pixbufModulePattern [ #mask := value ]
--   
setPixbufModulePatternMask :: MonadIO m => PixbufModulePattern -> CString -> m ()

-- | Set the value of the “prefix” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #prefix
--   
clearPixbufModulePatternPrefix :: MonadIO m => PixbufModulePattern -> m ()

-- | Get the value of the “prefix” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get pixbufModulePattern #prefix
--   
getPixbufModulePatternPrefix :: MonadIO m => PixbufModulePattern -> m (Maybe Text)

-- | Set the value of the “prefix” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set pixbufModulePattern [ #prefix := value ]
--   
setPixbufModulePatternPrefix :: MonadIO m => PixbufModulePattern -> CString -> m ()

-- | Get the value of the “relevance” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufModulePattern #relevance
--   
getPixbufModulePatternRelevance :: MonadIO m => PixbufModulePattern -> m Int32

-- | Set the value of the “relevance” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufModulePattern [ #relevance := value ]
--   
setPixbufModulePatternRelevance :: MonadIO m => PixbufModulePattern -> Int32 -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.GdkPixbuf.Structs.PixbufModulePattern.PixbufModulePattern
instance Data.GI.Base.BasicTypes.CallocPtr GI.GdkPixbuf.Structs.PixbufModulePattern.PixbufModulePattern
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.GdkPixbuf.Structs.PixbufModulePattern.PixbufModulePattern tag
instance GHC.Classes.Eq GI.GdkPixbuf.Structs.PixbufModulePattern.PixbufModulePattern
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Structs.PixbufModulePattern.PixbufModulePattern

-- | A GdkPixbufFormat contains information about the image format
--   accepted by a module.
--   
--   Only modules should access the fields directly, applications should
--   use the gdk_pixbuf_format_* family of functions.
--   
--   Since: 2.2
module GI.GdkPixbuf.Structs.PixbufFormat

-- | Memory-managed wrapper type.
newtype PixbufFormat
PixbufFormat :: ManagedPtr PixbufFormat -> PixbufFormat

-- | Construct a PixbufFormat struct initialized to zero.
newZeroPixbufFormat :: MonadIO m => m PixbufFormat

-- | Creates a copy of format.
--   
--   Since: 2.22
pixbufFormatCopy :: (HasCallStack, MonadIO m) => PixbufFormat -> m (Maybe PixbufFormat)

-- | Frees the resources allocated when copying a GdkPixbufFormat
--   using pixbufFormatCopy
--   
--   Since: 2.22
pixbufFormatFree :: (HasCallStack, MonadIO m) => PixbufFormat -> m ()

-- | Returns a description of the format.
--   
--   Since: 2.2
pixbufFormatGetDescription :: (HasCallStack, MonadIO m) => PixbufFormat -> m (Maybe Text)

-- | Returns the filename extensions typically used for files in the given
--   format.
--   
--   Since: 2.2
pixbufFormatGetExtensions :: (HasCallStack, MonadIO m) => PixbufFormat -> m (Maybe [Text])

-- | Returns information about the license of the image loader for the
--   format.
--   
--   The returned string should be a shorthand for a well known license,
--   e.g. "LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate some
--   other license.
--   
--   Since: 2.6
pixbufFormatGetLicense :: (HasCallStack, MonadIO m) => PixbufFormat -> m (Maybe Text)

-- | Returns the mime types supported by the format.
--   
--   Since: 2.2
pixbufFormatGetMimeTypes :: (HasCallStack, MonadIO m) => PixbufFormat -> m (Maybe [Text])

-- | Returns the name of the format.
--   
--   Since: 2.2
pixbufFormatGetName :: (HasCallStack, MonadIO m) => PixbufFormat -> m (Maybe Text)

-- | Returns whether this image format is disabled.
--   
--   See pixbufFormatSetDisabled.
--   
--   Since: 2.6
pixbufFormatIsDisabled :: (HasCallStack, MonadIO m) => PixbufFormat -> m Bool

-- | Returns TRUE if the save option specified by
--   optionKey is supported when saving a pixbuf using the
--   module implementing format.
--   
--   See gdk_pixbuf_save() for more information about
--   option keys.
--   
--   Since: 2.36
pixbufFormatIsSaveOptionSupported :: (HasCallStack, MonadIO m) => PixbufFormat -> Text -> m Bool

-- | Returns whether this image format is scalable.
--   
--   If a file is in a scalable format, it is preferable to load it at the
--   desired size, rather than loading it at the default size and scaling
--   the resulting pixbuf to the desired size.
--   
--   Since: 2.6
pixbufFormatIsScalable :: (HasCallStack, MonadIO m) => PixbufFormat -> m Bool

-- | Returns whether pixbufs can be saved in the given format.
--   
--   Since: 2.2
pixbufFormatIsWritable :: (HasCallStack, MonadIO m) => PixbufFormat -> m Bool

-- | Disables or enables an image format.
--   
--   If a format is disabled, GdkPixbuf won't use the image loader for this
--   format to load images.
--   
--   Applications can use this to avoid using image loaders with an
--   inappropriate license, see pixbufFormatGetLicense.
--   
--   Since: 2.6
pixbufFormatSetDisabled :: (HasCallStack, MonadIO m) => PixbufFormat -> Bool -> m ()

-- | Set the value of the “description” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #description
--   
clearPixbufFormatDescription :: MonadIO m => PixbufFormat -> m ()

-- | Get the value of the “description” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufFormat #description
--   
getPixbufFormatDescription :: MonadIO m => PixbufFormat -> m (Maybe Text)

-- | Set the value of the “description” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #description := value ]
--   
setPixbufFormatDescription :: MonadIO m => PixbufFormat -> CString -> m ()

-- | Get the value of the “disabled” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufFormat #disabled
--   
getPixbufFormatDisabled :: MonadIO m => PixbufFormat -> m Bool

-- | Set the value of the “disabled” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #disabled := value ]
--   
setPixbufFormatDisabled :: MonadIO m => PixbufFormat -> Bool -> m ()

-- | Set the value of the “domain” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #domain
--   
clearPixbufFormatDomain :: MonadIO m => PixbufFormat -> m ()

-- | Get the value of the “domain” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get pixbufFormat #domain
--   
getPixbufFormatDomain :: MonadIO m => PixbufFormat -> m (Maybe Text)

-- | Set the value of the “domain” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #domain := value ]
--   
setPixbufFormatDomain :: MonadIO m => PixbufFormat -> CString -> m ()

-- | Set the value of the “extensions” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #extensions
--   
clearPixbufFormatExtensions :: MonadIO m => PixbufFormat -> m ()

-- | Get the value of the “extensions” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufFormat #extensions
--   
getPixbufFormatExtensions :: MonadIO m => PixbufFormat -> m (Maybe [Text])

-- | Set the value of the “extensions” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #extensions := value ]
--   
setPixbufFormatExtensions :: MonadIO m => PixbufFormat -> Ptr CString -> m ()

-- | Get the value of the “flags” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get pixbufFormat #flags
--   
getPixbufFormatFlags :: MonadIO m => PixbufFormat -> m Word32

-- | Set the value of the “flags” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #flags := value ]
--   
setPixbufFormatFlags :: MonadIO m => PixbufFormat -> Word32 -> m ()

-- | Set the value of the “license” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #license
--   
clearPixbufFormatLicense :: MonadIO m => PixbufFormat -> m ()

-- | Get the value of the “license” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get pixbufFormat #license
--   
getPixbufFormatLicense :: MonadIO m => PixbufFormat -> m (Maybe Text)

-- | Set the value of the “license” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #license := value ]
--   
setPixbufFormatLicense :: MonadIO m => PixbufFormat -> CString -> m ()

-- | Set the value of the “mime_types” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #mimeTypes
--   
clearPixbufFormatMimeTypes :: MonadIO m => PixbufFormat -> m ()

-- | Get the value of the “mime_types” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufFormat #mimeTypes
--   
getPixbufFormatMimeTypes :: MonadIO m => PixbufFormat -> m (Maybe [Text])

-- | Set the value of the “mime_types” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #mimeTypes := value ]
--   
setPixbufFormatMimeTypes :: MonadIO m => PixbufFormat -> Ptr CString -> m ()

-- | Set the value of the “name” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #name
--   
clearPixbufFormatName :: MonadIO m => PixbufFormat -> m ()

-- | Get the value of the “name” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get pixbufFormat #name
--   
getPixbufFormatName :: MonadIO m => PixbufFormat -> m (Maybe Text)

-- | Set the value of the “name” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #name := value ]
--   
setPixbufFormatName :: MonadIO m => PixbufFormat -> CString -> m ()

-- | Set the value of the “signature” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #signature
--   
clearPixbufFormatSignature :: MonadIO m => PixbufFormat -> m ()

-- | Get the value of the “signature” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufFormat #signature
--   
getPixbufFormatSignature :: MonadIO m => PixbufFormat -> m (Maybe PixbufModulePattern)

-- | Set the value of the “signature” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufFormat [ #signature := value ]
--   
setPixbufFormatSignature :: MonadIO m => PixbufFormat -> Ptr PixbufModulePattern -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat tag
instance GHC.Classes.Eq GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat
instance Data.GI.Base.BasicTypes.GBoxed GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Structs.PixbufFormat.PixbufFormat

module GI.GdkPixbuf.Callbacks

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufDestroyNotify = Ptr Word8 -> Ptr () -> IO ()

-- | A function of this type is responsible for freeing the pixel array of
--   a pixbuf.
--   
--   The pixbufNewFromData function lets you pass in a pre-allocated
--   pixel array so that a pixbuf can be created from it; in this case you
--   will need to pass in a function of type
--   GdkPixbufDestroyNotify so that the pixel data can be freed
--   when the pixbuf is finalized.
type PixbufDestroyNotify = Ptr Word8 -> IO ()

-- | A function of this type is responsible for freeing the pixel array of
--   a pixbuf.
--   
--   The pixbufNewFromData function lets you pass in a pre-allocated
--   pixel array so that a pixbuf can be created from it; in this case you
--   will need to pass in a function of type
--   GdkPixbufDestroyNotify so that the pixel data can be freed
--   when the pixbuf is finalized.
type PixbufDestroyNotify_WithClosures = Ptr Word8 -> Ptr () -> IO ()

-- | A simple wrapper that ignores the closure arguments.
drop_closures_PixbufDestroyNotify :: PixbufDestroyNotify -> PixbufDestroyNotify_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufDestroyNotify :: (HasCallStack, MonadIO m) => FunPtr C_PixbufDestroyNotify -> Ptr Word8 -> Ptr () -> m ()

-- | Wrap the callback into a GClosure.
genClosure_PixbufDestroyNotify :: MonadIO m => PixbufDestroyNotify -> m (GClosure C_PixbufDestroyNotify)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufDestroyNotify.
mk_PixbufDestroyNotify :: C_PixbufDestroyNotify -> IO (FunPtr C_PixbufDestroyNotify)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufDestroyNotify.
noPixbufDestroyNotify :: Maybe PixbufDestroyNotify

-- | A convenience synonym for Nothing :: Maybe
--   PixbufDestroyNotify_WithClosures.
noPixbufDestroyNotify_WithClosures :: Maybe PixbufDestroyNotify_WithClosures

-- | Wrap a PixbufDestroyNotify into a C_PixbufDestroyNotify.
wrap_PixbufDestroyNotify :: Maybe (Ptr (FunPtr C_PixbufDestroyNotify)) -> PixbufDestroyNotify_WithClosures -> C_PixbufDestroyNotify

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleFillInfoFunc = Ptr PixbufFormat -> IO ()

-- | Defines the type of the function used to fill a PixbufFormat
--   structure with information about a module.
--   
--   Since: 2.2
type PixbufModuleFillInfoFunc = PixbufFormat -> IO ()

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleFillInfoFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleFillInfoFunc -> PixbufFormat -> m ()

-- | Wrap the callback into a GClosure.
genClosure_PixbufModuleFillInfoFunc :: MonadIO m => PixbufModuleFillInfoFunc -> m (GClosure C_PixbufModuleFillInfoFunc)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleFillInfoFunc.
mk_PixbufModuleFillInfoFunc :: C_PixbufModuleFillInfoFunc -> IO (FunPtr C_PixbufModuleFillInfoFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleFillInfoFunc.
noPixbufModuleFillInfoFunc :: Maybe PixbufModuleFillInfoFunc

-- | Wrap a PixbufModuleFillInfoFunc into a
--   C_PixbufModuleFillInfoFunc.
wrap_PixbufModuleFillInfoFunc :: Maybe (Ptr (FunPtr C_PixbufModuleFillInfoFunc)) -> PixbufModuleFillInfoFunc -> C_PixbufModuleFillInfoFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleFillVtableFunc = Ptr PixbufModule -> IO ()

-- | Defines the type of the function used to set the vtable of a
--   PixbufModule when it is loaded.
--   
--   Since: 2.2
type PixbufModuleFillVtableFunc = PixbufModule -> IO ()

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleFillVtableFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleFillVtableFunc -> PixbufModule -> m ()

-- | Wrap the callback into a GClosure.
genClosure_PixbufModuleFillVtableFunc :: MonadIO m => PixbufModuleFillVtableFunc -> m (GClosure C_PixbufModuleFillVtableFunc)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleFillVtableFunc.
mk_PixbufModuleFillVtableFunc :: C_PixbufModuleFillVtableFunc -> IO (FunPtr C_PixbufModuleFillVtableFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleFillVtableFunc.
noPixbufModuleFillVtableFunc :: Maybe PixbufModuleFillVtableFunc

-- | Wrap a PixbufModuleFillVtableFunc into a
--   C_PixbufModuleFillVtableFunc.
wrap_PixbufModuleFillVtableFunc :: Maybe (Ptr (FunPtr C_PixbufModuleFillVtableFunc)) -> PixbufModuleFillVtableFunc -> C_PixbufModuleFillVtableFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleIncrementLoadFunc = Ptr () -> Ptr Word8 -> Word32 -> Ptr Ptr GError -> IO CInt

-- | Incrementally loads a buffer into the image data.
type PixbufModuleIncrementLoadFunc = Ptr () -> ByteString -> IO ()

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleIncrementLoadFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleIncrementLoadFunc -> Ptr () -> ByteString -> m ()

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleIncrementLoadFunc.
mk_PixbufModuleIncrementLoadFunc :: C_PixbufModuleIncrementLoadFunc -> IO (FunPtr C_PixbufModuleIncrementLoadFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleIncrementLoadFunc.
noPixbufModuleIncrementLoadFunc :: Maybe PixbufModuleIncrementLoadFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleLoadAnimationFunc = Ptr () -> Ptr Ptr GError -> IO Ptr PixbufAnimation

-- | Loads a file from a standard C file stream into a new
--   GdkPixbufAnimation.
--   
--   In case of error, this function should return NULL and set
--   the error argument.
type PixbufModuleLoadAnimationFunc = Ptr () -> IO PixbufAnimation

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleLoadAnimationFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleLoadAnimationFunc -> Ptr () -> m PixbufAnimation

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleLoadAnimationFunc.
mk_PixbufModuleLoadAnimationFunc :: C_PixbufModuleLoadAnimationFunc -> IO (FunPtr C_PixbufModuleLoadAnimationFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleLoadAnimationFunc.
noPixbufModuleLoadAnimationFunc :: Maybe PixbufModuleLoadAnimationFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleLoadFunc = Ptr () -> Ptr Ptr GError -> IO Ptr Pixbuf

-- | Loads a file from a standard C file stream into a new
--   GdkPixbuf.
--   
--   In case of error, this function should return NULL and set
--   the error argument.
type PixbufModuleLoadFunc = Ptr () -> IO Pixbuf

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleLoadFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleLoadFunc -> Ptr () -> m Pixbuf

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleLoadFunc.
mk_PixbufModuleLoadFunc :: C_PixbufModuleLoadFunc -> IO (FunPtr C_PixbufModuleLoadFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleLoadFunc.
noPixbufModuleLoadFunc :: Maybe PixbufModuleLoadFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleLoadXpmDataFunc = Ptr CString -> IO Ptr Pixbuf

-- | Loads XPM data into a new GdkPixbuf.
type PixbufModuleLoadXpmDataFunc = [Text] -> IO Pixbuf

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleLoadXpmDataFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleLoadXpmDataFunc -> [Text] -> m Pixbuf

-- | Wrap the callback into a GClosure.
genClosure_PixbufModuleLoadXpmDataFunc :: MonadIO m => PixbufModuleLoadXpmDataFunc -> m (GClosure C_PixbufModuleLoadXpmDataFunc)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleLoadXpmDataFunc.
mk_PixbufModuleLoadXpmDataFunc :: C_PixbufModuleLoadXpmDataFunc -> IO (FunPtr C_PixbufModuleLoadXpmDataFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleLoadXpmDataFunc.
noPixbufModuleLoadXpmDataFunc :: Maybe PixbufModuleLoadXpmDataFunc

-- | Wrap a PixbufModuleLoadXpmDataFunc into a
--   C_PixbufModuleLoadXpmDataFunc.
wrap_PixbufModuleLoadXpmDataFunc :: Maybe (Ptr (FunPtr C_PixbufModuleLoadXpmDataFunc)) -> PixbufModuleLoadXpmDataFunc -> C_PixbufModuleLoadXpmDataFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModulePreparedFunc = Ptr Pixbuf -> Ptr PixbufAnimation -> Ptr () -> IO ()

-- | Defines the type of the function that gets called once the initial
--   setup of pixbuf is done.
--   
--   PixbufLoader uses a function of this type to emit the "<link
--   linkend="GdkPixbufLoader-area-prepared">area_prepared</link>"
--   signal.
--   
--   Since: 2.2
type PixbufModulePreparedFunc = Pixbuf -> PixbufAnimation -> IO ()

-- | Defines the type of the function that gets called once the initial
--   setup of pixbuf is done.
--   
--   PixbufLoader uses a function of this type to emit the "<link
--   linkend="GdkPixbufLoader-area-prepared">area_prepared</link>"
--   signal.
--   
--   Since: 2.2
type PixbufModulePreparedFunc_WithClosures = Pixbuf -> PixbufAnimation -> Ptr () -> IO ()

-- | A simple wrapper that ignores the closure arguments.
drop_closures_PixbufModulePreparedFunc :: PixbufModulePreparedFunc -> PixbufModulePreparedFunc_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModulePreparedFunc :: (HasCallStack, MonadIO m, IsPixbuf a, IsPixbufAnimation b) => FunPtr C_PixbufModulePreparedFunc -> a -> b -> Ptr () -> m ()

-- | Wrap the callback into a GClosure.
genClosure_PixbufModulePreparedFunc :: MonadIO m => PixbufModulePreparedFunc -> m (GClosure C_PixbufModulePreparedFunc)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModulePreparedFunc.
mk_PixbufModulePreparedFunc :: C_PixbufModulePreparedFunc -> IO (FunPtr C_PixbufModulePreparedFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModulePreparedFunc.
noPixbufModulePreparedFunc :: Maybe PixbufModulePreparedFunc

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModulePreparedFunc_WithClosures.
noPixbufModulePreparedFunc_WithClosures :: Maybe PixbufModulePreparedFunc_WithClosures

-- | Wrap a PixbufModulePreparedFunc into a
--   C_PixbufModulePreparedFunc.
wrap_PixbufModulePreparedFunc :: Maybe (Ptr (FunPtr C_PixbufModulePreparedFunc)) -> PixbufModulePreparedFunc_WithClosures -> C_PixbufModulePreparedFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleSaveFunc = Ptr () -> Ptr Pixbuf -> Ptr CString -> Ptr CString -> Ptr Ptr GError -> IO CInt

-- | Saves a GdkPixbuf into a standard C file stream.
--   
--   The optional param_keys and param_values arrays
--   contain the keys and values (in the same order) for attributes to be
--   saved alongside the image data.
type PixbufModuleSaveFunc = Ptr () -> Pixbuf -> Maybe [Text] -> Maybe [Text] -> IO ()

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleSaveFunc :: (HasCallStack, MonadIO m, IsPixbuf a) => FunPtr C_PixbufModuleSaveFunc -> Ptr () -> a -> Maybe [Text] -> Maybe [Text] -> m ()

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleSaveFunc.
mk_PixbufModuleSaveFunc :: C_PixbufModuleSaveFunc -> IO (FunPtr C_PixbufModuleSaveFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleSaveFunc.
noPixbufModuleSaveFunc :: Maybe PixbufModuleSaveFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleSaveOptionSupportedFunc = CString -> IO CInt

-- | Checks whether the given option_key is supported when saving.
type PixbufModuleSaveOptionSupportedFunc = Text -> IO Bool

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleSaveOptionSupportedFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleSaveOptionSupportedFunc -> Text -> m Bool

-- | Wrap the callback into a GClosure.
genClosure_PixbufModuleSaveOptionSupportedFunc :: MonadIO m => PixbufModuleSaveOptionSupportedFunc -> m (GClosure C_PixbufModuleSaveOptionSupportedFunc)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleSaveOptionSupportedFunc.
mk_PixbufModuleSaveOptionSupportedFunc :: C_PixbufModuleSaveOptionSupportedFunc -> IO (FunPtr C_PixbufModuleSaveOptionSupportedFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleSaveOptionSupportedFunc.
noPixbufModuleSaveOptionSupportedFunc :: Maybe PixbufModuleSaveOptionSupportedFunc

-- | Wrap a PixbufModuleSaveOptionSupportedFunc into a
--   C_PixbufModuleSaveOptionSupportedFunc.
wrap_PixbufModuleSaveOptionSupportedFunc :: Maybe (Ptr (FunPtr C_PixbufModuleSaveOptionSupportedFunc)) -> PixbufModuleSaveOptionSupportedFunc -> C_PixbufModuleSaveOptionSupportedFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleSizeFunc = Int32 -> Int32 -> Ptr () -> IO ()

-- | Defines the type of the function that gets called once the size of the
--   loaded image is known.
--   
--   The function is expected to set width and
--   height to the desired size to which the image should
--   be scaled. If a module has no efficient way to achieve the desired
--   scaling during the loading of the image, it may either ignore the size
--   request, or only approximate it - gdk-pixbuf will then perform the
--   required scaling on the completely loaded image.
--   
--   If the function sets width or height
--   to zero, the module should interpret this as a hint that it will be
--   closed soon and shouldn't allocate further resources. This convention
--   is used to implement pixbufGetFileInfo efficiently.
--   
--   Since: 2.2
type PixbufModuleSizeFunc = Int32 -> Int32 -> IO ()

-- | Defines the type of the function that gets called once the size of the
--   loaded image is known.
--   
--   The function is expected to set width and
--   height to the desired size to which the image should
--   be scaled. If a module has no efficient way to achieve the desired
--   scaling during the loading of the image, it may either ignore the size
--   request, or only approximate it - gdk-pixbuf will then perform the
--   required scaling on the completely loaded image.
--   
--   If the function sets width or height
--   to zero, the module should interpret this as a hint that it will be
--   closed soon and shouldn't allocate further resources. This convention
--   is used to implement pixbufGetFileInfo efficiently.
--   
--   Since: 2.2
type PixbufModuleSizeFunc_WithClosures = Int32 -> Int32 -> Ptr () -> IO ()

-- | A simple wrapper that ignores the closure arguments.
drop_closures_PixbufModuleSizeFunc :: PixbufModuleSizeFunc -> PixbufModuleSizeFunc_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleSizeFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleSizeFunc -> Int32 -> Int32 -> Ptr () -> m ()

-- | Wrap the callback into a GClosure.
genClosure_PixbufModuleSizeFunc :: MonadIO m => PixbufModuleSizeFunc -> m (GClosure C_PixbufModuleSizeFunc)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleSizeFunc.
mk_PixbufModuleSizeFunc :: C_PixbufModuleSizeFunc -> IO (FunPtr C_PixbufModuleSizeFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleSizeFunc.
noPixbufModuleSizeFunc :: Maybe PixbufModuleSizeFunc

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleSizeFunc_WithClosures.
noPixbufModuleSizeFunc_WithClosures :: Maybe PixbufModuleSizeFunc_WithClosures

-- | Wrap a PixbufModuleSizeFunc into a
--   C_PixbufModuleSizeFunc.
wrap_PixbufModuleSizeFunc :: Maybe (Ptr (FunPtr C_PixbufModuleSizeFunc)) -> PixbufModuleSizeFunc_WithClosures -> C_PixbufModuleSizeFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleStopLoadFunc = Ptr () -> Ptr Ptr GError -> IO CInt

-- | Finalizes the image loading state.
--   
--   This function is called on success and error states.
type PixbufModuleStopLoadFunc = Ptr () -> IO ()

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleStopLoadFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleStopLoadFunc -> Ptr () -> m ()

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleStopLoadFunc.
mk_PixbufModuleStopLoadFunc :: C_PixbufModuleStopLoadFunc -> IO (FunPtr C_PixbufModuleStopLoadFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleStopLoadFunc.
noPixbufModuleStopLoadFunc :: Maybe PixbufModuleStopLoadFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufModuleUpdatedFunc = Ptr Pixbuf -> Int32 -> Int32 -> Int32 -> Int32 -> Ptr () -> IO ()

-- | Defines the type of the function that gets called every time a region
--   of pixbuf is updated.
--   
--   PixbufLoader uses a function of this type to emit the "<link
--   linkend="GdkPixbufLoader-area-updated">area_updated</link>"
--   signal.
--   
--   Since: 2.2
type PixbufModuleUpdatedFunc = Pixbuf -> Int32 -> Int32 -> Int32 -> Int32 -> IO ()

-- | Defines the type of the function that gets called every time a region
--   of pixbuf is updated.
--   
--   PixbufLoader uses a function of this type to emit the "<link
--   linkend="GdkPixbufLoader-area-updated">area_updated</link>"
--   signal.
--   
--   Since: 2.2
type PixbufModuleUpdatedFunc_WithClosures = Pixbuf -> Int32 -> Int32 -> Int32 -> Int32 -> Ptr () -> IO ()

-- | A simple wrapper that ignores the closure arguments.
drop_closures_PixbufModuleUpdatedFunc :: PixbufModuleUpdatedFunc -> PixbufModuleUpdatedFunc_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufModuleUpdatedFunc :: (HasCallStack, MonadIO m, IsPixbuf a) => FunPtr C_PixbufModuleUpdatedFunc -> a -> Int32 -> Int32 -> Int32 -> Int32 -> Ptr () -> m ()

-- | Wrap the callback into a GClosure.
genClosure_PixbufModuleUpdatedFunc :: MonadIO m => PixbufModuleUpdatedFunc -> m (GClosure C_PixbufModuleUpdatedFunc)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufModuleUpdatedFunc.
mk_PixbufModuleUpdatedFunc :: C_PixbufModuleUpdatedFunc -> IO (FunPtr C_PixbufModuleUpdatedFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleUpdatedFunc.
noPixbufModuleUpdatedFunc :: Maybe PixbufModuleUpdatedFunc

-- | A convenience synonym for Nothing :: Maybe
--   PixbufModuleUpdatedFunc_WithClosures.
noPixbufModuleUpdatedFunc_WithClosures :: Maybe PixbufModuleUpdatedFunc_WithClosures

-- | Wrap a PixbufModuleUpdatedFunc into a
--   C_PixbufModuleUpdatedFunc.
wrap_PixbufModuleUpdatedFunc :: Maybe (Ptr (FunPtr C_PixbufModuleUpdatedFunc)) -> PixbufModuleUpdatedFunc_WithClosures -> C_PixbufModuleUpdatedFunc

-- | Type for the callback on the (unwrapped) C side.
type C_PixbufSaveFunc = Ptr Word8 -> CSize -> Ptr Ptr GError -> Ptr () -> IO CInt

-- | Save functions used by
--   Pixbuf.save_to_callback().
--   
--   This function is called once for each block of bytes that is "written"
--   by gdk_pixbuf_save_to_callback().
--   
--   If successful it should return TRUE; if an error occurs it
--   should set error and return FALSE, in which case
--   gdk_pixbuf_save_to_callback() will fail with the same error.
--   
--   Since: 2.4
type PixbufSaveFunc = ByteString -> IO (Bool, GError)

-- | Save functions used by
--   Pixbuf.save_to_callback().
--   
--   This function is called once for each block of bytes that is "written"
--   by gdk_pixbuf_save_to_callback().
--   
--   If successful it should return TRUE; if an error occurs it
--   should set error and return FALSE, in which case
--   gdk_pixbuf_save_to_callback() will fail with the same error.
--   
--   Since: 2.4
type PixbufSaveFunc_WithClosures = ByteString -> Ptr () -> IO (Bool, GError)

-- | A simple wrapper that ignores the closure arguments.
drop_closures_PixbufSaveFunc :: PixbufSaveFunc -> PixbufSaveFunc_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_PixbufSaveFunc :: (HasCallStack, MonadIO m) => FunPtr C_PixbufSaveFunc -> ByteString -> Ptr () -> m (Bool, GError)

-- | Wrap the callback into a GClosure.
genClosure_PixbufSaveFunc :: MonadIO m => PixbufSaveFunc -> m (GClosure C_PixbufSaveFunc)

-- | Generate a function pointer callable from C code, from a
--   C_PixbufSaveFunc.
mk_PixbufSaveFunc :: C_PixbufSaveFunc -> IO (FunPtr C_PixbufSaveFunc)

-- | A convenience synonym for Nothing :: Maybe
--   PixbufSaveFunc.
noPixbufSaveFunc :: Maybe PixbufSaveFunc

-- | A convenience synonym for Nothing :: Maybe
--   PixbufSaveFunc_WithClosures.
noPixbufSaveFunc_WithClosures :: Maybe PixbufSaveFunc_WithClosures

-- | Wrap a PixbufSaveFunc into a C_PixbufSaveFunc.
wrap_PixbufSaveFunc :: Maybe (Ptr (FunPtr C_PixbufSaveFunc)) -> PixbufSaveFunc_WithClosures -> C_PixbufSaveFunc

-- | A GdkPixbufModule contains the necessary functions to load
--   and save images in a certain file format.
--   
--   If GdkPixbuf has been compiled with GModule support,
--   it can be extended by modules which can load (and perhaps also save)
--   new image and animation formats.
--   
--   
Implementing modules
--   
--   The GdkPixbuf interfaces needed for implementing modules are
--   contained in gdk-pixbuf-io.h (and
--   gdk-pixbuf-animation.h if the module supports animations).
--   They are not covered by the same stability guarantees as the regular
--   GdkPixbuf API. To underline this fact, they are protected by the
--   GDK_PIXBUF_ENABLE_BACKEND pre-processor symbol.
--   
--   Each loadable module must contain a
--   GdkPixbufModuleFillVtableFunc function named
--   fill_vtable, which will get called when the module is loaded
--   and must set the function pointers of the GdkPixbufModule.
--   
--   In order to make format-checking work before actually loading the
--   modules (which may require calling dlopen to load image
--   libraries), modules export their signatures (and other information)
--   via the fill_info function. An external utility,
--   gdk-pixbuf-query-loaders, uses this to create a text file
--   containing a list of all available loaders and their signatures. This
--   file is then read at runtime by GdkPixbuf to obtain the list
--   of available loaders and their signatures.
--   
--   Modules may only implement a subset of the functionality available via
--   GdkPixbufModule. If a particular functionality is not
--   implemented, the fill_vtable function will simply not set the
--   corresponding function pointers of the GdkPixbufModule
--   structure. If a module supports incremental loading (i.e. provides
--   begin_load, stop_load and load_increment),
--   it doesn't have to implement load, since GdkPixbuf
--   can supply a generic load implementation wrapping the
--   incremental loading.
--   
--   
Installing modules
--   
--   Installing a module is a two-step process:
--   
--   
--   
- copy the module file(s) to the loader directory (normally
--   $libdir/gdk-pixbuf-2.0/$version/loaders, unless overridden by
--   the environment variable GDK_PIXBUF_MODULEDIR)
--   
- call gdk-pixbuf-query-loaders to update the module file
--   (normally $libdir/gdk-pixbuf-2.0/$version/loaders.cache,
--   unless overridden by the environment variable
--   GDK_PIXBUF_MODULE_FILE)
--   
module GI.GdkPixbuf.Structs.PixbufModule

-- | Memory-managed wrapper type.
newtype PixbufModule
PixbufModule :: ManagedPtr PixbufModule -> PixbufModule

-- | Construct a PixbufModule struct initialized to zero.
newZeroPixbufModule :: MonadIO m => m PixbufModule

-- | Set the value of the “info” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #info
--   
clearPixbufModuleInfo :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “info” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get pixbufModule #info
--   
getPixbufModuleInfo :: MonadIO m => PixbufModule -> m (Maybe PixbufFormat)

-- | Set the value of the “info” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #info := value ]
--   
setPixbufModuleInfo :: MonadIO m => PixbufModule -> Ptr PixbufFormat -> m ()

-- | Set the value of the “is_save_option_supported” field to
--   Nothing. When overloading is enabled, this is equivalent
--   to
--   
--   
--   clear #isSaveOptionSupported
--   
clearPixbufModuleIsSaveOptionSupported :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “is_save_option_supported” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufModule #isSaveOptionSupported
--   
getPixbufModuleIsSaveOptionSupported :: MonadIO m => PixbufModule -> m (Maybe PixbufModuleSaveOptionSupportedFunc)

-- | Set the value of the “is_save_option_supported” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #isSaveOptionSupported := value ]
--   
setPixbufModuleIsSaveOptionSupported :: MonadIO m => PixbufModule -> FunPtr C_PixbufModuleSaveOptionSupportedFunc -> m ()

-- | Set the value of the “load” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #load
--   
clearPixbufModuleLoad :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “load” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get pixbufModule #load
--   
getPixbufModuleLoad :: MonadIO m => PixbufModule -> m (Maybe PixbufModuleLoadFunc)

-- | Set the value of the “load” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #load := value ]
--   
setPixbufModuleLoad :: MonadIO m => PixbufModule -> FunPtr C_PixbufModuleLoadFunc -> m ()

-- | Set the value of the “load_animation” field to
--   Nothing. When overloading is enabled, this is equivalent
--   to
--   
--   
--   clear #loadAnimation
--   
clearPixbufModuleLoadAnimation :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “load_animation” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufModule #loadAnimation
--   
getPixbufModuleLoadAnimation :: MonadIO m => PixbufModule -> m (Maybe PixbufModuleLoadAnimationFunc)

-- | Set the value of the “load_animation” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #loadAnimation := value ]
--   
setPixbufModuleLoadAnimation :: MonadIO m => PixbufModule -> FunPtr C_PixbufModuleLoadAnimationFunc -> m ()

-- | Set the value of the “load_increment” field to
--   Nothing. When overloading is enabled, this is equivalent
--   to
--   
--   
--   clear #loadIncrement
--   
clearPixbufModuleLoadIncrement :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “load_increment” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufModule #loadIncrement
--   
getPixbufModuleLoadIncrement :: MonadIO m => PixbufModule -> m (Maybe PixbufModuleIncrementLoadFunc)

-- | Set the value of the “load_increment” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #loadIncrement := value ]
--   
setPixbufModuleLoadIncrement :: MonadIO m => PixbufModule -> FunPtr C_PixbufModuleIncrementLoadFunc -> m ()

-- | Set the value of the “load_xpm_data” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #loadXpmData
--   
clearPixbufModuleLoadXpmData :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “load_xpm_data” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufModule #loadXpmData
--   
getPixbufModuleLoadXpmData :: MonadIO m => PixbufModule -> m (Maybe PixbufModuleLoadXpmDataFunc)

-- | Set the value of the “load_xpm_data” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #loadXpmData := value ]
--   
setPixbufModuleLoadXpmData :: MonadIO m => PixbufModule -> FunPtr C_PixbufModuleLoadXpmDataFunc -> m ()

-- | Set the value of the “module” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #module
--   
clearPixbufModuleModule :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “module” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get pixbufModule #module
--   
getPixbufModuleModule :: MonadIO m => PixbufModule -> m (Maybe Module)

-- | Set the value of the “module” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #module := value ]
--   
setPixbufModuleModule :: MonadIO m => PixbufModule -> Ptr Module -> m ()

-- | Set the value of the “module_name” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #moduleName
--   
clearPixbufModuleModuleName :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “module_name” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufModule #moduleName
--   
getPixbufModuleModuleName :: MonadIO m => PixbufModule -> m (Maybe Text)

-- | Set the value of the “module_name” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #moduleName := value ]
--   
setPixbufModuleModuleName :: MonadIO m => PixbufModule -> CString -> m ()

-- | Set the value of the “module_path” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #modulePath
--   
clearPixbufModuleModulePath :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “module_path” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufModule #modulePath
--   
getPixbufModuleModulePath :: MonadIO m => PixbufModule -> m (Maybe Text)

-- | Set the value of the “module_path” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #modulePath := value ]
--   
setPixbufModuleModulePath :: MonadIO m => PixbufModule -> CString -> m ()

-- | Set the value of the “save” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #save
--   
clearPixbufModuleSave :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “save” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get pixbufModule #save
--   
getPixbufModuleSave :: MonadIO m => PixbufModule -> m (Maybe PixbufModuleSaveFunc)

-- | Set the value of the “save” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #save := value ]
--   
setPixbufModuleSave :: MonadIO m => PixbufModule -> FunPtr C_PixbufModuleSaveFunc -> m ()

-- | Set the value of the “stop_load” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #stopLoad
--   
clearPixbufModuleStopLoad :: MonadIO m => PixbufModule -> m ()

-- | Get the value of the “stop_load” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbufModule #stopLoad
--   
getPixbufModuleStopLoad :: MonadIO m => PixbufModule -> m (Maybe PixbufModuleStopLoadFunc)

-- | Set the value of the “stop_load” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set pixbufModule [ #stopLoad := value ]
--   
setPixbufModuleStopLoad :: MonadIO m => PixbufModule -> FunPtr C_PixbufModuleStopLoadFunc -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.GdkPixbuf.Structs.PixbufModule.PixbufModule
instance Data.GI.Base.BasicTypes.CallocPtr GI.GdkPixbuf.Structs.PixbufModule.PixbufModule
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.GdkPixbuf.Structs.PixbufModule.PixbufModule tag
instance GHC.Classes.Eq GI.GdkPixbuf.Structs.PixbufModule.PixbufModule
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Structs.PixbufModule.PixbufModule

module GI.GdkPixbuf.Structs

-- | No description available in the introspection data.
module GI.GdkPixbuf.Objects.PixbufSimpleAnimIter

-- | Memory-managed wrapper type.
newtype PixbufSimpleAnimIter
PixbufSimpleAnimIter :: ManagedPtr PixbufSimpleAnimIter -> PixbufSimpleAnimIter

-- | Type class for types which can be safely cast to
--   PixbufSimpleAnimIter, for instance with
--   toPixbufSimpleAnimIter.
class (GObject o, IsDescendantOf PixbufSimpleAnimIter o) => IsPixbufSimpleAnimIter o

-- | Cast to PixbufSimpleAnimIter, for types for which this is known
--   to be safe. For general casts, use castTo.
toPixbufSimpleAnimIter :: (MonadIO m, IsPixbufSimpleAnimIter o) => o -> m PixbufSimpleAnimIter
instance GHC.Classes.Eq GI.GdkPixbuf.Objects.PixbufSimpleAnimIter.PixbufSimpleAnimIter
instance Data.GI.Base.BasicTypes.GObject GI.GdkPixbuf.Objects.PixbufSimpleAnimIter.PixbufSimpleAnimIter
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Objects.PixbufSimpleAnimIter.PixbufSimpleAnimIter
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.GdkPixbuf.Objects.PixbufSimpleAnimIter.PixbufSimpleAnimIter)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.GdkPixbuf.Objects.PixbufSimpleAnimIter.PixbufSimpleAnimIter o) => GI.GdkPixbuf.Objects.PixbufSimpleAnimIter.IsPixbufSimpleAnimIter o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Objects.PixbufSimpleAnimIter.PixbufSimpleAnimIter
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Objects.PixbufSimpleAnimIter.PixbufSimpleAnimIter

-- | An opaque struct representing a simple animation.
module GI.GdkPixbuf.Objects.PixbufSimpleAnim

-- | Memory-managed wrapper type.
newtype PixbufSimpleAnim
PixbufSimpleAnim :: ManagedPtr PixbufSimpleAnim -> PixbufSimpleAnim

-- | Type class for types which can be safely cast to
--   PixbufSimpleAnim, for instance with toPixbufSimpleAnim.
class (GObject o, IsDescendantOf PixbufSimpleAnim o) => IsPixbufSimpleAnim o

-- | Cast to PixbufSimpleAnim, for types for which this is known to
--   be safe. For general casts, use castTo.
toPixbufSimpleAnim :: (MonadIO m, IsPixbufSimpleAnim o) => o -> m PixbufSimpleAnim

-- | Adds a new frame to animation. The
--   pixbuf must have the dimensions specified when the
--   animation was constructed.
--   
--   Since: 2.8

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufSimpleAnimAddFrame :: (HasCallStack, MonadIO m, IsPixbufSimpleAnim a, IsPixbuf b) => a -> b -> m ()

-- | Gets whether animation should loop indefinitely when
--   it reaches the end.
--   
--   Since: 2.18

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufSimpleAnimGetLoop :: (HasCallStack, MonadIO m, IsPixbufSimpleAnim a) => a -> m Bool

-- | Creates a new, empty animation.
--   
--   Since: 2.8

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufSimpleAnimNew :: (HasCallStack, MonadIO m) => Int32 -> Int32 -> Float -> m PixbufSimpleAnim

-- | Sets whether animation should loop indefinitely when
--   it reaches the end.
--   
--   Since: 2.18

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufSimpleAnimSetLoop :: (HasCallStack, MonadIO m, IsPixbufSimpleAnim a) => a -> Bool -> m ()

-- | Construct a GValueConstruct with valid value for the
--   “loop” property. This is rarely needed directly, but it is
--   used by new.
constructPixbufSimpleAnimLoop :: (IsPixbufSimpleAnim o, MonadIO m) => Bool -> m (GValueConstruct o)

-- | Get the value of the “loop” property. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get pixbufSimpleAnim #loop
--   
getPixbufSimpleAnimLoop :: (MonadIO m, IsPixbufSimpleAnim o) => o -> m Bool

-- | Set the value of the “loop” property. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set pixbufSimpleAnim [ #loop := value ]
--   
setPixbufSimpleAnimLoop :: (MonadIO m, IsPixbufSimpleAnim o) => o -> Bool -> m ()
instance GHC.Classes.Eq GI.GdkPixbuf.Objects.PixbufSimpleAnim.PixbufSimpleAnim
instance Data.GI.Base.BasicTypes.GObject GI.GdkPixbuf.Objects.PixbufSimpleAnim.PixbufSimpleAnim
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Objects.PixbufSimpleAnim.PixbufSimpleAnim
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.GdkPixbuf.Objects.PixbufSimpleAnim.PixbufSimpleAnim)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.GdkPixbuf.Objects.PixbufSimpleAnim.PixbufSimpleAnim o) => GI.GdkPixbuf.Objects.PixbufSimpleAnim.IsPixbufSimpleAnim o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Objects.PixbufSimpleAnim.PixbufSimpleAnim
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Objects.PixbufSimpleAnim.PixbufSimpleAnim

-- | No description available in the introspection data.
module GI.GdkPixbuf.Objects.PixbufNonAnim

-- | Memory-managed wrapper type.
newtype PixbufNonAnim
PixbufNonAnim :: ManagedPtr PixbufNonAnim -> PixbufNonAnim

-- | Type class for types which can be safely cast to PixbufNonAnim,
--   for instance with toPixbufNonAnim.
class (GObject o, IsDescendantOf PixbufNonAnim o) => IsPixbufNonAnim o

-- | Cast to PixbufNonAnim, for types for which this is known to be
--   safe. For general casts, use castTo.
toPixbufNonAnim :: (MonadIO m, IsPixbufNonAnim o) => o -> m PixbufNonAnim

-- | No description available in the introspection data.
pixbufNonAnimNew :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m PixbufNonAnim
instance GHC.Classes.Eq GI.GdkPixbuf.Objects.PixbufNonAnim.PixbufNonAnim
instance Data.GI.Base.BasicTypes.GObject GI.GdkPixbuf.Objects.PixbufNonAnim.PixbufNonAnim
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Objects.PixbufNonAnim.PixbufNonAnim
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.GdkPixbuf.Objects.PixbufNonAnim.PixbufNonAnim)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.GdkPixbuf.Objects.PixbufNonAnim.PixbufNonAnim o) => GI.GdkPixbuf.Objects.PixbufNonAnim.IsPixbufNonAnim o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Objects.PixbufNonAnim.PixbufNonAnim
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Objects.PixbufNonAnim.PixbufNonAnim

-- | Incremental image loader.
--   
--   GdkPixbufLoader provides a way for applications to drive the
--   process of loading an image, by letting them send the image data
--   directly to the loader instead of having the loader read the data from
--   a file. Applications can use this functionality instead of
--   gdk_pixbuf_new_from_file() or
--   gdk_pixbuf_animation_new_from_file() when they need to parse
--   image data in small chunks. For example, it should be used when
--   reading an image from a (potentially) slow network connection, or when
--   loading an extremely large file.
--   
--   To use GdkPixbufLoader to load an image, create a new
--   instance, and call pixbufLoaderWrite to send the data to it.
--   When done, pixbufLoaderClose should be called to end the stream
--   and finalize everything.
--   
--   The loader will emit three important signals throughout the process:
--   
--   
--   
- PixbufLoader::sizePrepared will be emitted as soon as the
--   image has enough information to determine the size of the image to be
--   used. If you want to scale the image while loading it, you can call
--   pixbufLoaderSetSize in response to this signal.
--   
- PixbufLoader::areaPrepared will be emitted as soon as the
--   pixbuf of the desired has been allocated. You can obtain the
--   GdkPixbuf instance by calling pixbufLoaderGetPixbuf.
--   If you want to use it, simply acquire a reference to it. You can also
--   call gdk_pixbuf_loader_get_pixbuf() later to get the same
--   pixbuf.
--   
- PixbufLoader::areaUpdated will be emitted every time a
--   region is updated. This way you can update a partially completed
--   image. Note that you do not know anything about the completeness of an
--   image from the updated area. For example, in an interlaced image you
--   will need to make several passes before the image is done
--   loading.
--   
--   
--   
Loading an animation
--   
--   Loading an animation is almost as easy as loading an image. Once the
--   first PixbufLoader::areaPrepared signal has been emitted, you
--   can call pixbufLoaderGetAnimation to get the
--   PixbufAnimation instance, and then call and
--   pixbufAnimationGetIter to get a PixbufAnimationIter to
--   retrieve the pixbuf for the desired time stamp.
module GI.GdkPixbuf.Objects.PixbufLoader

-- | Memory-managed wrapper type.
newtype PixbufLoader
PixbufLoader :: ManagedPtr PixbufLoader -> PixbufLoader

-- | Type class for types which can be safely cast to PixbufLoader,
--   for instance with toPixbufLoader.
class (GObject o, IsDescendantOf PixbufLoader o) => IsPixbufLoader o

-- | Cast to PixbufLoader, for types for which this is known to be
--   safe. For general casts, use castTo.
toPixbufLoader :: (MonadIO m, IsPixbufLoader o) => o -> m PixbufLoader

-- | Informs a pixbuf loader that no further writes with
--   pixbufLoaderWrite will occur, so that it can free its internal
--   loading structures.
--   
--   This function also tries to parse any data that hasn't yet been
--   parsed; if the remaining data is partial or corrupt, an error will be
--   returned.
--   
--   If FALSE is returned, error will be set to an error
--   from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains.
--   
--   If you're just cancelling a load rather than expecting it to be
--   finished, passing NULL for error to ignore it is
--   reasonable.
--   
--   Remember that this function does not release a reference on the
--   loader, so you will need to explicitly release any reference you hold.
pixbufLoaderClose :: (HasCallStack, MonadIO m, IsPixbufLoader a) => a -> m ()

-- | Queries the PixbufAnimation that a pixbuf loader is currently
--   creating.
--   
--   In general it only makes sense to call this function after the
--   PixbufLoader::areaPrepared signal has been emitted by the
--   loader.
--   
--   If the loader doesn't have enough bytes yet, and hasn't emitted the
--   area-prepared signal, this function will return
--   NULL.
pixbufLoaderGetAnimation :: (HasCallStack, MonadIO m, IsPixbufLoader a) => a -> m (Maybe PixbufAnimation)

-- | Obtains the available information about the format of the currently
--   loading image file.
--   
--   Since: 2.2
pixbufLoaderGetFormat :: (HasCallStack, MonadIO m, IsPixbufLoader a) => a -> m (Maybe PixbufFormat)

-- | Queries the Pixbuf that a pixbuf loader is currently creating.
--   
--   In general it only makes sense to call this function after the
--   PixbufLoader::areaPrepared signal has been emitted by the
--   loader; this means that enough data has been read to know the size of
--   the image that will be allocated.
--   
--   If the loader has not received enough data via
--   pixbufLoaderWrite, then this function returns NULL.
--   
--   The returned pixbuf will be the same in all future calls to the
--   loader, so if you want to keep using it, you should acquire a
--   reference to it.
--   
--   Additionally, if the loader is an animation, it will return the
--   "static image" of the animation (see
--   pixbufAnimationGetStaticImage).
pixbufLoaderGetPixbuf :: (HasCallStack, MonadIO m, IsPixbufLoader a) => a -> m (Maybe Pixbuf)

-- | Creates a new pixbuf loader object.
pixbufLoaderNew :: (HasCallStack, MonadIO m) => m PixbufLoader

-- | Creates a new pixbuf loader object that always attempts to parse image
--   data as if it were an image of MIME type mimeType,
--   instead of identifying the type automatically.
--   
--   This function is useful if you want an error if the image isn't the
--   expected MIME type; for loading image formats that can't be reliably
--   identified by looking at the data; or if the user manually forces a
--   specific MIME type.
--   
--   The list of supported mime types depends on what image loaders are
--   installed, but typically "image/png", "image/jpeg", "image/gif",
--   "image/tiff" and "image/x-xpixmap" are among the supported mime types.
--   To obtain the full list of supported mime types, call
--   pixbufFormatGetMimeTypes on each of the PixbufFormat
--   structs returned by pixbufGetFormats.
--   
--   Since: 2.4
pixbufLoaderNewWithMimeType :: (HasCallStack, MonadIO m) => Text -> m PixbufLoader

-- | Creates a new pixbuf loader object that always attempts to parse image
--   data as if it were an image of type imageType, instead
--   of identifying the type automatically.
--   
--   This function is useful if you want an error if the image isn't the
--   expected type; for loading image formats that can't be reliably
--   identified by looking at the data; or if the user manually forces a
--   specific type.
--   
--   The list of supported image formats depends on what image loaders are
--   installed, but typically "png", "jpeg", "gif", "tiff" and "xpm" are
--   among the supported formats. To obtain the full list of supported
--   image formats, call pixbufFormatGetName on each of the
--   PixbufFormat structs returned by pixbufGetFormats.
pixbufLoaderNewWithType :: (HasCallStack, MonadIO m) => Text -> m PixbufLoader

-- | Causes the image to be scaled while it is loaded.
--   
--   The desired image size can be determined relative to the original size
--   of the image by calling pixbufLoaderSetSize from a signal
--   handler for the sizePrepared signal.
--   
--   Attempts to set the desired image size are ignored after the emission
--   of the sizePrepared signal.
--   
--   Since: 2.2
pixbufLoaderSetSize :: (HasCallStack, MonadIO m, IsPixbufLoader a) => a -> Int32 -> Int32 -> m ()

-- | Parses the next count bytes in the given image buffer.
pixbufLoaderWrite :: (HasCallStack, MonadIO m, IsPixbufLoader a) => a -> ByteString -> m ()

-- | Parses the next contents of the given image buffer.
--   
--   Since: 2.30
pixbufLoaderWriteBytes :: (HasCallStack, MonadIO m, IsPixbufLoader a) => a -> Bytes -> m ()

-- | This signal is emitted when the pixbuf loader has allocated the pixbuf
--   in the desired size.
--   
--   After this signal is emitted, applications can call
--   pixbufLoaderGetPixbuf to fetch the partially-loaded pixbuf.
type PixbufLoaderAreaPreparedCallback = IO ()

-- | Connect a signal handler for the areaPrepared signal, to be run
--   after the default handler. When overloading is enabled, this is
--   equivalent to
--   
--   
--   after pixbufLoader #areaPrepared callback
--   
--   
--   By default the object invoking the signal is not passed to the
--   callback. If you need to access it, you can use the implit
--   ?self parameter. Note that this requires activating the
--   ImplicitParams GHC extension.
afterPixbufLoaderAreaPrepared :: (IsPixbufLoader a, MonadIO m) => a -> ((?self :: a) => PixbufLoaderAreaPreparedCallback) -> m SignalHandlerId

-- | Connect a signal handler for the areaPrepared signal, to be run
--   before the default handler. When overloading is enabled, this
--   is equivalent to
--   
--   
--   on pixbufLoader #areaPrepared callback
--   
onPixbufLoaderAreaPrepared :: (IsPixbufLoader a, MonadIO m) => a -> ((?self :: a) => PixbufLoaderAreaPreparedCallback) -> m SignalHandlerId

-- | This signal is emitted when a significant area of the image being
--   loaded has been updated.
--   
--   Normally it means that a complete scanline has been read in, but it
--   could be a different area as well.
--   
--   Applications can use this signal to know when to repaint areas of an
--   image that is being loaded.
type PixbufLoaderAreaUpdatedCallback = Int32 -> Int32 -> Int32 -> Int32 -> IO ()

-- | Connect a signal handler for the areaUpdated signal, to be run
--   after the default handler. When overloading is enabled, this is
--   equivalent to
--   
--   
--   after pixbufLoader #areaUpdated callback
--   
--   
--   By default the object invoking the signal is not passed to the
--   callback. If you need to access it, you can use the implit
--   ?self parameter. Note that this requires activating the
--   ImplicitParams GHC extension.
afterPixbufLoaderAreaUpdated :: (IsPixbufLoader a, MonadIO m) => a -> ((?self :: a) => PixbufLoaderAreaUpdatedCallback) -> m SignalHandlerId

-- | Connect a signal handler for the areaUpdated signal, to be run
--   before the default handler. When overloading is enabled, this
--   is equivalent to
--   
--   
--   on pixbufLoader #areaUpdated callback
--   
onPixbufLoaderAreaUpdated :: (IsPixbufLoader a, MonadIO m) => a -> ((?self :: a) => PixbufLoaderAreaUpdatedCallback) -> m SignalHandlerId

-- | This signal is emitted when pixbufLoaderClose is called.
--   
--   It can be used by different parts of an application to receive
--   notification when an image loader is closed by the code that drives
--   it.
type PixbufLoaderClosedCallback = IO ()

-- | Connect a signal handler for the closed signal, to be run after
--   the default handler. When overloading is enabled, this is
--   equivalent to
--   
--   
--   after pixbufLoader #closed callback
--   
--   
--   By default the object invoking the signal is not passed to the
--   callback. If you need to access it, you can use the implit
--   ?self parameter. Note that this requires activating the
--   ImplicitParams GHC extension.
afterPixbufLoaderClosed :: (IsPixbufLoader a, MonadIO m) => a -> ((?self :: a) => PixbufLoaderClosedCallback) -> m SignalHandlerId

-- | Connect a signal handler for the closed signal, to be run
--   before the default handler. When overloading is enabled, this
--   is equivalent to
--   
--   
--   on pixbufLoader #closed callback
--   
onPixbufLoaderClosed :: (IsPixbufLoader a, MonadIO m) => a -> ((?self :: a) => PixbufLoaderClosedCallback) -> m SignalHandlerId

-- | This signal is emitted when the pixbuf loader has been fed the initial
--   amount of data that is required to figure out the size of the image
--   that it will create.
--   
--   Applications can call pixbufLoaderSetSize in response to this
--   signal to set the desired size to which the image should be scaled.
type PixbufLoaderSizePreparedCallback = Int32 -> Int32 -> IO ()

-- | Connect a signal handler for the sizePrepared signal, to be run
--   after the default handler. When overloading is enabled, this is
--   equivalent to
--   
--   
--   after pixbufLoader #sizePrepared callback
--   
--   
--   By default the object invoking the signal is not passed to the
--   callback. If you need to access it, you can use the implit
--   ?self parameter. Note that this requires activating the
--   ImplicitParams GHC extension.
afterPixbufLoaderSizePrepared :: (IsPixbufLoader a, MonadIO m) => a -> ((?self :: a) => PixbufLoaderSizePreparedCallback) -> m SignalHandlerId

-- | Connect a signal handler for the sizePrepared signal, to be run
--   before the default handler. When overloading is enabled, this
--   is equivalent to
--   
--   
--   on pixbufLoader #sizePrepared callback
--   
onPixbufLoaderSizePrepared :: (IsPixbufLoader a, MonadIO m) => a -> ((?self :: a) => PixbufLoaderSizePreparedCallback) -> m SignalHandlerId
instance GHC.Classes.Eq GI.GdkPixbuf.Objects.PixbufLoader.PixbufLoader
instance Data.GI.Base.BasicTypes.GObject GI.GdkPixbuf.Objects.PixbufLoader.PixbufLoader
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Objects.PixbufLoader.PixbufLoader
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.GdkPixbuf.Objects.PixbufLoader.PixbufLoader)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.GdkPixbuf.Objects.PixbufLoader.PixbufLoader o) => GI.GdkPixbuf.Objects.PixbufLoader.IsPixbufLoader o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Objects.PixbufLoader.PixbufLoader
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Objects.PixbufLoader.PixbufLoader

-- | An opaque object representing an iterator which points to a certain
--   position in an animation.
module GI.GdkPixbuf.Objects.PixbufAnimationIter

-- | Memory-managed wrapper type.
newtype PixbufAnimationIter
PixbufAnimationIter :: ManagedPtr PixbufAnimationIter -> PixbufAnimationIter

-- | Type class for types which can be safely cast to
--   PixbufAnimationIter, for instance with
--   toPixbufAnimationIter.
class (GObject o, IsDescendantOf PixbufAnimationIter o) => IsPixbufAnimationIter o

-- | Cast to PixbufAnimationIter, for types for which this is known
--   to be safe. For general casts, use castTo.
toPixbufAnimationIter :: (MonadIO m, IsPixbufAnimationIter o) => o -> m PixbufAnimationIter

-- | Possibly advances an animation to a new frame.
--   
--   Chooses the frame based on the start time passed to
--   pixbufAnimationGetIter.
--   
--   currentTime would normally come from
--   getCurrentTime, and must be greater than or equal to the time
--   passed to pixbufAnimationGetIter, and must increase or remain
--   unchanged each time pixbufAnimationIterGetPixbuf is called.
--   That is, you can't go backward in time; animations only play forward.
--   
--   As a shortcut, pass NULL for the current time and
--   getCurrentTime will be invoked on your behalf. So you only need
--   to explicitly pass currentTime if you're doing
--   something odd like playing the animation at double speed.
--   
--   If this function returns FALSE, there's no need to update the
--   animation display, assuming the display had been rendered prior to
--   advancing; if TRUE, you need to call
--   pixbufAnimationIterGetPixbuf and update the display with the
--   new pixbuf.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationIterAdvance :: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) => a -> Maybe TimeVal -> m Bool

-- | Gets the number of milliseconds the current pixbuf should be
--   displayed, or -1 if the current pixbuf should be displayed forever.
--   
--   The g_timeout_add() function conveniently takes a timeout in
--   milliseconds, so you can use a timeout to schedule the next update.
--   
--   Note that some formats, like GIF, might clamp the timeout values in
--   the image file to avoid updates that are just too quick. The minimum
--   timeout for GIF images is currently 20 milliseconds.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationIterGetDelayTime :: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) => a -> m Int32

-- | Gets the current pixbuf which should be displayed.
--   
--   The pixbuf might not be the same size as the animation itself
--   (pixbufAnimationGetWidth, pixbufAnimationGetHeight).
--   
--   This pixbuf should be displayed for
--   pixbufAnimationIterGetDelayTime milliseconds.
--   
--   The caller of this function does not own a reference to the returned
--   pixbuf; the returned pixbuf will become invalid when the iterator
--   advances to the next frame, which may happen anytime you call
--   pixbufAnimationIterAdvance.
--   
--   Copy the pixbuf to keep it (don't just add a reference), as it may get
--   recycled as you advance the iterator.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationIterGetPixbuf :: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) => a -> m Pixbuf

-- | Used to determine how to respond to the area_updated signal on
--   PixbufLoader when loading an animation.
--   
--   The ::area_updated signal is emitted for an area of the frame
--   currently streaming in to the loader. So if you're on the currently
--   loading frame, you will need to redraw the screen for the updated
--   area.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationIterOnCurrentlyLoadingFrame :: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) => a -> m Bool
instance GHC.Classes.Eq GI.GdkPixbuf.Objects.PixbufAnimationIter.PixbufAnimationIter
instance Data.GI.Base.BasicTypes.GObject GI.GdkPixbuf.Objects.PixbufAnimationIter.PixbufAnimationIter
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Objects.PixbufAnimationIter.PixbufAnimationIter
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.GdkPixbuf.Objects.PixbufAnimationIter.PixbufAnimationIter)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.GdkPixbuf.Objects.PixbufAnimationIter.PixbufAnimationIter o) => GI.GdkPixbuf.Objects.PixbufAnimationIter.IsPixbufAnimationIter o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Objects.PixbufAnimationIter.PixbufAnimationIter
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Objects.PixbufAnimationIter.PixbufAnimationIter

-- | An opaque object representing an animation.
--   
--   The GdkPixBuf library provides a simple mechanism to load and
--   represent animations. An animation is conceptually a series of frames
--   to be displayed over time.
--   
--   The animation may not be represented as a series of frames internally;
--   for example, it may be stored as a sprite and instructions for moving
--   the sprite around a background.
--   
--   To display an animation you don't need to understand its
--   representation, however; you just ask GdkPixbuf what should
--   be displayed at a given point in time.
module GI.GdkPixbuf.Objects.PixbufAnimation

-- | Memory-managed wrapper type.
newtype PixbufAnimation
PixbufAnimation :: ManagedPtr PixbufAnimation -> PixbufAnimation

-- | Type class for types which can be safely cast to
--   PixbufAnimation, for instance with toPixbufAnimation.
class (GObject o, IsDescendantOf PixbufAnimation o) => IsPixbufAnimation o

-- | Cast to PixbufAnimation, for types for which this is known to
--   be safe. For general casts, use castTo.
toPixbufAnimation :: (MonadIO m, IsPixbufAnimation o) => o -> m PixbufAnimation

-- | Queries the height of the bounding box of a pixbuf animation.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationGetHeight :: (HasCallStack, MonadIO m, IsPixbufAnimation a) => a -> m Int32

-- | Get an iterator for displaying an animation.
--   
--   The iterator provides the frames that should be displayed at a given
--   time.
--   
--   startTime would normally come from
--   getCurrentTime, and marks the beginning of animation playback.
--   After creating an iterator, you should immediately display the pixbuf
--   returned by pixbufAnimationIterGetPixbuf. Then, you should
--   install a timeout (with g_timeout_add()) or by some
--   other mechanism ensure that you'll update the image after
--   pixbufAnimationIterGetDelayTime milliseconds. Each time the
--   image is updated, you should reinstall the timeout with the new,
--   possibly-changed delay time.
--   
--   As a shortcut, if startTime is NULL, the
--   result of getCurrentTime will be used automatically.
--   
--   To update the image (i.e. possibly change the result of
--   pixbufAnimationIterGetPixbuf to a new frame of the animation),
--   call pixbufAnimationIterAdvance.
--   
--   If you're using PixbufLoader, in addition to updating the image
--   after the delay time, you should also update it whenever you receive
--   the area_updated signal and
--   pixbufAnimationIterOnCurrentlyLoadingFrame returns
--   TRUE. In this case, the frame currently being fed into the
--   loader has received new data, so needs to be refreshed. The delay time
--   for a frame may also be modified after an area_updated signal, for
--   example if the delay time for a frame is encoded in the data after the
--   frame itself. So your timeout should be reinstalled after any
--   area_updated signal.
--   
--   A delay time of -1 is possible, indicating "infinite".

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationGetIter :: (HasCallStack, MonadIO m, IsPixbufAnimation a) => a -> Maybe TimeVal -> m PixbufAnimationIter

-- | Retrieves a static image for the animation.
--   
--   If an animation is really just a plain image (has only one frame),
--   this function returns that image.
--   
--   If the animation is an animation, this function returns a reasonable
--   image to use as a static unanimated image, which might be the first
--   frame, or something more sophisticated depending on the file format.
--   
--   If an animation hasn't loaded any frames yet, this function will
--   return NULL.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationGetStaticImage :: (HasCallStack, MonadIO m, IsPixbufAnimation a) => a -> m Pixbuf

-- | Queries the width of the bounding box of a pixbuf animation.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationGetWidth :: (HasCallStack, MonadIO m, IsPixbufAnimation a) => a -> m Int32

-- | Checks whether the animation is a static image.
--   
--   If you load a file with pixbufAnimationNewFromFile and it turns
--   out to be a plain, unanimated image, then this function will return
--   TRUE. Use pixbufAnimationGetStaticImage to retrieve
--   the image.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationIsStaticImage :: (HasCallStack, MonadIO m, IsPixbufAnimation a) => a -> m Bool

-- | Creates a new animation by loading it from a file.
--   
--   The file format is detected automatically.
--   
--   If the file's format does not support multi-frame images, then an
--   animation with a single frame will be created.
--   
--   Possible errors are in the GDK_PIXBUF_ERROR and
--   G_FILE_ERROR domains.

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationNewFromFile :: (HasCallStack, MonadIO m) => [Char] -> m (Maybe PixbufAnimation)

-- | Creates a new pixbuf animation by loading an image from an resource.
--   
--   The file format is detected automatically. If NULL is
--   returned, then error will be set.
--   
--   Since: 2.28

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationNewFromResource :: (HasCallStack, MonadIO m) => Text -> m (Maybe PixbufAnimation)

-- | Creates a new animation by loading it from an input stream.
--   
--   The file format is detected automatically.
--   
--   If NULL 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
--   G_IO_ERROR_CANCELLED will be returned. Other possible errors
--   are in the GDK_PIXBUF_ERROR and G_IO_ERROR domains.
--   
--   The stream is not closed.
--   
--   Since: 2.28

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationNewFromStream :: (HasCallStack, MonadIO m, IsInputStream a, IsCancellable b) => a -> Maybe b -> m (Maybe PixbufAnimation)

-- | Creates a new animation by asynchronously loading an image from an
--   input stream.
--   
--   For more details see 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
--   pixbufAnimationNewFromStreamFinish to get the result of the
--   operation.
--   
--   Since: 2.28

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationNewFromStreamAsync :: (HasCallStack, MonadIO m, IsInputStream a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()

-- | Finishes an asynchronous pixbuf animation creation operation started
--   with pixbufAnimationNewFromStreamAsync.
--   
--   Since: 2.28

-- | Deprecated: (Since version 2.44)Use a different image loading
--   library for animatable assets
pixbufAnimationNewFromStreamFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m (Maybe PixbufAnimation)
instance GHC.Classes.Eq GI.GdkPixbuf.Objects.PixbufAnimation.PixbufAnimation
instance Data.GI.Base.BasicTypes.GObject GI.GdkPixbuf.Objects.PixbufAnimation.PixbufAnimation
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Objects.PixbufAnimation.PixbufAnimation
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.GdkPixbuf.Objects.PixbufAnimation.PixbufAnimation)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.GdkPixbuf.Objects.PixbufAnimation.PixbufAnimation o) => GI.GdkPixbuf.Objects.PixbufAnimation.IsPixbufAnimation o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Objects.PixbufAnimation.PixbufAnimation
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Objects.PixbufAnimation.PixbufAnimation

-- | A pixel buffer.
--   
--   GdkPixbuf contains information about an 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).
--   
--   
Creating new GdkPixbuf
--   
--   The most basic way to create a pixbuf is to wrap an existing pixel
--   buffer with a Pixbuf instance. You can use the
--   [ctor@GdkPixbuf.Pixbuf.new_from_data] function to do this.
--   
--   Every time you create a new GdkPixbuf instance for some data,
--   you will need to specify the destroy notification function that will
--   be called when the data buffer needs to be freed; this will happen
--   when a GdkPixbuf is finalized by the reference counting
--   functions. If you have a chunk of static data compiled into your
--   application, you can pass in NULL as the destroy notification
--   function so that the data will not be freed.
--   
--   The [ctor@GdkPixbuf.Pixbuf.new] constructor function can be
--   used as a convenience to create a pixbuf with an empty buffer; this is
--   equivalent to allocating a data buffer using malloc() and
--   then wrapping it with gdk_pixbuf_new_from_data(). The
--   gdk_pixbuf_new() function will compute an optimal rowstride
--   so that rendering can be performed with an efficient algorithm.
--   
--   You can also copy an existing pixbuf with the
--   [methodpixbuf.copy] function. This is not the same as
--   just acquiring a reference to the old pixbuf instance: the copy
--   function will actually duplicate the pixel data in memory and create a
--   new [classpixbuf] instance for it.
--   
--   
Reference counting
--   
--   GdkPixbuf structures are reference counted. This means that
--   an application can share a single pixbuf among many parts of the code.
--   When a piece of the program needs to use a pixbuf, it should acquire a
--   reference to it by calling g_object_ref(); when it no longer
--   needs the pixbuf, it should release the reference it acquired by
--   calling g_object_unref(). The resources associated with a
--   GdkPixbuf will be freed when its reference count drops to
--   zero. Newly-created GdkPixbuf instances start with a
--   reference count of one.
--   
--   
Image Data
--   
--   Image data in a pixbuf is stored in memory in an uncompressed, packed
--   format. Rows in the image are stored top to bottom, and in each row
--   pixels are stored from left to right.
--   
--   There may be padding at the end of a row.
--   
--   The "rowstride" value of a pixbuf, as returned by
--   [method@GdkPixbuf.Pixbuf.get_rowstride], indicates the number
--   of bytes between rows.
--   
--   NOTE: If you are copying raw pixbuf data with memcpy()
--   note that the last row in the pixbuf may not be as wide as the full
--   rowstride, but rather just as wide as the pixel data needs to be; that
--   is: it is unsafe to do memcpy (dest, pixels, rowstride *
--   height) to copy a whole pixbuf. Use pixbufCopy instead, or
--   compute the width in bytes of the last row as:
--   
--   
c code
--   
--   
--   last_row = width * ((n_channels * bits_per_sample + 7) / 8);
--   
--   
--   The same rule applies when iterating over each row of a
--   GdkPixbuf pixels array.
--   
--   The following code illustrates a simple put_pixel() function
--   for RGB pixbufs with 8 bits per channel with an alpha channel.
--   
--   
c code
--   
--   
--   static void
--   put_pixel (GdkPixbuf *pixbuf,
--              int x,
--   	   int y,
--   	   guchar red,
--   	   guchar green,
--   	   guchar blue,
--   	   guchar alpha)
--   {
--     int n_channels = gdk_pixbuf_get_n_channels (pixbuf);
--   
--     // Ensure that the pixbuf is valid
--     g_assert (gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB);
--     g_assert (gdk_pixbuf_get_bits_per_sample (pixbuf) == 8);
--     g_assert (gdk_pixbuf_get_has_alpha (pixbuf));
--     g_assert (n_channels == 4);
--   
--     int width = gdk_pixbuf_get_width (pixbuf);
--     int height = gdk_pixbuf_get_height (pixbuf);
--   
--     // Ensure that the coordinates are in a valid range
--     g_assert (x >= 0 && x < width);
--     g_assert (y >= 0 && y < height);
--   
--     int rowstride = gdk_pixbuf_get_rowstride (pixbuf);
--   
--     // The pixel buffer in the GdkPixbuf instance
--     guchar *pixels = gdk_pixbuf_get_pixels (pixbuf);
--   
--     // The pixel we wish to modify
--     guchar *p = pixels + y * rowstride + x * n_channels;
--     p[0] = red;
--     p[1] = green;
--     p[2] = blue;
--     p[3] = alpha;
--   }
--   
--   
--   
Loading images
--   
--   The GdkPixBuf class provides a simple mechanism for loading
--   an image from a file in synchronous and asynchronous fashion.
--   
--   For GUI applications, it is recommended to use the asynchronous stream
--   API to avoid blocking the control flow of the application.
--   
--   Additionally, GdkPixbuf provides the
--   [classgdkPixbuf.PixbufLoader@] API for progressive
--   image loading.
--   
--   ## Saving images
--   
--   The GdkPixbuf class provides methods for saving image data in
--   a number of file formats. The formatted data can be written to a file
--   or to a memory buffer. @GdkPixbuf` can also call a user-defined
--   callback on the data, which allows to e.g. write the image to a socket
--   or store it in a database.
module GI.GdkPixbuf.Objects.Pixbuf

-- | Memory-managed wrapper type.
newtype Pixbuf
Pixbuf :: ManagedPtr Pixbuf -> Pixbuf

-- | Type class for types which can be safely cast to Pixbuf, for
--   instance with toPixbuf.
class (GObject o, IsDescendantOf Pixbuf o) => IsPixbuf o

-- | Cast to Pixbuf, for types for which this is known to be safe.
--   For general casts, use castTo.
toPixbuf :: (MonadIO m, IsPixbuf o) => o -> m 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 substitute_color is TRUE, then the color
--   specified by the (r, g, b) arguments will
--   be assigned zero opacity. That is, if you pass (255, 255,
--   255) for the substitute color, all white pixels will become fully
--   transparent.
--   
--   If substitute_color is FALSE, then the (r,
--   g, b) arguments will be ignored.
pixbufAddAlpha :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Bool -> Word8 -> Word8 -> Word8 -> m (Maybe Pixbuf)

-- | Takes an existing pixbuf and checks for the presence of an associated
--   "orientation" option.
--   
--   The orientation option 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 :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m (Maybe Pixbuf)

-- | Calculates the rowstride that an image created with those values would
--   have.
--   
--   This function is useful for front-ends and backends that want to check
--   image values without needing to create a GdkPixbuf.
--   
--   Since: 2.36.8
pixbufCalculateRowstride :: (HasCallStack, MonadIO m) => Colorspace -> Bool -> Int32 -> Int32 -> Int32 -> m Int32

-- | 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.
--   
pixbufComposite :: (HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) => a -> b -> Int32 -> Int32 -> Int32 -> Int32 -> Double -> Double -> Double -> Double -> InterpType -> Int32 -> m ()

-- | 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 pixbufCompositeColorSimple for a simpler variant of this
--   function suitable for many tasks.
pixbufCompositeColor :: (HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) => a -> b -> Int32 -> Int32 -> Int32 -> Int32 -> Double -> Double -> Double -> Double -> InterpType -> Int32 -> Int32 -> Int32 -> Int32 -> Word32 -> Word32 -> m ()

-- | Creates a new pixbuf by scaling src to dest_width x
--   dest_height and alpha blending the result with a checkboard
--   of colors color1 and color2.
pixbufCompositeColorSimple :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Int32 -> Int32 -> InterpType -> Int32 -> Int32 -> Word32 -> Word32 -> m (Maybe Pixbuf)

-- | Creates a new GdkPixbuf with a copy of the information in the
--   specified pixbuf.
--   
--   Note that this does not copy the options set on the original
--   GdkPixbuf, use pixbufCopyOptions for this.
pixbufCopy :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m (Maybe Pixbuf)

-- | Copies a rectangular area from src_pixbuf to
--   dest_pixbuf.
--   
--   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 :: (HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) => a -> Int32 -> Int32 -> Int32 -> Int32 -> b -> Int32 -> Int32 -> m ()

-- | Copies the key/value pair options attached to a GdkPixbuf to
--   another GdkPixbuf.
--   
--   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 :: (HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) => a -> b -> m Bool

-- | Clears a pixbuf to the given RGBA value, converting the RGBA value
--   into the pixbuf's pixel format.
--   
--   The alpha component will be ignored if the pixbuf doesn't have an
--   alpha channel.
pixbufFill :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Word32 -> m ()

-- | Flips a pixbuf horizontally or vertically and returns the result in a
--   new pixbuf.
--   
--   Since: 2.6
pixbufFlip :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Bool -> m (Maybe Pixbuf)

-- | Queries the number of bits per color sample in a pixbuf.
pixbufGetBitsPerSample :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Int32

-- | Returns the length of the pixel data, in bytes.
--   
--   Since: 2.26
pixbufGetByteLength :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m CSize

-- | Queries the color space of a pixbuf.
pixbufGetColorspace :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Colorspace

-- | Parses an image file far enough to determine its format and size.
--   
--   Since: 2.4
pixbufGetFileInfo :: (HasCallStack, MonadIO m) => [Char] -> m (Maybe PixbufFormat, Int32, Int32)

-- | Asynchronously parses an image file far enough to determine its format
--   and size.
--   
--   For more details see 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
--   pixbufGetFileInfoFinish to get the result of the operation.
--   
--   Since: 2.32
pixbufGetFileInfoAsync :: (HasCallStack, MonadIO m, IsCancellable a) => [Char] -> Maybe a -> Maybe AsyncReadyCallback -> m ()

-- | Finishes an asynchronous pixbuf parsing operation started with
--   pixbufGetFileInfoAsync.
--   
--   Since: 2.32
pixbufGetFileInfoFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m (Maybe PixbufFormat, Int32, Int32)

-- | Obtains the available information about the image formats supported by
--   GdkPixbuf.
--   
--   Since: 2.2
pixbufGetFormats :: (HasCallStack, MonadIO m) => m [PixbufFormat]

-- | Queries whether a pixbuf has an alpha channel (opacity information).
pixbufGetHasAlpha :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Bool

-- | Queries the height of a pixbuf.
pixbufGetHeight :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Int32

-- | Queries the number of channels of a pixbuf.
pixbufGetNChannels :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Int32

-- | 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 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 :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Text -> m (Maybe Text)

-- | Queries a pointer to the pixel data of a pixbuf.
--   
--   This function will cause an implicit copy of the pixbuf data if the
--   pixbuf was created from read-only data.
--   
--   Please see the section on image data for information about how
--   the pixel data is stored in memory.
--   
--   Since: 2.26
pixbufGetPixels :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m ByteString

-- | 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 :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Int32

-- | Queries the width of a pixbuf.
pixbufGetWidth :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Int32

-- | Initalizes the gdk-pixbuf loader modules referenced by the
--   loaders.cache file present inside that directory.
--   
--   This is to be used by applications that want to ship certain loaders
--   in a different location from the system ones.
--   
--   This is needed when the OS or runtime ships a minimal number of
--   loaders so as to reduce the potential attack surface of carefully
--   crafted image files, especially for uncommon file types. Applications
--   that require broader image file types coverage, such as image viewers,
--   would be expected to ship the gdk-pixbuf modules in a separate
--   location, bundled with the application in a separate directory from
--   the OS or runtime- provided modules.
--   
--   Since: 2.40
pixbufInitModules :: (HasCallStack, MonadIO m) => Text -> m ()

-- | Creates a new GdkPixbuf structure and allocates a buffer for
--   it.
--   
--   If the allocation of the buffer failed, this function will return
--   NULL.
--   
--   The buffer has an optimal rowstride. Note that the buffer is not
--   cleared; you will have to fill it completely yourself.
pixbufNew :: (HasCallStack, MonadIO m) => Colorspace -> Bool -> Int32 -> Int32 -> Int32 -> m (Maybe Pixbuf)

-- | Creates a new Pixbuf out of in-memory readonly image data.
--   
--   Currently only RGB images with 8 bits per sample are supported.
--   
--   This is the GBytes variant of pixbufNewFromData,
--   useful for language bindings.
--   
--   Since: 2.32
pixbufNewFromBytes :: (HasCallStack, MonadIO m) => Bytes -> Colorspace -> Bool -> Int32 -> Int32 -> Int32 -> Int32 -> m Pixbuf

-- | Creates a new 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
--   GdkPixbufDestroyNotify. 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: pixbufNewFromBytes
pixbufNewFromData :: (HasCallStack, MonadIO m) => Ptr Word8 -> Colorspace -> Bool -> Int32 -> Int32 -> Int32 -> Int32 -> Maybe PixbufDestroyNotify -> m Pixbuf

-- | Creates a new pixbuf by loading an image from a file.
--   
--   The file format is detected automatically.
--   
--   If NULL is returned, then error will be set.
--   Possible errors are:
--   
--   
--   
- the file could not be opened
--   
- there is no loader for the file's format
--   
- there is not enough memory to allocate the image buffer
--   
- the image buffer contains invalid data
--   
--   
--   The error domains are GDK_PIXBUF_ERROR and
--   G_FILE_ERROR.
pixbufNewFromFile :: (HasCallStack, MonadIO m) => [Char] -> m (Maybe Pixbuf)

-- | Creates a new pixbuf by loading an image from a file.
--   
--   The file format is detected automatically.
--   
--   If NULL is returned, then error will be set.
--   Possible errors are:
--   
--   
--   
- the file could not be opened
--   
- there is no loader for the file's format
--   
- there is not enough memory to allocate the image buffer
--   
- the image buffer contains invalid data
--   
--   
--   The error domains are GDK_PIXBUF_ERROR and
--   G_FILE_ERROR.
--   
--   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 :: (HasCallStack, MonadIO m) => [Char] -> Int32 -> Int32 -> Bool -> m (Maybe Pixbuf)

-- | Creates a new pixbuf by loading an image from a file.
--   
--   The file format is detected automatically.
--   
--   If NULL is returned, then error will be set.
--   Possible errors are:
--   
--   
--   
- the file could not be opened
--   
- there is no loader for the file's format
--   
- there is not enough memory to allocate the image buffer
--   
- the image buffer contains invalid data
--   
--   
--   The error domains are GDK_PIXBUF_ERROR and
--   G_FILE_ERROR.
--   
--   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 pixbufNewFromFileAtScale.
--   
--   Since: 2.4
pixbufNewFromFileAtSize :: (HasCallStack, MonadIO m) => [Char] -> Int32 -> Int32 -> m (Maybe Pixbuf)

-- | Creates a GdkPixbuf 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.
--   
--   GdkPixbuf ships with a program called 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 copy_pixels. If you
--   pass --rle to gdk-pixbuf-csource, a copy will be
--   made even if copy_pixels 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:
--   
--   
c code
--   
--   
--   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.

-- | Deprecated: (Since version 2.32)Use GResource instead.
pixbufNewFromInline :: (HasCallStack, MonadIO m) => ByteString -> Bool -> m Pixbuf

-- | Creates a new pixbuf by loading an image from an resource.
--   
--   The file format is detected automatically. If NULL is
--   returned, then error will be set.
--   
--   Since: 2.26
pixbufNewFromResource :: (HasCallStack, MonadIO m) => Text -> m (Maybe Pixbuf)

-- | Creates a new pixbuf by loading an image from an resource.
--   
--   The file format is detected automatically. If NULL 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 :: (HasCallStack, MonadIO m) => Text -> Int32 -> Int32 -> Bool -> m (Maybe Pixbuf)

-- | Creates a new pixbuf by loading an image from an input stream.
--   
--   The file format is detected automatically.
--   
--   If NULL 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
--   G_IO_ERROR_CANCELLED 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 :: (HasCallStack, MonadIO m, IsInputStream a, IsCancellable b) => a -> Maybe b -> m (Maybe Pixbuf)

-- | Creates a new pixbuf by asynchronously loading an image from an input
--   stream.
--   
--   For more details see 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
--   pixbufNewFromStreamFinish to get the result of the operation.
--   
--   Since: 2.24
pixbufNewFromStreamAsync :: (HasCallStack, MonadIO m, IsInputStream a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()

-- | Creates a new pixbuf by loading an image from an input stream.
--   
--   The file format is detected automatically. If NULL 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
--   G_IO_ERROR_CANCELLED 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 :: (HasCallStack, MonadIO m, IsInputStream a, IsCancellable b) => a -> Int32 -> Int32 -> Bool -> Maybe b -> m (Maybe Pixbuf)

-- | Creates a new pixbuf by asynchronously loading an image from an input
--   stream.
--   
--   For more details see 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
--   pixbufNewFromStreamFinish to get the result of the operation.
--   
--   Since: 2.24
pixbufNewFromStreamAtScaleAsync :: (HasCallStack, MonadIO m, IsInputStream a, IsCancellable b) => a -> Int32 -> Int32 -> Bool -> Maybe b -> Maybe AsyncReadyCallback -> m ()

-- | Finishes an asynchronous pixbuf creation operation started with
--   pixbufNewFromStreamAsync.
--   
--   Since: 2.24
pixbufNewFromStreamFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m (Maybe 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.

-- | Deprecated: (Since version 2.44)Use pixbufNewFromStream
--   witha MemoryInputStream, making sure to handle errors incase
--   the XPM format loader is not available
pixbufNewFromXpmData :: (HasCallStack, MonadIO m) => [Text] -> m (Maybe Pixbuf)

-- | Creates a new pixbuf which represents a sub-region of
--   src_pixbuf.
--   
--   The new pixbuf shares its pixels with the original pixbuf, so writing
--   to one affects both. The new pixbuf holds a reference to
--   src_pixbuf, so src_pixbuf will not be finalized
--   until the new pixbuf is finalized.
--   
--   Note that if src_pixbuf is read-only, this function will
--   force it to be mutable.
pixbufNewSubpixbuf :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Int32 -> Int32 -> Int32 -> Int32 -> m Pixbuf

-- | Provides a 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 :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Bytes

-- | Provides a read-only pointer to the raw pixel data.
--   
--   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 :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m Word8

-- | Removes the key/value pair option attached to a GdkPixbuf.
--   
--   Since: 2.36
pixbufRemoveOption :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Text -> m Bool

-- | Rotates a pixbuf by a multiple of 90 degrees, and returns the result
--   in a new pixbuf.
--   
--   If angle is 0, this function will return a copy of
--   src.
--   
--   Since: 2.6
pixbufRotateSimple :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> PixbufRotation -> m (Maybe Pixbuf)

-- | Modifies saturation and optionally pixelates src, placing the
--   result in dest.
--   
--   The src and dest pixbufs must have the same image
--   format, size, and rowstride.
--   
--   The src and dest arguments 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.
pixbufSaturateAndPixelate :: (HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) => a -> b -> Float -> Bool -> m ()

-- | Vector version of gdk_pixbuf_save_to_buffer().
--   
--   Saves pixbuf to a new buffer in format type, which is
--   currently "jpeg", "tiff", "png", "ico" or "bmp".
--   
--   See Pixbuf.save_to_buffer() for more details.
--   
--   Since: 2.4
pixbufSaveToBufferv :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Text -> Maybe [Text] -> Maybe [Text] -> m ByteString

-- | Vector version of gdk_pixbuf_save_to_callback().
--   
--   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 Pixbuf.save_to_callback() for more details.
--   
--   Since: 2.4
pixbufSaveToCallbackv :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> PixbufSaveFunc -> Text -> Maybe [Text] -> Maybe [Text] -> m ()

-- | Finishes an asynchronous pixbuf save operation started with
--   gdk_pixbuf_save_to_stream_async().
--   
--   Since: 2.24
pixbufSaveToStreamFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m ()

-- | Saves pixbuf to an output stream.
--   
--   Supported file formats are currently "jpeg", "tiff", "png", "ico" or
--   "bmp".
--   
--   See Pixbuf.save_to_stream() for more details.
--   
--   Since: 2.36
pixbufSaveToStreamv :: (HasCallStack, MonadIO m, IsPixbuf a, IsOutputStream b, IsCancellable c) => a -> b -> Text -> Maybe [Text] -> Maybe [Text] -> Maybe c -> m ()

-- | Saves pixbuf to an output stream asynchronously.
--   
--   For more details see 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 pixbufSaveToStreamFinish to get the result of
--   the operation.
--   
--   Since: 2.36
pixbufSaveToStreamvAsync :: (HasCallStack, MonadIO m, IsPixbuf a, IsOutputStream b, IsCancellable c) => a -> b -> Text -> Maybe [Text] -> Maybe [Text] -> Maybe c -> Maybe AsyncReadyCallback -> m ()

-- | Vector version of gdk_pixbuf_save().
--   
--   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 Pixbuf.save() for more details.
pixbufSavev :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> [Char] -> Text -> Maybe [Text] -> Maybe [Text] -> m ()

-- | 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 pixbufScaleSimple first; this function is the
--   industrial-strength power tool you can fall back to, if
--   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 :: (HasCallStack, MonadIO m, IsPixbuf a, IsPixbuf b) => a -> b -> Int32 -> Int32 -> Int32 -> Int32 -> Double -> Double -> Double -> Double -> InterpType -> m ()

-- | Create a new pixbuf containing a copy of src scaled to
--   dest_width x dest_height.
--   
--   This function leaves src unaffected.
--   
--   The interp_type should be GDK_INTERP_NEAREST if you
--   want maximum speed (but when scaling down GDK_INTERP_NEAREST
--   is usually unusably ugly). The default interp_type 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 pixbufNewSubpixbuf.
--   
--   If dest_width and dest_height are equal to the width
--   and height of src, this function will return an unscaled copy
--   of src.
--   
--   For more complicated scaling/alpha blending see pixbufScale and
--   pixbufComposite.
pixbufScaleSimple :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Int32 -> Int32 -> InterpType -> m (Maybe Pixbuf)

-- | Attaches a key/value pair as an option to a GdkPixbuf.
--   
--   If key already exists in the list of options attached to the
--   pixbuf, the new value is ignored and FALSE is
--   returned.
--   
--   Since: 2.2
pixbufSetOption :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> Text -> Text -> m Bool

-- | Construct a GValueConstruct with valid value for the
--   “bits-per-sample” property. This is rarely needed directly,
--   but it is used by new.
constructPixbufBitsPerSample :: (IsPixbuf o, MonadIO m) => Int32 -> m (GValueConstruct o)

-- | Get the value of the “bits-per-sample” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #bitsPerSample
--   
getPixbufBitsPerSample :: (MonadIO m, IsPixbuf o) => o -> m Int32

-- | Construct a GValueConstruct with valid value for the
--   “colorspace” property. This is rarely needed directly, but it
--   is used by new.
constructPixbufColorspace :: (IsPixbuf o, MonadIO m) => Colorspace -> m (GValueConstruct o)

-- | Get the value of the “colorspace” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #colorspace
--   
getPixbufColorspace :: (MonadIO m, IsPixbuf o) => o -> m Colorspace

-- | Construct a GValueConstruct with valid value for the
--   “has-alpha” property. This is rarely needed directly, but it
--   is used by new.
constructPixbufHasAlpha :: (IsPixbuf o, MonadIO m) => Bool -> m (GValueConstruct o)

-- | Get the value of the “has-alpha” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #hasAlpha
--   
getPixbufHasAlpha :: (MonadIO m, IsPixbuf o) => o -> m Bool

-- | Construct a GValueConstruct with valid value for the
--   “height” property. This is rarely needed directly, but it is
--   used by new.
constructPixbufHeight :: (IsPixbuf o, MonadIO m) => Int32 -> m (GValueConstruct o)

-- | Get the value of the “height” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #height
--   
getPixbufHeight :: (MonadIO m, IsPixbuf o) => o -> m Int32

-- | Construct a GValueConstruct with valid value for the
--   “n-channels” property. This is rarely needed directly, but it
--   is used by new.
constructPixbufNChannels :: (IsPixbuf o, MonadIO m) => Int32 -> m (GValueConstruct o)

-- | Get the value of the “n-channels” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #nChannels
--   
getPixbufNChannels :: (MonadIO m, IsPixbuf o) => o -> m Int32

-- | Construct a GValueConstruct with valid value for the
--   “pixel-bytes” property. This is rarely needed directly, but
--   it is used by new.
constructPixbufPixelBytes :: (IsPixbuf o, MonadIO m) => Bytes -> m (GValueConstruct o)

-- | Get the value of the “pixel-bytes” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #pixelBytes
--   
getPixbufPixelBytes :: (MonadIO m, IsPixbuf o) => o -> m (Maybe Bytes)

-- | Construct a GValueConstruct with valid value for the
--   “pixels” property. This is rarely needed directly, but it is
--   used by new.
constructPixbufPixels :: (IsPixbuf o, MonadIO m) => Ptr () -> m (GValueConstruct o)

-- | Get the value of the “pixels” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #pixels
--   
getPixbufPixels :: (MonadIO m, IsPixbuf o) => o -> m (Ptr ())

-- | Construct a GValueConstruct with valid value for the
--   “rowstride” property. This is rarely needed directly, but it
--   is used by new.
constructPixbufRowstride :: (IsPixbuf o, MonadIO m) => Int32 -> m (GValueConstruct o)

-- | Get the value of the “rowstride” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #rowstride
--   
getPixbufRowstride :: (MonadIO m, IsPixbuf o) => o -> m Int32

-- | Construct a GValueConstruct with valid value for the
--   “width” property. This is rarely needed directly, but it is
--   used by new.
constructPixbufWidth :: (IsPixbuf o, MonadIO m) => Int32 -> m (GValueConstruct o)

-- | Get the value of the “width” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get pixbuf #width
--   
getPixbufWidth :: (MonadIO m, IsPixbuf o) => o -> m Int32
instance GHC.Classes.Eq GI.GdkPixbuf.Objects.Pixbuf.Pixbuf
instance Data.GI.Base.BasicTypes.GObject GI.GdkPixbuf.Objects.Pixbuf.Pixbuf
instance Data.GI.Base.Overloading.HasParentTypes GI.GdkPixbuf.Objects.Pixbuf.Pixbuf
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.GdkPixbuf.Objects.Pixbuf.Pixbuf)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.GdkPixbuf.Objects.Pixbuf.Pixbuf o) => GI.GdkPixbuf.Objects.Pixbuf.IsPixbuf o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.GdkPixbuf.Objects.Pixbuf.Pixbuf
instance Data.GI.Base.BasicTypes.TypedObject GI.GdkPixbuf.Objects.Pixbuf.Pixbuf

module GI.GdkPixbuf.Objects

module GI.GdkPixbuf
