7647 lines
426 KiB
XML
7647 lines
426 KiB
XML
<?xml version="1.0"?>
|
|
<!-- This file was automatically generated from C sources - DO NOT EDIT!
|
|
To affect the contents of this file, edit the original C definitions,
|
|
and/or use gtk-doc annotations. -->
|
|
<repository xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0" version="1.2">
|
|
<include name="GObject" version="2.0"/>
|
|
<package name="graphene-gobject-1.0"/>
|
|
<c:include name="graphene-gobject.h"/>
|
|
<namespace name="Graphene" version="1.0" shared-library="libgraphene-1.0.so.0" c:identifier-prefixes="Graphene" c:symbol-prefixes="graphene">
|
|
<record name="Box" c:type="graphene_box_t" version="1.2" glib:type-name="GrapheneBox" glib:get-type="graphene_box_get_type" c:symbol-prefix="box">
|
|
<doc xml:space="preserve" filename="src/graphene-box.h" line="36">A 3D box, described as the volume between a minimum and
|
|
a maximum vertices.</doc>
|
|
|
|
<field name="min" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<field name="max" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_box_alloc" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="52">Allocates a new #graphene_box_t.
|
|
|
|
The contents of the returned structure are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="59">the newly allocated #graphene_box_t structure.
|
|
Use graphene_box_free() to free the resources allocated by this function</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="contains_box" c:identifier="graphene_box_contains_box" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="552">Checks whether the #graphene_box_t @a contains the given
|
|
#graphene_box_t @b.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="560">`true` if the box is contained in the given box</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="554">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="555">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="contains_point" c:identifier="graphene_box_contains_point" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="528">Checks whether @box contains the given @point.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="535">`true` if the point is contained in the given box</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="530">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="531">the coordinates to check</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_box_equal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="587">Checks whether the two given boxes are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="594">`true` if the boxes are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="589">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="590">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="expand" c:identifier="graphene_box_expand" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="269">Expands the dimensions of @box to include the coordinates at @point.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="271">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="272">the coordinates of the point to include</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="273">return location for the expanded box</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="expand_scalar" c:identifier="graphene_box_expand_scalar" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="289">Expands the dimensions of @box by the given @scalar value.
|
|
|
|
If @scalar is positive, the #graphene_box_t will grow; if @scalar is
|
|
negative, the #graphene_box_t will shrink.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="291">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="scalar" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="292">a scalar value</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="293">return location for the expanded box</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="expand_vec3" c:identifier="graphene_box_expand_vec3" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="250">Expands the dimensions of @box to include the coordinates of the
|
|
given vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="252">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="vec" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="253">the coordinates of the point to include, as a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="254">return location for the expanded box</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_box_free" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="70">Frees the resources allocated by graphene_box_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="72">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_bounding_sphere" c:identifier="graphene_box_get_bounding_sphere" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="605">Computes the bounding #graphene_sphere_t capable of containing the given
|
|
#graphene_box_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="607">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="sphere" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="608">return location for the bounding sphere</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_center" c:identifier="graphene_box_get_center" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="443">Retrieves the coordinates of the center of a #graphene_box_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="445">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="center" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="446">return location for the coordinates of
|
|
the center</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_depth" c:identifier="graphene_box_get_depth" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="408">Retrieves the size of the @box on the Z axis.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="414">the depth of the box</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="410">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_height" c:identifier="graphene_box_get_height" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="390">Retrieves the size of the @box on the Y axis.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="396">the height of the box</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="392">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_max" c:identifier="graphene_box_get_max" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="482">Retrieves the coordinates of the maximum point of the given
|
|
#graphene_box_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="484">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="max" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="485">return location for the maximum point</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_min" c:identifier="graphene_box_get_min" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="465">Retrieves the coordinates of the minimum point of the given
|
|
#graphene_box_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="467">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="min" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="468">return location for the minimum point</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_size" c:identifier="graphene_box_get_size" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="426">Retrieves the size of the box on all three axes, and stores
|
|
it into the given @size vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="428">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="size" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="429">return location for the size</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_vertices" c:identifier="graphene_box_get_vertices" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="499">Computes the vertices of the given #graphene_box_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="501">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="vertices" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="502">return location for an array
|
|
of 8 #graphene_vec3_t</doc>
|
|
<array zero-terminated="0" c:type="graphene_vec3_t*" fixed-size="8">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_width" c:identifier="graphene_box_get_width" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="372">Retrieves the size of the @box on the X axis.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="378">the width of the box</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="374">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_box_init" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="84">Initializes the given #graphene_box_t with two vertices.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="92">the initialized #graphene_box_t</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="86">the #graphene_box_t to initialize</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="min" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="87">the coordinates of the minimum vertex</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="max" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="88">the coordinates of the maximum vertex</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_box" c:identifier="graphene_box_init_from_box" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="177">Initializes the given #graphene_box_t with the vertices of
|
|
another #graphene_box_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="185">the initialized #graphene_box_t</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="179">the #graphene_box_t to initialize</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="180">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_points" c:identifier="graphene_box_init_from_points" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="114">Initializes the given #graphene_box_t with the given array
|
|
of vertices.
|
|
|
|
If @n_points is 0, the returned box is initialized with
|
|
graphene_box_empty().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="126">the initialized #graphene_box_t</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="116">the #graphene_box_t to initialize</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="n_points" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="117">the number #graphene_point3d_t in the @points array</doc>
|
|
<type name="guint" c:type="unsigned int"/>
|
|
</parameter>
|
|
<parameter name="points" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="118">an array of #graphene_point3d_t</doc>
|
|
<array length="0" zero-terminated="0" c:type="const graphene_point3d_t*">
|
|
<type name="Point3D" c:type="graphene_point3d_t"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec3" c:identifier="graphene_box_init_from_vec3" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="199">Initializes the given #graphene_box_t with two vertices
|
|
stored inside #graphene_vec3_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="208">the initialized #graphene_box_t</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="201">the #graphene_box_t to initialize</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="min" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="202">the coordinates of the minimum vertex</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="max" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="203">the coordinates of the maximum vertex</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vectors" c:identifier="graphene_box_init_from_vectors" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="148">Initializes the given #graphene_box_t with the given array
|
|
of vertices.
|
|
|
|
If @n_vectors is 0, the returned box is initialized with
|
|
graphene_box_empty().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="160">the initialized #graphene_box_t</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="150">the #graphene_box_t to initialize</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="n_vectors" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="151">the number #graphene_point3d_t in the @vectors array</doc>
|
|
<type name="guint" c:type="unsigned int"/>
|
|
</parameter>
|
|
<parameter name="vectors" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="152">an array of #graphene_vec3_t</doc>
|
|
<array length="0" zero-terminated="0" c:type="const graphene_vec3_t*">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="intersection" c:identifier="graphene_box_intersection" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="333">Intersects the two given #graphene_box_t.
|
|
|
|
If the two boxes do not intersect, @res will contain a degenerate box
|
|
initialized with graphene_box_empty().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="344">true if the two boxes intersect</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="335">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="336">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="337">return location for the result</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="union" c:identifier="graphene_box_union" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="314">Unions the two given #graphene_box_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="316">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="317">the box to union to @a</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="318">return location for the result</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<function name="empty" c:identifier="graphene_box_empty" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="817">A degenerate #graphene_box_t that can only be expanded.
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="824">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="infinite" c:identifier="graphene_box_infinite" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="798">A degenerate #graphene_box_t that cannot be expanded.
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="805">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="minus_one" c:identifier="graphene_box_minus_one" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="758">A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the
|
|
maximum vertex set at (0, 0, 0).
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="766">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="one" c:identifier="graphene_box_one" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="738">A #graphene_box_t with the minimum vertex set at (0, 0, 0) and the
|
|
maximum vertex set at (1, 1, 1).
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="746">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="one_minus_one" c:identifier="graphene_box_one_minus_one" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="778">A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the
|
|
maximum vertex set at (1, 1, 1).
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="786">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="zero" c:identifier="graphene_box_zero" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="719">A #graphene_box_t with both the minimum and maximum vertices set at (0, 0, 0).
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="726">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</record>
|
|
<record name="Euler" c:type="graphene_euler_t" version="1.2" glib:type-name="GrapheneEuler" glib:get-type="graphene_euler_get_type" c:symbol-prefix="euler">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="64">Describe a rotation using Euler angles.
|
|
|
|
The contents of the #graphene_euler_t structure are private
|
|
and should never be accessed directly.</doc>
|
|
|
|
<field name="angles" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<field name="order" readable="0" private="1">
|
|
<type name="EulerOrder" c:type="graphene_euler_order_t"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_euler_alloc" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="54">Allocates a new #graphene_euler_t.
|
|
|
|
The contents of the returned structure are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="61">the newly allocated #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="equal" c:identifier="graphene_euler_equal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="454">Checks if two #graphene_euler_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="461">`true` if the two #graphene_euler_t are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="456">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="457">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_euler_free" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="71">Frees the resources allocated by graphene_euler_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="73">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_order" c:identifier="graphene_euler_get_order" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="520">Retrieves the order used to apply the rotations described in the
|
|
#graphene_euler_t structure, when converting to and from other
|
|
structures, like #graphene_quaternion_t and #graphene_matrix_t.
|
|
|
|
This function does not return the %GRAPHENE_EULER_ORDER_DEFAULT
|
|
enumeration value; it will return the effective order of rotation
|
|
instead.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="532">the order used to apply the rotations</doc>
|
|
<type name="EulerOrder" c:type="graphene_euler_order_t"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="522">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_x" c:identifier="graphene_euler_get_x" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="472">Retrieves the rotation angle on the X axis, in degrees.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="478">the rotation angle</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="474">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_y" c:identifier="graphene_euler_get_y" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="488">Retrieves the rotation angle on the Y axis, in degrees.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="494">the rotation angle</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="490">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_z" c:identifier="graphene_euler_get_z" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="504">Retrieves the rotation angle on the Z axis, in degrees.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="510">the rotation angle</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="506">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_euler_init" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="111">Initializes a #graphene_euler_t using the given angles.
|
|
|
|
The order of the rotations is %GRAPHENE_EULER_ORDER_DEFAULT.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="122">the initialized #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="113">the #graphene_euler_t to initialize</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="114">rotation angle on the X axis, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="115">rotation angle on the Y axis, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="116">rotation angle on the Z axis, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_euler" c:identifier="graphene_euler_init_from_euler" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="417">Initializes a #graphene_euler_t using the angles and order of
|
|
another #graphene_euler_t.
|
|
|
|
If the #graphene_euler_t @src is %NULL, this function is equivalent
|
|
to calling graphene_euler_init() with all angles set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="428">the initialized #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="419">the #graphene_euler_t to initialize</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="420">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_matrix" c:identifier="graphene_euler_init_from_matrix" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="167">Initializes a #graphene_euler_t using the given rotation matrix.
|
|
|
|
If the #graphene_matrix_t @m is %NULL, the #graphene_euler_t will
|
|
be initialized with all angles set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="178">the initialized #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="169">the #graphene_euler_t to initialize</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="m" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="170">a rotation matrix</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
<parameter name="order" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="171">the order used to apply the rotations</doc>
|
|
<type name="EulerOrder" c:type="graphene_euler_order_t"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_quaternion" c:identifier="graphene_euler_init_from_quaternion" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="305">Initializes a #graphene_euler_t using the given normalized quaternion.
|
|
|
|
If the #graphene_quaternion_t @q is %NULL, the #graphene_euler_t will
|
|
be initialized with all angles set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="316">the initialized #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="307">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="q" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="308">a normalized #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</parameter>
|
|
<parameter name="order" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="309">the order used to apply the rotations</doc>
|
|
<type name="EulerOrder" c:type="graphene_euler_order_t"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec3" c:identifier="graphene_euler_init_from_vec3" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="385">Initializes a #graphene_euler_t using the angles contained in a
|
|
#graphene_vec3_t.
|
|
|
|
If the #graphene_vec3_t @v is %NULL, the #graphene_euler_t will be
|
|
initialized with all angles set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="398">the initialized #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="387">the #graphene_euler_t to initialize</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="388">a #graphene_vec3_t containing the rotation
|
|
angles in degrees</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="order" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="390">the order used to apply the rotations</doc>
|
|
<type name="EulerOrder" c:type="graphene_euler_order_t"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_with_order" c:identifier="graphene_euler_init_with_order" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="139">Initializes a #graphene_euler_t with the given angles and @order.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="149">the initialized #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="141">the #graphene_euler_t to initialize</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="142">rotation angle on the X axis, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="143">rotation angle on the Y axis, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="144">rotation angle on the Z axis, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="order" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="145">the order used to apply the rotations</doc>
|
|
<type name="EulerOrder" c:type="graphene_euler_order_t"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="reorder" c:identifier="graphene_euler_reorder" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="705">Reorders a #graphene_euler_t using @order.
|
|
|
|
This function is equivalent to creating a #graphene_quaternion_t from the
|
|
given #graphene_euler_t, and then converting the quaternion into another
|
|
#graphene_euler_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="707">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="order" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="708">the new order</doc>
|
|
<type name="EulerOrder" c:type="graphene_euler_order_t"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="709">return location for the reordered
|
|
#graphene_euler_t</doc>
|
|
<type name="Euler" c:type="graphene_euler_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_matrix" c:identifier="graphene_euler_to_matrix" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="563">Converts a #graphene_euler_t into a transformation matrix expressing
|
|
the extrinsic composition of rotations described by the Euler angles.
|
|
|
|
The rotations are applied over the reference frame axes in the order
|
|
associated with the #graphene_euler_t; for instance, if the order
|
|
used to initialize @e is %GRAPHENE_EULER_ORDER_XYZ:
|
|
|
|
* the first rotation moves the body around the X axis with
|
|
an angle φ
|
|
* the second rotation moves the body around the Y axis with
|
|
an angle of ϑ
|
|
* the third rotation moves the body around the Z axis with
|
|
an angle of ψ
|
|
|
|
The rotation sign convention is left-handed, to preserve compatibility
|
|
between Euler-based, quaternion-based, and angle-axis-based rotations.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="565">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="566">return location for a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_vec3" c:identifier="graphene_euler_to_vec3" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="545">Retrieves the angles of a #graphene_euler_t and initializes a
|
|
#graphene_vec3_t with them.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="547">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.c" line="548">return location for a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<enumeration name="EulerOrder" version="1.2" c:type="graphene_euler_order_t">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="36">Specify the order of the rotations on each axis.
|
|
|
|
The %GRAPHENE_EULER_ORDER_DEFAULT value is special, and is used
|
|
as an alias for one of the other orders.</doc>
|
|
|
|
<member name="default" value="-1" c:identifier="GRAPHENE_EULER_ORDER_DEFAULT">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="38">Rotate in the default order; the
|
|
default order is one of the following enumeration values</doc>
|
|
</member>
|
|
<member name="xyz" value="0" c:identifier="GRAPHENE_EULER_ORDER_XYZ">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="40">Rotate in the X, Y, and Z order</doc>
|
|
</member>
|
|
<member name="yzx" value="1" c:identifier="GRAPHENE_EULER_ORDER_YZX">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="41">Rotate in the Y, Z, and X order</doc>
|
|
</member>
|
|
<member name="zxy" value="2" c:identifier="GRAPHENE_EULER_ORDER_ZXY">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="42">Rotate in the Z, X, and Y order</doc>
|
|
</member>
|
|
<member name="xzy" value="3" c:identifier="GRAPHENE_EULER_ORDER_XZY">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="43">Rotate in the X, Z, and Y order</doc>
|
|
</member>
|
|
<member name="yxz" value="4" c:identifier="GRAPHENE_EULER_ORDER_YXZ">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="44">Rotate in the Y, X, and Z order</doc>
|
|
</member>
|
|
<member name="zyx" value="5" c:identifier="GRAPHENE_EULER_ORDER_ZYX">
|
|
<doc xml:space="preserve" filename="src/graphene-euler.h" line="45">Rotate in the Z, Y, and X order</doc>
|
|
</member>
|
|
</enumeration>
|
|
<record name="Frustum" c:type="graphene_frustum_t" version="1.2" glib:type-name="GrapheneFrustum" glib:get-type="graphene_frustum_get_type" c:symbol-prefix="frustum">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.h" line="36">A 3D volume delimited by 2D clip planes.
|
|
|
|
The contents of the `graphene_frustum_t` are private, and should not be
|
|
modified directly.</doc>
|
|
|
|
<field name="planes" readable="0" private="1">
|
|
<array zero-terminated="0" fixed-size="6" c:type="graphene_plane_t">
|
|
<type name="Plane" c:type="graphene_plane_t"/>
|
|
</array>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_frustum_alloc" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="48">Allocates a new #graphene_frustum_t structure.
|
|
|
|
The contents of the returned structure are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="55">the newly allocated #graphene_frustum_t
|
|
structure. Use graphene_frustum_free() to free the resources
|
|
allocated by this function.</doc>
|
|
<type name="Frustum" c:type="graphene_frustum_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="contains_point" c:identifier="graphene_frustum_contains_point" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="210">Checks whether a point is inside the volume defined by the given
|
|
#graphene_frustum_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="218">`true` if the point is inside the frustum</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="f" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="212">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="const graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="213">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_frustum_equal" version="1.6">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="335">Checks whether the two given #graphene_frustum_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="342">`true` if the given frustums are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="337">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="const graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="338">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="const graphene_frustum_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_frustum_free" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="67">Frees the resources allocated by graphene_frustum_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="f" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="69">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_planes" c:identifier="graphene_frustum_get_planes" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="192">Retrieves the planes that define the given #graphene_frustum_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="f" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="194">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="const graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="planes" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="195">return location for an array
|
|
of 6 #graphene_plane_t</doc>
|
|
<array zero-terminated="0" c:type="graphene_plane_t*" fixed-size="6">
|
|
<type name="Plane" c:type="graphene_plane_t"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_frustum_init" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="81">Initializes the given #graphene_frustum_t using the provided
|
|
clipping planes.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="94">the initialized frustum</doc>
|
|
<type name="Frustum" c:type="graphene_frustum_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="f" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="83">the #graphene_frustum_t to initialize</doc>
|
|
<type name="Frustum" c:type="graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p0" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="84">a clipping plane</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
<parameter name="p1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="85">a clipping plane</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
<parameter name="p2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="86">a clipping plane</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
<parameter name="p3" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="87">a clipping plane</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
<parameter name="p4" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="88">a clipping plane</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
<parameter name="p5" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="89">a clipping plane</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_frustum" c:identifier="graphene_frustum_init_from_frustum" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="117">Initializes the given #graphene_frustum_t using the clipping
|
|
planes of another #graphene_frustum_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="125">the initialized frustum</doc>
|
|
<type name="Frustum" c:type="graphene_frustum_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="f" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="119">the #graphene_frustum_t to initialize</doc>
|
|
<type name="Frustum" c:type="graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="120">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="const graphene_frustum_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_matrix" c:identifier="graphene_frustum_init_from_matrix" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="139">Initializes a #graphene_frustum_t using the given @matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="146">the initialized frustum</doc>
|
|
<type name="Frustum" c:type="graphene_frustum_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="f" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="141">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="matrix" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="142">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="intersects_box" c:identifier="graphene_frustum_intersects_box" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="271">Checks whether the given @box intersects a plane of
|
|
a #graphene_frustum_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="279">`true` if the box intersects the frustum</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="f" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="273">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="const graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="box" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="274">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="intersects_sphere" c:identifier="graphene_frustum_intersects_sphere" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="240">Checks whether the given @sphere intersects a plane of
|
|
a #graphene_frustum_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="248">`true` if the sphere intersects the frustum</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="f" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="242">a #graphene_frustum_t</doc>
|
|
<type name="Frustum" c:type="const graphene_frustum_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="sphere" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-frustum.c" line="243">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<constant name="HAS_GCC" value="1" c:type="GRAPHENE_HAS_GCC">
|
|
|
|
<type name="gint" c:type="gint"/>
|
|
</constant>
|
|
<constant name="HAS_SCALAR" value="1" c:type="GRAPHENE_HAS_SCALAR">
|
|
|
|
<type name="gint" c:type="gint"/>
|
|
</constant>
|
|
<constant name="HAS_SSE" value="1" c:type="GRAPHENE_HAS_SSE">
|
|
|
|
<type name="gint" c:type="gint"/>
|
|
</constant>
|
|
<record name="Matrix" c:type="graphene_matrix_t" glib:type-name="GrapheneMatrix" glib:get-type="graphene_matrix_get_type" c:symbol-prefix="matrix">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.h" line="31">A structure capable of holding a 4x4 matrix.
|
|
|
|
The contents of the #graphene_matrix_t structure are private and
|
|
should never be accessed directly.</doc>
|
|
|
|
<field name="value" readable="0" private="1">
|
|
<type name="Simd4X4F" c:type="graphene_simd4x4f_t"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_matrix_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="69">Allocates a new #graphene_matrix_t.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="74">the newly allocated matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="determinant" c:identifier="graphene_matrix_determinant" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="783">Computes the determinant of the given matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="789">the value of the determinant</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="785">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_matrix_equal" version="1.10">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2249">Checks whether the two given #graphene_matrix_t matrices are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2256">`true` if the two matrices are equal, and `false` otherwise</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2251">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2252">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal_fast" c:identifier="graphene_matrix_equal_fast" version="1.10">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2267">Checks whether the two given #graphene_matrix_t matrices are
|
|
byte-by-byte equal.
|
|
|
|
While this function is faster than graphene_matrix_equal(), it
|
|
can also return false negatives, so it should be used in
|
|
conjuction with either graphene_matrix_equal() or
|
|
graphene_matrix_near(). For instance:
|
|
|
|
|[<!-- language="C" -->
|
|
if (graphene_matrix_equal_fast (a, b))
|
|
{
|
|
// matrices are definitely the same
|
|
}
|
|
else
|
|
{
|
|
if (graphene_matrix_equal (a, b))
|
|
// matrices contain the same values within an epsilon of FLT_EPSILON
|
|
else if (graphene_matrix_near (a, b, 0.0001))
|
|
// matrices contain the same values within an epsilon of 0.0001
|
|
else
|
|
// matrices are not equal
|
|
}
|
|
]|</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2296">`true` if the matrices are equal. and `false` otherwise</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2269">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2270">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_matrix_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="84">Frees the resources allocated by graphene_matrix_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="86">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_row" c:identifier="graphene_matrix_get_row" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="656">Retrieves the given row vector at @index_ inside a matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="658">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="index_" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="659">the index of the row vector, between 0 and 3</doc>
|
|
<type name="guint" c:type="unsigned int"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="660">return location for the #graphene_vec4_t
|
|
that is used to store the row vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_value" c:identifier="graphene_matrix_get_value" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="696">Retrieves the value at the given @row and @col index.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="704">the value at the given indices</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="698">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="row" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="699">the row index</doc>
|
|
<type name="guint" c:type="unsigned int"/>
|
|
</parameter>
|
|
<parameter name="col" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="700">the column index</doc>
|
|
<type name="guint" c:type="unsigned int"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_x_scale" c:identifier="graphene_matrix_get_x_scale" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1739">Retrieves the scaling factor on the X axis in @m.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1745">the value of the scaling factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1741">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_x_translation" c:identifier="graphene_matrix_get_x_translation" version="1.10">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1691">Retrieves the translation component on the X axis from @m.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1697">the translation component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1693">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_y_scale" c:identifier="graphene_matrix_get_y_scale" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1755">Retrieves the scaling factor on the Y axis in @m.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1761">the value of the scaling factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1757">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_y_translation" c:identifier="graphene_matrix_get_y_translation" version="1.10">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1707">Retrieves the translation component on the Y axis from @m.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1713">the translation component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1709">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_z_scale" c:identifier="graphene_matrix_get_z_scale" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1771">Retrieves the scaling factor on the Z axis in @m.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1777">the value of the scaling factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1773">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_z_translation" c:identifier="graphene_matrix_get_z_translation" version="1.10">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1723">Retrieves the translation component on the Z axis from @m.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1729">the translation component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1725">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_2d" c:identifier="graphene_matrix_init_from_2d" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="547">Initializes a #graphene_matrix_t from the values of an affine
|
|
transformation matrix.
|
|
|
|
The arguments map to the following matrix layout:
|
|
|
|
|[<!-- language="plain" -->
|
|
⎛ xx yx ⎞ ⎛ a b 0 ⎞
|
|
⎜ xy yy ⎟ = ⎜ c d 0 ⎟
|
|
⎝ x0 y0 ⎠ ⎝ tx ty 1 ⎠
|
|
]|
|
|
|
|
This function can be used to convert between an affine matrix type
|
|
from other libraries and a #graphene_matrix_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="571">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="549">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="xx" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="550">the xx member</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="yx" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="551">the yx member</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="xy" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="552">the xy member</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="yy" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="553">the yy member</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="x_0" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="554">the x0 member</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="y_0" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="555">the y0 member</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_float" c:identifier="graphene_matrix_init_from_float" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="142">Initializes a #graphene_matrix_t with the given array of floating
|
|
point values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="151">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="144">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="145">an array of at least 16 floating
|
|
point values</doc>
|
|
<array zero-terminated="0" c:type="const float*" fixed-size="16">
|
|
<type name="gfloat" c:type="float"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_matrix" c:identifier="graphene_matrix_init_from_matrix" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="194">Initializes a #graphene_matrix_t using the values of the
|
|
given matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="202">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="196">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="197">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec4" c:identifier="graphene_matrix_init_from_vec4" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="164">Initializes a #graphene_matrix_t with the given four row
|
|
vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="175">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="166">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v0" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="167">the first row vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="v1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="168">the second row vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="v2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="169">the third row vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="v3" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="170">the fourth row vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_frustum" c:identifier="graphene_matrix_init_frustum" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="301">Initializes a #graphene_matrix_t compatible with #graphene_frustum_t.
|
|
|
|
See also: graphene_frustum_init_from_matrix()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="315">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="303">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="left" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="304">distance of the left clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="right" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="305">distance of the right clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="bottom" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="306">distance of the bottom clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="top" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="307">distance of the top clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z_near" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="308">distance of the near clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z_far" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="309">distance of the far clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_identity" c:identifier="graphene_matrix_init_identity" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="124">Initializes a #graphene_matrix_t with the identity matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="130">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="126">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_look_at" c:identifier="graphene_matrix_init_look_at" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="273">Initializes a #graphene_matrix_t so that it positions the "camera"
|
|
at the given @eye coordinates towards an object at the @center
|
|
coordinates. The top of the camera is aligned to the direction
|
|
of the @up vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="286">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="275">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="eye" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="276">the vector describing the position to look from</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="center" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="277">the vector describing the position to look at</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="up" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="278">the vector describing the world's upward direction; usually,
|
|
this is the graphene_vec3_y_axis() vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_ortho" c:identifier="graphene_matrix_init_ortho" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="243">Initializes a #graphene_matrix_t with an orthographic projection.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="255">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="245">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="left" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="246">the left edge of the clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="right" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="247">the right edge of the clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="top" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="248">the top edge of the clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="bottom" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="249">the bottom edge of the clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z_near" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="250">the distance of the near clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z_far" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="251">the distance of the far clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_perspective" c:identifier="graphene_matrix_init_perspective" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="215">Initializes a #graphene_matrix_t with a perspective projection.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="225">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="217">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="fovy" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="218">the field of view angle, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="aspect" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="219">the aspect value</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z_near" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="220">the near Z plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z_far" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="221">the far Z plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_rotate" c:identifier="graphene_matrix_init_rotate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="418">Initializes @m to represent a rotation of @angle degrees on
|
|
the axis represented by the @axis vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="427">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="420">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="angle" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="421">the rotation angle, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="axis" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="422">the axis vector as a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_scale" c:identifier="graphene_matrix_init_scale" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="333">Initializes a #graphene_matrix_t with the given scaling factors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="342">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="335">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="336">the scale factor on the X axis</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="337">the scale factor on the Y axis</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="338">the scale factor on the Z axis</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_skew" c:identifier="graphene_matrix_init_skew" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="386">Initializes a #graphene_matrix_t with a skew transformation
|
|
with the given factors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="395">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="388">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x_skew" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="389">skew factor, in radians, on the X axis</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y_skew" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="390">skew factor, in radians, on the Y axis</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_translate" c:identifier="graphene_matrix_init_translate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="361">Initializes a #graphene_matrix_t with a translation to the
|
|
given coordinates.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="369">the initialized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="363">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="364">the translation coordinates</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="interpolate" c:identifier="graphene_matrix_interpolate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2008">Linearly interpolates the two given #graphene_matrix_t by
|
|
interpolating the decomposed transformations separately.
|
|
|
|
If either matrix cannot be reduced to their transformations
|
|
then the interpolation cannot be performed, and this function
|
|
will return an identity matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2010">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2011">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2012">the linear interpolation factor</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2013">return location for the
|
|
interpolated matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="inverse" c:identifier="graphene_matrix_inverse" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1623">Inverts the given matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1631">`true` if the matrix is invertible</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1625">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1626">return location for the
|
|
inverse matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="is_2d" c:identifier="graphene_matrix_is_2d" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="459">Checks whether the given #graphene_matrix_t is compatible with an
|
|
a 2D affine transformation matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="466">`true` if the matrix is compatible with an affine
|
|
transformation matrix</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="461">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="is_backface_visible" c:identifier="graphene_matrix_is_backface_visible" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="505">Checks whether a #graphene_matrix_t has a visible back face.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="511">`true` if the back face of the matrix is visible</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="507">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="is_identity" c:identifier="graphene_matrix_is_identity" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="443">Checks whether the given #graphene_matrix_t is the identity matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="449">`true` if the matrix is the identity matrix</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="445">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="is_singular" c:identifier="graphene_matrix_is_singular" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="527">Checks whether a matrix is singular.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="533">`true` if the matrix is singular</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="529">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="multiply" c:identifier="graphene_matrix_multiply" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="761">Multiplies two #graphene_matrix_t.
|
|
|
|
Matrix multiplication is not commutative in general; the order of the factors matters.
|
|
The product of this multiplication is (@a × @b)</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="763">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="764">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="765">return location for the matrix
|
|
result</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="near" c:identifier="graphene_matrix_near" version="1.10">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2210">Compares the two given #graphene_matrix_t matrices and check
|
|
whether their values are within the given @epsilon of each
|
|
other.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2219">`true` if the two matrices are near each other, and
|
|
`false` otherwise</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2212">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2213">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
<parameter name="epsilon" transfer-ownership="none">
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize" c:identifier="graphene_matrix_normalize" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1664">Normalizes the given #graphene_matrix_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1666">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1667">return location for the normalized matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="perspective" c:identifier="graphene_matrix_perspective" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1642">Applies a perspective of @depth to the matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1644">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="depth" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1645">the depth of the perspective</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1646">return location for the
|
|
perspective matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="print" c:identifier="graphene_matrix_print" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2188">Prints the contents of a matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="2190">The matrix to print</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="project_point" c:identifier="graphene_matrix_project_point" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1102">Projects a #graphene_point_t using the matrix @m.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1104">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1105">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1106">return location for the projected
|
|
point</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="project_rect" c:identifier="graphene_matrix_project_rect" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1179">Projects a #graphene_rect_t using the given matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1181">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1182">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1183">return location for the projected
|
|
rectangle</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="project_rect_bounds" c:identifier="graphene_matrix_project_rect_bounds" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1136">Projects a #graphene_rect_t using the given matrix.
|
|
|
|
The resulting rectangle is the axis aligned bounding rectangle capable
|
|
of containing fully the projected rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1138">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1139">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1140">return location for the projected
|
|
rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="rotate" c:identifier="graphene_matrix_rotate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1419">Adds a rotation transformation to @m, using the given @angle
|
|
and @axis vector.
|
|
|
|
This is the equivalent of calling graphene_matrix_init_rotate() and
|
|
then multiplying the matrix @m with the rotation matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1421">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="angle" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1422">the rotation angle, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="axis" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1423">the rotation axis, as a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="rotate_euler" c:identifier="graphene_matrix_rotate_euler" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1388">Adds a rotation transformation to @m, using the given
|
|
#graphene_euler_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1390">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1391">a rotation described by a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="rotate_quaternion" c:identifier="graphene_matrix_rotate_quaternion" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1365">Adds a rotation transformation to @m, using the given
|
|
#graphene_quaternion_t.
|
|
|
|
This is the equivalent of calling graphene_quaternion_to_matrix() and
|
|
then multiplying @m with the rotation matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1367">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1368">a rotation described by a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="rotate_x" c:identifier="graphene_matrix_rotate_x" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1441">Adds a rotation transformation around the X axis to @m, using
|
|
the given @angle.
|
|
|
|
See also: graphene_matrix_rotate()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1443">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="angle" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1444">the rotation angle, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="rotate_y" c:identifier="graphene_matrix_rotate_y" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1461">Adds a rotation transformation around the Y axis to @m, using
|
|
the given @angle.
|
|
|
|
See also: graphene_matrix_rotate()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1463">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="angle" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1464">the rotation angle, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="rotate_z" c:identifier="graphene_matrix_rotate_z" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1481">Adds a rotation transformation around the Z axis to @m, using
|
|
the given @angle.
|
|
|
|
See also: graphene_matrix_rotate()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1483">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="angle" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1484">the rotation angle, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="scale" c:identifier="graphene_matrix_scale" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1501">Adds a scaling transformation to @m, using the three
|
|
given factors.
|
|
|
|
This is the equivalent of calling graphene_matrix_init_scale() and then
|
|
multiplying the matrix @m with the scale matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1503">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor_x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1504">scaling factor on the X axis</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="factor_y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1505">scaling factor on the Y axis</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="factor_z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1506">scaling factor on the Z axis</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="skew_xy" c:identifier="graphene_matrix_skew_xy" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1528">Adds a skew of @factor on the X and Y axis to the given matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1530">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1531">skew factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="skew_xz" c:identifier="graphene_matrix_skew_xz" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1549">Adds a skew of @factor on the X and Z axis to the given matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1551">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1552">skew factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="skew_yz" c:identifier="graphene_matrix_skew_yz" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1570">Adds a skew of @factor on the Y and Z axis to the given matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1572">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1573">skew factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_2d" c:identifier="graphene_matrix_to_2d" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="592">Converts a #graphene_matrix_t to an affine transformation
|
|
matrix, if the given matrix is compatible.
|
|
|
|
The returned values have the following layout:
|
|
|
|
|[<!-- language="plain" -->
|
|
⎛ xx yx ⎞ ⎛ a b 0 ⎞
|
|
⎜ xy yy ⎟ = ⎜ c d 0 ⎟
|
|
⎝ x0 y0 ⎠ ⎝ tx ty 1 ⎠
|
|
]|
|
|
|
|
This function can be used to convert between a #graphene_matrix_t
|
|
and an affine matrix type from other libraries.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="616">`true` if the matrix is compatible with an affine
|
|
transformation matrix</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="594">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="xx" direction="out" caller-allocates="0" transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="595">return location for the xx member</doc>
|
|
<type name="gdouble" c:type="double*"/>
|
|
</parameter>
|
|
<parameter name="yx" direction="out" caller-allocates="0" transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="596">return location for the yx member</doc>
|
|
<type name="gdouble" c:type="double*"/>
|
|
</parameter>
|
|
<parameter name="xy" direction="out" caller-allocates="0" transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="597">return location for the xy member</doc>
|
|
<type name="gdouble" c:type="double*"/>
|
|
</parameter>
|
|
<parameter name="yy" direction="out" caller-allocates="0" transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="598">return location for the yy member</doc>
|
|
<type name="gdouble" c:type="double*"/>
|
|
</parameter>
|
|
<parameter name="x_0" direction="out" caller-allocates="0" transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="599">return location for the x0 member</doc>
|
|
<type name="gdouble" c:type="double*"/>
|
|
</parameter>
|
|
<parameter name="y_0" direction="out" caller-allocates="0" transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="600">return location for the y0 member</doc>
|
|
<type name="gdouble" c:type="double*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_float" c:identifier="graphene_matrix_to_float" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="98">Converts a #graphene_matrix_t to an array of floating point
|
|
values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="100">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="101">return location
|
|
for an array of floating point values. The array must be capable
|
|
of holding at least 16 values.</doc>
|
|
<array zero-terminated="0" c:type="float*" fixed-size="16">
|
|
<type name="gfloat" c:type="float"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_bounds" c:identifier="graphene_matrix_transform_bounds" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="946">Transforms each corner of a #graphene_rect_t using the given matrix @m.
|
|
|
|
The result is the axis aligned bounding rectangle containing the coplanar
|
|
quadrilateral.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="948">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="949">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="950">return location for the bounds
|
|
of the transformed rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_box" c:identifier="graphene_matrix_transform_box" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1045">Transforms the vertices of a #graphene_box_t using the given matrix @m.
|
|
|
|
The result is the axis aligned bounding box containing the transformed
|
|
vertices.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1047">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1048">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1049">return location for the bounds
|
|
of the transformed box</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_point" c:identifier="graphene_matrix_transform_point" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="847">Transforms the given #graphene_point_t using the matrix @m.
|
|
|
|
Unlike graphene_matrix_transform_vec3(), this function will take into
|
|
account the fourth row vector of the #graphene_matrix_t when computing
|
|
the dot product of each row vector of the matrix.
|
|
|
|
See also: graphene_simd4x4f_point3_mul()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="849">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="850">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="851">return location for the
|
|
transformed #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_point3d" c:identifier="graphene_matrix_transform_point3d" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="878">Transforms the given #graphene_point3d_t using the matrix @m.
|
|
|
|
Unlike graphene_matrix_transform_vec3(), this function will take into
|
|
account the fourth row vector of the #graphene_matrix_t when computing
|
|
the dot product of each row vector of the matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="880">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="881">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="882">return location for the result</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_ray" c:identifier="graphene_matrix_transform_ray" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1074">Transform a #graphene_ray_t using the given matrix @m.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1076">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1077">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1078">return location for the
|
|
transformed ray</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_rect" c:identifier="graphene_matrix_transform_rect" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="907">Transforms each corner of a #graphene_rect_t using the given matrix @m.
|
|
|
|
The result is a coplanar quadrilateral.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="909">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="910">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="911">return location for the
|
|
transformed quad</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_sphere" c:identifier="graphene_matrix_transform_sphere" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1017">Transforms a #graphene_sphere_t using the given matrix @m. The
|
|
result is the bounding sphere containing the transformed sphere.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1019">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1020">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1021">return location for the bounds
|
|
of the transformed sphere</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_vec3" c:identifier="graphene_matrix_transform_vec3" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="803">Transforms the given #graphene_vec3_t using the matrix @m.
|
|
|
|
This function will multiply the X, Y, and Z row vectors of the matrix @m
|
|
with the corresponding components of the vector @v. The W row vector will
|
|
be ignored.
|
|
|
|
See also: graphene_simd4x4f_vec3_mul()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="805">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="806">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="807">return location for a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transform_vec4" c:identifier="graphene_matrix_transform_vec4" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="827">Transforms the given #graphene_vec4_t using the matrix @m.
|
|
|
|
See also: graphene_simd4x4f_vec4_mul()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="829">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="830">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="831">return location for a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="translate" c:identifier="graphene_matrix_translate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1342">Adds a translation transformation to @m using the coordinates
|
|
of the given #graphene_point3d_t.
|
|
|
|
This is the equivalent of calling graphene_matrix_init_translate() and
|
|
then multiplying @m with the translation matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1344">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="pos" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1345">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="transpose" c:identifier="graphene_matrix_transpose" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1606">Transposes the given matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1608">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1609">return location for the
|
|
transposed matrix</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="unproject_point3d" c:identifier="graphene_matrix_unproject_point3d" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1302">Unprojects the given @point using the @projection matrix and
|
|
a @modelview matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="projection" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1304">a #graphene_matrix_t for the projection matrix</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="modelview" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1305">a #graphene_matrix_t for the modelview matrix; this is
|
|
the inverse of the modelview used when projecting the point</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1307">a #graphene_point3d_t with the coordinates of the point</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1308">return location for the unprojected
|
|
point</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="untransform_bounds" c:identifier="graphene_matrix_untransform_bounds" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1257">Undoes the transformation on the corners of a #graphene_rect_t using the
|
|
given matrix, within the given axis aligned rectangular @bounds.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1259">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1260">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="bounds" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1261">the bounds of the transformation</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1262">return location for the
|
|
untransformed rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="untransform_point" c:identifier="graphene_matrix_untransform_point" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1212">Undoes the transformation of a #graphene_point_t using the
|
|
given matrix, within the given axis aligned rectangular @bounds.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1223">`true` if the point was successfully untransformed</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1214">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1215">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="bounds" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1216">the bounds of the transformation</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-matrix.c" line="1217">return location for the
|
|
untransformed point</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<constant name="PI" value="3.141593" c:type="GRAPHENE_PI">
|
|
|
|
<type name="gdouble" c:type="gdouble"/>
|
|
</constant>
|
|
<constant name="PI_2" value="1.570796" c:type="GRAPHENE_PI_2">
|
|
|
|
<type name="gdouble" c:type="gdouble"/>
|
|
</constant>
|
|
<record name="Plane" c:type="graphene_plane_t" version="1.2" glib:type-name="GraphenePlane" glib:get-type="graphene_plane_get_type" c:symbol-prefix="plane">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.h" line="36">A 2D plane that extends infinitely in a 3D volume.
|
|
|
|
The contents of the `graphene_plane_t` are private, and should not be
|
|
modified directly.</doc>
|
|
|
|
<field name="normal" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<field name="constant" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_plane_alloc" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="47">Allocates a new #graphene_plane_t structure.
|
|
|
|
The contents of the returned structure are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="54">the newly allocated #graphene_plane_t.
|
|
Use graphene_plane_free() to free the resources allocated by
|
|
this function</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="distance" c:identifier="graphene_plane_distance" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="261">Computes the distance of @point from a #graphene_plane_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="268">the distance of the given #graphene_point3d_t from the plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="263">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="264">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_plane_equal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="328">Checks whether the two given #graphene_plane_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="335">`true` if the given planes are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="330">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="331">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_plane_free" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="66">Frees the resources allocated by graphene_plane_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="68">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_constant" c:identifier="graphene_plane_get_constant" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="300">Retrieves the distance along the normal vector of the
|
|
given #graphene_plane_t from the origin.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="307">the constant value of the plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="302">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_normal" c:identifier="graphene_plane_get_normal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="283">Retrieves the normal vector pointing towards the origin of the
|
|
given #graphene_plane_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="285">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="normal" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="286">return location for the normal vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_plane_init" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="80">Initializes the given #graphene_plane_t using the given @normal vector
|
|
and @constant values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="92">the initialized plane</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="82">the #graphene_plane_t to initialize</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="normal" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="83">a unit length normal vector defining the plane
|
|
pointing towards the origin; if unset, we use the X axis by default</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="constant" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="85">the distance from the origin to the plane along the
|
|
normal vector; the sign determines the half-space occupied by the
|
|
plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_plane" c:identifier="graphene_plane_init_from_plane" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="134">Initializes the given #graphene_plane_t using the normal
|
|
vector and constant of another #graphene_plane_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="142">the initialized plane</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="136">the #graphene_plane_t to initialize</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="137">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_point" c:identifier="graphene_plane_init_from_point" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="156">Initializes the given #graphene_plane_t using the given normal vector
|
|
and an arbitrary co-planar point.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="165">the initialized plane</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="158">the #graphene_plane_t to initialize</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="normal" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="159">a normal vector defining the plane pointing towards the origin</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="160">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_points" c:identifier="graphene_plane_init_from_points" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="184">Initializes the given #graphene_plane_t using the 3 provided co-planar
|
|
points.
|
|
|
|
The winding order is counter-clockwise, and determines which direction
|
|
the normal vector will point.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="197">the initialized plane</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="186">the #graphene_plane_t to initialize</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="187">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="188">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="c" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="189">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec4" c:identifier="graphene_plane_init_from_vec4" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="111">Initializes the given #graphene_plane_t using the components of
|
|
the given #graphene_vec4_t vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="120">the initialized plane</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="113">the #graphene_plane_t to initialize</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="114">a #graphene_vec4_t containing the normal vector in its first
|
|
three components, and the distance in its fourth component</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="negate" c:identifier="graphene_plane_negate" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="243">Negates the normal vector and constant of a #graphene_plane_t, effectively
|
|
mirroring the plane across the origin.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="245">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="246">return location for the negated plane</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize" c:identifier="graphene_plane_normalize" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="223">Normalizes the vector of the given #graphene_plane_t,
|
|
and adjusts the constant accordingly.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="225">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-plane.c" line="226">return location for the normalized plane</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<record name="Point" c:type="graphene_point_t" version="1.0" glib:type-name="GraphenePoint" glib:get-type="graphene_point_get_type" c:symbol-prefix="point">
|
|
<doc xml:space="preserve" filename="src/graphene-point.h" line="60">A point with two coordinates.</doc>
|
|
|
|
<field name="x" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-point.h" line="62">the X coordinate of the point</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="y" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-point.h" line="63">the Y coordinate of the point</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_point_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="45">Allocates a new #graphene_point_t structure.
|
|
|
|
The coordinates of the returned point are (0, 0).
|
|
|
|
It's possible to chain this function with graphene_point_init()
|
|
or graphene_point_init_from_point(), e.g.:
|
|
|
|
|[<!-- language="C" -->
|
|
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);
|
|
}
|
|
]|</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="69">the newly allocated #graphene_point_t.
|
|
Use graphene_point_free() to free the resources allocated by
|
|
this function.</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="distance" c:identifier="graphene_point_distance" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="194">Computes the distance between @a and @b.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="203">the distance between the two points</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="196">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="197">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="d_x" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="198">distance component on the X axis</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
<parameter name="d_y" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="199">distance component on the Y axis</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_point_equal" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="171">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
|
|
graphene_point_near() instead.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="183">`true` if the points have the same coordinates</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="173">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="174">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_point_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="81">Frees the resources allocated by graphene_point_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="83">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_point_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="95">Initializes @p to the given @x and @y coordinates.
|
|
|
|
It's safe to call this function multiple times.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="105">the initialized point</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="97">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="98">the X coordinate</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="99">the Y coordinate</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_point" c:identifier="graphene_point_init_from_point" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="120">Initializes @p with the same coordinates of @src.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="127">the initialized point</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="122">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="123">the #graphene_point_t to use</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec2" c:identifier="graphene_point_init_from_vec2" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="140">Initializes @p with the coordinates inside the given #graphene_vec2_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="147">the initialized point</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="142">the #graphene_point_t to initialize</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="143">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="interpolate" c:identifier="graphene_point_interpolate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="258">Linearly interpolates the coordinates of @a and @b using the
|
|
given @factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="260">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="261">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="262">the linear interpolation factor</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="263">return location for the interpolated
|
|
point</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="near" c:identifier="graphene_point_near" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="229">Checks whether the two points @a and @b are within
|
|
the threshold of @epsilon.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="238">`true` if the distance is within @epsilon</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="231">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="232">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="epsilon" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="233">threshold between the two points</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_vec2" c:identifier="graphene_point_to_vec2" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="281">Stores the coordinates of the given #graphene_point_t into a
|
|
#graphene_vec2_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="283">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="284">return location for the vertex</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<function name="zero" c:identifier="graphene_point_zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="300">Returns a point fixed at (0, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="305">a fixed point</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</record>
|
|
<record name="Point3D" c:type="graphene_point3d_t" version="1.0" glib:type-name="GraphenePoint3D" glib:get-type="graphene_point3d_get_type" c:symbol-prefix="point3d">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.h" line="56">A point with three components: X, Y, and Z.</doc>
|
|
|
|
<field name="x" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.h" line="58">the X coordinate</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="y" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.h" line="59">the Y coordinate</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="z" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.h" line="60">the Z coordinate</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_point3d_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="45">Allocates a #graphene_point3d_t structure.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="50">the newly allocated structure.
|
|
Use graphene_point3d_free() to free the resources
|
|
allocated by this function.</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="cross" c:identifier="graphene_point3d_cross" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="262">Computes the cross product of the two given #graphene_point3d_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="264">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="265">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="266">return location for the cross
|
|
product</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="distance" c:identifier="graphene_point3d_distance" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="348">Computes the distance between the two given #graphene_point3d_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="357">the distance between two points</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="350">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="351">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="delta" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="352">return location for the distance
|
|
components on the X, Y, and Z axis</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="dot" c:identifier="graphene_point3d_dot" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="285">Computes the dot product of the two given #graphene_point3d_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="292">the value of the dot product</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="287">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="288">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_point3d_equal" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="190">Checks whether two given points are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="197">`true` if the points are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="192">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="193">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_point3d_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="62">Frees the resources allocated via graphene_point3d_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="64">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_point3d_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="76">Initializes a #graphene_point3d_t with the given coordinates.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="85">the initialized #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="78">the #graphene_point3d_t to initialize</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="79">the X coordinate of the point</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="80">the Y coordinate of the point</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="81">the Z coordinate of the point</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_point" c:identifier="graphene_point3d_init_from_point" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="123">Initializes a #graphene_point3d_t using the coordinates of
|
|
another #graphene_point3d_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="131">the initialized point</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="125">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="126">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec3" c:identifier="graphene_point3d_init_from_vec3" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="144">Initializes a #graphene_point3d_t using the components
|
|
of a #graphene_vec3_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="152">the initialized #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="146">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="147">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="interpolate" c:identifier="graphene_point3d_interpolate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="383">Linearly interpolates each component of @a and @b using the
|
|
provided @factor, and places the result in @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="385">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="386">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="387">the interpolation factor</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="388">the return location for the
|
|
interpolated #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="length" c:identifier="graphene_point3d_length" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="306">Computes the length of the vector represented by the
|
|
coordinates of the given #graphene_point3d_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="313">the length of the vector represented by the point</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="308">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="near" c:identifier="graphene_point3d_near" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="208">Checks whether the two points are near each other, within
|
|
an @epsilon factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="217">`true` if the points are near each other</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="210">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="211">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="epsilon" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="212">fuzzyness factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize" c:identifier="graphene_point3d_normalize" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="325">Computes the normalization of the vector represented by the
|
|
coordinates of the given #graphene_point3d_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="327">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="328">return location for the normalized
|
|
#graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize_viewport" c:identifier="graphene_point3d_normalize_viewport" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="407">Normalizes the coordinates of a #graphene_point3d_t using the
|
|
given viewport and clipping planes.
|
|
|
|
The coordinates of the resulting #graphene_point3d_t will be
|
|
in the [ -1, 1 ] range.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="409">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="viewport" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="410">a #graphene_rect_t representing a viewport</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="z_near" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="411">the coordinate of the near clipping plane, or 0 for
|
|
the default near clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z_far" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="413">the coordinate of the far clipping plane, or 1 for the
|
|
default far clipping plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="415">the return location for the
|
|
normalized #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="scale" c:identifier="graphene_point3d_scale" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="238">Scales the coordinates of the given #graphene_point3d_t by
|
|
the given @factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="240">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="241">the scaling factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="242">return location for the scaled point</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_vec3" c:identifier="graphene_point3d_to_vec3" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="163">Stores the coordinates of a #graphene_point3d_t into a
|
|
#graphene_vec3_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="165">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="166">return location for a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<function name="zero" c:identifier="graphene_point3d_zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="444">Retrieves a constant point with all three coordinates set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="449">a zero point</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</record>
|
|
<record name="Quad" c:type="graphene_quad_t" version="1.0" glib:type-name="GrapheneQuad" glib:get-type="graphene_quad_get_type" c:symbol-prefix="quad">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.h" line="32">A 4 vertex quadrilateral, as represented by four #graphene_point_t.
|
|
|
|
The contents of a #graphene_quad_t are private and should never be
|
|
accessed directly.</doc>
|
|
|
|
<field name="points" readable="0" private="1">
|
|
<array zero-terminated="0" fixed-size="4" c:type="graphene_point_t">
|
|
<type name="Point" c:type="graphene_point_t"/>
|
|
</array>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_quad_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="42">Allocates a new #graphene_quad_t instance.
|
|
|
|
The contents of the returned instance are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="49">the newly created #graphene_quad_t instance</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="bounds" c:identifier="graphene_quad_bounds" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="174">Computes the bounding rectangle of @q and places it into @r.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="176">a #graphene_quad_t</doc>
|
|
<type name="Quad" c:type="const graphene_quad_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="r" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="177">return location for a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="contains" c:identifier="graphene_quad_contains" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="146">Checks if the given #graphene_quad_t contains the given #graphene_point_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="153">`true` if the point is inside the #graphene_quad_t</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="148">a #graphene_quad_t</doc>
|
|
<type name="Quad" c:type="const graphene_quad_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="149">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_quad_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="59">Frees the resources allocated by graphene_quad_alloc()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="61">a #graphene_quad_t</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_point" c:identifier="graphene_quad_get_point" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="203">Retrieves the point of a #graphene_quad_t at the given index.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="210">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="205">a #graphene_quad_t</doc>
|
|
<type name="Quad" c:type="const graphene_quad_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="index_" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="206">the index of the point to retrieve</doc>
|
|
<type name="guint" c:type="unsigned int"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_quad_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="73">Initializes a #graphene_quad_t with the given points.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="83">the initialized #graphene_quad_t</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="75">the #graphene_quad_t to initialize</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="76">the first point of the quadrilateral</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="p2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="77">the second point of the quadrilateral</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="p3" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="78">the third point of the quadrilateral</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="p4" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="79">the fourth point of the quadrilateral</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_points" c:identifier="graphene_quad_init_from_points" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="126">Initializes a #graphene_quad_t using an array of points.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="133">the initialized #graphene_quad_t</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="128">the #graphene_quad_t to initialize</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="points" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="129">an array of 4 #graphene_point_t</doc>
|
|
<array zero-terminated="0" c:type="const graphene_point_t*" fixed-size="4">
|
|
<type name="Point" c:type="graphene_point_t"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_rect" c:identifier="graphene_quad_init_from_rect" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="102">Initializes a #graphene_quad_t using the four corners of the
|
|
given #graphene_rect_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="110">the initialized #graphene_quad_t</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="104">the #graphene_quad_t to initialize</doc>
|
|
<type name="Quad" c:type="graphene_quad_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quad.c" line="105">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<record name="Quaternion" c:type="graphene_quaternion_t" version="1.0" glib:type-name="GrapheneQuaternion" glib:get-type="graphene_quaternion_get_type" c:symbol-prefix="quaternion">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.h" line="36">A quaternion.
|
|
|
|
The contents of the #graphene_quaternion_t structure are private
|
|
and should never be accessed directly.</doc>
|
|
|
|
<field name="x" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="y" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="z" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="w" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_quaternion_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="51">Allocates a new #graphene_quaternion_t.
|
|
|
|
The contents of the returned value are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="58">the newly allocated #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="dot" c:identifier="graphene_quaternion_dot" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="647">Computes the dot product of two #graphene_quaternion_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="654">the value of the dot products</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="649">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="650">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_quaternion_equal" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="629">Checks whether the given quaternions are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="636">`true` if the quaternions are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="631">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="632">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_quaternion_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="68">Releases the resources allocated by graphene_quaternion_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="70">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_quaternion_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="82">Initializes a #graphene_quaternion_t using the given four values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="92">the initialized quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="84">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="85">the first component of the quaternion</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="86">the second component of the quaternion</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="87">the third component of the quaternion</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="w" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="88">the fourth component of the quaternion</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_angle_vec3" c:identifier="graphene_quaternion_init_from_angle_vec3" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="454">Initializes a #graphene_quaternion_t using an @angle on a
|
|
specific @axis.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="463">the initialized quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="456">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="angle" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="457">the rotation on a given axis, in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="axis" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="458">the axis of rotation, expressed as a vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_angles" c:identifier="graphene_quaternion_init_from_angles" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="309">Initializes a #graphene_quaternion_t using the values of
|
|
the [Euler angles](http://en.wikipedia.org/wiki/Euler_angles)
|
|
on each axis.
|
|
|
|
See also: graphene_quaternion_init_from_euler()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="322">the initialized quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="311">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="deg_x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="312">rotation angle on the X axis (yaw), in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="deg_y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="313">rotation angle on the Y axis (pitch), in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="deg_z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="314">rotation angle on the Z axis (roll), in degrees</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_euler" c:identifier="graphene_quaternion_init_from_euler" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="525">Initializes a #graphene_quaternion_t using the given #graphene_euler_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="532">the initialized #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="527">the #graphene_quaternion_t to initialize</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="e" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="528">a #graphene_euler_t</doc>
|
|
<type name="Euler" c:type="const graphene_euler_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_matrix" c:identifier="graphene_quaternion_init_from_matrix" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="196">Initializes a #graphene_quaternion_t using the rotation components
|
|
of a transformation matrix.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="204">the initialized quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="198">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="m" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="199">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="const graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_quaternion" c:identifier="graphene_quaternion_init_from_quaternion" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="131">Initializes a #graphene_quaternion_t with the values from @src.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="138">the initialized quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="133">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="134">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_radians" c:identifier="graphene_quaternion_init_from_radians" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="338">Initializes a #graphene_quaternion_t using the values of
|
|
the [Euler angles](http://en.wikipedia.org/wiki/Euler_angles)
|
|
on each axis.
|
|
|
|
See also: graphene_quaternion_init_from_euler()</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="351">the initialized quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="340">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="rad_x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="341">rotation angle on the X axis (yaw), in radians</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="rad_y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="342">rotation angle on the Y axis (pitch), in radians</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="rad_z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="343">rotation angle on the Z axis (roll), in radians</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec4" c:identifier="graphene_quaternion_init_from_vec4" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="160">Initializes a #graphene_quaternion_t with the values from @src.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="167">the initialized quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="162">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="163">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_identity" c:identifier="graphene_quaternion_init_identity" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="111">Initializes a #graphene_quaternion_t using the identity
|
|
transformation.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="118">the initialized quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="113">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="invert" c:identifier="graphene_quaternion_invert" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="668">Inverts a #graphene_quaternion_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="670">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="671">return location for the inverted
|
|
quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize" c:identifier="graphene_quaternion_normalize" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="688">Normalizes a #graphene_quaternion_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="690">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="691">return location for the normalized
|
|
quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="slerp" c:identifier="graphene_quaternion_slerp" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="262">Interpolates between the two given quaternions using a spherical
|
|
linear interpolation, or [SLERP](http://en.wikipedia.org/wiki/Slerp),
|
|
using the given interpolation @factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="264">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="265">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="266">the linear interpolation factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="267">return location for the interpolated
|
|
quaternion</doc>
|
|
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_angle_vec3" c:identifier="graphene_quaternion_to_angle_vec3" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="489">Converts a quaternion into an @angle, @axis pair.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="491">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="angle" direction="out" caller-allocates="0" transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="492">return location for the angle, in degrees</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
<parameter name="axis" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="493">return location for the rotation axis</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_angles" c:identifier="graphene_quaternion_to_angles" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="376">Converts a #graphene_quaternion_t to its corresponding rotations
|
|
on the [Euler angles](http://en.wikipedia.org/wiki/Euler_angles)
|
|
on each axis.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="378">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="deg_x" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="379">return location for the rotation angle on
|
|
the X axis (yaw), in degrees</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
<parameter name="deg_y" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="381">return location for the rotation angle on
|
|
the Y axis (pitch), in degrees</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
<parameter name="deg_z" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="383">return location for the rotation angle on
|
|
the Z axis (roll), in degrees</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_matrix" c:identifier="graphene_quaternion_to_matrix" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="233">Converts a quaternion into a transformation matrix expressing
|
|
the rotation defined by the #graphene_quaternion_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="235">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="m" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="236">a #graphene_matrix_t</doc>
|
|
<type name="Matrix" c:type="graphene_matrix_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_radians" c:identifier="graphene_quaternion_to_radians" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="410">Converts a #graphene_quaternion_t to its corresponding rotations
|
|
on the [Euler angles](http://en.wikipedia.org/wiki/Euler_angles)
|
|
on each axis.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="412">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="rad_x" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="413">return location for the rotation angle on
|
|
the X axis (yaw), in radians</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
<parameter name="rad_y" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="415">return location for the rotation angle on
|
|
the Y axis (pitch), in radians</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
<parameter name="rad_z" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="417">return location for the rotation angle on
|
|
the Z axis (roll), in radians</doc>
|
|
<type name="gfloat" c:type="float*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_vec4" c:identifier="graphene_quaternion_to_vec4" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="178">Copies the components of a #graphene_quaternion_t into a
|
|
#graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="q" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="180">a #graphene_quaternion_t</doc>
|
|
<type name="Quaternion" c:type="const graphene_quaternion_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-quaternion.c" line="181">return location for a
|
|
#graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<record name="Ray" c:type="graphene_ray_t" version="1.4" glib:type-name="GrapheneRay" glib:get-type="graphene_ray_get_type" c:symbol-prefix="ray">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.h" line="36">A ray emitted from an origin in a given direction.
|
|
|
|
The contents of the `graphene_ray_t` structure are private, and should not
|
|
be modified directly.</doc>
|
|
|
|
<field name="origin" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<field name="direction" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_ray_alloc" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="46">Allocates a new #graphene_ray_t structure.
|
|
|
|
The contents of the returned structure are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="53">the newly allocated #graphene_ray_t.
|
|
Use graphene_ray_free() to free the resources allocated by
|
|
this function</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="equal" c:identifier="graphene_ray_equal" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="306">Checks whether the two given #graphene_ray_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="313">`true` if the given rays are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="308">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="309">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_ray_free" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="65">Frees the resources allocated by graphene_ray_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="67">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_closest_point_to_point" c:identifier="graphene_ray_get_closest_point_to_point" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="324">Computes the point on the given #graphene_ray_t that is closest to the
|
|
given point @p.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="326">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="327">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="328">return location for the closest point3d</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_direction" c:identifier="graphene_ray_get_direction" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="175">Retrieves the direction of the given #graphene_ray_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="177">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="direction" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="178">return location for the direction</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_distance_to_plane" c:identifier="graphene_ray_get_distance_to_plane" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="255">Computes the distance of the origin of the given #graphene_ray_t from the
|
|
given plane.
|
|
|
|
If the ray does not intersect the plane, this function returns `INFINITY`.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="265">the distance of the origin of the ray from the plane</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="257">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="258">a #graphene_plane_t</doc>
|
|
<type name="Plane" c:type="const graphene_plane_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_distance_to_point" c:identifier="graphene_ray_get_distance_to_point" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="215">Computes the distance from the origin of the given ray to the given point.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="222">the distance of the point</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="217">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="218">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_origin" c:identifier="graphene_ray_get_origin" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="159">Retrieves the origin of the given #graphene_ray_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="161">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="origin" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="162">return location for the origin</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_position_at" c:identifier="graphene_ray_get_position_at" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="191">Retrieves the coordinates of a point at the distance @t along the
|
|
given #graphene_ray_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="193">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="194">the distance along the ray</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="position" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="195">return location for the position</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_ray_init" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="79">Initializes the given #graphene_ray_t using the given @origin
|
|
and @direction values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="88">the initialized ray</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="81">the #graphene_ray_t to initialize</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="origin" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="82">the origin of the ray</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="direction" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="83">the direction vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_ray" c:identifier="graphene_ray_init_from_ray" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="110">Initializes the given #graphene_ray_t using the origin and direction
|
|
values of another #graphene_ray_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="118">the initialized ray</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="112">the #graphene_ray_t to initialize</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="113">a #graphene_ray_t</doc>
|
|
<type name="Ray" c:type="const graphene_ray_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec3" c:identifier="graphene_ray_init_from_vec3" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="129">Initializes the given #graphene_ray_t using the given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="137">the initialized ray</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="131">the #graphene_ray_t to initialize</doc>
|
|
<type name="Ray" c:type="graphene_ray_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="origin" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="132">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="direction" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-ray.c" line="133">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<record name="Rect" c:type="graphene_rect_t" version="1.0" glib:type-name="GrapheneRect" glib:get-type="graphene_rect_get_type" c:symbol-prefix="rect">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.h" line="62">The location and size of a rectangle region.
|
|
|
|
The width and height of a #graphene_rect_t can be negative; for instance,
|
|
a #graphene_rect_t with an origin of [ 0, 0 ] and a size of [ 10, 10 ] is
|
|
equivalent to a #graphene_rect_t with an origin of [ 10, 10 ] and a size
|
|
of [ -10, -10 ].
|
|
|
|
Application code can normalize rectangles using graphene_rect_normalize();
|
|
this function will ensure that the width and height of a rectangle are
|
|
positive values. All functions taking a #graphene_rect_t as an argument
|
|
will internally operate on a normalized copy; all functions returning a
|
|
#graphene_rect_t will always return a normalized rectangle.</doc>
|
|
|
|
<field name="origin" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.h" line="64">the coordinates of the origin of the rectangle</doc>
|
|
<type name="Point" c:type="graphene_point_t"/>
|
|
</field>
|
|
<field name="size" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.h" line="65">the size of the rectangle</doc>
|
|
<type name="Size" c:type="graphene_size_t"/>
|
|
</field>
|
|
<method name="contains_point" c:identifier="graphene_rect_contains_point" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="523">Checks whether a #graphene_rect_t contains the given coordinates.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="530">`true` if the rectangle contains the point</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="525">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="526">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="contains_rect" c:identifier="graphene_rect_contains_rect" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="549">Checks whether a #graphene_rect_t fully contains the given
|
|
rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="557">`true` if the rectangle @a fully contains @b</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="551">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="552">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_rect_equal" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="175">Checks whether the two given rectangle are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="182">`true` if the rectangles are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="177">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="178">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="expand" c:identifier="graphene_rect_expand" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="759">Expands a #graphene_rect_t to contain the given #graphene_point_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="761">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="762">a #graphene_point_t</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="763">return location for the expanded rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_rect_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="88">Frees the resources allocated by graphene_rect_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="90">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_bottom_left" c:identifier="graphene_rect_get_bottom_left" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="304">Retrieves the coordinates of the bottom-left corner of the given rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="306">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="307">return location for a #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_bottom_right" c:identifier="graphene_rect_get_bottom_right" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="325">Retrieves the coordinates of the bottom-right corner of the given rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="327">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="328">return location for a #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_center" c:identifier="graphene_rect_get_center" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="239">Retrieves the coordinates of the center of the given rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="241">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="242">return location for a #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_height" c:identifier="graphene_rect_get_height" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="422">Retrieves the normalized height of the given rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="428">the normalized height of the rectangle</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="424">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_top_left" c:identifier="graphene_rect_get_top_left" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="262">Retrieves the coordinates of the top-left corner of the given rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="264">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="265">return location for a #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_top_right" c:identifier="graphene_rect_get_top_right" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="283">Retrieves the coordinates of the top-right corner of the given rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="285">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="286">return location for a #graphene_point_t</doc>
|
|
<type name="Point" c:type="graphene_point_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_vertices" c:identifier="graphene_rect_get_vertices" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="348">Computes the four vertices of a #graphene_rect_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="350">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="vertices" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="351">return location for an array
|
|
of 4 #graphene_vec2_t</doc>
|
|
<array zero-terminated="0" c:type="graphene_vec2_t*" fixed-size="4">
|
|
<type name="Vec2" c:type="graphene_vec2_t"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_width" c:identifier="graphene_rect_get_width" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="410">Retrieves the normalized width of the given rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="416">the normalized width of the rectangle</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="412">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_x" c:identifier="graphene_rect_get_x" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="384">Retrieves the normalized X coordinate of the origin of the given
|
|
rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="391">the normalized X coordinate of the rectangle</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="386">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_y" c:identifier="graphene_rect_get_y" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="397">Retrieves the normalized Y coordinate of the origin of the given
|
|
rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="404">the normalized Y coordinate of the rectangle</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="399">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_rect_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="102">Initializes the given #graphene_rect_t with the given values.
|
|
|
|
This function will implicitly normalize the #graphene_rect_t
|
|
before returning.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="115">the initialized rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="104">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="105">the X coordinate of the @graphene_rect_t.origin</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="106">the Y coordinate of the @graphene_rect_t.origin</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="width" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="107">the width of the @graphene_rect_t.size</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="height" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="108">the height of the @graphene_rect_t.size</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_rect" c:identifier="graphene_rect_init_from_rect" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="134">Initializes @r using the given @src rectangle.
|
|
|
|
This function will implicitly normalize the #graphene_rect_t
|
|
before returning.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="144">the initialized rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="136">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="137">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="inset" c:identifier="graphene_rect_inset" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="622">Changes the given rectangle to be smaller, or larger depending on the
|
|
given inset parameters.
|
|
|
|
To create an inset rectangle, use positive @d_x or @d_y values; to
|
|
create a larger, encompassing rectangle, use negative @d_x or @d_y
|
|
values.
|
|
|
|
The origin of the rectangle is offset by @d_x and @d_y, while the size
|
|
is adjusted by `(2 * @d_x, 2 * @d_y)`. If @d_x and @d_y are positive
|
|
values, the size of the rectangle is decreased; if @d_x and @d_y are
|
|
negative values, the size of the rectangle is increased.
|
|
|
|
If the size of the resulting inset rectangle has a negative width or
|
|
height then the size will be set to zero.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="643">the inset rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="624">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="d_x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="625">the horizontal inset</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="d_y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="626">the vertical inset</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="inset_r" c:identifier="graphene_rect_inset_r" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="657">Changes the given rectangle to be smaller, or larger depending on the
|
|
given inset parameters.
|
|
|
|
To create an inset rectangle, use positive @d_x or @d_y values; to
|
|
create a larger, encompassing rectangle, use negative @d_x or @d_y
|
|
values.
|
|
|
|
The origin of the rectangle is offset by @d_x and @d_y, while the size
|
|
is adjusted by `(2 * @d_x, 2 * @d_y)`. If @d_x and @d_y are positive
|
|
values, the size of the rectangle is decreased; if @d_x and @d_y are
|
|
negative values, the size of the rectangle is increased.
|
|
|
|
If the size of the resulting inset rectangle has a negative width or
|
|
height then the size will be set to zero.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="659">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="d_x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="660">the horizontal inset</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="d_y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="661">the vertical inset</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="662">return location for the inset rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="interpolate" c:identifier="graphene_rect_interpolate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="782">Linearly interpolates the origin and size of the two given
|
|
rectangles.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="784">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="785">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="786">the linear interpolation factor</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="787">return location for the
|
|
interpolated rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="intersection" c:identifier="graphene_rect_intersection" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="470">Computes the intersection of the two given rectangles.
|
|
|
|
|
|
|
|
The intersection in the image above is the blue outline.
|
|
|
|
If the two rectangles do not intersect, @res will contain
|
|
a degenerate rectangle with origin in (0, 0) and a size of 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="486">`true` if the two rectangles intersect</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="472">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="473">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="474">return location for
|
|
a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize" c:identifier="graphene_rect_normalize" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="193">Normalizes the passed rectangle.
|
|
|
|
This function ensures that the size of the rectangle is made of
|
|
positive values, and that the origin is the top-left corner of
|
|
the rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="203">the normalized rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="195">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize_r" c:identifier="graphene_rect_normalize_r" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="215">Normalizes the passed rectangle.
|
|
|
|
This function ensures that the size of the rectangle is made of
|
|
positive values, and that the origin is in the top-left corner
|
|
of the rectangle.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="217">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="218">the return location for the
|
|
normalized rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="offset" c:identifier="graphene_rect_offset" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="572">Offsets the origin by @d_x and @d_y.
|
|
|
|
The size of the rectangle is unchanged.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="582">the offset rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="574">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="d_x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="575">the horizontal offset</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="d_y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="576">the vertical offset</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="offset_r" c:identifier="graphene_rect_offset_r" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="596">Offsets the origin of the given rectangle by @d_x and @d_y.
|
|
|
|
The size of the rectangle is left unchanged.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="598">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="d_x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="599">the horizontal offset</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="d_y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="600">the vertical offset</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="601">return location for the offset
|
|
rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="round" c:identifier="graphene_rect_round" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="731">Rounds the origin and size of the given rectangle to
|
|
their nearest integer values; the rounding is guaranteed
|
|
to be large enough to contain the original rectangle.
|
|
|
|
This function is the equivalent of calling `floor` on
|
|
the coordinates of the origin, and `ceil` on the size.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="733">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="734">return location for the
|
|
rounded rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="round_to_pixel" c:identifier="graphene_rect_round_to_pixel" version="1.0" deprecated="1" deprecated-version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="709">Rounds the origin and the size of the given rectangle to
|
|
their nearest integer values; the rounding is guaranteed
|
|
to be large enough to contain the original rectangle.</doc>
|
|
<doc-deprecated xml:space="preserve">Use graphene_rect_round() instead</doc-deprecated>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="717">the pixel-aligned rectangle.</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="711">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="scale" c:identifier="graphene_rect_scale" version="1.10">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="833">Scales the size and origin of a rectangle horizontaly by @s_h,
|
|
and vertically by @s_v. The result @res is normalized.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="r" transfer-ownership="none">
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="s_h" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="835">horizontal scale factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="s_v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="836">vertical scale factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="837">return location for the
|
|
scaled rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="union" c:identifier="graphene_rect_union" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="436">Computes the union of the two given rectangles.
|
|
|
|
|
|
|
|
The union in the image above is the blue outline.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="438">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="439">a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="440">return location for a #graphene_rect_t</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<function name="alloc" c:identifier="graphene_rect_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="71">Allocates a new #graphene_rect_t.
|
|
|
|
The contents of the returned rectangle are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="78">the newly allocated rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="zero" c:identifier="graphene_rect_zero" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="817">Returns a degenerate rectangle with origin fixed at (0, 0) and
|
|
a size of 0, 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="823">a fixed rectangle</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</record>
|
|
<constant name="SIMD_S" value="sse" c:type="GRAPHENE_SIMD_S">
|
|
|
|
<type name="utf8" c:type="gchar*"/>
|
|
</constant>
|
|
<record name="Simd4F" c:type="graphene_simd4f_t">
|
|
|
|
<field name="x" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="y" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="z" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="w" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
</record>
|
|
<record name="Simd4X4F" c:type="graphene_simd4x4f_t">
|
|
|
|
<field name="x" readable="0" private="1">
|
|
<type name="Simd4F" c:type="graphene_simd4f_t"/>
|
|
</field>
|
|
<field name="y" readable="0" private="1">
|
|
<type name="Simd4F" c:type="graphene_simd4f_t"/>
|
|
</field>
|
|
<field name="z" readable="0" private="1">
|
|
<type name="Simd4F" c:type="graphene_simd4f_t"/>
|
|
</field>
|
|
<field name="w" readable="0" private="1">
|
|
<type name="Simd4F" c:type="graphene_simd4f_t"/>
|
|
</field>
|
|
</record>
|
|
<record name="Size" c:type="graphene_size_t" version="1.0" glib:type-name="GrapheneSize" glib:get-type="graphene_size_get_type" c:symbol-prefix="size">
|
|
<doc xml:space="preserve" filename="src/graphene-size.h" line="60">A size.</doc>
|
|
|
|
<field name="width" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-size.h" line="62">the width</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<field name="height" writable="1">
|
|
<doc xml:space="preserve" filename="src/graphene-size.h" line="63">the height</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_size_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="38">Allocates a new #graphene_size_t.
|
|
|
|
The contents of the returned value are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="45">the newly allocated #graphene_size_t</doc>
|
|
<type name="Size" c:type="graphene_size_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="equal" c:identifier="graphene_size_equal" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="124">Checks whether the two give #graphene_size_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="131">`true` if the sizes are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="126">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="const graphene_size_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="127">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="const graphene_size_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_size_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="55">Frees the resources allocated by graphene_size_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="57">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="graphene_size_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_size_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="69">Initializes a #graphene_size_t using the given @width and @height.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="77">the initialized #graphene_size_t</doc>
|
|
<type name="Size" c:type="graphene_size_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="71">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="graphene_size_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="width" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="72">the width</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="height" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="73">the height</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_size" c:identifier="graphene_size_init_from_size" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="92">Initializes a #graphene_size_t using the width and height of
|
|
the given @src.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="100">the initialized #graphene_size_t</doc>
|
|
<type name="Size" c:type="graphene_size_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="94">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="graphene_size_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="95">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="const graphene_size_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="interpolate" c:identifier="graphene_size_interpolate" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="163">Linearly interpolates the two given #graphene_size_t using the given
|
|
interpolation @factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="165">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="const graphene_size_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="166">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="const graphene_size_t*"/>
|
|
</parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="167">the linear interpolation factor</doc>
|
|
<type name="gdouble" c:type="double"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="168">return location for the interpolated size</doc>
|
|
<type name="Size" c:type="graphene_size_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="scale" c:identifier="graphene_size_scale" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="142">Scales the components of a #graphene_size_t using the given @factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="144">a #graphene_size_t</doc>
|
|
<type name="Size" c:type="const graphene_size_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="145">the scaling factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="146">return location for the scaled size</doc>
|
|
<type name="Size" c:type="graphene_size_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<function name="zero" c:identifier="graphene_size_zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="187">A constant pointer to a zero #graphene_size_t, useful for
|
|
equality checks and interpolations.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="193">a constant size</doc>
|
|
<type name="Size" c:type="const graphene_size_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</record>
|
|
<record name="Sphere" c:type="graphene_sphere_t" version="1.2" glib:type-name="GrapheneSphere" glib:get-type="graphene_sphere_get_type" c:symbol-prefix="sphere">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.h" line="36">A sphere, represented by its center and radius.</doc>
|
|
|
|
<field name="center" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<field name="radius" readable="0" private="1">
|
|
<type name="gfloat" c:type="float"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_sphere_alloc" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="44">Allocates a new #graphene_sphere_t.
|
|
|
|
The contents of the newly allocated structure are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="51">the newly allocated #graphene_sphere_t. Use
|
|
graphene_sphere_free() to free the resources allocated by this function</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="contains_point" c:identifier="graphene_sphere_contains_point" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="259">Checks whether the given @point is contained in the volume
|
|
of a #graphene_sphere_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="267">`true` if the sphere contains the point</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="261">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="262">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="distance" c:identifier="graphene_sphere_distance" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="287">Computes the distance of the given @point from the surface of
|
|
a #graphene_sphere_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="295">the distance of the point</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="289">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="290">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_sphere_equal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="361">Checks whether two #graphene_sphere_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="368">`true` if the spheres are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="363">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="364">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_sphere_free" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="62">Frees the resources allocated by graphene_sphere_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="64">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_bounding_box" c:identifier="graphene_sphere_get_bounding_box" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="310">Computes the bounding box capable of containing the
|
|
given #graphene_sphere_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="312">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="box" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="313">return location for the bounding box</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_center" c:identifier="graphene_sphere_get_center" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="212">Retrieves the coordinates of the center of a #graphene_sphere_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="214">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="center" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="215">return location for the coordinates of
|
|
the center</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_radius" c:identifier="graphene_sphere_get_radius" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="229">Retrieves the radius of a #graphene_sphere_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="231">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_sphere_init" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="76">Initializes the given #graphene_sphere_t with the given @center and @radius.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="85">the initialized #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="78">the #graphene_sphere_t to initialize</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="center" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="79">the coordinates of the center of the sphere, or %NULL
|
|
for a center in (0, 0, 0)</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="radius" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="81">the radius of the sphere</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_points" c:identifier="graphene_sphere_init_from_points" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="114">Initializes the given #graphene_sphere_t using the given array
|
|
of 3D coordinates so that the sphere includes them.
|
|
|
|
The center of the sphere can either be specified, or will be center
|
|
of the 3D volume that encompasses all @points.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="127">the initialized #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="116">the #graphene_sphere_t to initialize</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="n_points" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="117">the number of #graphene_point3d_t in the @points array</doc>
|
|
<type name="guint" c:type="unsigned int"/>
|
|
</parameter>
|
|
<parameter name="points" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="118">an array of #graphene_point3d_t</doc>
|
|
<array length="0" zero-terminated="0" c:type="const graphene_point3d_t*">
|
|
<type name="Point3D" c:type="graphene_point3d_t"/>
|
|
</array>
|
|
</parameter>
|
|
<parameter name="center" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="119">the center of the sphere</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vectors" c:identifier="graphene_sphere_init_from_vectors" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="166">Initializes the given #graphene_sphere_t using the given array
|
|
of 3D coordinates so that the sphere includes them.
|
|
|
|
The center of the sphere can either be specified, or will be center
|
|
of the 3D volume that encompasses all @vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="179">the initialized #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="168">the #graphene_sphere_t to initialize</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="n_vectors" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="169">the number of #graphene_vec3_t in the @vectors array</doc>
|
|
<type name="guint" c:type="unsigned int"/>
|
|
</parameter>
|
|
<parameter name="vectors" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="170">an array of #graphene_vec3_t</doc>
|
|
<array length="0" zero-terminated="0" c:type="const graphene_vec3_t*">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</array>
|
|
</parameter>
|
|
<parameter name="center" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="171">the center of the sphere</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="is_empty" c:identifier="graphene_sphere_is_empty" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="243">Checks whether the sphere has a zero radius.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="249">`true` if the sphere is empty</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="245">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="translate" c:identifier="graphene_sphere_translate" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="328">Translates the center of the given #graphene_sphere_t using the @point
|
|
coordinates as the delta of the translation.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="s" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="330">a #graphene_sphere_t</doc>
|
|
<type name="Sphere" c:type="const graphene_sphere_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="point" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="331">the coordinates of the translation</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-sphere.c" line="332">return location for the translated sphere</doc>
|
|
<type name="Sphere" c:type="graphene_sphere_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<record name="Triangle" c:type="graphene_triangle_t" version="1.2" glib:type-name="GrapheneTriangle" glib:get-type="graphene_triangle_get_type" c:symbol-prefix="triangle">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.h" line="36">A triangle.</doc>
|
|
|
|
<field name="a" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<field name="b" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<field name="c" readable="0" private="1">
|
|
<type name="Vec3" c:type="graphene_vec3_t"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_triangle_alloc" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="45">Allocates a new #graphene_triangle_t.
|
|
|
|
The contents of the returned structure are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="52">the newly allocated #graphene_triangle_t
|
|
structure. Use graphene_triangle_free() to free the resources
|
|
allocated by this function</doc>
|
|
<type name="Triangle" c:type="graphene_triangle_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="contains_point" c:identifier="graphene_triangle_contains_point" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="406">Checks whether the given triangle @t contains the point @p.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="413">`true` if the point is inside the triangle</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="408">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="409">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_triangle_equal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="448">Checks whether the two given #graphene_triangle_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="455">`true` if the triangles are equal</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="450">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="451">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_triangle_free" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="64">Frees the resources allocated by graphene_triangle_alloc().</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="66">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_area" c:identifier="graphene_triangle_get_area" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="206">Computes the area of the given #graphene_triangle_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="212">the area of the triangle</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="208">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_barycoords" c:identifier="graphene_triangle_get_barycoords" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="356">Computes the [barycentric coordinates](http://en.wikipedia.org/wiki/Barycentric_coordinate_system)
|
|
of the given point @p.
|
|
|
|
The point @p must lie on the same plane as the triangle @t; if the
|
|
point is not coplanar, the result of this function is undefined.
|
|
|
|
If we place the origin in the coordinates of the triangle's A point,
|
|
the barycentric coordinates are `u`, which is on the AC vector; and `v`
|
|
which is on the AB vector:
|
|
|
|
|
|
|
|
The returned #graphene_vec2_t contains the following values, in order:
|
|
|
|
- `res.x = u`
|
|
- `res.y = v`</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="380">`true` if the barycentric coordinates are valid</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="358">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="p" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="359">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="360">return location for the vector
|
|
with the barycentric coordinates</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_bounding_box" c:identifier="graphene_triangle_get_bounding_box" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="305">Computes the bounding box of the given #graphene_triangle_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="307">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="308">return location for the box</doc>
|
|
<type name="Box" c:type="graphene_box_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_midpoint" c:identifier="graphene_triangle_get_midpoint" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="229">Computes the coordinates of the midpoint of the given #graphene_triangle_t.
|
|
|
|
The midpoint G is the [centroid](https://en.wikipedia.org/wiki/Centroid#Triangle_centroid)
|
|
of the triangle, i.e. the intersection of its medians.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="231">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="232">return location for the coordinates of
|
|
the midpoint</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_normal" c:identifier="graphene_triangle_get_normal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="255">Computes the normal vector of the given #graphene_triangle_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="257">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="258">return location for the normal vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_plane" c:identifier="graphene_triangle_get_plane" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="283">Computes the plane based on the vertices of the given #graphene_triangle_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="285">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="286">return location for the plane</doc>
|
|
<type name="Plane" c:type="graphene_plane_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_points" c:identifier="graphene_triangle_get_points" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="152">Retrieves the three vertices of the given #graphene_triangle_t and returns
|
|
their coordinates as #graphene_point3d_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="154">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="a" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="155">return location for the coordinates
|
|
of the first vertex</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="b" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="157">return location for the coordinates
|
|
of the second vertex</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="c" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="159">return location for the coordinates
|
|
of the third vertex</doc>
|
|
<type name="Point3D" c:type="graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_vertices" c:identifier="graphene_triangle_get_vertices" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="181">Retrieves the three vertices of the given #graphene_triangle_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="183">a #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="const graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="a" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="184">return location for the first vertex</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="b" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="185">return location for the second vertex</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="c" direction="out" caller-allocates="1" transfer-ownership="none" optional="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="186">return location for the third vertex</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_point3d" c:identifier="graphene_triangle_init_from_point3d" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="78">Initializes a #graphene_triangle_t using the three given 3D points.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="87">the initialized #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="graphene_triangle_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="80">the #graphene_triangle_t to initialize</doc>
|
|
<type name="Triangle" c:type="graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="a" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="81">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="b" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="82">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
<parameter name="c" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="83">a #graphene_point3d_t</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec3" c:identifier="graphene_triangle_init_from_vec3" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="115">Initializes a #graphene_triangle_t using the three given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="124">the initialized #graphene_triangle_t</doc>
|
|
<type name="Triangle" c:type="graphene_triangle_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="t" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="117">the #graphene_triangle_t to initialize</doc>
|
|
<type name="Triangle" c:type="graphene_triangle_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="a" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="118">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="b" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="119">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="c" transfer-ownership="none" nullable="1" allow-none="1">
|
|
<doc xml:space="preserve" filename="src/graphene-triangle.c" line="120">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
</record>
|
|
<constant name="VEC2_LEN" value="2" c:type="GRAPHENE_VEC2_LEN" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-types.h" line="37">Evaluates to the number of components of a #graphene_vec2_t.</doc>
|
|
|
|
<type name="gint" c:type="gint"/>
|
|
</constant>
|
|
<constant name="VEC3_LEN" value="3" c:type="GRAPHENE_VEC3_LEN" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-types.h" line="46">Evaluates to the number of components of a #graphene_vec3_t.</doc>
|
|
|
|
<type name="gint" c:type="gint"/>
|
|
</constant>
|
|
<constant name="VEC4_LEN" value="4" c:type="GRAPHENE_VEC4_LEN" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-types.h" line="55">Evaluates to the number of components of a #graphene_vec4_t.</doc>
|
|
|
|
<type name="gint" c:type="gint"/>
|
|
</constant>
|
|
<record name="Vec2" c:type="graphene_vec2_t" glib:type-name="GrapheneVec2" glib:get-type="graphene_vec2_get_type" c:symbol-prefix="vec2">
|
|
<doc xml:space="preserve" filename="src/graphene-vec2.h" line="35">A structure capable of holding a vector with two dimensions, x and y.
|
|
|
|
The contents of the #graphene_vec2_t structure are private and should
|
|
never be accessed directly.</doc>
|
|
|
|
<field name="value" readable="0" private="1">
|
|
<type name="Simd4F" c:type="graphene_simd4f_t"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_vec2_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="53">Allocates a new #graphene_vec2_t structure.
|
|
|
|
The contents of the returned structure are undefined.
|
|
|
|
Use graphene_vec2_init() to initialize the vector.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="62">the newly allocated #graphene_vec2_t
|
|
structure. Use graphene_vec2_free() to free the resources allocated
|
|
by this function.</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="add" c:identifier="graphene_vec2_add" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="202">Adds each component of the two passed vectors and places
|
|
each result into the components of @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="204">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="205">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="206">return location for the result</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="divide" c:identifier="graphene_vec2_divide" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="260">Divides each component of the first operand @a by the corresponding
|
|
component of the second operand @b, and places the results into the
|
|
vector @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="262">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="263">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="264">return location for the result</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="dot" c:identifier="graphene_vec2_dot" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="280">Computes the dot product of the two given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="287">the dot product of the vectors</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="282">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="283">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_vec2_equal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="419">Checks whether the two given #graphene_vec2_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="426">`true` if the two vectors are equal, and false otherwise</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="421">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="422">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_vec2_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="74">Frees the resources allocated by @v</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="76">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_x" c:identifier="graphene_vec2_get_x" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="153">Retrieves the X component of the #graphene_vec2_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="159">the value of the X component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="155">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_y" c:identifier="graphene_vec2_get_y" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="169">Retrieves the Y component of the #graphene_vec2_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="175">the value of the Y component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="171">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_vec2_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="88">Initializes a #graphene_vec2_t using the given values.
|
|
|
|
This function can be called multiple times.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="98">the initialized vector</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="90">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="91">the X field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="92">the Y field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_float" c:identifier="graphene_vec2_init_from_float" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="132">Initializes @v with the contents of the given array.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="140">the initialized vector</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="134">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="135">an array of floating point values
|
|
with at least two elements</doc>
|
|
<array zero-terminated="0" c:type="const float*" fixed-size="2">
|
|
<type name="gfloat" c:type="float"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec2" c:identifier="graphene_vec2_init_from_vec2" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="112">Copies the contents of @src into @v.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="119">the initialized vector</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="114">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="115">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="length" c:identifier="graphene_vec2_length" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="298">Computes the length of the given vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="304">the length of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="300">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="max" c:identifier="graphene_vec2_max" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="353">Compares the two given vectors and places the maximum
|
|
values of each component into @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="355">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="356">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="357">the resulting vector</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="min" c:identifier="graphene_vec2_min" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="334">Compares the two given vectors and places the minimum
|
|
values of each component into @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="336">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="337">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="338">the resulting vector</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="multiply" c:identifier="graphene_vec2_multiply" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="241">Multiplies each component of the two passed vectors and places
|
|
each result into the components of @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="243">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="244">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="245">return location for the result</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="near" c:identifier="graphene_vec2_near" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="437">Compares the two given #graphene_vec2_t vectors and checks
|
|
whether their values are within the given @epsilon.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="446">`true` if the two vectors are near each other</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="439">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="440">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
<parameter name="epsilon" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="441">the threshold between the two vectors</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="negate" c:identifier="graphene_vec2_negate" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="390">Negates the given #graphene_vec2_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="392">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="393">return location for the result vector</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize" c:identifier="graphene_vec2_normalize" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="314">Computes the normalized vector for the given vector @v.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="316">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="317">return location for the
|
|
normalized vector</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="scale" c:identifier="graphene_vec2_scale" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="372">Multiplies all components of the given vector with the given scalar @factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="374">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="375">the scalar factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="376">return location for the result vector</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="subtract" c:identifier="graphene_vec2_subtract" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="221">Subtracts from each component of the first operand @a the
|
|
corresponding component of the second operand @b and places
|
|
each result into the components of @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="223">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="224">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="225">return location for the result</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_float" c:identifier="graphene_vec2_to_float" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="185">Stores the components of @v into an array.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="187">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="dest" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="188">return location
|
|
for an array of floating point values with at least 2 elements</doc>
|
|
<array zero-terminated="0" c:type="float*" fixed-size="2">
|
|
<type name="gfloat" c:type="float"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<function name="one" c:identifier="graphene_vec2_one" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="554">Retrieves a constant vector with (1, 1) components.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="559">the one vector</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="x_axis" c:identifier="graphene_vec2_x_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="571">Retrieves a constant vector with (1, 0) components.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="576">the X axis vector</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="y_axis" c:identifier="graphene_vec2_y_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="588">Retrieves a constant vector with (0, 1) components.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="593">the Y axis vector</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="zero" c:identifier="graphene_vec2_zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="537">Retrieves a constant vector with (0, 0) components.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="542">the zero vector</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</record>
|
|
<record name="Vec3" c:type="graphene_vec3_t" glib:type-name="GrapheneVec3" glib:get-type="graphene_vec3_get_type" c:symbol-prefix="vec3">
|
|
<doc xml:space="preserve" filename="src/graphene-vec3.h" line="35">A structure capable of holding a vector with three dimensions: x, y, and z.
|
|
|
|
The contents of the #graphene_vec3_t structure are private and should
|
|
never be accessed directly.</doc>
|
|
|
|
<field name="value" readable="0" private="1">
|
|
<type name="Simd4F" c:type="graphene_simd4f_t"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_vec3_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="609">Allocates a new #graphene_vec3_t structure.
|
|
|
|
The contents of the returned structure are undefined.
|
|
|
|
Use graphene_vec3_init() to initialize the vector.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="618">the newly allocated #graphene_vec3_t
|
|
structure. Use graphene_vec3_free() to free the resources allocated
|
|
by this function.</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="add" c:identifier="graphene_vec3_add" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="777">Adds each component of the two given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="779">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="780">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="781">return location for the resulting vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="cross" c:identifier="graphene_vec3_cross" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="853">Computes the cross product of the two given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="855">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="856">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="857">return location for the resulting vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="divide" c:identifier="graphene_vec3_divide" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="833">Divides each component of the first operand @a by the corresponding
|
|
component of the second operand @b, and places the results into the
|
|
vector @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="835">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="836">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="837">return location for the resulting vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="dot" c:identifier="graphene_vec3_dot" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="871">Computes the dot product of the two given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="878">the value of the dot product</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="873">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="874">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_vec3_equal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1098">Checks whether the two given #graphene_vec3_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1105">`true` if the two vectors are equal, and false otherwise</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1100">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1101">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_vec3_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="630">Frees the resources allocated by @v</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="632">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_x" c:identifier="graphene_vec3_get_x" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="712">Retrieves the first component of the given vector @v.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="718">the value of the first component of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="714">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_xy" c:identifier="graphene_vec3_get_xy" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="980">Creates a #graphene_vec2_t that contains the first and second
|
|
components of the given #graphene_vec3_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="982">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="983">return location for a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_xy0" c:identifier="graphene_vec3_get_xy0" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="997">Creates a #graphene_vec3_t that contains the first two components of
|
|
the given #graphene_vec3_t, and the third component set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="999">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1000">return location for a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_xyz0" c:identifier="graphene_vec3_get_xyz0" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1014">Converts a #graphene_vec3_t in a #graphene_vec4_t using 0.0
|
|
as the value for the fourth component of the resulting vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1016">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1017">return location for the vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_xyz1" c:identifier="graphene_vec3_get_xyz1" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1031">Converts a #graphene_vec3_t in a #graphene_vec4_t using 1.0
|
|
as the value for the fourth component of the resulting vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1033">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1034">return location for the vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_xyzw" c:identifier="graphene_vec3_get_xyzw" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1049">Converts a #graphene_vec3_t in a #graphene_vec4_t using @w as
|
|
the value of the fourth component of the resulting vector.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1051">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="w" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1052">the value of the W component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1053">return location for the vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_y" c:identifier="graphene_vec3_get_y" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="728">Retrieves the second component of the given vector @v.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="734">the value of the second component of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="730">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_z" c:identifier="graphene_vec3_get_z" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="744">Retrieves the third component of the given vector @v.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="750">the value of the third component of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="746">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_vec3_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="644">Initializes a #graphene_vec3_t using the given values.
|
|
|
|
This function can be called multiple times.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="655">a pointer to the initialized
|
|
vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="646">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="647">the X field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="648">the Y field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="649">the Z field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_float" c:identifier="graphene_vec3_init_from_float" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="692">Initializes a #graphene_vec3_t with the values from an array.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="699">the initialized vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="694">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="695">an array of 3 floating point values</doc>
|
|
<array zero-terminated="0" c:type="const float*" fixed-size="3">
|
|
<type name="gfloat" c:type="float"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec3" c:identifier="graphene_vec3_init_from_vec3" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="671">Initializes a #graphene_vec3_t with the values of another
|
|
#graphene_vec3_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="679">the initialized vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="673">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="674">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="length" c:identifier="graphene_vec3_length" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="889">Retrieves the length of the given vector @v.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="895">the value of the length of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="891">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="max" c:identifier="graphene_vec3_max" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="943">Compares each component of the two given vectors and creates a
|
|
vector that contains the maximum values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="945">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="946">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="947">return location for the result vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="min" c:identifier="graphene_vec3_min" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="924">Compares each component of the two given vectors and creates a
|
|
vector that contains the minimum values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="926">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="927">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="928">return location for the result vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="multiply" c:identifier="graphene_vec3_multiply" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="815">Multiplies each component of the two given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="817">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="818">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="819">return location for the resulting vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="near" c:identifier="graphene_vec3_near" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1116">Compares the two given #graphene_vec3_t vectors and checks
|
|
whether their values are within the given @epsilon.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1125">`true` if the two vectors are near each other</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1118">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1119">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="epsilon" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1120">the threshold between the two vectors</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="negate" c:identifier="graphene_vec3_negate" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1069">Negates the given #graphene_vec3_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1071">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1072">return location for the result vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize" c:identifier="graphene_vec3_normalize" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="905">Normalizes the given #graphene_vec3_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="907">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="908">return location for the normalized vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="scale" c:identifier="graphene_vec3_scale" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="962">Multiplies all components of the given vector with the given scalar @factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="964">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="965">the scalar factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="966">return location for the result vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="subtract" c:identifier="graphene_vec3_subtract" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="795">Subtracts from each component of the first operand @a the
|
|
corresponding component of the second operand @b and places
|
|
each result into the components of @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="797">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="798">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="799">return location for the resulting vector</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_float" c:identifier="graphene_vec3_to_float" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="760">Copies the components of a #graphene_vec3_t into the given array.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="762">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="dest" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="763">return location for
|
|
an array of floating point values</doc>
|
|
<array zero-terminated="0" c:type="float*" fixed-size="3">
|
|
<type name="gfloat" c:type="float"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<function name="one" c:identifier="graphene_vec3_one" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1236">Provides a constant pointer to a vector with three components,
|
|
all sets to 1.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1242">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="x_axis" c:identifier="graphene_vec3_x_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1254">Provides a constant pointer to a vector with three components
|
|
with values set to (1, 0, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1260">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="y_axis" c:identifier="graphene_vec3_y_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1272">Provides a constant pointer to a vector with three components
|
|
with values set to (0, 1, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1278">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="z_axis" c:identifier="graphene_vec3_z_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1290">Provides a constant pointer to a vector with three components
|
|
with values set to (0, 0, 1).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1296">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="zero" c:identifier="graphene_vec3_zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1218">Provides a constant pointer to a vector with three components,
|
|
all sets to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1224">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</record>
|
|
<record name="Vec4" c:type="graphene_vec4_t" glib:type-name="GrapheneVec4" glib:get-type="graphene_vec4_get_type" c:symbol-prefix="vec4">
|
|
<doc xml:space="preserve" filename="src/graphene-vec4.h" line="35">A structure capable of holding a vector with four dimensions: x, y, z, and w.
|
|
|
|
The contents of the #graphene_vec4_t structure are private and should
|
|
never be accessed directly.</doc>
|
|
|
|
<field name="value" readable="0" private="1">
|
|
<type name="Simd4F" c:type="graphene_simd4f_t"/>
|
|
</field>
|
|
<constructor name="alloc" c:identifier="graphene_vec4_alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1311">Allocates a new #graphene_vec4_t structure.
|
|
|
|
The contents of the returned structure are undefined.
|
|
|
|
Use graphene_vec4_init() to initialize the vector.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1320">the newly allocated #graphene_vec4_t
|
|
structure. Use graphene_vec4_free() to free the resources allocated
|
|
by this function.</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</return-value>
|
|
</constructor>
|
|
<method name="add" c:identifier="graphene_vec4_add" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1546">Adds each component of the two given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1548">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1549">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1550">return location for the resulting vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="divide" c:identifier="graphene_vec4_divide" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1602">Divides each component of the first operand @a by the corresponding
|
|
component of the second operand @b, and places the results into the
|
|
vector @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1604">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1605">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1606">return location for the resulting vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="dot" c:identifier="graphene_vec4_dot" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1622">Computes the dot product of the two given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1629">the value of the dot product</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1624">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1625">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="equal" c:identifier="graphene_vec4_equal" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1795">Checks whether the two given #graphene_vec4_t are equal.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1802">`true` if the two vectors are equal, and false otherwise</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1797">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1798">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="free" c:identifier="graphene_vec4_free" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1332">Frees the resources allocated by @v</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1334">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_w" c:identifier="graphene_vec4_get_w" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1512">Retrieves the value of the fourth component of the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1518">the value of the fourth component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1514">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_x" c:identifier="graphene_vec4_get_x" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1464">Retrieves the value of the first component of the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1470">the value of the first component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1466">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_xy" c:identifier="graphene_vec4_get_xy" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1732">Creates a #graphene_vec2_t that contains the first two components
|
|
of the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1734">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1735">return location for a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="graphene_vec2_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_xyz" c:identifier="graphene_vec4_get_xyz" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1749">Creates a #graphene_vec3_t that contains the first three components
|
|
of the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1751">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1752">return location for a graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="graphene_vec3_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_y" c:identifier="graphene_vec4_get_y" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1480">Retrieves the value of the second component of the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1486">the value of the second component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1482">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="get_z" c:identifier="graphene_vec4_get_z" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1496">Retrieves the value of the third component of the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1502">the value of the third component</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1498">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init" c:identifier="graphene_vec4_init" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1346">Initializes a #graphene_vec4_t using the given values.
|
|
|
|
This function can be called multiple times.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1358">a pointer to the initialized
|
|
vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1348">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="x" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1349">the X field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="y" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1350">the Y field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1351">the Z field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="w" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1352">the W field of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_float" c:identifier="graphene_vec4_init_from_float" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1444">Initializes a #graphene_vec4_t with the values inside the given array.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1451">the initialized vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1446">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1447">an array of four floating point values</doc>
|
|
<array zero-terminated="0" c:type="const float*" fixed-size="4">
|
|
<type name="gfloat" c:type="float"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec2" c:identifier="graphene_vec4_init_from_vec2" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1419">Initializes a #graphene_vec4_t using the components of a
|
|
#graphene_vec2_t and the values of @z and @w.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1429">the initialized vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1421">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1422">a #graphene_vec2_t</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</parameter>
|
|
<parameter name="z" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1423">the value for the third component of @v</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="w" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1424">the value for the fourth component of @v</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec3" c:identifier="graphene_vec4_init_from_vec3" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1396">Initializes a #graphene_vec4_t using the components of a
|
|
#graphene_vec3_t and the value of @w.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1405">the initialized vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1398">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1399">a #graphene_vec3_t</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</parameter>
|
|
<parameter name="w" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1400">the value for the fourth component of @v</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="init_from_vec4" c:identifier="graphene_vec4_init_from_vec4" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1375">Initializes a #graphene_vec4_t using the components of
|
|
another #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1383">the initialized vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1377">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="src" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1378">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="length" c:identifier="graphene_vec4_length" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1640">Computes the length of the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1646">the length of the vector</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1642">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="max" c:identifier="graphene_vec4_max" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1695">Compares each component of the two given vectors and creates a
|
|
vector that contains the maximum values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1697">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1698">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1699">return location for the result vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="min" c:identifier="graphene_vec4_min" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1676">Compares each component of the two given vectors and creates a
|
|
vector that contains the minimum values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1678">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1679">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1680">return location for the result vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="multiply" c:identifier="graphene_vec4_multiply" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1584">Multiplies each component of the two given vectors.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1586">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1587">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1588">return location for the resulting vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="near" c:identifier="graphene_vec4_near" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1813">Compares the two given #graphene_vec4_t vectors and checks
|
|
whether their values are within the given @epsilon.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1822">`true` if the two vectors are near each other</doc>
|
|
<type name="gboolean" c:type="_Bool"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1815">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="v2" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1816">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="epsilon" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1817">the threshold between the two vectors</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="negate" c:identifier="graphene_vec4_negate" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1766">Negates the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1768">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1769">return location for the result vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="normalize" c:identifier="graphene_vec4_normalize" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1656">Normalizes the given #graphene_vec4_t.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1658">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1659">return location for the normalized
|
|
vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="scale" c:identifier="graphene_vec4_scale" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1714">Multiplies all components of the given vector with the given scalar @factor.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1716">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="factor" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1717">the scalar factor</doc>
|
|
<type name="gfloat" c:type="float"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1718">return location for the result vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="subtract" c:identifier="graphene_vec4_subtract" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1564">Subtracts from each component of the first operand @a the
|
|
corresponding component of the second operand @b and places
|
|
each result into the components of @res.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="a" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1566">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="b" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1567">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</parameter>
|
|
<parameter name="res" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1568">return location for the resulting vector</doc>
|
|
<type name="Vec4" c:type="graphene_vec4_t*"/>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<method name="to_float" c:identifier="graphene_vec4_to_float" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1528">Stores the components of the given #graphene_vec4_t into an array
|
|
of floating point values.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<type name="none" c:type="void"/>
|
|
</return-value>
|
|
<parameters>
|
|
<instance-parameter name="v" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1530">a #graphene_vec4_t</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</instance-parameter>
|
|
<parameter name="dest" direction="out" caller-allocates="1" transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1531">return location for
|
|
an array of floating point values</doc>
|
|
<array zero-terminated="0" c:type="float*" fixed-size="4">
|
|
<type name="gfloat" c:type="float"/>
|
|
</array>
|
|
</parameter>
|
|
</parameters>
|
|
</method>
|
|
<function name="one" c:identifier="graphene_vec4_one" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1936">Retrieves a pointer to a #graphene_vec4_t with all its
|
|
components set to 1.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1942">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="w_axis" c:identifier="graphene_vec4_w_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="2008">Retrieves a pointer to a #graphene_vec4_t with its
|
|
components set to (0, 0, 0, 1).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="2014">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="x_axis" c:identifier="graphene_vec4_x_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1954">Retrieves a pointer to a #graphene_vec4_t with its
|
|
components set to (1, 0, 0, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1960">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="y_axis" c:identifier="graphene_vec4_y_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1972">Retrieves a pointer to a #graphene_vec4_t with its
|
|
components set to (0, 1, 0, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1978">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="z_axis" c:identifier="graphene_vec4_z_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1990">Retrieves a pointer to a #graphene_vec4_t with its
|
|
components set to (0, 0, 1, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1996">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="zero" c:identifier="graphene_vec4_zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1918">Retrieves a pointer to a #graphene_vec4_t with all its
|
|
components set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1924">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</record>
|
|
<function name="box_empty" c:identifier="graphene_box_empty" moved-to="Box.empty" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="817">A degenerate #graphene_box_t that can only be expanded.
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="824">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="box_infinite" c:identifier="graphene_box_infinite" moved-to="Box.infinite" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="798">A degenerate #graphene_box_t that cannot be expanded.
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="805">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="box_minus_one" c:identifier="graphene_box_minus_one" moved-to="Box.minus_one" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="758">A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the
|
|
maximum vertex set at (0, 0, 0).
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="766">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="box_one" c:identifier="graphene_box_one" moved-to="Box.one" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="738">A #graphene_box_t with the minimum vertex set at (0, 0, 0) and the
|
|
maximum vertex set at (1, 1, 1).
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="746">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="box_one_minus_one" c:identifier="graphene_box_one_minus_one" moved-to="Box.one_minus_one" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="778">A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the
|
|
maximum vertex set at (1, 1, 1).
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="786">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="box_zero" c:identifier="graphene_box_zero" moved-to="Box.zero" version="1.2">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="719">A #graphene_box_t with both the minimum and maximum vertices set at (0, 0, 0).
|
|
|
|
The returned value is owned by Graphene and should not be modified or freed.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-box.c" line="726">a #graphene_box_t</doc>
|
|
<type name="Box" c:type="const graphene_box_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<constant name="false" value="0" c:type="false">
|
|
|
|
<type name="gint" c:type="gint"/>
|
|
</constant>
|
|
<function name="point3d_zero" c:identifier="graphene_point3d_zero" moved-to="Point3D.zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="444">Retrieves a constant point with all three coordinates set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point3d.c" line="449">a zero point</doc>
|
|
<type name="Point3D" c:type="const graphene_point3d_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="point_zero" c:identifier="graphene_point_zero" moved-to="Point.zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="300">Returns a point fixed at (0, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-point.c" line="305">a fixed point</doc>
|
|
<type name="Point" c:type="const graphene_point_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="rect_alloc" c:identifier="graphene_rect_alloc" moved-to="Rect.alloc" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="71">Allocates a new #graphene_rect_t.
|
|
|
|
The contents of the returned rectangle are undefined.</doc>
|
|
|
|
<return-value transfer-ownership="full">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="78">the newly allocated rectangle</doc>
|
|
<type name="Rect" c:type="graphene_rect_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="rect_zero" c:identifier="graphene_rect_zero" moved-to="Rect.zero" version="1.4">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="817">Returns a degenerate rectangle with origin fixed at (0, 0) and
|
|
a size of 0, 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-rect.c" line="823">a fixed rectangle</doc>
|
|
<type name="Rect" c:type="const graphene_rect_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="size_zero" c:identifier="graphene_size_zero" moved-to="Size.zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="187">A constant pointer to a zero #graphene_size_t, useful for
|
|
equality checks and interpolations.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-size.c" line="193">a constant size</doc>
|
|
<type name="Size" c:type="const graphene_size_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<constant name="true" value="1" c:type="true">
|
|
|
|
<type name="gint" c:type="gint"/>
|
|
</constant>
|
|
<function name="vec2_one" c:identifier="graphene_vec2_one" moved-to="Vec2.one" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="554">Retrieves a constant vector with (1, 1) components.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="559">the one vector</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec2_x_axis" c:identifier="graphene_vec2_x_axis" moved-to="Vec2.x_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="571">Retrieves a constant vector with (1, 0) components.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="576">the X axis vector</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec2_y_axis" c:identifier="graphene_vec2_y_axis" moved-to="Vec2.y_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="588">Retrieves a constant vector with (0, 1) components.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="593">the Y axis vector</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec2_zero" c:identifier="graphene_vec2_zero" moved-to="Vec2.zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="537">Retrieves a constant vector with (0, 0) components.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="542">the zero vector</doc>
|
|
<type name="Vec2" c:type="const graphene_vec2_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec3_one" c:identifier="graphene_vec3_one" moved-to="Vec3.one" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1236">Provides a constant pointer to a vector with three components,
|
|
all sets to 1.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1242">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec3_x_axis" c:identifier="graphene_vec3_x_axis" moved-to="Vec3.x_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1254">Provides a constant pointer to a vector with three components
|
|
with values set to (1, 0, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1260">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec3_y_axis" c:identifier="graphene_vec3_y_axis" moved-to="Vec3.y_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1272">Provides a constant pointer to a vector with three components
|
|
with values set to (0, 1, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1278">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec3_z_axis" c:identifier="graphene_vec3_z_axis" moved-to="Vec3.z_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1290">Provides a constant pointer to a vector with three components
|
|
with values set to (0, 0, 1).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1296">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec3_zero" c:identifier="graphene_vec3_zero" moved-to="Vec3.zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1218">Provides a constant pointer to a vector with three components,
|
|
all sets to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1224">a constant vector</doc>
|
|
<type name="Vec3" c:type="const graphene_vec3_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec4_one" c:identifier="graphene_vec4_one" moved-to="Vec4.one" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1936">Retrieves a pointer to a #graphene_vec4_t with all its
|
|
components set to 1.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1942">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec4_w_axis" c:identifier="graphene_vec4_w_axis" moved-to="Vec4.w_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="2008">Retrieves a pointer to a #graphene_vec4_t with its
|
|
components set to (0, 0, 0, 1).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="2014">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec4_x_axis" c:identifier="graphene_vec4_x_axis" moved-to="Vec4.x_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1954">Retrieves a pointer to a #graphene_vec4_t with its
|
|
components set to (1, 0, 0, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1960">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec4_y_axis" c:identifier="graphene_vec4_y_axis" moved-to="Vec4.y_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1972">Retrieves a pointer to a #graphene_vec4_t with its
|
|
components set to (0, 1, 0, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1978">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec4_z_axis" c:identifier="graphene_vec4_z_axis" moved-to="Vec4.z_axis" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1990">Retrieves a pointer to a #graphene_vec4_t with its
|
|
components set to (0, 0, 1, 0).</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1996">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
<function name="vec4_zero" c:identifier="graphene_vec4_zero" moved-to="Vec4.zero" version="1.0">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1918">Retrieves a pointer to a #graphene_vec4_t with all its
|
|
components set to 0.</doc>
|
|
|
|
<return-value transfer-ownership="none">
|
|
<doc xml:space="preserve" filename="src/graphene-vectors.c" line="1924">a constant vector</doc>
|
|
<type name="Vec4" c:type="const graphene_vec4_t*"/>
|
|
</return-value>
|
|
</function>
|
|
</namespace>
|
|
</repository>
|