updated docs
[sdlgit/SDL-Site.git] / pages / SDL-GFX-Rotozoom.html-inc
1 <div class="pod">
2 <!-- INDEX START -->
3 <h3 id="TOP">Index</h3>
4
5 <ul><li><a href="#NAME">NAME</a></li>
6 <li><a href="#CATEGORY">CATEGORY</a></li>
7 <li><a href="#CONSTANTS">CONSTANTS</a></li>
8 <li><a href="#METHODS">METHODS</a>
9 <ul><li><a href="#surface">surface</a></li>
10 <li><a href="#surface_xy">surface_xy</a></li>
11 <li><a href="#surface_size">surface_size</a></li>
12 <li><a href="#surface_size_xy">surface_size_xy</a></li>
13 <li><a href="#zoom_surface">zoom_surface</a></li>
14 <li><a href="#zoom_surface_size">zoom_surface_size</a></li>
15 <li><a href="#shrink_surface">shrink_surface</a></li>
16 <li><a href="#rotate_surface_90_degrees">rotate_surface_90_degrees</a></li>
17 </ul>
18 </li>
19 <li><a href="#AUTHORS">AUTHORS</a>
20 </li>
21 </ul><hr />
22 <!-- INDEX END -->
23
24 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
25 <div id="NAME_CONTENT">
26 <p>SDL::GFX::Rotozoom - rotation and zooming functions for surfaces</p>
27
28 </div>
29 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
30 <div id="CATEGORY_CONTENT">
31 <p>TODO, GFX</p>
32
33 </div>
34 <h1 id="CONSTANTS">CONSTANTS</h1><p><a href="#TOP" class="toplink">Top</a></p>
35 <div id="CONSTANTS_CONTENT">
36 <p>The constants are not exported by default. You can export them into your namespace by doing:</p>
37 <pre> use SDL::GFX::Rotozoom ':all';
38
39 </pre>
40 <p>or access them directly:</p>
41 <pre> SDL::GFX::Rotozoom::SMOOTHING_OFF;
42
43 </pre>
44 <p>or by choosing the export tags below:</p>
45 <p>Export tag: ':smoothing'</p>
46 <pre> SMOOTHING_OFF
47  SMOOTHING_ON
48
49 </pre>
50
51 </div>
52 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
53 <div id="METHODS_CONTENT">
54
55 </div>
56 <h2 id="surface">surface</h2>
57 <div id="surface_CONTENT">
58 <pre> SDL_Surface *
59  gfx_roto_surface(src, angle, zoom, smooth)
60         SDL_Surface * src
61         double angle
62         double zoom
63         int smooth
64         PREINIT:
65                 char *CLASS = &quot;SDL::Surface&quot;;
66         CODE:
67                 RETVAL = rotozoomSurface(src, angle, zoom, smooth);
68         OUTPUT:
69                 RETVAL
70
71 </pre>
72
73 </div>
74 <h2 id="surface_xy">surface_xy</h2>
75 <div id="surface_xy_CONTENT">
76 <pre> SDL_Surface *
77  gfx_roto_surface_xy(src, angle, zoomx, zoomy, smooth)
78         SDL_Surface * src
79         double angle
80         double zoomx
81         double zoomy
82         int smooth
83         PREINIT:
84                 char *CLASS = &quot;SDL::Surface&quot;;
85         CODE:
86                 RETVAL = rotozoomSurfaceXY(src, angle, zoomx, zoomy, smooth);
87         OUTPUT:
88                 RETVAL
89
90 </pre>
91
92 </div>
93 <h2 id="surface_size">surface_size</h2>
94 <div id="surface_size_CONTENT">
95 <pre> void 
96  gfx_roto_surface_size(width, height, angle, zoom, dstwidth, dstheight)
97         int width
98         int height
99         double angle
100         double zoom
101         int *dstwidth
102         int *dstheight
103         CODE:
104                 rotozoomSurfaceSize(width, height, angle, zoom, dstwidth, dstheight);
105
106 </pre>
107
108 </div>
109 <h2 id="surface_size_xy">surface_size_xy</h2>
110 <div id="surface_size_xy_CONTENT">
111 <pre> void 
112  gfx_roto_surface_size_xy(width, height, angle, zoomx, zoomy, dstwidth, dstheight)
113         int width
114         int height
115         double angle
116         double zoomx
117         double zoomy
118         int *dstwidth
119         int *dstheight
120         CODE:
121                 rotozoomSurfaceSizeXY(width, height, angle, zoomx, zoomy, dstwidth, dstheight);
122
123 </pre>
124
125 </div>
126 <h2 id="zoom_surface">zoom_surface</h2>
127 <div id="zoom_surface_CONTENT">
128 <pre> SDL_Surface *
129  gfx_roto_zoom_surface(src, zoomx, zoomy, smooth)
130         SDL_Surface * src
131         double zoomx
132         double zoomy
133         int smooth
134         PREINIT:
135                 char *CLASS = &quot;SDL::Surface&quot;;
136         CODE:
137                 RETVAL = zoomSurface(src, zoomx, zoomy, smooth);
138         OUTPUT:
139                 RETVAL
140
141 </pre>
142
143 </div>
144 <h2 id="zoom_surface_size">zoom_surface_size</h2>
145 <div id="zoom_surface_size_CONTENT">
146 <pre> void
147  gfx_roto_zoom_surface_size(width, height, zoomx, zoomy, dstwidth, dstheight)
148         int width
149         int height
150         double zoomx
151         double zoomy
152         int *dstwidth
153         int *dstheight
154         CODE:
155                 zoomSurfaceSize(width, height, zoomx, zoomy, dstwidth, dstheight);
156
157 </pre>
158
159 </div>
160 <h2 id="shrink_surface">shrink_surface</h2>
161 <div id="shrink_surface_CONTENT">
162 <pre> SDL_Surface *
163  gfx_roto_shrink_surface(src, factorx, factory)
164         SDL_Surface * src
165         int factorx
166         int factory
167         PREINIT:
168                 char *CLASS = &quot;SDL::Surface&quot;;
169         CODE:
170                 RETVAL = shrinkSurface(src, factorx, factory);
171         OUTPUT:
172                 RETVAL
173
174 </pre>
175
176 </div>
177 <h2 id="rotate_surface_90_degrees">rotate_surface_90_degrees</h2>
178 <div id="rotate_surface_90_degrees_CONTENT">
179 <pre> SDL_Surface *
180  gfx_roto_rotate_surface_90_degrees(pSurf, numClockwiseTurns)
181         SDL_Surface* pSurf
182         int numClockwiseTurns
183         PREINIT:
184                 char *CLASS = &quot;SDL::Surface&quot;;
185         CODE:
186                 RETVAL = rotateSurface90Degrees(pSurf, numClockwiseTurns);
187         OUTPUT:
188                 RETVAL
189
190 </pre>
191
192 </div>
193 <h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
194 <div id="AUTHORS_CONTENT">
195 <p>See <b>AUTHORS</b> in <cite>SDL</cite>.</p>
196
197
198
199
200
201 </div>
202 </div>