GI.Graphene.Structs.Quad

A 4 vertex quadrilateral, as represented by four Point.

The contents of a Quad are private and should never be accessed directly.

Since: 1.0

Exported types

newtype Quad

Memory-managed wrapper type.

Constructors

Quad (ManagedPtr Quad)

Instances

Eq Quad

Defined in GI.Graphene.Structs.Quad

Methods

(==) :: Quad -> Quad -> Bool

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

GBoxed Quad

Defined in GI.Graphene.Structs.Quad

ManagedPtrNewtype Quad

Defined in GI.Graphene.Structs.Quad

Methods

toManagedPtr :: Quad -> ManagedPtr Quad

TypedObject Quad

Defined in GI.Graphene.Structs.Quad

Methods

glibType :: IO GType

HasParentTypes Quad

Defined in GI.Graphene.Structs.Quad

tag ~ 'AttrSet => Constructible Quad tag

Defined in GI.Graphene.Structs.Quad

Methods

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

IsGValue (Maybe Quad)

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

Defined in GI.Graphene.Structs.Quad

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Quad

Defined in GI.Graphene.Structs.Quad

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

newZeroQuad :: MonadIO m => m Quad

Construct a Quad struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

bounds, contains, free, init, initFromPoints, initFromRect.

Getters

getPoint.

Setters

None.

alloc

quadAlloc

Arguments

:: (HasCallStack, MonadIO m)

=> m Quad

Returns: the newly created Quad instance

Allocates a new Quad instance.

The contents of the returned instance are undefined.

Since: 1.0

bounds

quadBounds

Arguments

:: (HasCallStack, MonadIO m)

=> Quad

q: a Quad

-> m Rect

Computes the bounding rectangle of q and places it into r.

Since: 1.0

contains

quadContains

Arguments

:: (HasCallStack, MonadIO m)

=> Quad

q: a Quad

-> Point

p: a Point

-> m Bool

Returns: true if the point is inside the Quad

Checks if the given Quad contains the given Point.

Since: 1.0

free

quadFree

Arguments

:: (HasCallStack, MonadIO m)

=> Quad

q: a Quad

-> m ()

Frees the resources allocated by quadAlloc

Since: 1.0

getPoint

quadGetPoint

Arguments

:: (HasCallStack, MonadIO m)

=> Quad

q: a Quad

-> Word32

index_: the index of the point to retrieve

-> m Point

Returns: a Point

Retrieves the point of a Quad at the given index.

Since: 1.0

init

quadInit

Arguments

:: (HasCallStack, MonadIO m)

=> Quad

q: the Quad to initialize

-> Point

p1: the first point of the quadrilateral

-> Point

p2: the second point of the quadrilateral

-> Point

p3: the third point of the quadrilateral

-> Point

p4: the fourth point of the quadrilateral

-> m Quad

Returns: the initialized Quad

Initializes a Quad with the given points.

Since: 1.0

initFromPoints

quadInitFromPoints

Arguments

:: (HasCallStack, MonadIO m)

=> Quad

q: the Quad to initialize

-> [Point]

points: an array of 4 Point

-> m Quad

Returns: the initialized Quad

Initializes a Quad using an array of points.

Since: 1.2

initFromRect

quadInitFromRect

Arguments

:: (HasCallStack, MonadIO m)

=> Quad

q: the Quad to initialize

-> Rect

r: a Rect

-> m Quad

Returns: the initialized Quad

Initializes a Quad using the four corners of the given Rect.

Since: 1.0