GI.Clutter.Structs.Point

A point in 2D space.

Since: 1.12

Exported types

newtype Point

Memory-managed wrapper type.

Constructors

Point (ManagedPtr Point)

Instances

Eq Point

Defined in GI.Clutter.Structs.Point

Methods

(==) :: Point -> Point -> Bool

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

GBoxed Point

Defined in GI.Clutter.Structs.Point

ManagedPtrNewtype Point

Defined in GI.Clutter.Structs.Point

Methods

toManagedPtr :: Point -> ManagedPtr Point

TypedObject Point

Defined in GI.Clutter.Structs.Point

Methods

glibType :: IO GType

HasParentTypes Point

Defined in GI.Clutter.Structs.Point

tag ~ 'AttrSet => Constructible Point tag

Defined in GI.Clutter.Structs.Point

Methods

new :: MonadIO m => (ManagedPtr Point -> Point) -> [AttrOp Point tag] -> m Point

IsGValue (Maybe Point)

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

Defined in GI.Clutter.Structs.Point

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Point

Defined in GI.Clutter.Structs.Point

type ParentTypes Point = '[] :: [Type]

newZeroPoint :: MonadIO m => m Point

Construct a Point struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

copy, distance, equals, free, init.

Getters

None.

Setters

None.

alloc

pointAlloc

Arguments

:: (HasCallStack, MonadIO m)

=> m Point

Returns: the newly allocated Point. Use pointFree to free its resources.

Allocates a new Point.

Since: 1.12

copy

pointCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Point

point: a Point

-> m Point

Returns: a newly allocated Point. Use pointFree to free its resources.

Creates a new Point with the same coordinates of point.

Since: 1.12

distance

pointDistance

Arguments

:: (HasCallStack, MonadIO m)

=> Point

a: a Point

-> Point

b: a Point

-> m (Float, Float, Float)

Returns: the distance between the points.

Computes the distance between two Point.

Since: 1.12

equals

pointEquals

Arguments

:: (HasCallStack, MonadIO m)

=> Point

a: the first Point to compare

-> Point

b: the second Point to compare

-> m Bool

Returns: True if the ClutterPoints are equal

Compares two Point for equality.

Since: 1.12

free

pointFree

Arguments

:: (HasCallStack, MonadIO m)

=> Point

point: a Point

-> m ()

Frees the resources allocated for point.

Since: 1.12

init

pointInit

Arguments

:: (HasCallStack, MonadIO m)

=> Point

point: a Point

-> Float

x: the X coordinate of the point

-> Float

y: the Y coordinate of the point

-> m Point

Returns: the initialized Point

Initializes point with the given coordinates.

Since: 1.12

zero

pointZero

Arguments

:: (HasCallStack, MonadIO m)

=> m Point

Returns: a point centered in (0, 0); the returned Point is owned by Clutter and it should not be modified or freed.

A point centered at (0, 0).

The returned value can be used as a guard.

Since: 1.12

Properties

x

X coordinate, in pixels

getPointX :: MonadIO m => Point -> m Float

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

get point #x

setPointX :: MonadIO m => Point -> Float -> m ()

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

set point [ #x := value ]

y

Y coordinate, in pixels

getPointY :: MonadIO m => Point -> m Float

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

get point #y

setPointY :: MonadIO m => Point -> Float -> m ()

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

set point [ #y := value ]