aboutsummaryrefslogtreecommitdiff
path: root/doc/Manual/en/BH_Vec2i.pod
blob: bdfeb5eda8f010df9ec82ae085112cf665686135 (plain)
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
=encoding UTF-8


=head1 NAME

BH_Vec2i - two-dimensional integer vector


=head1 SYNTAX

 #include <BH/Math.h>

 cc prog.c -o prog -lbh


=head1 DESCRIPTION

The BH_Vec2i module provides a set of functions for working with two-dimensional
integer vectors.


=head1 API CALLS


=head2 BH_Vec2iAdd

 void BH_Vec2iAdd(const int a[2],
                  const int b[2],
                  int out[2]);

Calculates the sum of two vectors I<a> and I<b>.

The I<out> parameter describes the resulting vector.


=head2 BH_Vec2iSub

 void BH_Vec2iSub(const int a[2],
                  const int b[2],
                  int out[2]);

Calculates the difference between two vectors I<a> and I<b>.

The I<out> parameter describes the resulting vector.


=head2 BH_Vec2iMul

 void BH_Vec2iMul(const int a[2],
                  const int b[2],
                  int out[2]);

Calculates the result of multiplying two vectors I<a> and I<b>.

The I<out> parameter describes the resulting vector.


=head2 BH_Vec2iScale

 void BH_Vec2iScale(const int a[2],
                    int b,
                    int out[2]);

Calculates the result of multiplying vector I<a> by value I<b>.

The I<out> parameter describes the resulting vector.


=head2 BH_Vec2iMulAdd

 void BH_Vec2iMulAdd(const int a[2],
                     const int b[2],
                     const int c[2],
                     int out[2]);

Calculates the result of the sum I<c> and the result of multiplying vectors I<a>
and I<b>.

The I<out> parameter describes the resulting vector.


=head2 BH_Vec2iNegate

 void BH_Vec2iNegate(const int in[2],
                     int out[2]);

Calculates the opposite vector from vector I<in>.

The I<out> parameter describes the resulting vector.


=head2 BH_Vec2iMin

 void BH_Vec2iMin(const int a[2],
                  const int b[2],
                  int out[2]);

Calculates the element-wise minimum of two vectors I<a> and I<b>.

The I<out> parameter describes the resulting vector.


=head2 BH_Vec2iMax

 void BH_Vec2iMax(const int a[2],
                  const int b[2],
                  int out[2]);

Calculates the element-wise maximum of two vectors I<a> and I<b>.

The I<out> parameter describes the resulting vector.


=head1 SEE ALSO

L<BH>