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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.22 by root, Sun Nov 20 10:25:17 2011 UTC vs.
Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC

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
241=item * Structures are often specified by flattening out their components 329=item * Structures are often specified by flattening out their components
242as with short vectors, and returned as arrayrefs. 330as with short vectors, and returned as arrayrefs.
243 331
244=item * When enqueuing commands, the wait list is specified by adding 332=item * When enqueuing commands, the wait list is specified by adding
245extra arguments to the function - anywhere a C<$wait_events...> argument 333extra arguments to the function - anywhere a C<$wait_events...> argument
246is 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.
247 337
248=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
249context, 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
250by the method. 340by the method.
251 341
271 ulong IV - Q 361 ulong IV - Q
272 float NV float f 362 float NV float f
273 half IV ushort S 363 half IV ushort S
274 double NV double d 364 double NV double d
275 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=head2 EVENT SYSTEM
382
383OpenCL can generate a number of (potentially) asynchronous events, for
384example, after compiling a program, to signal a context-related error or,
385perhaps most important, to signal completion of queued jobs (by setting
386callbacks on OpenCL::Event objects).
387
388To facilitate this, this module maintains an event queue - each
389time an asynchronous event happens, it is queued, and perl will be
390interrupted. This is implemented via the L<Async::Interrupt> module. In
391addition, this module has L<AnyEvent> support, so it can seamlessly
392integrate itself into many event loops.
393
394Since this module is a bit hard to understand, here are some case examples:
395
396=head3 Don't use callbacks.
397
398When your program never uses any callbacks, then there will never be any
399notifications you need to take care of, and therefore no need to worry
400about all this.
401
402You can achieve a great deal by explicitly waiting for events, or using
403barriers and flush calls. In many programs, there is no need at all to
404tinker with asynchronous events.
405
406=head3 Use AnyEvent
407
408This module automatically registers a watcher that invokes all outstanding
409event callbacks when AnyEvent is initialised (and block asynchronous
410interruptions). Using this mode of operations is the safest and most
411recommended one.
412
413To use this, simply use AnyEvent and this module normally, make sure you
414have an event loop running:
415
416 use Gtk2 -init;
417 use AnyEvent;
418
419 # initialise AnyEvent, by creating a watcher, or:
420 AnyEvent::detect;
421
422 my $e = $queue->enqueue_marker;
423 $e->cb (sub {
424 warn "opencl is finished\n";
425 })
426
427 main Gtk2;
428
429Note that this module will not initialise AnyEvent for you. Before
430AnyEvent is initialised, the module will asynchronously interrupt perl
431instead. To avoid any surprises, it's best to explicitly initialise
432AnyEvent.
433
434You can temporarily enable asynchronous interruptions (see next paragraph)
435by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
436calling C<$OpenCL::INTERRUPT->block>.
437
438=head3 Let yourself be interrupted at any time
439
440This mode is the default unless AnyEvent is loaded and initialised. In
441this mode, OpenCL asynchronously interrupts a running perl program. The
442emphasis is on both I<asynchronously> and I<running> here.
443
444Asynchronously means that perl might execute your callbacks at any
445time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
446the C<until> loop following the marker call will be interrupted by the
447callback:
448
449 my $e = $queue->enqueue_marker;
450 my $flag;
451 $e->cb (sub { $flag = 1 });
452 1 until $flag;
453 # $flag is now 1
454
455The reason why you shouldn't blindly copy the above code is that
456busy waiting is a really really bad thing, and really really bad for
457performance.
458
459While at first this asynchronous business might look exciting, it can be
460really hard, because you need to be prepared for the callback code to be
461executed at any time, which limits the amount of things the callback code
462can do safely.
463
464This can be mitigated somewhat by using C<<
465$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
466documentation for details).
467
468The other problem is that your program must be actively I<running> to be
469interrupted. When you calculate stuff, your program is running. When you
470hang in some C functions or other block execution (by calling C<sleep>,
471C<select>, running an event loop and so on), your program is waiting, not
472running.
473
474One way around that would be to attach a read watcher to your event loop,
475listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
476dummy callback (C<sub { }>) to temporarily execute some perl code.
477
478That is then awfully close to using the built-in AnyEvent support above,
479though, so consider that one instead.
480
481=head3 Be creative
482
483OpenCL exports the L<Async::Interrupt> object it uses in the global
484variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
485
486So if you want to feel like a real pro, err, wait, if you feel no risk
487menas no fun, you can experiment by implementing your own mode of
488operations.
489
490=cut
491
492package OpenCL;
493
494use common::sense;
495use Async::Interrupt ();
496
497our $POLL_FUNC; # set by XS
498
499BEGIN {
500 our $VERSION = '0.97';
501
502 require XSLoader;
503 XSLoader::load (__PACKAGE__, $VERSION);
504
505 @OpenCL::Platform::ISA =
506 @OpenCL::Device::ISA =
507 @OpenCL::Context::ISA =
508 @OpenCL::Queue::ISA =
509 @OpenCL::Memory::ISA =
510 @OpenCL::Sampler::ISA =
511 @OpenCL::Program::ISA =
512 @OpenCL::Kernel::ISA =
513 @OpenCL::Event::ISA = OpenCL::Object::;
514
515 @OpenCL::Buffer::ISA =
516 @OpenCL::Image::ISA = OpenCL::Memory::;
517
518 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
519
520 @OpenCL::Image2D::ISA =
521 @OpenCL::Image3D::ISA =
522 @OpenCL::Image2DArray::ISA =
523 @OpenCL::Image1D::ISA =
524 @OpenCL::Image1DArray::ISA =
525 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
526
527 @OpenCL::UserEvent::ISA = OpenCL::Event::;
528}
529
276=head2 THE OpenCL PACKAGE 530=head2 THE OpenCL PACKAGE
277 531
278=over 4 532=over 4
279 533
280=item $int = OpenCL::errno 534=item $int = OpenCL::errno
286 540
287Comverts an error value into a human readable string. 541Comverts an error value into a human readable string.
288 542
289=item $str = OpenCL::enum2str $enum 543=item $str = OpenCL::enum2str $enum
290 544
291Converts most enum values (inof parameter names, image format constants, 545Converts most enum values (of parameter names, image format constants,
292object types, addressing and filter modes, command types etc.) into a 546object types, addressing and filter modes, command types etc.) into a
293human readbale string. When confronted with some random integer it can be 547human readable string. When confronted with some random integer it can be
294very helpful to pass it through this function to maybe get some readable 548very helpful to pass it through this function to maybe get some readable
295string out of it. 549string out of it.
296 550
297=item @platforms = OpenCL::platforms 551=item @platforms = OpenCL::platforms
298 552
299Returns all available OpenCL::Platform objects. 553Returns all available OpenCL::Platform objects.
300 554
301L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 555L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
302 556
303=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef 557=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr
304 558
305Tries to create a context from a default device and platform - never worked for me. 559Tries to create a context from a default device and platform - never worked for me.
306 560
307L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 561L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
308 562
310 564
311Waits for all events to complete. 565Waits for all events to complete.
312 566
313L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 567L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314 568
569=item OpenCL::poll
570
571Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
572invokes their callbacks.
573
574=item $OpenCL::INTERRUPT
575
576The L<Async::Interrupt> object used to signal asynchronous events (see
577L<EVENT SYSTEM>).
578
579=cut
580
581our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
582
583&_eq_initialise ($INTERRUPT->signal_func);
584
585=item $OpenCL::WATCHER
586
587The L<AnyEvent> watcher object used to watch for asynchronous events (see
588L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
589loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
590
591=cut
592
593our $WATCHER;
594
595sub _init_anyevent {
596 $INTERRUPT->block;
597 $WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
598}
599
600if (defined $AnyEvent::MODEL) {
601 _init_anyevent;
602} else {
603 push @AnyEvent::post_detect, \&_init_anyevent;
604}
605
315=back 606=back
316 607
608=head2 THE OpenCL::Object CLASS
609
610This is the base class for all objects in the OpenCL module. The only
611method it implements is the C<id> method, which is only useful if you want
612to interface to OpenCL on the C level.
613
614=over 4
615
616=item $iv = $obj->id
617
618OpenCL objects are represented by pointers or integers on the C level. If
619you want to interface to an OpenCL object directly on the C level, then
620you need this value, which is returned by this method. You should use an
621C<IV> type in your code and cast that to the correct type.
622
623=cut
624
625sub OpenCL::Object::id {
626 ref $_[0] eq "SCALAR"
627 ? ${ $_[0] }
628 : $_[0][0]
629}
630
631=back
632
317=head2 THE OpenCL::Platform CLASS 633=head2 THE OpenCL::Platform CLASS
318 634
319=over 4 635=over 4
320 636
321=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 637=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322 638
323Returns a list of matching OpenCL::Device objects. 639Returns a list of matching OpenCL::Device objects.
324 640
325=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 641=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr)
326 642
327Tries to create a context. Never worked for me, and you need devices explicitly anyway. 643Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 644
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 645L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 646
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 647=item $ctx = $platform->context ($properties, @$devices, $notify = $print_stderr)
332 648
333Create a new OpenCL::Context object using the given device object(s)- a 649Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 650CL_CONTEXT_PLATFORM property is supplied automatically.
335 651
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 652L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
344It's best to avoid this method and use one of the following convenience 660It's best to avoid this method and use one of the following convenience
345wrappers. 661wrappers.
346 662
347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 663L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348 664
665=item $platform->unload_compiler
666
667Attempts to unload the compiler for this platform, for endless
668profit. Does nothing on OpenCL 1.1.
669
670L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
671
349=for gengetinfo begin platform 672=for gengetinfo begin platform
350 673
351=item $string = $platform->profile 674=item $string = $platform->profile
352 675
353Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s). 676Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
354 677
355=item $string = $platform->version 678=item $string = $platform->version
356 679
357Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s). 680Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
358 681
359=item $string = $platform->name 682=item $string = $platform->name
360 683
361Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s). 684Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
362 685
363=item $string = $platform->vendor 686=item $string = $platform->vendor
364 687
365Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s). 688Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
366 689
367=item $string = $platform->extensions 690=item $string = $platform->extensions
368 691
369Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s). 692Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
370 693
371=for gengetinfo end platform 694=for gengetinfo end platform
372 695
373=back 696=back
374 697
384 707
385=for gengetinfo begin device 708=for gengetinfo begin device
386 709
387=item $device_type = $device->type 710=item $device_type = $device->type
388 711
389Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s). 712Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
390 713
391=item $uint = $device->vendor_id 714=item $uint = $device->vendor_id
392 715
393Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s). 716Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
394 717
395=item $uint = $device->max_compute_units 718=item $uint = $device->max_compute_units
396 719
397Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s). 720Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
398 721
399=item $uint = $device->max_work_item_dimensions 722=item $uint = $device->max_work_item_dimensions
400 723
401Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s). 724Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
402 725
403=item $int = $device->max_work_group_size 726=item $int = $device->max_work_group_size
404 727
405Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s). 728Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
406 729
407=item @ints = $device->max_work_item_sizes 730=item @ints = $device->max_work_item_sizes
408 731
409Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s). 732Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
410 733
411=item $uint = $device->preferred_vector_width_char 734=item $uint = $device->preferred_vector_width_char
412 735
413Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s). 736Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
414 737
415=item $uint = $device->preferred_vector_width_short 738=item $uint = $device->preferred_vector_width_short
416 739
417Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s). 740Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
418 741
419=item $uint = $device->preferred_vector_width_int 742=item $uint = $device->preferred_vector_width_int
420 743
421Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s). 744Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
422 745
423=item $uint = $device->preferred_vector_width_long 746=item $uint = $device->preferred_vector_width_long
424 747
425Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s). 748Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
426 749
427=item $uint = $device->preferred_vector_width_float 750=item $uint = $device->preferred_vector_width_float
428 751
429Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s). 752Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
430 753
431=item $uint = $device->preferred_vector_width_double 754=item $uint = $device->preferred_vector_width_double
432 755
433Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s). 756Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
434 757
435=item $uint = $device->max_clock_frequency 758=item $uint = $device->max_clock_frequency
436 759
437Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s). 760Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
438 761
439=item $bitfield = $device->address_bits 762=item $bitfield = $device->address_bits
440 763
441Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s). 764Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
442 765
443=item $uint = $device->max_read_image_args 766=item $uint = $device->max_read_image_args
444 767
445Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s). 768Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
446 769
447=item $uint = $device->max_write_image_args 770=item $uint = $device->max_write_image_args
448 771
449Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s). 772Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
450 773
451=item $ulong = $device->max_mem_alloc_size 774=item $ulong = $device->max_mem_alloc_size
452 775
453Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s). 776Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
454 777
455=item $int = $device->image2d_max_width 778=item $int = $device->image2d_max_width
456 779
457Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s). 780Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
458 781
459=item $int = $device->image2d_max_height 782=item $int = $device->image2d_max_height
460 783
461Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s). 784Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
462 785
463=item $int = $device->image3d_max_width 786=item $int = $device->image3d_max_width
464 787
465Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s). 788Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
466 789
467=item $int = $device->image3d_max_height 790=item $int = $device->image3d_max_height
468 791
469Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s). 792Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
470 793
471=item $int = $device->image3d_max_depth 794=item $int = $device->image3d_max_depth
472 795
473Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s). 796Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
474 797
475=item $uint = $device->image_support 798=item $uint = $device->image_support
476 799
477Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s). 800Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
478 801
479=item $int = $device->max_parameter_size 802=item $int = $device->max_parameter_size
480 803
481Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s). 804Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
482 805
483=item $uint = $device->max_samplers 806=item $uint = $device->max_samplers
484 807
485Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s). 808Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
486 809
487=item $uint = $device->mem_base_addr_align 810=item $uint = $device->mem_base_addr_align
488 811
489Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s). 812Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
490 813
491=item $uint = $device->min_data_type_align_size 814=item $uint = $device->min_data_type_align_size
492 815
493Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s). 816Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
494 817
495=item $device_fp_config = $device->single_fp_config 818=item $device_fp_config = $device->single_fp_config
496 819
497Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s). 820Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
498 821
499=item $device_mem_cache_type = $device->global_mem_cache_type 822=item $device_mem_cache_type = $device->global_mem_cache_type
500 823
501Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s). 824Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
502 825
503=item $uint = $device->global_mem_cacheline_size 826=item $uint = $device->global_mem_cacheline_size
504 827
505Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s). 828Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
506 829
507=item $ulong = $device->global_mem_cache_size 830=item $ulong = $device->global_mem_cache_size
508 831
509Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s). 832Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
510 833
511=item $ulong = $device->global_mem_size 834=item $ulong = $device->global_mem_size
512 835
513Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s). 836Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
514 837
515=item $ulong = $device->max_constant_buffer_size 838=item $ulong = $device->max_constant_buffer_size
516 839
517Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s). 840Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
518 841
519=item $uint = $device->max_constant_args 842=item $uint = $device->max_constant_args
520 843
521Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s). 844Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
522 845
523=item $device_local_mem_type = $device->local_mem_type 846=item $device_local_mem_type = $device->local_mem_type
524 847
525Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s). 848Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
526 849
527=item $ulong = $device->local_mem_size 850=item $ulong = $device->local_mem_size
528 851
529Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s). 852Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
530 853
531=item $boolean = $device->error_correction_support 854=item $boolean = $device->error_correction_support
532 855
533Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s). 856Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
534 857
535=item $int = $device->profiling_timer_resolution 858=item $int = $device->profiling_timer_resolution
536 859
537Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s). 860Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
538 861
539=item $boolean = $device->endian_little 862=item $boolean = $device->endian_little
540 863
541Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s). 864Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
542 865
543=item $boolean = $device->available 866=item $boolean = $device->available
544 867
545Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s). 868Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
546 869
547=item $boolean = $device->compiler_available 870=item $boolean = $device->compiler_available
548 871
549Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s). 872Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
550 873
551=item $device_exec_capabilities = $device->execution_capabilities 874=item $device_exec_capabilities = $device->execution_capabilities
552 875
553Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s). 876Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
554 877
555=item $command_queue_properties = $device->properties 878=item $command_queue_properties = $device->properties
556 879
557Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s). 880Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
558 881
559=item $ = $device->platform 882=item $ = $device->platform
560 883
561Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s). 884Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
562 885
563=item $string = $device->name 886=item $string = $device->name
564 887
565Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s). 888Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
566 889
567=item $string = $device->vendor 890=item $string = $device->vendor
568 891
569Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s). 892Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
570 893
571=item $string = $device->driver_version 894=item $string = $device->driver_version
572 895
573Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s). 896Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
574 897
575=item $string = $device->profile 898=item $string = $device->profile
576 899
577Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s). 900Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
578 901
579=item $string = $device->version 902=item $string = $device->version
580 903
581Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s). 904Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
582 905
583=item $string = $device->extensions 906=item $string = $device->extensions
584 907
585Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s). 908Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
586 909
587=item $uint = $device->preferred_vector_width_half 910=item $uint = $device->preferred_vector_width_half
588 911
589Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s). 912Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
590 913
591=item $uint = $device->native_vector_width_char 914=item $uint = $device->native_vector_width_char
592 915
593Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s). 916Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
594 917
595=item $uint = $device->native_vector_width_short 918=item $uint = $device->native_vector_width_short
596 919
597Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s). 920Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
598 921
599=item $uint = $device->native_vector_width_int 922=item $uint = $device->native_vector_width_int
600 923
601Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s). 924Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
602 925
603=item $uint = $device->native_vector_width_long 926=item $uint = $device->native_vector_width_long
604 927
605Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s). 928Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
606 929
607=item $uint = $device->native_vector_width_float 930=item $uint = $device->native_vector_width_float
608 931
609Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s). 932Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
610 933
611=item $uint = $device->native_vector_width_double 934=item $uint = $device->native_vector_width_double
612 935
613Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s). 936Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
614 937
615=item $uint = $device->native_vector_width_half 938=item $uint = $device->native_vector_width_half
616 939
617Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s). 940Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
618 941
619=item $device_fp_config = $device->double_fp_config 942=item $device_fp_config = $device->double_fp_config
620 943
621Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s). 944Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
622 945
623=item $device_fp_config = $device->half_fp_config 946=item $device_fp_config = $device->half_fp_config
624 947
625Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s). 948Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
626 949
627=item $boolean = $device->host_unified_memory 950=item $boolean = $device->host_unified_memory
628 951
629Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s). 952Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
630 953
631=item $device = $device->parent_device_ext 954=item $device = $device->parent_device_ext
632 955
633Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s). 956Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
634 957
635=item @device_partition_property_exts = $device->partition_types_ext 958=item @device_partition_property_exts = $device->partition_types_ext
636 959
637Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s). 960Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
638 961
639=item @device_partition_property_exts = $device->affinity_domains_ext 962=item @device_partition_property_exts = $device->affinity_domains_ext
640 963
641Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s). 964Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
642 965
643=item $uint = $device->reference_count_ext 966=item $uint = $device->reference_count_ext
644 967
645Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s). 968Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
646 969
647=item @device_partition_property_exts = $device->partition_style_ext 970=item @device_partition_property_exts = $device->partition_style_ext
648 971
649Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s). 972Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
650 973
651=for gengetinfo end device 974=for gengetinfo end device
652 975
653=back 976=back
654 977
655=head2 THE OpenCL::Context CLASS 978=head2 THE OpenCL::Context CLASS
656 979
657=over 4 980=over 4
658 981
982=item $prog = $ctx->build_program ($program, $options = "")
983
984This convenience function tries to build the program on all devices in
985the context. If the build fails, then the function will C<croak> with the
986build log. Otherwise ti returns the program object.
987
988The C<$program> can either be a C<OpenCL::Program> object or a string
989containing the program. In the latter case, a program objetc will be
990created automatically.
991
992=cut
993
994sub OpenCL::Context::build_program {
995 my ($self, $prog, $options) = @_;
996
997 require Carp;
998
999 $prog = $self->program_with_source ($prog)
1000 unless ref $prog;
1001
1002 # we build separately per device so we instantly know which one failed
1003 for my $dev ($self->devices) {
1004 eval { $prog->build ([$dev], $options); 1 }
1005 or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
1006 . $prog->build_log ($dev));
1007 }
1008
1009 $prog
1010}
1011
659=item $queue = $ctx->queue ($device, $properties) 1012=item $queue = $ctx->queue ($device, $properties)
660 1013
661Create a new OpenCL::Queue object from the context and the given device. 1014Create a new OpenCL::Queue object from the context and the given device.
662 1015
663L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 1016L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
664 1017
1018Example: create an out-of-order queue.
1019
1020 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
1021
665=item $ev = $ctx->user_event 1022=item $ev = $ctx->user_event
666 1023
667Creates a new OpenCL::UserEvent object. 1024Creates a new OpenCL::UserEvent object.
668 1025
669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 1026L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
670 1027
671=item $buf = $ctx->buffer ($flags, $len) 1028=item $buf = $ctx->buffer ($flags, $len)
672 1029
673Creates a new OpenCL::Buffer object with the given flags and octet-size. 1030Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1031given flags and octet-size.
674 1032
675L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1033L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
676 1034
677=item $buf = $ctx->buffer_sv ($flags, $data) 1035=item $buf = $ctx->buffer_sv ($flags, $data)
678 1036
679Creates a new OpenCL::Buffer object and initialise it with the given data values. 1037Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1038initialise it with the given data values.
1039
1040=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)
1041
1042Creates a new OpenCL::Image object and optionally initialises it with
1043the given data values.
1044
1045L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
680 1046
681=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1047=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
682 1048
683Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 1049Creates a new OpenCL::Image2D object and optionally initialises it with
1050the given data values.
684 1051
685L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 1052L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
686 1053
687=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 1054=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
688 1055
689Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 1056Creates a new OpenCL::Image3D object and optionally initialises it with
1057the given data values.
690 1058
691L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 1059L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
1060
1061=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1062
1063Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1064OpenGL buffer object.
1065
1066http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1067
1068=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1069
1070Creates a new OpenCL::Image object that refers to the given OpenGL
1071texture object or buffer.
1072
1073http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1074
1075=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1076
1077Creates a new OpenCL::Image2D object that refers to the given OpenGL
10782D texture object.
1079
1080http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
1081
1082=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
1083
1084Creates a new OpenCL::Image3D object that refers to the given OpenGL
10853D texture object.
1086
1087http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
1088
1089=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
1090
1091Creates a new OpenCL::Image2D object that refers to the given OpenGL
1092render buffer.
1093
1094http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
692 1095
693=item @formats = $ctx->supported_image_formats ($flags, $image_type) 1096=item @formats = $ctx->supported_image_formats ($flags, $image_type)
694 1097
695Returns a list of matching image formats - each format is an arrayref with 1098Returns a list of matching image formats - each format is an arrayref with
696two values, $channel_order and $channel_type, in it. 1099two values, $channel_order and $channel_type, in it.
717 1120
718=for gengetinfo begin context 1121=for gengetinfo begin context
719 1122
720=item $uint = $context->reference_count 1123=item $uint = $context->reference_count
721 1124
722Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s). 1125Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
723 1126
724=item @devices = $context->devices 1127=item @devices = $context->devices
725 1128
726Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s). 1129Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
727 1130
728=item @property_ints = $context->properties 1131=item @property_ints = $context->properties
729 1132
730Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s). 1133Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
731 1134
732=item $uint = $context->num_devices 1135=item $uint = $context->num_devices
733 1136
734Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s). 1137Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
735 1138
736=for gengetinfo end context 1139=for gengetinfo end context
737 1140
738=back 1141=back
739 1142
747for completion, unless the method is called in void context, in which case 1150for completion, unless the method is called in void context, in which case
748no event object is created. 1151no event object is created.
749 1152
750They also allow you to specify any number of other event objects that this 1153They also allow you to specify any number of other event objects that this
751request has to wait for before it starts executing, by simply passing the 1154request has to wait for before it starts executing, by simply passing the
752event objects as extra parameters to the enqueue methods. 1155event objects as extra parameters to the enqueue methods. To simplify
1156program design, this module ignores any C<undef> values in the list of
1157events. This makes it possible to code operations such as this, without
1158having to put a valid event object into C<$event> first:
1159
1160 $event = $queue->enqueue_xxx (..., $event);
753 1161
754Queues execute in-order by default, without any parallelism, so in most 1162Queues execute in-order by default, without any parallelism, so in most
755cases (i.e. you use only one queue) it's not necessary to wait for or 1163cases (i.e. you use only one queue) it's not necessary to wait for or
756create event objects. 1164create event objects, althoguh an our of order queue is often a bit
1165faster.
757 1166
758=over 4 1167=over 4
759 1168
760=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1169=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
761 1170
771 1180
772=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1181=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
773 1182
774L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1183L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
775 1184
1185=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...)
1186
1187http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1188
1189=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...)
1190
1191http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1192
776=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1193=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
777 1194
1195L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1196
1197=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...)
1198
778L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1199L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
779 1200
780=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1201=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
781 1202
782L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1203L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
783 1204
1205=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...)
1206
1207L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1208
1209=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...)
1210
1211L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1212
784=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...) 1213=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...)
785 1214
786Yeah. 1215Yeah.
787 1216
788L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
789
790=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...)
791
792L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1217L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
793 1218
794=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...) 1219=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
795 1220
1221Fills the given buffer object with repeated applications of C<$pattern>,
1222starting at C<$offset> for C<$size> octets.
1223
1224L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1225
1226=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1227
1228Fills the given image area with the given rgba colour components. The
1229components are normally floating point values between C<0> and C<1>,
1230except when the image channel data type is a signe dor unsigned
1231unnormalised format, in which case the range is determined by the format.
1232
796L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1233L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
797
798=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...)
799
800L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
801 1234
802=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1235=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
803 1236
804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1237L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
805 1238
819reference to an array of local work sizes, with the same number of 1252reference to an array of local work sizes, with the same number of
820elements as @$global_work_size. 1253elements as @$global_work_size.
821 1254
822L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1255L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
823 1256
824=item $ev = $queue->enqueue_marker 1257=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
825 1258
1259Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1260for subsequent OpenCL usage.
1261
826L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1262L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1263
1264=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1265
1266Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1267for subsequent OpenGL usage.
1268
1269L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
827 1270
828=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1271=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
829 1272
830L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1273L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
831 1274
832=item $queue->enqueue_barrier 1275=item $ev = $queue->enqueue_marker ($wait_events...)
833 1276
1277L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1278
1279=item $ev = $queue->enqueue_barrier ($wait_events...)
1280
834L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1281L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
835 1282
836=item $queue->flush 1283=item $queue->flush
837 1284
838L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1285L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
839 1286
849 1296
850=for gengetinfo begin command_queue 1297=for gengetinfo begin command_queue
851 1298
852=item $ctx = $command_queue->context 1299=item $ctx = $command_queue->context
853 1300
854Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s). 1301Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
855 1302
856=item $device = $command_queue->device 1303=item $device = $command_queue->device
857 1304
858Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s). 1305Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
859 1306
860=item $uint = $command_queue->reference_count 1307=item $uint = $command_queue->reference_count
861 1308
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s). 1309Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
863 1310
864=item $command_queue_properties = $command_queue->properties 1311=item $command_queue_properties = $command_queue->properties
865 1312
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s). 1313Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
867 1314
868=for gengetinfo end command_queue 1315=for gengetinfo end command_queue
869 1316
870=back 1317=back
871 1318
884 1331
885=for gengetinfo begin mem 1332=for gengetinfo begin mem
886 1333
887=item $mem_object_type = $mem->type 1334=item $mem_object_type = $mem->type
888 1335
889Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s). 1336Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
890 1337
891=item $mem_flags = $mem->flags 1338=item $mem_flags = $mem->flags
892 1339
893Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s). 1340Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
894 1341
895=item $int = $mem->size 1342=item $int = $mem->size
896 1343
897Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s). 1344Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
898 1345
899=item $ptr_value = $mem->host_ptr 1346=item $ptr_value = $mem->host_ptr
900 1347
901Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s). 1348Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
902 1349
903=item $uint = $mem->map_count 1350=item $uint = $mem->map_count
904 1351
905Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s). 1352Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
906 1353
907=item $uint = $mem->reference_count 1354=item $uint = $mem->reference_count
908 1355
909Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s). 1356Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
910 1357
911=item $ctx = $mem->context 1358=item $ctx = $mem->context
912 1359
913Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s). 1360Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
914 1361
915=item $mem = $mem->associated_memobject 1362=item $mem = $mem->associated_memobject
916 1363
917Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s). 1364Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
918 1365
919=item $int = $mem->offset 1366=item $int = $mem->offset
920 1367
921Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s). 1368Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
922 1369
923=for gengetinfo end mem 1370=for gengetinfo end mem
924 1371
1372=item ($type, $name) = $mem->gl_object_info
1373
1374Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1375object "name" (e.g. the texture name) used to create this memory object.
1376
1377L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1378
925=back 1379=back
926 1380
1381=head2 THE OpenCL::Buffer CLASS
1382
1383This is a subclass of OpenCL::Memory, and the superclass of
1384OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1385and sub-buffers.
1386
1387=head2 THE OpenCL::BufferObj CLASS
1388
1389This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1390because one cna create sub buffers of OpenLC::BufferObj objects, but not
1391sub buffers from these sub buffers.
1392
1393=over 4
1394
1395=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1396
1397Creates an OpenCL::Buffer objects from this buffer and returns it. The
1398C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1399
1400L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1401
1402=back
1403
927=head2 THE OpenCL::Image CLASS 1404=head2 THE OpenCL::Image CLASS
928 1405
929This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1406This is the superclass of all image objects - OpenCL::Image1D,
1407OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1408OpenCL::Image2DArray and OpenCL::Image3D.
930 1409
931=over 4 1410=over 4
932 1411
933=item $packed_value = $ev->image_info ($name) 1412=item $packed_value = $image->image_info ($name)
934 1413
935See C<< $platform->info >> for details. 1414See C<< $platform->info >> for details.
936 1415
937The reason this method is not called C<info> is that there already is an 1416The reason this method is not called C<info> is that there already is an
938C<< ->info >> method inherited from C<OpenCL::Memory>. 1417C<< ->info >> method inherited from C<OpenCL::Memory>.
939 1418
940L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1419L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
941 1420
1421=item ($channel_order, $channel_data_type) = $image->format
1422
1423Returns the channel order and type used to create the image by calling
1424C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
1425
942=for gengetinfo begin image 1426=for gengetinfo begin image
943 1427
944=item $int = $image->element_size 1428=item $int = $image->element_size
945 1429
946Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s). 1430Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
947 1431
948=item $int = $image->row_pitch 1432=item $int = $image->row_pitch
949 1433
950Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s). 1434Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
951 1435
952=item $int = $image->slice_pitch 1436=item $int = $image->slice_pitch
953 1437
954Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s). 1438Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
955 1439
956=item $int = $image->width 1440=item $int = $image->width
957 1441
958Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s). 1442Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
959 1443
960=item $int = $image->height 1444=item $int = $image->height
961 1445
962Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s). 1446Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
963 1447
964=item $int = $image->depth 1448=item $int = $image->depth
965 1449
966Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s). 1450Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
967 1451
968=for gengetinfo end image 1452=for gengetinfo end image
969 1453
1454=for gengetinfo begin gl_texture
1455
1456=item $GLenum = $gl_texture->target
1457
1458Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1459
1460=item $GLint = $gl_texture->gl_mipmap_level
1461
1462Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1463
1464=for gengetinfo end gl_texture
1465
970=back 1466=back
971 1467
972=head2 THE OpenCL::Sampler CLASS 1468=head2 THE OpenCL::Sampler CLASS
973 1469
974=over 4 1470=over 4
981 1477
982=for gengetinfo begin sampler 1478=for gengetinfo begin sampler
983 1479
984=item $uint = $sampler->reference_count 1480=item $uint = $sampler->reference_count
985 1481
986Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s). 1482Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
987 1483
988=item $ctx = $sampler->context 1484=item $ctx = $sampler->context
989 1485
990Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s). 1486Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
991 1487
992=item $addressing_mode = $sampler->normalized_coords 1488=item $addressing_mode = $sampler->normalized_coords
993 1489
994Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s). 1490Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
995 1491
996=item $filter_mode = $sampler->addressing_mode 1492=item $filter_mode = $sampler->addressing_mode
997 1493
998Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s). 1494Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
999 1495
1000=item $boolean = $sampler->filter_mode 1496=item $boolean = $sampler->filter_mode
1001 1497
1002Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s). 1498Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1003 1499
1004=for gengetinfo end sampler 1500=for gengetinfo end sampler
1005 1501
1006=back 1502=back
1007 1503
1008=head2 THE OpenCL::Program CLASS 1504=head2 THE OpenCL::Program CLASS
1009 1505
1010=over 4 1506=over 4
1011 1507
1012=item $program->build ($device, $options = "") 1508=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1013 1509
1014Tries to build the program with the givne options. 1510Tries to build the program with the given options. See also the
1511C<$ctx->build> convenience function.
1512
1513If a callback is specified, then it will be called when compilation is
1514finished. Note that many OpenCL implementations block your program while
1515compiling whether you use a callback or not. See C<build_async> if you
1516want to make sure the build is done in the background.
1517
1518Note that some OpenCL implementations atc up badly, and don't call the
1519callback in some error cases (but call it in others). This implementation
1520assumes the callback will always be called, and leaks memory if this is
1521not so. So best make sure you don't pass in invalid values.
1015 1522
1016L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1523L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1524
1525=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1526
1527Similar to C<< ->build >>, except it starts a thread, and never fails (you
1528need to check the compilation status form the callback, or by polling).
1017 1529
1018=item $packed_value = $program->build_info ($device, $name) 1530=item $packed_value = $program->build_info ($device, $name)
1019 1531
1020Similar to C<< $platform->info >>, but returns build info for a previous 1532Similar to C<< $platform->info >>, but returns build info for a previous
1021build attempt for the given device. 1533build attempt for the given device.
1027Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1539Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1028the program. 1540the program.
1029 1541
1030L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1542L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1031 1543
1544=item @kernels = $program->kernels_in_program
1545
1546Returns all kernels successfully compiled for all devices in program.
1547
1548http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1549
1032=for gengetinfo begin program_build 1550=for gengetinfo begin program_build
1033 1551
1034=item $build_status = $program->build_status ($device) 1552=item $build_status = $program->build_status ($device)
1035 1553
1036Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s). 1554Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1037 1555
1038=item $string = $program->build_options ($device) 1556=item $string = $program->build_options ($device)
1039 1557
1040Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s). 1558Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1041 1559
1042=item $string = $program->build_log ($device) 1560=item $string = $program->build_log ($device)
1043 1561
1044Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s). 1562Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1045 1563
1046=for gengetinfo end program_build 1564=for gengetinfo end program_build
1047 1565
1048=item $packed_value = $program->info ($name) 1566=item $packed_value = $program->info ($name)
1049 1567
1053 1571
1054=for gengetinfo begin program 1572=for gengetinfo begin program
1055 1573
1056=item $uint = $program->reference_count 1574=item $uint = $program->reference_count
1057 1575
1058Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s). 1576Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1059 1577
1060=item $ctx = $program->context 1578=item $ctx = $program->context
1061 1579
1062Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s). 1580Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1063 1581
1064=item $uint = $program->num_devices 1582=item $uint = $program->num_devices
1065 1583
1066Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s). 1584Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1067 1585
1068=item @devices = $program->devices 1586=item @devices = $program->devices
1069 1587
1070Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s). 1588Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1071 1589
1072=item $string = $program->source 1590=item $string = $program->source
1073 1591
1074Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s). 1592Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1075 1593
1076=item @ints = $program->binary_sizes 1594=item @ints = $program->binary_sizes
1077 1595
1078Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s). 1596Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1079 1597
1080=for gengetinfo end program 1598=for gengetinfo end program
1081 1599
1600=item @blobs = $program->binaries
1601
1602Returns a string for the compiled binary for every device associated with
1603the program, empty strings indicate missing programs, and an empty result
1604means no program binaries are available.
1605
1606These "binaries" are often, in fact, informative low-level assembly
1607sources.
1608
1609L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1610
1082=back 1611=back
1083 1612
1084=head2 THE OpenCL::Kernel CLASS 1613=head2 THE OpenCL::Kernel CLASS
1085 1614
1086=over 4 1615=over 4
1093 1622
1094=for gengetinfo begin kernel 1623=for gengetinfo begin kernel
1095 1624
1096=item $string = $kernel->function_name 1625=item $string = $kernel->function_name
1097 1626
1098Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s). 1627Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1099 1628
1100=item $uint = $kernel->num_args 1629=item $uint = $kernel->num_args
1101 1630
1102Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s). 1631Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1103 1632
1104=item $uint = $kernel->reference_count 1633=item $uint = $kernel->reference_count
1105 1634
1106Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s). 1635Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1107 1636
1108=item $ctx = $kernel->context 1637=item $ctx = $kernel->context
1109 1638
1110Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s). 1639Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1111 1640
1112=item $program = $kernel->program 1641=item $program = $kernel->program
1113 1642
1114Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s). 1643Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1115 1644
1116=for gengetinfo end kernel 1645=for gengetinfo end kernel
1117 1646
1118=item $packed_value = $kernel->work_group_info ($device, $name) 1647=item $packed_value = $kernel->work_group_info ($device, $name)
1119 1648
1126 1655
1127=for gengetinfo begin kernel_work_group 1656=for gengetinfo begin kernel_work_group
1128 1657
1129=item $int = $kernel->work_group_size ($device) 1658=item $int = $kernel->work_group_size ($device)
1130 1659
1131Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s). 1660Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1132 1661
1133=item @ints = $kernel->compile_work_group_size ($device) 1662=item @ints = $kernel->compile_work_group_size ($device)
1134 1663
1135Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s). 1664Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1136 1665
1137=item $ulong = $kernel->local_mem_size ($device) 1666=item $ulong = $kernel->local_mem_size ($device)
1138 1667
1139Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s). 1668Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1140 1669
1141=item $int = $kernel->preferred_work_group_size_multiple ($device) 1670=item $int = $kernel->preferred_work_group_size_multiple ($device)
1142 1671
1143Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s). 1672Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1144 1673
1145=item $ulong = $kernel->private_mem_size ($device) 1674=item $ulong = $kernel->private_mem_size ($device)
1146 1675
1147Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s). 1676Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1148 1677
1149=for gengetinfo end kernel_work_group 1678=for gengetinfo end kernel_work_group
1150 1679
1151=item $kernel->set_TYPE ($index, $value) 1680=item $kernel->set_TYPE ($index, $value)
1152 1681
1153This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1682This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1154 1683
1155TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1684TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1156C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1685C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1157C<image2d>, C<image3d>, C<sampler> or C<event>. 1686C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1158 1687
1159Chars and integers (including the half type) are specified as integers, 1688Chars and integers (including the half type) are specified as integers,
1160float and double as floating point values, memory/buffer/image2d/image3d 1689float and double as floating point values, memory/buffer/image2d/image3d
1161must be an object of that type or C<undef>, and sampler and event must be 1690must be an object of that type or C<undef>, local-memory arguments are
1162objects of that type. 1691set by specifying the size, and sampler and event must be objects of that
1692type.
1693
1694Setting an argument for a kernel does NOT keep a reference to the object -
1695for example, if you set an argument to some image object, free the image,
1696and call the kernel, you will run into undefined behaviour.
1163 1697
1164L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1698L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1165 1699
1166=back 1700=back
1167 1701
1176 1710
1177Waits for the event to complete. 1711Waits for the event to complete.
1178 1712
1179L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1713L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1180 1714
1715=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
1716
1717Adds a callback to the callback stack for the given event type. There is
1718no way to remove a callback again.
1719
1720L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
1721
1181=item $packed_value = $ev->info ($name) 1722=item $packed_value = $ev->info ($name)
1182 1723
1183See C<< $platform->info >> for details. 1724See C<< $platform->info >> for details.
1184 1725
1185L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1726L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1186 1727
1187=for gengetinfo begin event 1728=for gengetinfo begin event
1188 1729
1189=item $queue = $event->command_queue 1730=item $queue = $event->command_queue
1190 1731
1191Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s). 1732Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1192 1733
1193=item $command_type = $event->command_type 1734=item $command_type = $event->command_type
1194 1735
1195Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s). 1736Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1196 1737
1197=item $uint = $event->reference_count 1738=item $uint = $event->reference_count
1198 1739
1199Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s). 1740Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1200 1741
1201=item $uint = $event->command_execution_status 1742=item $uint = $event->command_execution_status
1202 1743
1203Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s). 1744Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1204 1745
1205=item $ctx = $event->context 1746=item $ctx = $event->context
1206 1747
1207Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s). 1748Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1208 1749
1209=for gengetinfo end event 1750=for gengetinfo end event
1210 1751
1211=item $packed_value = $ev->profiling_info ($name) 1752=item $packed_value = $ev->profiling_info ($name)
1212 1753
1219 1760
1220=for gengetinfo begin profiling 1761=for gengetinfo begin profiling
1221 1762
1222=item $ulong = $event->profiling_command_queued 1763=item $ulong = $event->profiling_command_queued
1223 1764
1224Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s). 1765Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1225 1766
1226=item $ulong = $event->profiling_command_submit 1767=item $ulong = $event->profiling_command_submit
1227 1768
1228Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s). 1769Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1229 1770
1230=item $ulong = $event->profiling_command_start 1771=item $ulong = $event->profiling_command_start
1231 1772
1232Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s). 1773Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1233 1774
1234=item $ulong = $event->profiling_command_end 1775=item $ulong = $event->profiling_command_end
1235 1776
1236Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s). 1777Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1237 1778
1238=for gengetinfo end profiling 1779=for gengetinfo end profiling
1239 1780
1240=back 1781=back
1241 1782
1245 1786
1246=over 4 1787=over 4
1247 1788
1248=item $ev->set_status ($execution_status) 1789=item $ev->set_status ($execution_status)
1249 1790
1791Sets the execution status of the user event. Can only be called once,
1792either with OpenCL::COMPLETE or a negative number as status.
1793
1250L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 1794L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1251 1795
1252=back 1796=back
1253 1797
1254=cut 1798=cut
1255
1256package OpenCL;
1257
1258use common::sense;
1259
1260BEGIN {
1261 our $VERSION = '0.55';
1262
1263 require XSLoader;
1264 XSLoader::load (__PACKAGE__, $VERSION);
1265
1266 @OpenCL::Buffer::ISA =
1267 @OpenCL::Image::ISA = OpenCL::Memory::;
1268
1269 @OpenCL::Image2D::ISA =
1270 @OpenCL::Image3D::ISA = OpenCL::Image::;
1271
1272 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1273}
1274 1799
12751; 18001;
1276 1801
1277=head1 AUTHOR 1802=head1 AUTHOR
1278 1803

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines