ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/OpenCL/OpenCL.pm
(Generate patch)

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.32 by root, Thu Apr 19 12:12:03 2012 UTC vs.
Revision 1.42 by root, Fri Apr 20 11:05:46 2012 UTC

160 '; 160 ';
161 161
162 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->program_with_source ($src);
163 163
164 # build croaks on compile errors, so catch it and print the compile errors 164 # build croaks on compile errors, so catch it and print the compile errors
165 eval { $prog->build ($dev); 1 } 165 eval { $prog->build ($dev, "-cl-fast-relaxed-math"); 1 }
166 or die $prog->build_log; 166 or die $prog->build_log;
167 167
168 my $kernel = $prog->kernel ("squareit"); 168 my $kernel = $prog->kernel ("squareit");
169 169
170=head2 Create some input and output float buffers, then call the 170=head2 Create some input and output float buffers, then call the
210 # enqueue an async read 210 # enqueue an async read
211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212 212
213 # wait for the last event to complete 213 # wait for the last event to complete
214 $ev->wait; 214 $ev->wait;
215
216=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
217set tunnel effect.
218
219This is quite a long example to get you going.
220
221 use OpenGL ":all";
222 use OpenCL;
223
224 # open a window and create a gl texture
225 OpenGL::glpOpenWindow width => 256, height => 256;
226 my $texid = glGenTextures_p 1;
227 glBindTexture GL_TEXTURE_2D, $texid;
228 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
229
230 # find and use the first opencl device that let's us get a shared opengl context
231 my $platform;
232 my $dev;
233 my $ctx;
234
235 for (OpenCL::platforms) {
236 $platform = $_;
237 for ($platform->devices) {
238 $dev = $_;
239 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
240 and last;
241 }
242 }
243
244 $ctx
245 or die "cannot find suitable OpenCL device\n";
246
247 my $queue = $ctx->queue ($dev);
248
249 # now attach an opencl image2d object to the opengl texture
250 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
251
252 # now the boring opencl code
253 my $src = <<EOF;
254 kernel void
255 juliatunnel (write_only image2d_t img, float time)
256 {
257 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
258
259 float2 m = (float2)(1.f, p.y) / fabs (p.x);
260 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
261
262 float2 z = m;
263 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
264
265 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
266 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
267
268 float3 colour = (float3)(z.x, z.y, z.x * z.y);
269 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
270 }
271 EOF
272 my $prog = $ctx->program_with_source ($src);
273 eval { $prog->build ($dev); 1 }
274 or die $prog->build_log ($dev);
275
276 my $kernel = $prog->kernel ("juliatunnel");
277
278 # program compiled, kernel ready, now draw and loop
279
280 for (my $time; ; ++$time) {
281 # acquire objects from opengl
282 $queue->enqueue_acquire_gl_objects ([$tex]);
283
284 # configure and run our kernel
285 $kernel->set_image2d (0, $tex);
286 $kernel->set_float (1, $time);
287 $queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
288
289 # release objects to opengl again
290 $queue->enqueue_release_gl_objects ([$tex]);
291
292 # wait
293 $queue->finish;
294
295 # now draw the texture, the defaults should be all right
296 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
297
298 glEnable GL_TEXTURE_2D;
299 glBegin GL_QUADS;
300 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
301 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
302 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
303 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
304 glEnd;
305
306 glXSwapBuffers;
307
308 select undef, undef, undef, 1/60;
309 }
215 310
216=head1 DOCUMENTATION 311=head1 DOCUMENTATION
217 312
218=head2 BASIC CONVENTIONS 313=head2 BASIC CONVENTIONS
219 314
271 ulong IV - Q 366 ulong IV - Q
272 float NV float f 367 float NV float f
273 half IV ushort S 368 half IV ushort S
274 double NV double d 369 double NV double d
275 370
276=head2 OpenGL sharing 371=head2 GLX SUPPORT
277 372
278This module can be optionally compiled with support for 373Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
279OpenGL sharing. The sharing functions are only available when 374module, which has little to no documentation and has little to no support
280C<OpenCL::HAVE_OPENGL> returns true, otherwise they are absent and cannot 375for glX), this module, as a special extension, treats context creation
281be called. 376properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
377specially: If either or both of these are C<undef>, then the OpenCL
378module tries to dynamically resolve C<glXGetCurrentDisplay> and
379C<glXGetCurrentContext>, call these functions and use their return values
380instead.
381
382For this to work, the OpenGL library must be loaded, a GLX context must
383have been created and be made current, and C<dlsym> must be available and
384capable of finding the function via C<RTLD_DEFAULT>.
282 385
283=head2 THE OpenCL PACKAGE 386=head2 THE OpenCL PACKAGE
284 387
285=over 4 388=over 4
286 389
699Creates a new OpenCL::Image3D object and optionally initialises it with 802Creates a new OpenCL::Image3D object and optionally initialises it with
700the given data values. 803the given data values.
701 804
702L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 805L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
703 806
807=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
808
809Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
810OpenGL buffer object.
811
812http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
813
814=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
815
816Creates a new OpenCL::Image2D object that refers to the given OpenGL
8172D texture object.
818
819http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
820
821=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
822
823Creates a new OpenCL::Image3D object that refers to the given OpenGL
8243D texture object.
825
826http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
827
828=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
829
830Creates a new OpenCL::Image2D object that refers to the given OpenGL
831render buffer.
832
833http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
834
704=item @formats = $ctx->supported_image_formats ($flags, $image_type) 835=item @formats = $ctx->supported_image_formats ($flags, $image_type)
705 836
706Returns a list of matching image formats - each format is an arrayref with 837Returns a list of matching image formats - each format is an arrayref with
707two values, $channel_order and $channel_type, in it. 838two values, $channel_order and $channel_type, in it.
708 839
838reference to an array of local work sizes, with the same number of 969reference to an array of local work sizes, with the same number of
839elements as @$global_work_size. 970elements as @$global_work_size.
840 971
841L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 972L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
842 973
843=item $ev = $queue->enqueue_marker 974=item $ev = $queue->enqueue_marker ($wait_events...)
844 975
845L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 976L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
977
978=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
979
980Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
981for subsequent OpenCL usage.
982
983L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
984
985=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
986
987Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
988for subsequent OpenGL usage.
989
990L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
846 991
847=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 992=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
848 993
849L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 994L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
850 995
938=item $int = $mem->offset 1083=item $int = $mem->offset
939 1084
940Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1085Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
941 1086
942=for gengetinfo end mem 1087=for gengetinfo end mem
1088
1089=item ($type, $name) = $mem->gl_object_info
1090
1091Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1092object "name" (e.g. the texture name) used to create this memory object.
1093
1094L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
943 1095
944=back 1096=back
945 1097
946=head2 THE OpenCL::Buffer CLASS 1098=head2 THE OpenCL::Buffer CLASS
947 1099
1007 1159
1008Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1160Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1009 1161
1010=for gengetinfo end image 1162=for gengetinfo end image
1011 1163
1164=for gengetinfo begin gl_texture
1165
1166=item $GLenum = $gl_texture->target
1167
1168Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1169
1170=item $GLint = $gl_texture->gl_mipmap_level
1171
1172Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1173
1174=for gengetinfo end gl_texture
1175
1012=back 1176=back
1013 1177
1014=head2 THE OpenCL::Sampler CLASS 1178=head2 THE OpenCL::Sampler CLASS
1015 1179
1016=over 4 1180=over 4
1205 1369
1206This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1370This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1207 1371
1208TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1372TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1209C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1373C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1210C<image2d>, C<image3d>, C<sampler> or C<event>. 1374C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1211 1375
1212Chars and integers (including the half type) are specified as integers, 1376Chars and integers (including the half type) are specified as integers,
1213float and double as floating point values, memory/buffer/image2d/image3d 1377float and double as floating point values, memory/buffer/image2d/image3d
1214must be an object of that type or C<undef>, and sampler and event must be 1378must be an object of that type or C<undef>, local-memory arguments are
1215objects of that type. 1379set by specifying the size, and sampler and event must be objects of that
1380type.
1216 1381
1217L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1382L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1218 1383
1219=back 1384=back
1220 1385
1309package OpenCL; 1474package OpenCL;
1310 1475
1311use common::sense; 1476use common::sense;
1312 1477
1313BEGIN { 1478BEGIN {
1314 our $VERSION = '0.92'; 1479 our $VERSION = '0.95';
1315 1480
1316 require XSLoader; 1481 require XSLoader;
1317 XSLoader::load (__PACKAGE__, $VERSION); 1482 XSLoader::load (__PACKAGE__, $VERSION);
1318 1483
1319 @OpenCL::Buffer::ISA = 1484 @OpenCL::Buffer::ISA =

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines