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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.25 by root, Tue Nov 22 10:39:47 2011 UTC vs.
Revision 1.39 by root, Thu Apr 19 19:37:18 2012 UTC

105 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
106 printf "platform: %s\n", $platform->name; 106 printf "platform: %s\n", $platform->name;
107 printf "extensions: %s\n", $platform->extensions; 107 printf "extensions: %s\n", $platform->extensions;
108 for my $device ($platform->devices) { 108 for my $device ($platform->devices) {
109 printf "+ device: %s\n", $device->name; 109 printf "+ device: %s\n", $device->name;
110 my $ctx = $device->context; 110 my $ctx = $platform->context (undef, [$device]);
111 # do stuff 111 # do stuff
112 } 112 }
113 } 113 }
114 114
115=head2 Get a useful context and a command queue. 115=head2 Get a useful context and a command queue.
149 149
150=head2 Create and build a program, then create a kernel out of one of its 150=head2 Create and build a program, then create a kernel out of one of its
151functions. 151functions.
152 152
153 my $src = ' 153 my $src = '
154 __kernel void 154 kernel void
155 squareit (__global float *input, __global float *output) 155 squareit (global float *input, global float *output)
156 { 156 {
157 $id = get_global_id (0); 157 $id = get_global_id (0);
158 output [id] = input [id] * input [id]; 158 output [id] = input [id] * input [id];
159 } 159 }
160 '; 160 ';
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->flush;
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
371=head2 GLX SUPPORT
372
373Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
374module, which has little to no documentation and has little to no support
375for glX), this module, as a special extension, treats context creation
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>.
385
276=head2 THE OpenCL PACKAGE 386=head2 THE OpenCL PACKAGE
277 387
278=over 4 388=over 4
279 389
280=item $int = OpenCL::errno 390=item $int = OpenCL::errno
286 396
287Comverts an error value into a human readable string. 397Comverts an error value into a human readable string.
288 398
289=item $str = OpenCL::enum2str $enum 399=item $str = OpenCL::enum2str $enum
290 400
291Converts most enum values (inof parameter names, image format constants, 401Converts most enum values (of parameter names, image format constants,
292object types, addressing and filter modes, command types etc.) into a 402object types, addressing and filter modes, command types etc.) into a
293human readbale string. When confronted with some random integer it can be 403human readable string. When confronted with some random integer it can be
294very helpful to pass it through this function to maybe get some readable 404very helpful to pass it through this function to maybe get some readable
295string out of it. 405string out of it.
296 406
297=item @platforms = OpenCL::platforms 407=item @platforms = OpenCL::platforms
298 408
326 436
327Tries to create a context. Never worked for me, and you need devices explicitly anyway. 437Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 438
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 440
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 441=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
332 442
333Create a new OpenCL::Context object using the given device object(s)- a 443Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 444CL_CONTEXT_PLATFORM property is supplied automatically.
335 445
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 446L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
668 778
669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 779L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
670 780
671=item $buf = $ctx->buffer ($flags, $len) 781=item $buf = $ctx->buffer ($flags, $len)
672 782
673Creates a new OpenCL::Buffer object with the given flags and octet-size. 783Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
784given flags and octet-size.
674 785
675L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 786L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
676 787
677=item $buf = $ctx->buffer_sv ($flags, $data) 788=item $buf = $ctx->buffer_sv ($flags, $data)
678 789
679Creates a new OpenCL::Buffer object and initialise it with the given data values. 790Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
791initialise it with the given data values.
680 792
681=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 793=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
682 794
683Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 795Creates a new OpenCL::Image2D object and optionally initialises it with
796the given data values.
684 797
685L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 798L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
686 799
687=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 800=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
688 801
689Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 802Creates a new OpenCL::Image3D object and optionally initialises it with
803the given data values.
690 804
691L<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>
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
692 834
693=item @formats = $ctx->supported_image_formats ($flags, $image_type) 835=item @formats = $ctx->supported_image_formats ($flags, $image_type)
694 836
695Returns 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
696two values, $channel_order and $channel_type, in it. 838two values, $channel_order and $channel_type, in it.
781 923
782http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html 924http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
783 925
784=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 926=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
785 927
928L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
929
930=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
931
786L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 932L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
787 933
788=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 934=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
789 935
790L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 936L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
791 937
938=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
939
940L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
941
942=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
943
944L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
945
792=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...) 946=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
793 947
794Yeah. 948Yeah.
795 949
796L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
797
798=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
799
800L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 950L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
801
802=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
803
804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
805
806=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
807
808L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
809 951
810=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 952=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
811 953
812L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 954L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
813 955
827reference 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
828elements as @$global_work_size. 970elements as @$global_work_size.
829 971
830L<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>
831 973
832=item $ev = $queue->enqueue_marker 974=item $ev = $queue->enqueue_marker ($wait_events...)
833 975
834L<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>
835 991
836=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 992=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
837 993
838L<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>
839 995
928 1084
929Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1085Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
930 1086
931=for gengetinfo end mem 1087=for gengetinfo end mem
932 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>
1095
1096=back
1097
1098=head2 THE OpenCL::Buffer CLASS
1099
1100This is a subclass of OpenCL::Memory, and the superclass of
1101OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1102and sub-buffers.
1103
1104=head2 THE OpenCL::BufferObj CLASS
1105
1106This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1107because one cna create sub buffers of OpenLC::BufferObj objects, but not
1108sub buffers from these sub buffers.
1109
1110=over 4
1111
1112=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1113
1114Creates an OpenCL::Buffer objects from this buffer and returns it. The
1115C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1116
1117L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1118
933=back 1119=back
934 1120
935=head2 THE OpenCL::Image CLASS 1121=head2 THE OpenCL::Image CLASS
936 1122
937This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1123This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
972=item $int = $image->depth 1158=item $int = $image->depth
973 1159
974Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1160Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
975 1161
976=for gengetinfo end image 1162=for gengetinfo end image
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
977 1175
978=back 1176=back
979 1177
980=head2 THE OpenCL::Sampler CLASS 1178=head2 THE OpenCL::Sampler CLASS
981 1179
1275package OpenCL; 1473package OpenCL;
1276 1474
1277use common::sense; 1475use common::sense;
1278 1476
1279BEGIN { 1477BEGIN {
1280 our $VERSION = '0.55'; 1478 our $VERSION = '0.95';
1281 1479
1282 require XSLoader; 1480 require XSLoader;
1283 XSLoader::load (__PACKAGE__, $VERSION); 1481 XSLoader::load (__PACKAGE__, $VERSION);
1284 1482
1285 @OpenCL::Buffer::ISA = 1483 @OpenCL::Buffer::ISA =
1286 @OpenCL::Image::ISA = OpenCL::Memory::; 1484 @OpenCL::Image::ISA = OpenCL::Memory::;
1287 1485
1486 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1487
1288 @OpenCL::Image2D::ISA = 1488 @OpenCL::Image2D::ISA =
1289 @OpenCL::Image3D::ISA = OpenCL::Image::; 1489 @OpenCL::Image3D::ISA = OpenCL::Image::;
1290 1490
1291 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1491 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1292} 1492}
1293 1493
12941; 14941;
1295 1495
1296=head1 AUTHOR 1496=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines