GI.Clutter.Objects.OffscreenEffect

The OffscreenEffect structure contains only private data and should be accessed using the provided API

Since: 1.4

Exported types

newtype OffscreenEffect

Memory-managed wrapper type.

Constructors

OffscreenEffect (ManagedPtr OffscreenEffect)

Instances

Eq OffscreenEffect

Defined in GI.Clutter.Objects.OffscreenEffect

Methods

(==) :: OffscreenEffect -> OffscreenEffect -> Bool

(/=) :: OffscreenEffect -> OffscreenEffect -> Bool

GObject OffscreenEffect

Defined in GI.Clutter.Objects.OffscreenEffect

ManagedPtrNewtype OffscreenEffect

Defined in GI.Clutter.Objects.OffscreenEffect

Methods

toManagedPtr :: OffscreenEffect -> ManagedPtr OffscreenEffect

TypedObject OffscreenEffect

Defined in GI.Clutter.Objects.OffscreenEffect

Methods

glibType :: IO GType

HasParentTypes OffscreenEffect

Defined in GI.Clutter.Objects.OffscreenEffect

IsGValue (Maybe OffscreenEffect)

Convert OffscreenEffect to and from GValue. See toGValue and fromGValue.

Defined in GI.Clutter.Objects.OffscreenEffect

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe OffscreenEffect -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe OffscreenEffect)

type ParentTypes OffscreenEffect

Defined in GI.Clutter.Objects.OffscreenEffect

type ParentTypes OffscreenEffect = '[Effect, ActorMeta, Object]

class (GObject o, IsDescendantOf OffscreenEffect o) => IsOffscreenEffect o

Type class for types which can be safely cast to OffscreenEffect, for instance with toOffscreenEffect.

Instances

(GObject o, IsDescendantOf OffscreenEffect o) => IsOffscreenEffect o

Defined in GI.Clutter.Objects.OffscreenEffect

toOffscreenEffect :: (MonadIO m, IsOffscreenEffect o) => o -> m OffscreenEffect

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

setData, setDataFull, setEnabled, setName, setProperty.

createTexture

offscreenEffectCreateTexture

Arguments

:: (HasCallStack, MonadIO m, IsOffscreenEffect a)

=> a

effect: a OffscreenEffect

-> Float

width: the minimum width of the target texture

-> Float

height: the minimum height of the target texture

-> m (Ptr ())

Returns: a handle to a Cogl texture, or COGL_INVALID_HANDLE. The returned handle has its reference count increased.

Calls the create_texture() virtual function of the effect

Since: 1.4

getTarget

offscreenEffectGetTarget

Arguments

:: (HasCallStack, MonadIO m, IsOffscreenEffect a)

=> a

effect: a OffscreenEffect

-> m Material

Returns: a Material or Nothing. The returned material is owned by Clutter and it should not be modified or freed

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

Arguments

:: (HasCallStack, MonadIO m, IsOffscreenEffect a)

=> a

effect: a OffscreenEffect

-> m (Bool, Rect)

Returns: True if the offscreen buffer has a valid rectangle, and False otherwise

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

Arguments

:: (HasCallStack, MonadIO m, IsOffscreenEffect a)

=> a

effect: a OffscreenEffect

-> m (Bool, Float, Float)

Returns: True if the offscreen buffer has a valid size, and False otherwise

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

Arguments

:: (HasCallStack, MonadIO m, IsOffscreenEffect a)

=> a

effect: a OffscreenEffect

-> m (Ptr ())

Returns: a CoglHandle or COGL_INVALID_HANDLE. The returned texture is owned by Clutter and it should not be modified or freed

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

Arguments

:: (HasCallStack, MonadIO m, IsOffscreenEffect a)

=> a

effect: a OffscreenEffect

-> m ()

Calls the paint_target() virtual function of the effect

Since: 1.4