Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
The OffscreenEffect
structure contains only private data
and should be accessed using the provided API
Since: 1.4
Synopsis
- newtype OffscreenEffect = OffscreenEffect (ManagedPtr OffscreenEffect)
- class (GObject o, IsDescendantOf OffscreenEffect o) => IsOffscreenEffect o
- toOffscreenEffect :: (MonadIO m, IsOffscreenEffect o) => o -> m OffscreenEffect
- offscreenEffectCreateTexture :: (HasCallStack, MonadIO m, IsOffscreenEffect a) => a -> Float -> Float -> m (Ptr ())
- offscreenEffectGetTarget :: (HasCallStack, MonadIO m, IsOffscreenEffect a) => a -> m Material
- offscreenEffectGetTargetRect :: (HasCallStack, MonadIO m, IsOffscreenEffect a) => a -> m (Bool, Rect)
- offscreenEffectGetTargetSize :: (HasCallStack, MonadIO m, IsOffscreenEffect a) => a -> m (Bool, Float, Float)
- offscreenEffectGetTexture :: (HasCallStack, MonadIO m, IsOffscreenEffect a) => a -> m (Ptr ())
- offscreenEffectPaintTarget :: (HasCallStack, MonadIO m, IsOffscreenEffect a) => a -> m ()
Exported types
newtype OffscreenEffect Source #
Memory-managed wrapper type.
OffscreenEffect (ManagedPtr OffscreenEffect) |
Instances
Eq OffscreenEffect Source # | |
Defined in GI.Clutter.Objects.OffscreenEffect (==) :: OffscreenEffect -> OffscreenEffect -> Bool # (/=) :: OffscreenEffect -> OffscreenEffect -> Bool # | |
GObject OffscreenEffect Source # | |
Defined in GI.Clutter.Objects.OffscreenEffect | |
ManagedPtrNewtype OffscreenEffect Source # | |
Defined in GI.Clutter.Objects.OffscreenEffect toManagedPtr :: OffscreenEffect -> ManagedPtr OffscreenEffect | |
TypedObject OffscreenEffect Source # | |
Defined in GI.Clutter.Objects.OffscreenEffect | |
HasParentTypes OffscreenEffect Source # | |
Defined in GI.Clutter.Objects.OffscreenEffect | |
IsGValue (Maybe OffscreenEffect) Source # | Convert |
Defined in GI.Clutter.Objects.OffscreenEffect gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe OffscreenEffect -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe OffscreenEffect) | |
type ParentTypes OffscreenEffect Source # | |
Defined in GI.Clutter.Objects.OffscreenEffect |
class (GObject o, IsDescendantOf OffscreenEffect o) => IsOffscreenEffect o Source #
Type class for types which can be safely cast to OffscreenEffect
, for instance with toOffscreenEffect
.
Instances
(GObject o, IsDescendantOf OffscreenEffect o) => IsOffscreenEffect o Source # | |
Defined in GI.Clutter.Objects.OffscreenEffect |
toOffscreenEffect :: (MonadIO m, IsOffscreenEffect o) => o -> m OffscreenEffect Source #
Cast to OffscreenEffect
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, createTexture, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, paintTarget, queueRepaint, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getActor, getData, getEnabled, getName, getProperty, getQdata, getTarget, getTargetRect, getTargetSize, getTexture.
Setters
createTexture
offscreenEffectCreateTexture Source #
:: (HasCallStack, MonadIO m, IsOffscreenEffect a) | |
=> a |
|
-> Float |
|
-> Float |
|
-> m (Ptr ()) | Returns: a handle to a Cogl texture, or
|
Calls the create_texture()
virtual function of the effect
Since: 1.4
getTarget
offscreenEffectGetTarget Source #
:: (HasCallStack, MonadIO m, IsOffscreenEffect a) | |
=> a |
|
-> m Material | Returns: a |
Retrieves the material used as a render target for the offscreen
buffer created by effect
You should only use the returned Material
when painting. The
returned material might change between different frames.
Since: 1.4
getTargetRect
offscreenEffectGetTargetRect Source #
:: (HasCallStack, MonadIO m, IsOffscreenEffect a) | |
=> a |
|
-> m (Bool, Rect) | Returns: |
Retrieves the origin and size of the offscreen buffer used by effect
to
paint the actor to which it has been applied.
This function should only be called by OffscreenEffect
implementations, from within the OffscreenEffectClass
.paint_target
()
virtual function.
Since: 1.14
getTargetSize
offscreenEffectGetTargetSize Source #
:: (HasCallStack, MonadIO m, IsOffscreenEffect a) | |
=> a |
|
-> m (Bool, Float, Float) | Returns: |
Deprecated: (Since version 1.14)Use offscreenEffectGetTargetRect
instead
Retrieves the size of the offscreen buffer used by effect
to
paint the actor to which it has been applied.
This function should only be called by OffscreenEffect
implementations, from within the OffscreenEffectClass
.paint_target
()
virtual function.
Since: 1.8
getTexture
offscreenEffectGetTexture Source #
:: (HasCallStack, MonadIO m, IsOffscreenEffect a) | |
=> a |
|
-> m (Ptr ()) | Returns: a |
Retrieves the texture used as a render target for the offscreen
buffer created by effect
You should only use the returned texture when painting. The texture
may change after ClutterEffectpre_paint is called so the effect
implementation should update any references to the texture after
chaining-up to the parent's pre_paint implementation. This can be
used instead of offscreenEffectGetTarget
when the
effect subclass wants to paint using its own material.
Since: 1.10
paintTarget
offscreenEffectPaintTarget Source #
:: (HasCallStack, MonadIO m, IsOffscreenEffect a) | |
=> a |
|
-> m () |
Calls the paint_target()
virtual function of the effect
Since: 1.4