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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines