Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
An opaque struct representing an iterator which points to a certain position in an animation.
Synopsis
- newtype PixbufAnimationIter = PixbufAnimationIter (ManagedPtr PixbufAnimationIter)
- class (GObject o, IsDescendantOf PixbufAnimationIter o) => IsPixbufAnimationIter o
- toPixbufAnimationIter :: (MonadIO m, IsPixbufAnimationIter o) => o -> m PixbufAnimationIter
- pixbufAnimationIterAdvance :: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) => a -> Maybe TimeVal -> m Bool
- pixbufAnimationIterGetDelayTime :: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) => a -> m Int32
- pixbufAnimationIterGetPixbuf :: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) => a -> m Pixbuf
- pixbufAnimationIterOnCurrentlyLoadingFrame :: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) => a -> m Bool
Exported types
newtype PixbufAnimationIter Source #
Memory-managed wrapper type.
Instances
Eq PixbufAnimationIter Source # | |
Defined in GI.GdkPixbuf.Objects.PixbufAnimationIter (==) :: PixbufAnimationIter -> PixbufAnimationIter -> Bool # (/=) :: PixbufAnimationIter -> PixbufAnimationIter -> Bool # | |
IsGValue PixbufAnimationIter Source # | Convert |
Defined in GI.GdkPixbuf.Objects.PixbufAnimationIter toGValue :: PixbufAnimationIter -> IO GValue # fromGValue :: GValue -> IO PixbufAnimationIter # | |
ManagedPtrNewtype PixbufAnimationIter Source # | |
TypedObject PixbufAnimationIter Source # | |
Defined in GI.GdkPixbuf.Objects.PixbufAnimationIter | |
GObject PixbufAnimationIter Source # | |
Defined in GI.GdkPixbuf.Objects.PixbufAnimationIter | |
HasParentTypes PixbufAnimationIter Source # | |
Defined in GI.GdkPixbuf.Objects.PixbufAnimationIter | |
type ParentTypes PixbufAnimationIter Source # | |
Defined in GI.GdkPixbuf.Objects.PixbufAnimationIter |
class (GObject o, IsDescendantOf PixbufAnimationIter o) => IsPixbufAnimationIter o Source #
Type class for types which can be safely cast to PixbufAnimationIter
, for instance with toPixbufAnimationIter
.
Instances
(GObject o, IsDescendantOf PixbufAnimationIter o) => IsPixbufAnimationIter o Source # | |
Defined in GI.GdkPixbuf.Objects.PixbufAnimationIter |
toPixbufAnimationIter :: (MonadIO m, IsPixbufAnimationIter o) => o -> m PixbufAnimationIter Source #
Cast to PixbufAnimationIter
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Overloaded methods
advance
pixbufAnimationIterAdvance Source #
:: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) | |
=> a |
|
-> Maybe TimeVal |
|
-> m Bool | Returns: |
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 Nothing
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.
getDelayTime
pixbufAnimationIterGetDelayTime Source #
:: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) | |
=> a |
|
-> m Int32 | Returns: delay time in milliseconds (thousandths of a second) |
Gets the number of milliseconds the current pixbuf should be displayed,
or -1 if the current pixbuf should be displayed forever. g_timeout_add()
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.
getPixbuf
pixbufAnimationIterGetPixbuf Source #
:: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) | |
=> a |
|
-> m Pixbuf | Returns: the pixbuf to be displayed |
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.
onCurrentlyLoadingFrame
pixbufAnimationIterOnCurrentlyLoadingFrame Source #
:: (HasCallStack, MonadIO m, IsPixbufAnimationIter a) | |
=> a |
|
-> m Bool | Returns: |
Used to determine how to respond to the area_updated signal on
PixbufLoader
when loading an animation. area_updated is emitted
for an area of the frame currently streaming in to the loader. So if
you're on the currently loading frame, you need to redraw the screen for
the updated area.