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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs.
Revision 1.52 by root, Tue Apr 24 14:24:42 2012 UTC

27OpenCL::Program objects, which store source code and, after building for a 27OpenCL::Program objects, which store source code and, after building for a
28specific device ("compiling and linking"), also binary programs. For each 28specific device ("compiling and linking"), also binary programs. For each
29kernel function in a program you can then create an OpenCL::Kernel object 29kernel function in a program you can then create an OpenCL::Kernel object
30which represents basically a function call with argument values. 30which represents basically a function call with argument values.
31 31
32OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat 32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d 33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34or 3d array) for bulk data and input and output for kernels. 34or 3d array) for bulk data and input and output for kernels.
35 35
36OpenCL::Sampler objects, which are kind of like texture filter modes in 36OpenCL::Sampler objects, which are kind of like texture filter modes in
37OpenGL. 37OpenGL.
101 101
102Best run this once to get a feel for the platforms and devices in your 102Best run this once to get a feel for the platforms and devices in your
103system. 103system.
104 104
105 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
106 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 106 printf "platform: %s\n", $platform->name;
107 printf "extensions: %s\n", $platform->info (OpenCL::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->info (OpenCL::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 ';
161 161
162 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->build_program ($src);
163
164 # build croaks on compile errors, so catch it and print the compile errors
165 eval { $prog->build ($dev); 1 }
166 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
167
168 my $kernel = $prog->kernel ("squareit"); 163 my $kernel = $prog->kernel ("squareit");
169 164
170=head2 Create some input and output float buffers, then call the 165=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them. 166'squareit' kernel on them.
172 167
210 # enqueue an async read 205 # enqueue an async read
211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 206 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212 207
213 # wait for the last event to complete 208 # wait for the last event to complete
214 $ev->wait; 209 $ev->wait;
210
211=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
212set tunnel effect.
213
214This is quite a long example to get you going.
215
216 use OpenGL ":all";
217 use OpenCL;
218
219 # open a window and create a gl texture
220 OpenGL::glpOpenWindow width => 256, height => 256;
221 my $texid = glGenTextures_p 1;
222 glBindTexture GL_TEXTURE_2D, $texid;
223 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
224
225 # find and use the first opencl device that let's us get a shared opengl context
226 my $platform;
227 my $dev;
228 my $ctx;
229
230 for (OpenCL::platforms) {
231 $platform = $_;
232 for ($platform->devices) {
233 $dev = $_;
234 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
235 and last;
236 }
237 }
238
239 $ctx
240 or die "cannot find suitable OpenCL device\n";
241
242 my $queue = $ctx->queue ($dev);
243
244 # now attach an opencl image2d object to the opengl texture
245 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
246
247 # now the boring opencl code
248 my $src = <<EOF;
249 kernel void
250 juliatunnel (write_only image2d_t img, float time)
251 {
252 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
253
254 float2 m = (float2)(1.f, p.y) / fabs (p.x);
255 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
256
257 float2 z = m;
258 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
259
260 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
261 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
262
263 float3 colour = (float3)(z.x, z.y, z.x * z.y);
264 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
265 }
266 EOF
267
268 my $prog = $ctx->build_program ($src);
269 my $kernel = $prog->kernel ("juliatunnel");
270
271 # program compiled, kernel ready, now draw and loop
272
273 for (my $time; ; ++$time) {
274 # acquire objects from opengl
275 $queue->enqueue_acquire_gl_objects ([$tex]);
276
277 # configure and run our kernel
278 $kernel->set_image2d (0, $tex);
279 $kernel->set_float (1, $time);
280 $queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
281
282 # release objects to opengl again
283 $queue->enqueue_release_gl_objects ([$tex]);
284
285 # wait
286 $queue->finish;
287
288 # now draw the texture, the defaults should be all right
289 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
290
291 glEnable GL_TEXTURE_2D;
292 glBegin GL_QUADS;
293 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
294 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
295 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
296 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
297 glEnd;
298
299 glXSwapBuffers;
300
301 select undef, undef, undef, 1/60;
302 }
215 303
216=head1 DOCUMENTATION 304=head1 DOCUMENTATION
217 305
218=head2 BASIC CONVENTIONS 306=head2 BASIC CONVENTIONS
219 307
226 314
227=item * Object lifetime managament is automatic - there is no need 315=item * Object lifetime managament is automatic - there is no need
228to free objects explicitly (C<clReleaseXXX>), the release function 316to free objects explicitly (C<clReleaseXXX>), the release function
229is called automatically once all Perl references to it go away. 317is called automatically once all Perl references to it go away.
230 318
231=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), 319=item * OpenCL uses CamelCase for function names
320(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
232while this module uses underscores as word separator and often leaves out 321uses underscores as word separator and often leaves out prefixes
233prefixes (C<< $platform->info >>). 322(C<OpenCL::platforms>, C<< $platform->info >>).
234 323
235=item * OpenCL often specifies fixed vector function arguments as short 324=item * OpenCL often specifies fixed vector function arguments as short
236arrays (C<$origin[3]>), while this module explicitly expects the 325arrays (C<size_t origin[3]>), while this module explicitly expects the
237components as separate arguments- 326components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
327function calls.
238 328
239=item * Structures are often specified with their components, and returned 329=item * Structures are often specified by flattening out their components
240as arrayrefs. 330as with short vectors, and returned as arrayrefs.
241
242=item * Where possible, one of the pitch values is calculated from the
243perl scalar length and need not be specified.
244 331
245=item * When enqueuing commands, the wait list is specified by adding 332=item * When enqueuing commands, the wait list is specified by adding
246extra arguments to the function - anywhere a C<$wait_events...> argument 333extra arguments to the function - anywhere a C<$wait_events...> argument
247is documented this can be any number of event objects. 334is documented this can be any number of event objects. As an extsnion
335implemented by this module, C<undef> values will be ignored in the event
336list.
248 337
249=item * When enqueuing commands, if the enqueue method is called in void 338=item * When enqueuing commands, if the enqueue method is called in void
250context, no event is created. In all other contexts an event is returned 339context, no event is created. In all other contexts an event is returned
251by the method. 340by the method.
252 341
272 ulong IV - Q 361 ulong IV - Q
273 float NV float f 362 float NV float f
274 half IV ushort S 363 half IV ushort S
275 double NV double d 364 double NV double d
276 365
366=head2 GLX SUPPORT
367
368Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
369module, which has little to no documentation and has little to no support
370for glX), this module, as a special extension, treats context creation
371properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
372specially: If either or both of these are C<undef>, then the OpenCL
373module tries to dynamically resolve C<glXGetCurrentDisplay> and
374C<glXGetCurrentContext>, call these functions and use their return values
375instead.
376
377For this to work, the OpenGL library must be loaded, a GLX context must
378have been created and be made current, and C<dlsym> must be available and
379capable of finding the function via C<RTLD_DEFAULT>.
380
381=cut
382
383package OpenCL;
384
385use common::sense;
386
387BEGIN {
388 our $VERSION = '0.96';
389
390 require XSLoader;
391 XSLoader::load (__PACKAGE__, $VERSION);
392
393 @OpenCL::Platform::ISA =
394 @OpenCL::Device::ISA =
395 @OpenCL::Context::ISA =
396 @OpenCL::Queue::ISA =
397 @OpenCL::Memory::ISA =
398 @OpenCL::Sampler::ISA =
399 @OpenCL::Program::ISA =
400 @OpenCL::Kernel::ISA =
401 @OpenCL::Event::ISA = OpenCL::Object::;
402
403 @OpenCL::Buffer::ISA =
404 @OpenCL::Image::ISA = OpenCL::Memory::;
405
406 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
407
408 @OpenCL::Image2D::ISA =
409 @OpenCL::Image3D::ISA =
410 @OpenCL::Image2DArray::ISA =
411 @OpenCL::Image1D::ISA =
412 @OpenCL::Image1DArray::ISA =
413 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
414
415 @OpenCL::UserEvent::ISA = OpenCL::Event::;
416}
417
277=head2 THE OpenCL PACKAGE 418=head2 THE OpenCL PACKAGE
278 419
279=over 4 420=over 4
280 421
281=item $int = OpenCL::errno 422=item $int = OpenCL::errno
287 428
288Comverts an error value into a human readable string. 429Comverts an error value into a human readable string.
289 430
290=item $str = OpenCL::enum2str $enum 431=item $str = OpenCL::enum2str $enum
291 432
292Converts most enum values (inof parameter names, image format constants, 433Converts most enum values (of parameter names, image format constants,
293object types, addressing and filter modes, command types etc.) into a 434object types, addressing and filter modes, command types etc.) into a
294human readbale string. When confronted with some random integer it can be 435human readable string. When confronted with some random integer it can be
295very helpful to pass it through this function to maybe get some readable 436very helpful to pass it through this function to maybe get some readable
296string out of it. 437string out of it.
297 438
298=item @platforms = OpenCL::platforms 439=item @platforms = OpenCL::platforms
299 440
313 454
314L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 455L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
315 456
316=back 457=back
317 458
459=head2 THE OpenCL::Object CLASS
460
461This is the base class for all objects in the OpenCL module. The only
462method it implements is the C<id> method, which is only useful if you want
463to interface to OpenCL on the C level.
464
465=over 4
466
467=item $iv = $obj->id
468
469OpenCL objects are represented by pointers or integers on the C level. If
470you want to interface to an OpenCL object directly on the C level, then
471you need this value, which is returned by this method. You should use an
472C<IV> type in your code and cast that to the correct type.
473
474=cut
475
476sub OpenCL::Object::id {
477 ${$_[0]}
478}
479
480=back
481
318=head2 THE OpenCL::Platform CLASS 482=head2 THE OpenCL::Platform CLASS
319 483
320=over 4 484=over 4
321 485
322=item $packed_value = $platform->info ($name)
323
324Calls C<clGetPlatformInfo> and returns the packed, raw value - for
325strings, this will be the string, for other values you probably need to
326use the correct C<unpack>. This might get improved in the future. Hopefully.
327
328L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
329
330=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 486=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
331 487
332Returns a list of matching OpenCL::Device objects. 488Returns a list of matching OpenCL::Device objects.
333 489
334=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 490=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
335 491
336Tries to create a context. Never worked for me, and you need devices explitly anyway. 492Tries to create a context. Never worked for me, and you need devices explicitly anyway.
337 493
338L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 494L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
339 495
340=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 496=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
341 497
342Create a new OpenCL::Context object using the given device object(s)- a 498Create a new OpenCL::Context object using the given device object(s)- a
343CL_CONTEXT_PLATFORM property is supplied automatically. 499CL_CONTEXT_PLATFORM property is supplied automatically.
344 500
345L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 501L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
346 502
503=item $packed_value = $platform->info ($name)
504
505Calls C<clGetPlatformInfo> and returns the packed, raw value - for
506strings, this will be the string (possibly including terminating \0), for
507other values you probably need to use the correct C<unpack>.
508
509It's best to avoid this method and use one of the following convenience
510wrappers.
511
512L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
513
514=item $platform->unload_compiler
515
516Attempts to unload the compiler for this platform, for endless
517profit. Does nothing on OpenCL 1.1.
518
519L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
520
521=for gengetinfo begin platform
522
523=item $string = $platform->profile
524
525Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
526
527=item $string = $platform->version
528
529Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
530
531=item $string = $platform->name
532
533Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
534
535=item $string = $platform->vendor
536
537Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
538
539=item $string = $platform->extensions
540
541Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
542
543=for gengetinfo end platform
544
347=back 545=back
348 546
349=head2 THE OpenCL::Device CLASS 547=head2 THE OpenCL::Device CLASS
350 548
351=over 4 549=over 4
354 552
355See C<< $platform->info >> for details. 553See C<< $platform->info >> for details.
356 554
357L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 555L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
358 556
557=for gengetinfo begin device
558
559=item $device_type = $device->type
560
561Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
562
563=item $uint = $device->vendor_id
564
565Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
566
567=item $uint = $device->max_compute_units
568
569Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
570
571=item $uint = $device->max_work_item_dimensions
572
573Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
574
575=item $int = $device->max_work_group_size
576
577Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
578
579=item @ints = $device->max_work_item_sizes
580
581Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
582
583=item $uint = $device->preferred_vector_width_char
584
585Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
586
587=item $uint = $device->preferred_vector_width_short
588
589Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
590
591=item $uint = $device->preferred_vector_width_int
592
593Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
594
595=item $uint = $device->preferred_vector_width_long
596
597Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
598
599=item $uint = $device->preferred_vector_width_float
600
601Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
602
603=item $uint = $device->preferred_vector_width_double
604
605Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
606
607=item $uint = $device->max_clock_frequency
608
609Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
610
611=item $bitfield = $device->address_bits
612
613Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
614
615=item $uint = $device->max_read_image_args
616
617Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
618
619=item $uint = $device->max_write_image_args
620
621Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
622
623=item $ulong = $device->max_mem_alloc_size
624
625Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
626
627=item $int = $device->image2d_max_width
628
629Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
630
631=item $int = $device->image2d_max_height
632
633Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
634
635=item $int = $device->image3d_max_width
636
637Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
638
639=item $int = $device->image3d_max_height
640
641Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
642
643=item $int = $device->image3d_max_depth
644
645Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
646
647=item $uint = $device->image_support
648
649Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
650
651=item $int = $device->max_parameter_size
652
653Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
654
655=item $uint = $device->max_samplers
656
657Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
658
659=item $uint = $device->mem_base_addr_align
660
661Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
662
663=item $uint = $device->min_data_type_align_size
664
665Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
666
667=item $device_fp_config = $device->single_fp_config
668
669Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
670
671=item $device_mem_cache_type = $device->global_mem_cache_type
672
673Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
674
675=item $uint = $device->global_mem_cacheline_size
676
677Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
678
679=item $ulong = $device->global_mem_cache_size
680
681Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
682
683=item $ulong = $device->global_mem_size
684
685Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
686
687=item $ulong = $device->max_constant_buffer_size
688
689Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
690
691=item $uint = $device->max_constant_args
692
693Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
694
695=item $device_local_mem_type = $device->local_mem_type
696
697Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
698
699=item $ulong = $device->local_mem_size
700
701Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
702
703=item $boolean = $device->error_correction_support
704
705Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
706
707=item $int = $device->profiling_timer_resolution
708
709Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
710
711=item $boolean = $device->endian_little
712
713Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
714
715=item $boolean = $device->available
716
717Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
718
719=item $boolean = $device->compiler_available
720
721Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
722
723=item $device_exec_capabilities = $device->execution_capabilities
724
725Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
726
727=item $command_queue_properties = $device->properties
728
729Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
730
731=item $ = $device->platform
732
733Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
734
735=item $string = $device->name
736
737Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
738
739=item $string = $device->vendor
740
741Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
742
743=item $string = $device->driver_version
744
745Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
746
747=item $string = $device->profile
748
749Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
750
751=item $string = $device->version
752
753Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
754
755=item $string = $device->extensions
756
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
758
759=item $uint = $device->preferred_vector_width_half
760
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
762
763=item $uint = $device->native_vector_width_char
764
765Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
766
767=item $uint = $device->native_vector_width_short
768
769Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
770
771=item $uint = $device->native_vector_width_int
772
773Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
774
775=item $uint = $device->native_vector_width_long
776
777Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
778
779=item $uint = $device->native_vector_width_float
780
781Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
782
783=item $uint = $device->native_vector_width_double
784
785Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
786
787=item $uint = $device->native_vector_width_half
788
789Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
790
791=item $device_fp_config = $device->double_fp_config
792
793Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
794
795=item $device_fp_config = $device->half_fp_config
796
797Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
798
799=item $boolean = $device->host_unified_memory
800
801Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
802
803=item $device = $device->parent_device_ext
804
805Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
806
807=item @device_partition_property_exts = $device->partition_types_ext
808
809Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
810
811=item @device_partition_property_exts = $device->affinity_domains_ext
812
813Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
814
815=item $uint = $device->reference_count_ext
816
817Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
818
819=item @device_partition_property_exts = $device->partition_style_ext
820
821Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
822
823=for gengetinfo end device
824
359=back 825=back
360 826
361=head2 THE OpenCL::Context CLASS 827=head2 THE OpenCL::Context CLASS
362 828
363=over 4 829=over 4
364 830
365=item $packed_value = $ctx->info ($name) 831=item $prog = $ctx->build_program ($program, $options = "")
366 832
367See C<< $platform->info >> for details. 833This convenience function tries to build the program on all devices in
834the context. If the build fails, then the function will C<croak> with the
835build log. Otherwise ti returns the program object.
368 836
369L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 837The C<$program> can either be a C<OpenCL::Program> object or a string
838containing the program. In the latter case, a program objetc will be
839created automatically.
840
841=cut
842
843sub OpenCL::Context::build_program {
844 my ($self, $prog, $options) = @_;
845
846 $prog = $self->program_with_source ($prog)
847 unless ref $prog;
848
849 for my $dev ($self->devices) {
850 eval { $prog->build ($dev, $options); 1 }
851 or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
852 . $prog->build_log ($dev);
853 }
854
855 $prog
856}
370 857
371=item $queue = $ctx->queue ($device, $properties) 858=item $queue = $ctx->queue ($device, $properties)
372 859
373Create a new OpenCL::Queue object from the context and the given device. 860Create a new OpenCL::Queue object from the context and the given device.
374 861
375L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 862L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
376 863
864Example: create an out-of-order queue.
865
866 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
867
377=item $ev = $ctx->user_event 868=item $ev = $ctx->user_event
378 869
379Creates a new OpenCL::UserEvent object. 870Creates a new OpenCL::UserEvent object.
380 871
381L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 872L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
382 873
383=item $buf = $ctx->buffer ($flags, $len) 874=item $buf = $ctx->buffer ($flags, $len)
384 875
385Creates a new OpenCL::Buffer object with the given flags and octet-size. 876Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
877given flags and octet-size.
386 878
387L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 879L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
388 880
389=item $buf = $ctx->buffer_sv ($flags, $data) 881=item $buf = $ctx->buffer_sv ($flags, $data)
390 882
391Creates a new OpenCL::Buffer object and initialise it with the given data values. 883Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
884initialise it with the given data values.
885
886=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
887
888Creates a new OpenCL::Image object and optionally initialises it with
889the given data values.
890
891L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
392 892
393=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 893=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
394 894
395Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 895Creates a new OpenCL::Image2D object and optionally initialises it with
896the given data values.
396 897
397L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 898L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
398 899
399=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 900=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
400 901
401Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 902Creates a new OpenCL::Image3D object and optionally initialises it with
903the given data values.
402 904
403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 905L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
906
907=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
908
909Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
910OpenGL buffer object.
911
912http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
913
914=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
915
916Creates a new OpenCL::Image object that refers to the given OpenGL
917texture object or buffer.
918
919http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
920
921=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
922
923Creates a new OpenCL::Image2D object that refers to the given OpenGL
9242D texture object.
925
926http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
927
928=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
929
930Creates a new OpenCL::Image3D object that refers to the given OpenGL
9313D texture object.
932
933http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
934
935=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
936
937Creates a new OpenCL::Image2D object that refers to the given OpenGL
938render buffer.
939
940http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
404 941
405=item @formats = $ctx->supported_image_formats ($flags, $image_type) 942=item @formats = $ctx->supported_image_formats ($flags, $image_type)
406 943
407Returns a list of matching image formats - each format is an arrayref with 944Returns a list of matching image formats - each format is an arrayref with
408two values, $channel_order and $channel_type, in it. 945two values, $channel_order and $channel_type, in it.
418=item $program = $ctx->program_with_source ($string) 955=item $program = $ctx->program_with_source ($string)
419 956
420Creates a new OpenCL::Program object from the given source code. 957Creates a new OpenCL::Program object from the given source code.
421 958
422L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 959L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
960
961=item $packed_value = $ctx->info ($name)
962
963See C<< $platform->info >> for details.
964
965L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
966
967=for gengetinfo begin context
968
969=item $uint = $context->reference_count
970
971Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
972
973=item @devices = $context->devices
974
975Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
976
977=item @property_ints = $context->properties
978
979Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
980
981=item $uint = $context->num_devices
982
983Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
984
985=for gengetinfo end context
423 986
424=back 987=back
425 988
426=head2 THE OpenCL::Queue CLASS 989=head2 THE OpenCL::Queue CLASS
427 990
433for completion, unless the method is called in void context, in which case 996for completion, unless the method is called in void context, in which case
434no event object is created. 997no event object is created.
435 998
436They also allow you to specify any number of other event objects that this 999They also allow you to specify any number of other event objects that this
437request has to wait for before it starts executing, by simply passing the 1000request has to wait for before it starts executing, by simply passing the
438event objects as extra parameters to the enqueue methods. 1001event objects as extra parameters to the enqueue methods. To simplify
1002program design, this module ignores any C<undef> values in the list of
1003events. This makes it possible to code operations such as this, without
1004having to put a valid event object into C<$event> first:
1005
1006 $event = $queue->enqueue_xxx (..., $event);
439 1007
440Queues execute in-order by default, without any parallelism, so in most 1008Queues execute in-order by default, without any parallelism, so in most
441cases (i.e. you use only one queue) it's not necessary to wait for or 1009cases (i.e. you use only one queue) it's not necessary to wait for or
442create event objects. 1010create event objects, althoguh an our of order queue is often a bit
1011faster.
443 1012
444=over 4 1013=over 4
445 1014
446=item $packed_value = $ctx->info ($name)
447
448See C<< $platform->info >> for details.
449
450L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
451
452=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1015=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
453 1016
454Reads data from buffer into the given string. 1017Reads data from buffer into the given string.
455 1018
456L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 1019L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
463 1026
464=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1027=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
465 1028
466L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1029L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
467 1030
1031=item $ev = $queue->enqueue_read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
1032
1033http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1034
1035=item $ev = $queue->enqueue_write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
1036
1037http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1038
468=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1039=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
469 1040
1041L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1042
1043=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...)
1044
470L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1045L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
471 1046
472=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1047=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
473 1048
474L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1049L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
475 1050
1051=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...)
1052
1053L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1054
1055=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...)
1056
1057L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1058
476=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...) 1059=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...)
477 1060
478Yeah. 1061Yeah.
479 1062
480L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
481
482=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...)
483
484L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1063L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
485 1064
486=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...) 1065=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
487 1066
1067Fills the given buffer object with repeated applications of C<$pattern>,
1068starting at C<$offset> for C<$size> octets.
1069
1070L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1071
1072=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1073
1074Fills the given image area with the given rgba colour components. The
1075components are normally floating point values between C<0> and C<1>,
1076except when the image channel data type is a signe dor unsigned
1077unnormalised format, in which case the range is determined by the format.
1078
488L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1079L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
489
490=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...)
491
492L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
493 1080
494=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1081=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
495 1082
496L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1083L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
497 1084
511reference to an array of local work sizes, with the same number of 1098reference to an array of local work sizes, with the same number of
512elements as @$global_work_size. 1099elements as @$global_work_size.
513 1100
514L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1101L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
515 1102
516=item $ev = $queue->enqueue_marker 1103=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
517 1104
1105Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1106for subsequent OpenCL usage.
1107
518L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1108L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1109
1110=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1111
1112Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1113for subsequent OpenGL usage.
1114
1115L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
519 1116
520=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1117=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
521 1118
522L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1119L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
523 1120
524=item $queue->enqueue_barrier 1121=item $ev = $queue->enqueue_marker ($wait_events...)
525 1122
1123L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1124
1125=item $ev = $queue->enqueue_barrier ($wait_events...)
1126
526L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1127L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
527 1128
528=item $queue->flush 1129=item $queue->flush
529 1130
530L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1131L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
531 1132
532=item $queue->finish 1133=item $queue->finish
533 1134
534L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1135L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
535 1136
1137=item $packed_value = $queue->info ($name)
1138
1139See C<< $platform->info >> for details.
1140
1141L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1142
1143=for gengetinfo begin command_queue
1144
1145=item $ctx = $command_queue->context
1146
1147Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1148
1149=item $device = $command_queue->device
1150
1151Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1152
1153=item $uint = $command_queue->reference_count
1154
1155Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1156
1157=item $command_queue_properties = $command_queue->properties
1158
1159Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1160
1161=for gengetinfo end command_queue
1162
536=back 1163=back
537 1164
538=head2 THE OpenCL::Memory CLASS 1165=head2 THE OpenCL::Memory CLASS
539 1166
540This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1167This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
541OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1168OpenCL::Image2D and OpenCL::Image3D.
542currently only exist to allow type-checking.
543 1169
544=over 4 1170=over 4
545 1171
546=item $packed_value = $memory->info ($name) 1172=item $packed_value = $memory->info ($name)
547 1173
548See C<< $platform->info >> for details. 1174See C<< $platform->info >> for details.
549 1175
550L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1176L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
551 1177
1178=for gengetinfo begin mem
1179
1180=item $mem_object_type = $mem->type
1181
1182Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1183
1184=item $mem_flags = $mem->flags
1185
1186Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1187
1188=item $int = $mem->size
1189
1190Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1191
1192=item $ptr_value = $mem->host_ptr
1193
1194Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1195
1196=item $uint = $mem->map_count
1197
1198Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1199
1200=item $uint = $mem->reference_count
1201
1202Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1203
1204=item $ctx = $mem->context
1205
1206Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1207
1208=item $mem = $mem->associated_memobject
1209
1210Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1211
1212=item $int = $mem->offset
1213
1214Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1215
1216=for gengetinfo end mem
1217
1218=item ($type, $name) = $mem->gl_object_info
1219
1220Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1221object "name" (e.g. the texture name) used to create this memory object.
1222
1223L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1224
552=back 1225=back
553 1226
1227=head2 THE OpenCL::Buffer CLASS
1228
1229This is a subclass of OpenCL::Memory, and the superclass of
1230OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1231and sub-buffers.
1232
1233=head2 THE OpenCL::BufferObj CLASS
1234
1235This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1236because one cna create sub buffers of OpenLC::BufferObj objects, but not
1237sub buffers from these sub buffers.
1238
1239=over 4
1240
1241=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1242
1243Creates an OpenCL::Buffer objects from this buffer and returns it. The
1244C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1245
1246L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1247
1248=back
1249
1250=head2 THE OpenCL::Image CLASS
1251
1252This is the superclass of all image objects - OpenCL::Image1D,
1253OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1254OpenCL::Image2DArray and OpenCL::Image3D.
1255
1256=over 4
1257
1258=item $packed_value = $ev->image_info ($name)
1259
1260See C<< $platform->info >> for details.
1261
1262The reason this method is not called C<info> is that there already is an
1263C<< ->info >> method inherited from C<OpenCL::Memory>.
1264
1265L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1266
1267=for gengetinfo begin image
1268
1269=item $int = $image->element_size
1270
1271Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1272
1273=item $int = $image->row_pitch
1274
1275Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1276
1277=item $int = $image->slice_pitch
1278
1279Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1280
1281=item $int = $image->width
1282
1283Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1284
1285=item $int = $image->height
1286
1287Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1288
1289=item $int = $image->depth
1290
1291Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1292
1293=for gengetinfo end image
1294
1295=for gengetinfo begin gl_texture
1296
1297=item $GLenum = $gl_texture->target
1298
1299Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1300
1301=item $GLint = $gl_texture->gl_mipmap_level
1302
1303Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1304
1305=for gengetinfo end gl_texture
1306
1307=back
1308
554=head2 THE OpenCL::Sampler CLASS 1309=head2 THE OpenCL::Sampler CLASS
555 1310
556=over 4 1311=over 4
557 1312
558=item $packed_value = $sampler->info ($name) 1313=item $packed_value = $sampler->info ($name)
559 1314
560See C<< $platform->info >> for details. 1315See C<< $platform->info >> for details.
561 1316
562L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1317L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
563 1318
1319=for gengetinfo begin sampler
1320
1321=item $uint = $sampler->reference_count
1322
1323Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1324
1325=item $ctx = $sampler->context
1326
1327Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1328
1329=item $addressing_mode = $sampler->normalized_coords
1330
1331Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1332
1333=item $filter_mode = $sampler->addressing_mode
1334
1335Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1336
1337=item $boolean = $sampler->filter_mode
1338
1339Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1340
1341=for gengetinfo end sampler
1342
564=back 1343=back
565 1344
566=head2 THE OpenCL::Program CLASS 1345=head2 THE OpenCL::Program CLASS
567 1346
568=over 4 1347=over 4
569 1348
570=item $packed_value = $program->info ($name)
571
572See C<< $platform->info >> for details.
573
574L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
575
576=item $program->build ($device, $options = "") 1349=item $program->build ($device, $options = "")
577 1350
578Tries to build the program with the givne options. 1351Tries to build the program with the given options. See also the
1352C<$ctx->build> convenience function.
579 1353
580L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1354L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
581 1355
582=item $packed_value = $program->build_info ($device, $name) 1356=item $packed_value = $program->build_info ($device, $name)
583 1357
591Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1365Creates an OpenCL::Kernel object out of the named C<__kernel> function in
592the program. 1366the program.
593 1367
594L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1368L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
595 1369
1370=item @kernels = $program->kernels_in_program
1371
1372Returns all kernels successfully compiled for all devices in program.
1373
1374http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1375
1376=for gengetinfo begin program_build
1377
1378=item $build_status = $program->build_status ($device)
1379
1380Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1381
1382=item $string = $program->build_options ($device)
1383
1384Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1385
1386=item $string = $program->build_log ($device)
1387
1388Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1389
1390=for gengetinfo end program_build
1391
1392=item $packed_value = $program->info ($name)
1393
1394See C<< $platform->info >> for details.
1395
1396L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1397
1398=for gengetinfo begin program
1399
1400=item $uint = $program->reference_count
1401
1402Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1403
1404=item $ctx = $program->context
1405
1406Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1407
1408=item $uint = $program->num_devices
1409
1410Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1411
1412=item @devices = $program->devices
1413
1414Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1415
1416=item $string = $program->source
1417
1418Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1419
1420=item @ints = $program->binary_sizes
1421
1422Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1423
1424=for gengetinfo end program
1425
1426=item @blobs = $program->binaries
1427
1428Returns a string for the compiled binary for every device associated with
1429the program, empty strings indicate missing programs, and an empty result
1430means no program binaries are available.
1431
1432These "binaries" are often, in fact, informative low-level assembly
1433sources.
1434
1435L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1436
596=back 1437=back
597 1438
598=head2 THE OpenCL::Kernel CLASS 1439=head2 THE OpenCL::Kernel CLASS
599 1440
600=over 4 1441=over 4
602=item $packed_value = $kernel->info ($name) 1443=item $packed_value = $kernel->info ($name)
603 1444
604See C<< $platform->info >> for details. 1445See C<< $platform->info >> for details.
605 1446
606L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1447L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1448
1449=for gengetinfo begin kernel
1450
1451=item $string = $kernel->function_name
1452
1453Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1454
1455=item $uint = $kernel->num_args
1456
1457Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1458
1459=item $uint = $kernel->reference_count
1460
1461Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1462
1463=item $ctx = $kernel->context
1464
1465Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1466
1467=item $program = $kernel->program
1468
1469Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1470
1471=for gengetinfo end kernel
1472
1473=item $packed_value = $kernel->work_group_info ($device, $name)
1474
1475See C<< $platform->info >> for details.
1476
1477The reason this method is not called C<info> is that there already is an
1478C<< ->info >> method.
1479
1480L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1481
1482=for gengetinfo begin kernel_work_group
1483
1484=item $int = $kernel->work_group_size ($device)
1485
1486Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1487
1488=item @ints = $kernel->compile_work_group_size ($device)
1489
1490Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1491
1492=item $ulong = $kernel->local_mem_size ($device)
1493
1494Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1495
1496=item $int = $kernel->preferred_work_group_size_multiple ($device)
1497
1498Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1499
1500=item $ulong = $kernel->private_mem_size ($device)
1501
1502Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1503
1504=for gengetinfo end kernel_work_group
607 1505
608=item $kernel->set_TYPE ($index, $value) 1506=item $kernel->set_TYPE ($index, $value)
609 1507
610This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1508This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
611 1509
612TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1510TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
613C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1511C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
614C<image2d>, C<image3d>, C<sampler> or C<event>. 1512C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
615 1513
616Chars and integers (including the half type) are specified as integers, 1514Chars and integers (including the half type) are specified as integers,
617float and double as floating point values, memory/buffer/image2d/image3d 1515float and double as floating point values, memory/buffer/image2d/image3d
618must be an object of that type or C<undef>, and sampler and event must be 1516must be an object of that type or C<undef>, local-memory arguments are
619objects of that type. 1517set by specifying the size, and sampler and event must be objects of that
1518type.
1519
1520Setting an argument for a kernel does NOT keep a reference to the object -
1521for example, if you set an argument to some image object, free the image,
1522and call the kernel, you will run into undefined behaviour.
620 1523
621L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1524L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
622 1525
623=back 1526=back
624 1527
627This is the superclass for all event objects (including OpenCL::UserEvent 1530This is the superclass for all event objects (including OpenCL::UserEvent
628objects). 1531objects).
629 1532
630=over 4 1533=over 4
631 1534
1535=item $ev->wait
1536
1537Waits for the event to complete.
1538
1539L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1540
632=item $packed_value = $ev->info ($name) 1541=item $packed_value = $ev->info ($name)
633 1542
634See C<< $platform->info >> for details. 1543See C<< $platform->info >> for details.
635 1544
636L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1545L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
637 1546
638=item $ev->wait 1547=for gengetinfo begin event
639 1548
640Waits for the event to complete. 1549=item $queue = $event->command_queue
641 1550
1551Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1552
1553=item $command_type = $event->command_type
1554
1555Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1556
1557=item $uint = $event->reference_count
1558
1559Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1560
1561=item $uint = $event->command_execution_status
1562
1563Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1564
1565=item $ctx = $event->context
1566
1567Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1568
1569=for gengetinfo end event
1570
1571=item $packed_value = $ev->profiling_info ($name)
1572
1573See C<< $platform->info >> for details.
1574
1575The reason this method is not called C<info> is that there already is an
1576C<< ->info >> method.
1577
642L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1578L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1579
1580=for gengetinfo begin profiling
1581
1582=item $ulong = $event->profiling_command_queued
1583
1584Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1585
1586=item $ulong = $event->profiling_command_submit
1587
1588Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1589
1590=item $ulong = $event->profiling_command_start
1591
1592Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1593
1594=item $ulong = $event->profiling_command_end
1595
1596Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1597
1598=for gengetinfo end profiling
643 1599
644=back 1600=back
645 1601
646=head2 THE OpenCL::UserEvent CLASS 1602=head2 THE OpenCL::UserEvent CLASS
647 1603
654L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 1610L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
655 1611
656=back 1612=back
657 1613
658=cut 1614=cut
659
660package OpenCL;
661
662use common::sense;
663
664BEGIN {
665 our $VERSION = '0.15';
666
667 require XSLoader;
668 XSLoader::load (__PACKAGE__, $VERSION);
669
670 @OpenCL::Buffer::ISA =
671 @OpenCL::Image::ISA = OpenCL::Memory::;
672
673 @OpenCL::Image2D::ISA =
674 @OpenCL::Image3D::ISA = OpenCL::Image::;
675
676 @OpenCL::UserEvent::ISA = OpenCL::Event::;
677}
678 1615
6791; 16161;
680 1617
681=head1 AUTHOR 1618=head1 AUTHOR
682 1619

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines