-
-
Notifications
You must be signed in to change notification settings - Fork 46
/
Graphene-1.0.gir
8356 lines (8148 loc) · 414 KB
/
Graphene-1.0.gir
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?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">
<function-macro name="ALIGNED_DECL" c:identifier="GRAPHENE_ALIGNED_DECL" introspectable="0">
<parameters>
<parameter name="x">
</parameter>
<parameter name="val">
</parameter>
</parameters>
</function-macro>
<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">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">Allocates a new #graphene_box_t.
The contents of the returned structure are undefined.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">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">Checks whether the #graphene_box_t @a contains the given
#graphene_box_t @b.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">`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">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">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">Checks whether @box contains the given @point.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">`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">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">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">Checks whether the two given boxes are equal.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">`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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">Retrieves the size of the @box on the Z axis.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">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">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">Retrieves the size of the @box on the Y axis.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">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">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">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">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">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">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">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">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">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">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">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">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">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">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">Retrieves the size of the @box on the X axis.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">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">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">Initializes the given #graphene_box_t with two vertices.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">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">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">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">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">Initializes the given #graphene_box_t with the vertices of
another #graphene_box_t.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">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">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">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">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">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">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">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">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">Initializes the given #graphene_box_t with two vertices
stored inside #graphene_vec3_t.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">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">a #graphene_box_t</doc>
<type name="Box" c:type="const graphene_box_t*"/>
</return-value>
</function>
</record>
<function-macro name="CHECK_VERSION" c:identifier="GRAPHENE_CHECK_VERSION" introspectable="0">
<parameters>
<parameter name="major">
</parameter>
<parameter name="minor">
</parameter>
<parameter name="micro">
</parameter>
</parameters>
</function-macro>
<function-macro name="DEPRECATED_FOR" c:identifier="GRAPHENE_DEPRECATED_FOR" introspectable="0">
<parameters>
<parameter name="f">
</parameter>
</parameters>
</function-macro>
<function-macro name="DEPRECATED_IN_1_0_FOR" c:identifier="GRAPHENE_DEPRECATED_IN_1_0_FOR" introspectable="0">
<parameters>
<parameter name="f">
</parameter>
</parameters>
</function-macro>
<function-macro name="DEPRECATED_IN_1_10_FOR" c:identifier="GRAPHENE_DEPRECATED_IN_1_10_FOR" introspectable="0">
<parameters>
<parameter name="f">
</parameter>
</parameters>
</function-macro>
<function-macro name="DEPRECATED_IN_1_2_FOR" c:identifier="GRAPHENE_DEPRECATED_IN_1_2_FOR" introspectable="0">
<parameters>
<parameter name="f">
</parameter>
</parameters>
</function-macro>
<function-macro name="DEPRECATED_IN_1_4_FOR" c:identifier="GRAPHENE_DEPRECATED_IN_1_4_FOR" introspectable="0">
<parameters>
<parameter name="f">
</parameter>
</parameters>
</function-macro>
<function-macro name="DEPRECATED_IN_1_6_FOR" c:identifier="GRAPHENE_DEPRECATED_IN_1_6_FOR" introspectable="0">
<parameters>
<parameter name="f">
</parameter>
</parameters>
</function-macro>
<function-macro name="DEPRECATED_IN_1_8_FOR" c:identifier="GRAPHENE_DEPRECATED_IN_1_8_FOR" introspectable="0">
<parameters>
<parameter name="f">
</parameter>
</parameters>
</function-macro>
<function-macro name="ENCODE_VERSION" c:identifier="GRAPHENE_ENCODE_VERSION" version="1.0" introspectable="0">
<doc xml:space="preserve">Encodes the given components into a value that can be used for
version checks.</doc>
<parameters>
<parameter name="major">
<doc xml:space="preserve">a major version</doc>
</parameter>
<parameter name="minor">
<doc xml:space="preserve">a minor version</doc>
</parameter>
<parameter name="micro">
<doc xml:space="preserve">a micro version</doc>
</parameter>
</parameters>
</function-macro>
<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">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">Allocates a new #graphene_euler_t.
The contents of the returned structure are undefined.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">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">Checks if two #graphene_euler_t are equal.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">`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">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">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">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">a #graphene_euler_t</doc>
<type name="Euler" c:type="graphene_euler_t*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_alpha" c:identifier="graphene_euler_get_alpha" version="1.10">
<doc xml:space="preserve">Retrieves the first component of the Euler angle vector,
depending on the order of rotation.
See also: graphene_euler_get_x()</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the first component of the Euler angle vector, in radians</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="e" transfer-ownership="none">
<doc xml:space="preserve">a #graphene_euler_t</doc>
<type name="Euler" c:type="const graphene_euler_t*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_beta" c:identifier="graphene_euler_get_beta" version="1.10">
<doc xml:space="preserve">Retrieves the second component of the Euler angle vector,
depending on the order of rotation.
See also: graphene_euler_get_y()</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the second component of the Euler angle vector, in radians</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="e" transfer-ownership="none">
<doc xml:space="preserve">a #graphene_euler_t</doc>
<type name="Euler" c:type="const graphene_euler_t*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_gamma" c:identifier="graphene_euler_get_gamma" version="1.10">
<doc xml:space="preserve">Retrieves the third component of the Euler angle vector,
depending on the order of rotation.
See also: graphene_euler_get_z()</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the third component of the Euler angle vector, in radians</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="e" transfer-ownership="none">
<doc xml:space="preserve">a #graphene_euler_t</doc>
<type name="Euler" c:type="const graphene_euler_t*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_order" c:identifier="graphene_euler_get_order" version="1.2">
<doc xml:space="preserve">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">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">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">Retrieves the rotation angle on the X axis, in degrees.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the rotation angle</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="e" transfer-ownership="none">
<doc xml:space="preserve">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">Retrieves the rotation angle on the Y axis, in degrees.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the rotation angle</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="e" transfer-ownership="none">
<doc xml:space="preserve">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">Retrieves the rotation angle on the Z axis, in degrees.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the rotation angle</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="e" transfer-ownership="none">
<doc xml:space="preserve">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">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">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">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">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">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">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">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">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">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">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">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">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">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">a rotation matrix</doc>
<type name="Matrix" c:type="const graphene_matrix_t*"/>
</parameter>
<parameter name="order" transfer-ownership="none">
<doc xml:space="preserve">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">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">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">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">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">the order used to apply the rotations</doc>
<type name="EulerOrder" c:type="graphene_euler_order_t"/>
</parameter>
</parameters>
</method>
<method name="init_from_radians" c:identifier="graphene_euler_init_from_radians" version="1.10">
<doc xml:space="preserve">Initializes a #graphene_euler_t using the given angles
and order of rotation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">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">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">rotation angle on the X axis, in radians</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">rotation angle on the Y axis, in radians</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z" transfer-ownership="none">
<doc xml:space="preserve">rotation angle on the Z axis, in radians</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="order" transfer-ownership="none">
<doc xml:space="preserve">order of 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">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">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">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">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">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">Initializes a #graphene_euler_t with the given angles and @order.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">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">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">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">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">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">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">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">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">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">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">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 right-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">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">return location for a #graphene_matrix_t</doc>
<type name="Matrix" c:type="graphene_matrix_t*"/>
</parameter>
</parameters>
</method>
<method name="to_quaternion" c:identifier="graphene_euler_to_quaternion" version="1.10">
<doc xml:space="preserve">Converts a #graphene_euler_t into a #graphene_quaternion_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">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">return location for a #graphene_quaternion_t</doc>
<type name="Quaternion" c:type="graphene_quaternion_t*"/>
</parameter>
</parameters>
</method>
<method name="to_vec3" c:identifier="graphene_euler_to_vec3" version="1.2">