GI.Graphene.Structs.Point

A point with two coordinates.

Since: 1.0

Exported types

newtype Point

Memory-managed wrapper type.

Constructors

Point (ManagedPtr Point)

Instances

Eq Point

Defined in GI.Graphene.Structs.Point

Methods

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

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

BoxedObject Point

Defined in GI.Graphene.Structs.Point

Methods

boxedType :: Point -> IO GType

IsGValue Point

Convert Point to and from GValue with toGValue and fromGValue.

Defined in GI.Graphene.Structs.Point

Methods

toGValue :: Point -> IO GValue

fromGValue :: GValue -> IO Point

tag ~ 'AttrSet => Constructible Point tag

Defined in GI.Graphene.Structs.Point

Methods

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

newZeroPoint :: MonadIO m => m Point

Construct a Point struct initialized to zero.

noPoint :: Maybe Point

A convenience alias for Nothing :: Maybe Point.

Methods

Overloaded methods

alloc

pointAlloc

Arguments

:: (HasCallStack, MonadIO m)

=> m Point

Returns: the newly allocated Point. Use pointFree to free the resources allocated by this function.

Allocates a new Point structure.

The coordinates of the returned point are (0, 0).

It's possible to chain this function with pointInit or pointInitFromPoint, e.g.:

C code

 graphene_point_t *
 point_new (float x, float y)
 {
   return graphene_point_init (graphene_point_alloc (), x, y);
 }

 graphene_point_t *
 point_copy (const graphene_point_t *p)
 {
   return graphene_point_init_from_point (graphene_point_alloc (), p);
 }

Since: 1.0

distance

pointDistance

Arguments

:: (HasCallStack, MonadIO m)

=> Point

a: a Point

-> Point

b: a Point

-> m (Float, Float, Float)

Returns: the distance between the two points

Computes the distance between a and b.

Since: 1.0

equal

pointEqual

Arguments

:: (HasCallStack, MonadIO m)

=> Point

a: a Point

-> Point

b: a Point

-> m Bool

Returns: true if the points have the same coordinates

Checks if the two points a and b point to the same coordinates.

This function accounts for floating point fluctuations; if you want to control the fuzziness of the match, you can use pointNear instead.

Since: 1.0

free

pointFree

Arguments

:: (HasCallStack, MonadIO m)

=> Point

p: a Point

-> m ()

Frees the resources allocated by pointAlloc.

Since: 1.0

init

pointInit

Arguments

:: (HasCallStack, MonadIO m)

=> Point

p: a Point

-> Float

x: the X coordinate

-> Float

y: the Y coordinate

-> m Point

Returns: the initialized point

Initializes p to the given x and y coordinates.

It's safe to call this function multiple times.

Since: 1.0

initFromPoint

pointInitFromPoint

Arguments

:: (HasCallStack, MonadIO m)

=> Point

p: a Point

-> Point

src: the Point to use

-> m Point

Returns: the initialized point

Initializes p with the same coordinates of src.

Since: 1.0

initFromVec2

pointInitFromVec2

Arguments

:: (HasCallStack, MonadIO m)

=> Point

p: the Point to initialize

-> Vec2

src: a Vec2

-> m Point

Returns: the initialized point

Initializes p with the coordinates inside the given Vec2.

Since: 1.4

interpolate

pointInterpolate

Arguments

:: (HasCallStack, MonadIO m)

=> Point

a: a Point

-> Point

b: a Point

-> Double

factor: the linear interpolation factor

-> m Point

Linearly interpolates the coordinates of a and b using the given factor.

Since: 1.0

near

pointNear

Arguments

:: (HasCallStack, MonadIO m)

=> Point

a: a Point

-> Point

b: a Point

-> Float

epsilon: threshold between the two points

-> m Bool

Returns: true if the distance is within epsilon

Checks whether the two points a and b are within the threshold of epsilon.

Since: 1.0

toVec2

pointToVec2

Arguments

:: (HasCallStack, MonadIO m)

=> Point

p: a Point

-> m Vec2

Stores the coordinates of the given Point into a Vec2.

Since: 1.4

zero

pointZero

Arguments

:: (HasCallStack, MonadIO m)

=> m Point

Returns: a fixed point

Returns a point fixed at (0, 0).

Since: 1.0

Properties

x

the X coordinate of the point

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

the Y coordinate of the point

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 ]