GI.Clutter.Objects.DeformEffect

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

Since: 1.4

Exported types

newtype DeformEffect

Memory-managed wrapper type.

Constructors

DeformEffect (ManagedPtr DeformEffect)

Instances

Eq DeformEffect

Defined in GI.Clutter.Objects.DeformEffect

Methods

(==) :: DeformEffect -> DeformEffect -> Bool

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

GObject DeformEffect

Defined in GI.Clutter.Objects.DeformEffect

ManagedPtrNewtype DeformEffect

Defined in GI.Clutter.Objects.DeformEffect

Methods

toManagedPtr :: DeformEffect -> ManagedPtr DeformEffect

TypedObject DeformEffect

Defined in GI.Clutter.Objects.DeformEffect

Methods

glibType :: IO GType

HasParentTypes DeformEffect

Defined in GI.Clutter.Objects.DeformEffect

IsGValue (Maybe DeformEffect)

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

Defined in GI.Clutter.Objects.DeformEffect

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes DeformEffect

Defined in GI.Clutter.Objects.DeformEffect

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

class (GObject o, IsDescendantOf DeformEffect o) => IsDeformEffect o

Type class for types which can be safely cast to DeformEffect, for instance with toDeformEffect.

Instances

(GObject o, IsDescendantOf DeformEffect o) => IsDeformEffect o

Defined in GI.Clutter.Objects.DeformEffect

toDeformEffect :: (MonadIO m, IsDeformEffect o) => o -> m DeformEffect

Cast to DeformEffect, 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, invalidate, isFloating, notify, notifyByPspec, paintTarget, queueRepaint, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActor, getBackMaterial, getData, getEnabled, getNTiles, getName, getProperty, getQdata, getTarget, getTargetRect, getTargetSize, getTexture.

Setters

setBackMaterial, setData, setDataFull, setEnabled, setNTiles, setName, setProperty.

getBackMaterial

deformEffectGetBackMaterial

Arguments

:: (HasCallStack, MonadIO m, IsDeformEffect a)

=> a

effect: a DeformEffect

-> m (Ptr ())

Returns: a handle for the material, or Nothing. The returned material is owned by the DeformEffect and it should not be freed directly

Retrieves the handle to the back face material used by effect

Since: 1.4

getNTiles

deformEffectGetNTiles

Arguments

:: (HasCallStack, MonadIO m, IsDeformEffect a)

=> a

effect: a DeformEffect

-> m (Word32, Word32)

Retrieves the number of horizontal and vertical tiles used to sub-divide the actor's geometry during the effect

Since: 1.4

invalidate

deformEffectInvalidate

Arguments

:: (HasCallStack, MonadIO m, IsDeformEffect a)

=> a

effect: a DeformEffect

-> m ()

Invalidates the effect's vertices and, if it is associated to an actor, it will queue a redraw

Since: 1.4

setBackMaterial

deformEffectSetBackMaterial

Arguments

:: (HasCallStack, MonadIO m, IsDeformEffect a)

=> a

effect: a DeformEffect

-> Ptr ()

material: a handle to a Cogl material

-> m ()

Sets the material that should be used when drawing the back face of the actor during a deformation

The DeformEffect will take a reference on the material's handle

Since: 1.4

setNTiles

deformEffectSetNTiles

Arguments

:: (HasCallStack, MonadIO m, IsDeformEffect a)

=> a

effect: a DeformEffect

-> Word32

xTiles: number of horizontal tiles

-> Word32

yTiles: number of vertical tiles

-> m ()

Sets the number of horizontal and vertical tiles to be used when applying the effect

More tiles allow a finer grained deformation at the expenses of computation

Since: 1.4

Properties

xTiles

The number of horizontal tiles. The bigger the number, the smaller the tiles

Since: 1.4

constructDeformEffectXTiles :: (IsDeformEffect o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “x-tiles” property. This is rarely needed directly, but it is used by new.

getDeformEffectXTiles :: (MonadIO m, IsDeformEffect o) => o -> m Word32

Get the value of the “x-tiles” property. When overloading is enabled, this is equivalent to

get deformEffect #xTiles

setDeformEffectXTiles :: (MonadIO m, IsDeformEffect o) => o -> Word32 -> m ()

Set the value of the “x-tiles” property. When overloading is enabled, this is equivalent to

set deformEffect [ #xTiles := value ]

yTiles

The number of vertical tiles. The bigger the number, the smaller the tiles

Since: 1.4

constructDeformEffectYTiles :: (IsDeformEffect o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “y-tiles” property. This is rarely needed directly, but it is used by new.

getDeformEffectYTiles :: (MonadIO m, IsDeformEffect o) => o -> m Word32

Get the value of the “y-tiles” property. When overloading is enabled, this is equivalent to

get deformEffect #yTiles

setDeformEffectYTiles :: (MonadIO m, IsDeformEffect o) => o -> Word32 -> m ()

Set the value of the “y-tiles” property. When overloading is enabled, this is equivalent to

set deformEffect [ #yTiles := value ]