Gsk.Path_Measure

Description

Performs measurements on paths 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.

<gtkada_demo>create_paths.adb</gtkada_demo>

From_Object

function From_Object (Object : System.Address) return Gsk_Path_Measure

Parameters

Object

Return Value

From_Object_Free

function From_Object_Free (B : access Gsk_Path_Measure'Class) return Gsk_Path_Measure

Parameters

B

Return Value

Get_Length

function Get_Length (Self : Gsk_Path_Measure) return Interfaces.C.C_float

Gets the length of the path being measured. The length is cached, so this function does not do any work. Since: gtk+ 4.14

Parameters

Self

Return Value

the length of the path measured by Self

Get_Path

function Get_Path (Self : Gsk_Path_Measure) return Gsk.Path.Gsk_Path

Returns the path that the measure was created for. Since: gtk+ 4.14

Parameters

Self

Return Value

the path of Self. Has transfer-ownership='none'.

Get_Point

function Get_Point
   (Self     : Gsk_Path_Measure;
    Distance : Interfaces.C.C_float;
    Result   : not null access Gsk.Path_Point.Gsk_Path_Point)
    return Boolean

Gets the point at the given distance into the path. An empty path has no points, so false is returned in that case. Since: gtk+ 4.14

Parameters

Self

Distance

the distance

Result

return location for the point

Return Value

true if Result was set

Get_Tolerance

function Get_Tolerance
   (Self : Gsk_Path_Measure) return Interfaces.C.C_float

Returns the tolerance that the measure was created with. Since: gtk+ 4.14

Parameters

Self

Return Value

the tolerance of Self

Get_Type

function Get_Type return Glib.GType

Return Value

Gsk_Path_Measure

type Gsk_Path_Measure is new Glib.C_Boxed with null record;

Gsk_Path_Measure_New

function Gsk_Path_Measure_New
   (Path : Gsk.Path.Gsk_Path) return Gsk_Path_Measure

Creates a measure object for the given Path with the default tolerance. Since: gtk+ 4.14

Parameters

Path

the path to measure

Return Value

Gsk_Path_Measure_New_With_Tolerance

function Gsk_Path_Measure_New_With_Tolerance
   (Path      : Gsk.Path.Gsk_Path;
    Tolerance : Interfaces.C.C_float) return Gsk_Path_Measure

Creates a measure object for the given Path and Tolerance. Since: gtk+ 4.14

Parameters

Path

the path to measure

Tolerance

the tolerance for measuring operations

Return Value

Gtk_New

procedure Gtk_New (Self : out Gsk_Path_Measure; Path : Gsk.Path.Gsk_Path)

Creates a measure object for the given Path with the default tolerance. Since: gtk+ 4.14

Parameters

Self

Path

the path to measure

Gtk_New_With_Tolerance

procedure Gtk_New_With_Tolerance
   (Self      : out Gsk_Path_Measure;
    Path      : Gsk.Path.Gsk_Path;
    Tolerance : Interfaces.C.C_float)

Creates a measure object for the given Path and Tolerance. Since: gtk+ 4.14

Parameters

Self

Path

the path to measure

Tolerance

the tolerance for measuring operations

Null_Gsk_Path_Measure

Null_Gsk_Path_Measure : constant Gsk_Path_Measure;

Ref

function Ref (Self : Gsk_Path_Measure) return Gsk_Path_Measure

Increases the reference count of a GskPathMeasure by one. Since: gtk+ 4.14

Parameters

Self

Return Value

the passed in GskPathMeasure. Has transfer-ownership='full'.

Unref

procedure Unref (Self : Gsk_Path_Measure)

Decreases the reference count of a GskPathMeasure by one. If the resulting reference count is zero, frees the object. Since: gtk+ 4.14

Parameters

Self