File: al_calculate_ribbon.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (42 lines) | stat: -rw-r--r-- 1,329 bytes parent folder | download
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
.TH al_calculate_ribbon 3 "" "Allegro reference manual"
.SH NAME
.PP
al_calculate_ribbon \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_primitives.h>

void\ al_calculate_ribbon(float*\ dest,\ int\ dest_stride,\ const\ float\ *points,
\ \ \ int\ points_stride,\ float\ thickness,\ int\ num_segments)
\f[]
.fi
.SH DESCRIPTION
.PP
Calculates a ribbon given an array of points.
The ribbon will go through all of the passed points.
If \f[C]thickness\ <=\ 0\f[], then \f[C]num_segments\f[] of points are
required in the destination buffer, otherwise twice as many are needed.
The destination and the points buffer should consist of regularly spaced
doublets of floats, corresponding to x and y coordinates of the
vertices.
.PP
\f[I]Parameters:\f[]
.IP \[bu] 2
dest \- Pointer to the destination buffer
.IP \[bu] 2
dest_stride \- Distance (in bytes) between starts of successive pairs of
coordinates in the destination buffer
.IP \[bu] 2
points \- An array of pairs of coordinates for each point
.IP \[bu] 2
points_stride \- Distance (in bytes) between starts successive pairs of
coordinates in the points buffer
.IP \[bu] 2
thickness \- Thickness of the spline ribbon
.IP \[bu] 2
num_segments \- The number of points to calculate
.SH SEE ALSO
.PP
al_draw_ribbon(3), al_calculate_arc(3), al_calculate_spline(3)