GI.Gsk.Structs.PathMeasure

GskPathMeasure is an object that allows measurements on GskPaths such as determining the length of the path.

Many measuring operations require sampling the path length at intermediate points. Therefore, a GskPathMeasure has a tolerance that determines what precision is required for such approximations.

A GskPathMeasure struct is a reference counted struct and should be treated as opaque.

Since: 4.14

Exported types

newtype PathMeasure

Memory-managed wrapper type.

Constructors

PathMeasure (ManagedPtr PathMeasure)

Instances

Eq PathMeasure

Defined in GI.Gsk.Structs.PathMeasure

Methods

(==) :: PathMeasure -> PathMeasure -> Bool

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

GBoxed PathMeasure

Defined in GI.Gsk.Structs.PathMeasure

ManagedPtrNewtype PathMeasure

Defined in GI.Gsk.Structs.PathMeasure

Methods

toManagedPtr :: PathMeasure -> ManagedPtr PathMeasure

TypedObject PathMeasure

Defined in GI.Gsk.Structs.PathMeasure

Methods

glibType :: IO GType

HasParentTypes PathMeasure

Defined in GI.Gsk.Structs.PathMeasure

IsGValue (Maybe PathMeasure)

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

Defined in GI.Gsk.Structs.PathMeasure

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PathMeasure

Defined in GI.Gsk.Structs.PathMeasure

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

Methods

Click to display all available methods, including inherited ones

Methods

ref, unref.

Getters

getLength, getPath, getTolerance.

Setters

None.

getLength

pathMeasureGetLength

Arguments

:: (HasCallStack, MonadIO m)

=> PathMeasure

self: a GskPathMeasure

-> m Float

Returns: The length of the path measured by self

Gets the length of the path being measured.

The length is cached, so this function does not do any work.

Since: 4.14

getPath

pathMeasureGetPath

Arguments

:: (HasCallStack, MonadIO m)

=> PathMeasure

self: a GskPathMeasure

-> m Path

Returns: the path of self

Returns the path that the measure was created for.

Since: 4.14

getTolerance

pathMeasureGetTolerance

Arguments

:: (HasCallStack, MonadIO m)

=> PathMeasure

self: a GskPathMeasure

-> m Float

Returns: the tolerance of self

Returns the tolerance that the measure was created with.

Since: 4.14

new

pathMeasureNew

Arguments

:: (HasCallStack, MonadIO m)

=> Path

path: the path to measure

-> m PathMeasure

Returns: a new GskPathMeasure representing path

Creates a measure object for the given path with the default tolerance.

Since: 4.14

newWithTolerance

pathMeasureNewWithTolerance

Arguments

:: (HasCallStack, MonadIO m)

=> Path

path: the path to measure

-> Float

tolerance: the tolerance for measuring operations

-> m PathMeasure

Returns: a new GskPathMeasure representing path

Creates a measure object for the given path and tolerance.

Since: 4.14

ref

pathMeasureRef

Arguments

:: (HasCallStack, MonadIO m)

=> PathMeasure

self: a GskPathMeasure

-> m PathMeasure

Returns: the passed in GskPathMeasure.

Increases the reference count of a GskPathMeasure by one.

Since: 4.14

unref

pathMeasureUnref

Arguments

:: (HasCallStack, MonadIO m)

=> PathMeasure

self: a GskPathMeasure

-> m ()

Decreases the reference count of a GskPathMeasure by one.

If the resulting reference count is zero, frees the object.

Since: 4.14