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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.23 by root, Sun Nov 20 22:29:36 2011 UTC vs.
Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC

… …
43 43
44OpenCL::Event objects are used to signal when something is complete. 44OpenCL::Event objects are used to signal when something is complete.
45 45
46=head2 HELPFUL RESOURCES 46=head2 HELPFUL RESOURCES
47 47
48The OpenCL spec used to develop this module (1.2 spec was available, but 48The OpenCL specs used to develop this module:
49no implementation was available to me :).
50 49
51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 50 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
52 53
53OpenCL manpages: 54OpenCL manpages:
54 55
55 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ 56 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
57 http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
56 58
57If you are into UML class diagrams, the following diagram might help - if 59If you are into UML class diagrams, the following diagram might help - if
58not, it will be mildly cobfusing: 60not, it will be mildly confusing (also, the class hierarchy of this module
61is much more fine-grained):
59 62
60 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html 63 http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/classDiagram.html
61 64
62Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it 65Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
63is, but at least it's free of charge: 66is, but at least it's free of charge:
64 67
65 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf 68 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
… …
101 104
102Best run this once to get a feel for the platforms and devices in your 105Best run this once to get a feel for the platforms and devices in your
103system. 106system.
104 107
105 for my $platform (OpenCL::platforms) { 108 for my $platform (OpenCL::platforms) {
106 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 109 printf "platform: %s\n", $platform->name;
107 printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); 110 printf "extensions: %s\n", $platform->extensions;
108 for my $device ($platform->devices) { 111 for my $device ($platform->devices) {
109 printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); 112 printf "+ device: %s\n", $device->name;
110 my $ctx = $device->context; 113 my $ctx = $platform->context (undef, [$device]);
111 # do stuff 114 # do stuff
112 } 115 }
113 } 116 }
114 117
115=head2 Get a useful context and a command queue. 118=head2 Get a useful context and a command queue.
… …
138=head2 Create a buffer with some predefined data, read it back synchronously, 141=head2 Create a buffer with some predefined data, read it back synchronously,
139then asynchronously. 142then asynchronously.
140 143
141 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut"); 144 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
142 145
143 $queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data); 146 $queue->read_buffer ($buf, 1, 1, 3, my $data);
144 print "$data\n"; 147 print "$data\n";
145 148
146 my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data); 149 my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
147 $ev->wait; 150 $ev->wait;
148 print "$data\n"; # prints "elm" 151 print "$data\n"; # prints "elm"
149 152
150=head2 Create and build a program, then create a kernel out of one of its 153=head2 Create and build a program, then create a kernel out of one of its
151functions. 154functions.
152 155
153 my $src = ' 156 my $src = '
154 __kernel void 157 kernel void
155 squareit (__global float *input, __global float *output) 158 squareit (global float *input, global float *output)
156 { 159 {
157 $id = get_global_id (0); 160 $id = get_global_id (0);
158 output [id] = input [id] * input [id]; 161 output [id] = input [id] * input [id];
159 } 162 }
160 '; 163 ';
161 164
162 my $prog = $ctx->program_with_source ($src); 165 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"); 166 my $kernel = $prog->kernel ("squareit");
169 167
170=head2 Create some input and output float buffers, then call the 168=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them. 169'squareit' kernel on them.
172 170
… …
176 # set buffer 174 # set buffer
177 $kernel->set_buffer (0, $input); 175 $kernel->set_buffer (0, $input);
178 $kernel->set_buffer (1, $output); 176 $kernel->set_buffer (1, $output);
179 177
180 # execute it for all 4 numbers 178 # execute it for all 4 numbers
181 $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 179 $queue->nd_range_kernel ($kernel, undef, [4], undef);
182 180
183 # enqueue a synchronous read 181 # enqueue a synchronous read
184 $queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 182 $queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
185 183
186 # print the results: 184 # print the results:
187 printf "%s\n", join ", ", unpack "f*", $data; 185 printf "%s\n", join ", ", unpack "f*", $data;
188 186
189=head2 The same enqueue operations as before, but assuming an out-of-order queue, 187=head2 The same enqueue operations as before, but assuming an out-of-order queue,
190showing off barriers. 188showing off barriers.
191 189
192 # execute it for all 4 numbers 190 # execute it for all 4 numbers
193 $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 191 $queue->nd_range_kernel ($kernel, undef, [4], undef);
194 192
195 # enqueue a barrier to ensure in-order execution 193 # enqueue a barrier to ensure in-order execution
196 $queue->enqueue_barrier; 194 $queue->barrier;
197 195
198 # enqueue an async read 196 # enqueue an async read
199 $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 197 $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
200 198
201 # wait for all requests to finish 199 # wait for all requests to finish
202 $queue->finish; 200 $queue->finish;
203 201
204=head2 The same enqueue operations as before, but assuming an out-of-order queue, 202=head2 The same enqueue operations as before, but assuming an out-of-order queue,
205showing off event objects and wait lists. 203showing off event objects and wait lists.
206 204
207 # execute it for all 4 numbers 205 # execute it for all 4 numbers
208 my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 206 my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
209 207
210 # enqueue an async read 208 # enqueue an async read
211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 209 $ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212 210
213 # wait for the last event to complete 211 # wait for the last event to complete
214 $ev->wait; 212 $ev->wait;
213
214=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215set tunnel effect.
216
217This is quite a long example to get you going.
218
219 use OpenGL ":all";
220 use OpenCL;
221
222 # open a window and create a gl texture
223 OpenGL::glpOpenWindow width => 256, height => 256;
224 my $texid = glGenTextures_p 1;
225 glBindTexture GL_TEXTURE_2D, $texid;
226 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
227
228 # find and use the first opencl device that let's us get a shared opengl context
229 my $platform;
230 my $dev;
231 my $ctx;
232
233 for (OpenCL::platforms) {
234 $platform = $_;
235 for ($platform->devices) {
236 $dev = $_;
237 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
238 and last;
239 }
240 }
241
242 $ctx
243 or die "cannot find suitable OpenCL device\n";
244
245 my $queue = $ctx->queue ($dev);
246
247 # now attach an opencl image2d object to the opengl texture
248 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
249
250 # now the boring opencl code
251 my $src = <<EOF;
252 kernel void
253 juliatunnel (write_only image2d_t img, float time)
254 {
255 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
256
257 float2 m = (float2)(1.f, p.y) / fabs (p.x);
258 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
259
260 float2 z = m;
261 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
262
263 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
264 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
265
266 float3 colour = (float3)(z.x, z.y, z.x * z.y);
267 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
268 }
269 EOF
270
271 my $prog = $ctx->build_program ($src);
272 my $kernel = $prog->kernel ("juliatunnel");
273
274 # program compiled, kernel ready, now draw and loop
275
276 for (my $time; ; ++$time) {
277 # acquire objects from opengl
278 $queue->acquire_gl_objects ([$tex]);
279
280 # configure and run our kernel
281 $kernel->set_image2d (0, $tex);
282 $kernel->set_float (1, $time);
283 $queue->nd_range_kernel ($kernel, undef, [256, 256], undef);
284
285 # release objects to opengl again
286 $queue->release_gl_objects ([$tex]);
287
288 # wait
289 $queue->finish;
290
291 # now draw the texture, the defaults should be all right
292 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
293
294 glEnable GL_TEXTURE_2D;
295 glBegin GL_QUADS;
296 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
297 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
298 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
299 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
300 glEnd;
301
302 glXSwapBuffers;
303
304 select undef, undef, undef, 1/60;
305 }
215 306
216=head1 DOCUMENTATION 307=head1 DOCUMENTATION
217 308
218=head2 BASIC CONVENTIONS 309=head2 BASIC CONVENTIONS
219 310
… …
241=item * Structures are often specified by flattening out their components 332=item * Structures are often specified by flattening out their components
242as with short vectors, and returned as arrayrefs. 333as with short vectors, and returned as arrayrefs.
243 334
244=item * When enqueuing commands, the wait list is specified by adding 335=item * When enqueuing commands, the wait list is specified by adding
245extra arguments to the function - anywhere a C<$wait_events...> argument 336extra arguments to the function - anywhere a C<$wait_events...> argument
246is documented this can be any number of event objects. 337is documented this can be any number of event objects. As an extsnion
338implemented by this module, C<undef> values will be ignored in the event
339list.
247 340
248=item * When enqueuing commands, if the enqueue method is called in void 341=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 342context, no event is created. In all other contexts an event is returned
250by the method. 343by the method.
251 344
… …
271 ulong IV - Q 364 ulong IV - Q
272 float NV float f 365 float NV float f
273 half IV ushort S 366 half IV ushort S
274 double NV double d 367 double NV double d
275 368
369=head2 GLX SUPPORT
370
371Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
372module, which has little to no documentation and has little to no support
373for glX), this module, as a special extension, treats context creation
374properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
375specially: If either or both of these are C<undef>, then the OpenCL
376module tries to dynamically resolve C<glXGetCurrentDisplay> and
377C<glXGetCurrentContext>, call these functions and use their return values
378instead.
379
380For this to work, the OpenGL library must be loaded, a GLX context must
381have been created and be made current, and C<dlsym> must be available and
382capable of finding the function via C<RTLD_DEFAULT>.
383
384=head2 EVENT SYSTEM
385
386OpenCL can generate a number of (potentially) asynchronous events, for
387example, after compiling a program, to signal a context-related error or,
388perhaps most important, to signal completion of queued jobs (by setting
389callbacks on OpenCL::Event objects).
390
391To facilitate this, this module maintains an event queue - each
392time an asynchronous event happens, it is queued, and perl will be
393interrupted. This is implemented via the L<Async::Interrupt> module. In
394addition, this module has L<AnyEvent> support, so it can seamlessly
395integrate itself into many event loops.
396
397Since this module is a bit hard to understand, here are some case examples:
398
399=head3 Don't use callbacks.
400
401When your program never uses any callbacks, then there will never be any
402notifications you need to take care of, and therefore no need to worry
403about all this.
404
405You can achieve a great deal by explicitly waiting for events, or using
406barriers and flush calls. In many programs, there is no need at all to
407tinker with asynchronous events.
408
409=head3 Use AnyEvent
410
411This module automatically registers a watcher that invokes all outstanding
412event callbacks when AnyEvent is initialised (and block asynchronous
413interruptions). Using this mode of operations is the safest and most
414recommended one.
415
416To use this, simply use AnyEvent and this module normally, make sure you
417have an event loop running:
418
419 use Gtk2 -init;
420 use AnyEvent;
421
422 # initialise AnyEvent, by creating a watcher, or:
423 AnyEvent::detect;
424
425 my $e = $queue->marker;
426 $e->cb (sub {
427 warn "opencl is finished\n";
428 })
429
430 main Gtk2;
431
432Note that this module will not initialise AnyEvent for you. Before
433AnyEvent is initialised, the module will asynchronously interrupt perl
434instead. To avoid any surprises, it's best to explicitly initialise
435AnyEvent.
436
437You can temporarily enable asynchronous interruptions (see next paragraph)
438by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
439calling C<$OpenCL::INTERRUPT->block>.
440
441=head3 Let yourself be interrupted at any time
442
443This mode is the default unless AnyEvent is loaded and initialised. In
444this mode, OpenCL asynchronously interrupts a running perl program. The
445emphasis is on both I<asynchronously> and I<running> here.
446
447Asynchronously means that perl might execute your callbacks at any
448time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
449the C<until> loop following the marker call will be interrupted by the
450callback:
451
452 my $e = $queue->marker;
453 my $flag;
454 $e->cb (sub { $flag = 1 });
455 1 until $flag;
456 # $flag is now 1
457
458The reason why you shouldn't blindly copy the above code is that
459busy waiting is a really really bad thing, and really really bad for
460performance.
461
462While at first this asynchronous business might look exciting, it can be
463really hard, because you need to be prepared for the callback code to be
464executed at any time, which limits the amount of things the callback code
465can do safely.
466
467This can be mitigated somewhat by using C<<
468$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
469documentation for details).
470
471The other problem is that your program must be actively I<running> to be
472interrupted. When you calculate stuff, your program is running. When you
473hang in some C functions or other block execution (by calling C<sleep>,
474C<select>, running an event loop and so on), your program is waiting, not
475running.
476
477One way around that would be to attach a read watcher to your event loop,
478listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
479dummy callback (C<sub { }>) to temporarily execute some perl code.
480
481That is then awfully close to using the built-in AnyEvent support above,
482though, so consider that one instead.
483
484=head3 Be creative
485
486OpenCL exports the L<Async::Interrupt> object it uses in the global
487variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
488
489So if you want to feel like a real pro, err, wait, if you feel no risk
490menas no fun, you can experiment by implementing your own mode of
491operations.
492
493=cut
494
495package OpenCL;
496
497use common::sense;
498use Carp ();
499use Async::Interrupt ();
500
501our $POLL_FUNC; # set by XS
502
503BEGIN {
504 our $VERSION = '0.98';
505
506 require XSLoader;
507 XSLoader::load (__PACKAGE__, $VERSION);
508
509 @OpenCL::Platform::ISA =
510 @OpenCL::Device::ISA =
511 @OpenCL::Context::ISA =
512 @OpenCL::Queue::ISA =
513 @OpenCL::Memory::ISA =
514 @OpenCL::Sampler::ISA =
515 @OpenCL::Program::ISA =
516 @OpenCL::Kernel::ISA =
517 @OpenCL::Event::ISA = OpenCL::Object::;
518
519 @OpenCL::Buffer::ISA =
520 @OpenCL::Image::ISA = OpenCL::Memory::;
521
522 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
523
524 @OpenCL::Image2D::ISA =
525 @OpenCL::Image3D::ISA =
526 @OpenCL::Image2DArray::ISA =
527 @OpenCL::Image1D::ISA =
528 @OpenCL::Image1DArray::ISA =
529 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
530
531 @OpenCL::UserEvent::ISA = OpenCL::Event::;
532}
533
276=head2 THE OpenCL PACKAGE 534=head2 THE OpenCL PACKAGE
277 535
278=over 4 536=over 4
279 537
280=item $int = OpenCL::errno 538=item $int = OpenCL::errno
281 539
282The last error returned by a function - it's only valid after an error occured 540The last error returned by a function - it's only valid after an error occured
283and before calling another OpenCL function. 541and before calling another OpenCL function.
284 542
285=item $str = OpenCL::err2str $errval 543=item $str = OpenCL::err2str [$errval]
286 544
287Comverts an error value into a human readable string. 545Converts an error value into a human readable string. IF no error value is
546given, then the last error will be used (as returned by OpenCL::errno).
288 547
289=item $str = OpenCL::enum2str $enum 548=item $str = OpenCL::enum2str $enum
290 549
291Converts most enum values (inof parameter names, image format constants, 550Converts most enum values (of parameter names, image format constants,
292object types, addressing and filter modes, command types etc.) into a 551object types, addressing and filter modes, command types etc.) into a
293human readbale string. When confronted with some random integer it can be 552human readable string. When confronted with some random integer it can be
294very helpful to pass it through this function to maybe get some readable 553very helpful to pass it through this function to maybe get some readable
295string out of it. 554string out of it.
296 555
297=item @platforms = OpenCL::platforms 556=item @platforms = OpenCL::platforms
298 557
299Returns all available OpenCL::Platform objects. 558Returns all available OpenCL::Platform objects.
300 559
301L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 560L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
302 561
303=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef 562=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
304 563
305Tries to create a context from a default device and platform - never worked for me. 564Tries to create a context from a default device and platform type - never worked for me.
306 565
307L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 566L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
308 567
568=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
569
570Create a new OpenCL::Context object using the given device object(s). This
571function isn't implemented yet, use C<< $platform->context >> instead.
572
573L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
574
309=item OpenCL::wait_for_events $wait_events... 575=item OpenCL::wait_for_events $wait_events...
310 576
311Waits for all events to complete. 577Waits for all events to complete.
312 578
313L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 579L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314 580
581=item OpenCL::poll
582
583Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
584invokes their callbacks.
585
586=item $OpenCL::INTERRUPT
587
588The L<Async::Interrupt> object used to signal asynchronous events (see
589L<EVENT SYSTEM>).
590
591=cut
592
593our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
594
595&_eq_initialise ($INTERRUPT->signal_func);
596
597=item $OpenCL::WATCHER
598
599The L<AnyEvent> watcher object used to watch for asynchronous events (see
600L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
601loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
602
603=cut
604
605our $WATCHER;
606
607sub _init_anyevent {
608 $INTERRUPT->block;
609 $WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
610}
611
612if (defined $AnyEvent::MODEL) {
613 _init_anyevent;
614} else {
615 push @AnyEvent::post_detect, \&_init_anyevent;
616}
617
315=back 618=back
316 619
620=head2 THE OpenCL::Object CLASS
621
622This is the base class for all objects in the OpenCL module. The only
623method it implements is the C<id> method, which is only useful if you want
624to interface to OpenCL on the C level.
625
626=over 4
627
628=item $iv = $obj->id
629
630OpenCL objects are represented by pointers or integers on the C level. If
631you want to interface to an OpenCL object directly on the C level, then
632you need this value, which is returned by this method. You should use an
633C<IV> type in your code and cast that to the correct type.
634
635=cut
636
637sub OpenCL::Object::id {
638 ref $_[0] eq "SCALAR"
639 ? ${ $_[0] }
640 : $_[0][0]
641}
642
643=back
644
317=head2 THE OpenCL::Platform CLASS 645=head2 THE OpenCL::Platform CLASS
318 646
319=over 4 647=over 4
320 648
321=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 649=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322 650
323Returns a list of matching OpenCL::Device objects. 651Returns a list of matching OpenCL::Device objects.
324 652
325=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 653=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
326 654
327Tries to create a context. Never worked for me, and you need devices explicitly anyway. 655Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 656
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 657L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 658
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 659=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
332 660
333Create a new OpenCL::Context object using the given device object(s)- a 661Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 662CL_CONTEXT_PLATFORM property is supplied automatically.
335 663
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 664L<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 672It's best to avoid this method and use one of the following convenience
345wrappers. 673wrappers.
346 674
347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 675L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348 676
677=item $platform->unload_compiler
678
679Attempts to unload the compiler for this platform, for endless
680profit. Does nothing on OpenCL 1.1.
681
682L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
683
349=for gengetinfo begin platform 684=for gengetinfo begin platform
350 685
351=item $string = $platform->profile 686=item $string = $platform->profile
352 687
353Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s). 688Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
354 689
355=item $string = $platform->version 690=item $string = $platform->version
356 691
357Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s). 692Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
358 693
359=item $string = $platform->name 694=item $string = $platform->name
360 695
361Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s). 696Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
362 697
363=item $string = $platform->vendor 698=item $string = $platform->vendor
364 699
365Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s). 700Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
366 701
367=item $string = $platform->extensions 702=item $string = $platform->extensions
368 703
369Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s). 704Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
370 705
371=for gengetinfo end platform 706=for gengetinfo end platform
372 707
373=back 708=back
374 709
… …
384 719
385=for gengetinfo begin device 720=for gengetinfo begin device
386 721
387=item $device_type = $device->type 722=item $device_type = $device->type
388 723
389Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s). 724Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
390 725
391=item $uint = $device->vendor_id 726=item $uint = $device->vendor_id
392 727
393Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s). 728Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
394 729
395=item $uint = $device->max_compute_units 730=item $uint = $device->max_compute_units
396 731
397Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s). 732Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
398 733
399=item $uint = $device->max_work_item_dimensions 734=item $uint = $device->max_work_item_dimensions
400 735
401Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s). 736Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
402 737
403=item $int = $device->max_work_group_size 738=item $int = $device->max_work_group_size
404 739
405Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s). 740Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
406 741
407=item @ints = $device->max_work_item_sizes 742=item @ints = $device->max_work_item_sizes
408 743
409Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s). 744Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
410 745
411=item $uint = $device->preferred_vector_width_char 746=item $uint = $device->preferred_vector_width_char
412 747
413Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s). 748Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
414 749
415=item $uint = $device->preferred_vector_width_short 750=item $uint = $device->preferred_vector_width_short
416 751
417Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s). 752Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
418 753
419=item $uint = $device->preferred_vector_width_int 754=item $uint = $device->preferred_vector_width_int
420 755
421Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s). 756Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
422 757
423=item $uint = $device->preferred_vector_width_long 758=item $uint = $device->preferred_vector_width_long
424 759
425Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s). 760Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
426 761
427=item $uint = $device->preferred_vector_width_float 762=item $uint = $device->preferred_vector_width_float
428 763
429Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s). 764Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
430 765
431=item $uint = $device->preferred_vector_width_double 766=item $uint = $device->preferred_vector_width_double
432 767
433Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s). 768Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
434 769
435=item $uint = $device->max_clock_frequency 770=item $uint = $device->max_clock_frequency
436 771
437Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s). 772Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
438 773
439=item $bitfield = $device->address_bits 774=item $bitfield = $device->address_bits
440 775
441Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s). 776Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
442 777
443=item $uint = $device->max_read_image_args 778=item $uint = $device->max_read_image_args
444 779
445Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s). 780Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
446 781
447=item $uint = $device->max_write_image_args 782=item $uint = $device->max_write_image_args
448 783
449Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s). 784Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
450 785
451=item $ulong = $device->max_mem_alloc_size 786=item $ulong = $device->max_mem_alloc_size
452 787
453Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s). 788Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
454 789
455=item $int = $device->image2d_max_width 790=item $int = $device->image2d_max_width
456 791
457Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s). 792Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
458 793
459=item $int = $device->image2d_max_height 794=item $int = $device->image2d_max_height
460 795
461Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s). 796Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
462 797
463=item $int = $device->image3d_max_width 798=item $int = $device->image3d_max_width
464 799
465Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s). 800Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
466 801
467=item $int = $device->image3d_max_height 802=item $int = $device->image3d_max_height
468 803
469Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s). 804Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
470 805
471=item $int = $device->image3d_max_depth 806=item $int = $device->image3d_max_depth
472 807
473Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s). 808Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
474 809
475=item $uint = $device->image_support 810=item $uint = $device->image_support
476 811
477Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s). 812Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
478 813
479=item $int = $device->max_parameter_size 814=item $int = $device->max_parameter_size
480 815
481Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s). 816Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
482 817
483=item $uint = $device->max_samplers 818=item $uint = $device->max_samplers
484 819
485Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s). 820Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
486 821
487=item $uint = $device->mem_base_addr_align 822=item $uint = $device->mem_base_addr_align
488 823
489Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s). 824Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
490 825
491=item $uint = $device->min_data_type_align_size 826=item $uint = $device->min_data_type_align_size
492 827
493Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s). 828Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
494 829
495=item $device_fp_config = $device->single_fp_config 830=item $device_fp_config = $device->single_fp_config
496 831
497Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s). 832Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
498 833
499=item $device_mem_cache_type = $device->global_mem_cache_type 834=item $device_mem_cache_type = $device->global_mem_cache_type
500 835
501Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s). 836Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
502 837
503=item $uint = $device->global_mem_cacheline_size 838=item $uint = $device->global_mem_cacheline_size
504 839
505Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s). 840Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
506 841
507=item $ulong = $device->global_mem_cache_size 842=item $ulong = $device->global_mem_cache_size
508 843
509Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s). 844Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
510 845
511=item $ulong = $device->global_mem_size 846=item $ulong = $device->global_mem_size
512 847
513Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s). 848Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
514 849
515=item $ulong = $device->max_constant_buffer_size 850=item $ulong = $device->max_constant_buffer_size
516 851
517Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s). 852Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
518 853
519=item $uint = $device->max_constant_args 854=item $uint = $device->max_constant_args
520 855
521Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s). 856Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
522 857
523=item $device_local_mem_type = $device->local_mem_type 858=item $device_local_mem_type = $device->local_mem_type
524 859
525Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s). 860Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
526 861
527=item $ulong = $device->local_mem_size 862=item $ulong = $device->local_mem_size
528 863
529Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s). 864Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
530 865
531=item $boolean = $device->error_correction_support 866=item $boolean = $device->error_correction_support
532 867
533Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s). 868Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
534 869
535=item $int = $device->profiling_timer_resolution 870=item $int = $device->profiling_timer_resolution
536 871
537Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s). 872Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
538 873
539=item $boolean = $device->endian_little 874=item $boolean = $device->endian_little
540 875
541Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s). 876Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
542 877
543=item $boolean = $device->available 878=item $boolean = $device->available
544 879
545Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s). 880Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
546 881
547=item $boolean = $device->compiler_available 882=item $boolean = $device->compiler_available
548 883
549Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s). 884Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
550 885
551=item $device_exec_capabilities = $device->execution_capabilities 886=item $device_exec_capabilities = $device->execution_capabilities
552 887
553Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s). 888Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
554 889
555=item $command_queue_properties = $device->properties 890=item $command_queue_properties = $device->properties
556 891
557Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s). 892Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
558 893
559=item $ = $device->platform 894=item $ = $device->platform
560 895
561Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s). 896Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
562 897
563=item $string = $device->name 898=item $string = $device->name
564 899
565Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s). 900Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
566 901
567=item $string = $device->vendor 902=item $string = $device->vendor
568 903
569Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s). 904Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
570 905
571=item $string = $device->driver_version 906=item $string = $device->driver_version
572 907
573Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s). 908Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
574 909
575=item $string = $device->profile 910=item $string = $device->profile
576 911
577Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s). 912Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
578 913
579=item $string = $device->version 914=item $string = $device->version
580 915
581Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s). 916Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
582 917
583=item $string = $device->extensions 918=item $string = $device->extensions
584 919
585Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s). 920Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
586 921
587=item $uint = $device->preferred_vector_width_half 922=item $uint = $device->preferred_vector_width_half
588 923
589Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s). 924Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
590 925
591=item $uint = $device->native_vector_width_char 926=item $uint = $device->native_vector_width_char
592 927
593Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s). 928Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
594 929
595=item $uint = $device->native_vector_width_short 930=item $uint = $device->native_vector_width_short
596 931
597Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s). 932Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
598 933
599=item $uint = $device->native_vector_width_int 934=item $uint = $device->native_vector_width_int
600 935
601Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s). 936Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
602 937
603=item $uint = $device->native_vector_width_long 938=item $uint = $device->native_vector_width_long
604 939
605Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s). 940Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
606 941
607=item $uint = $device->native_vector_width_float 942=item $uint = $device->native_vector_width_float
608 943
609Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s). 944Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
610 945
611=item $uint = $device->native_vector_width_double 946=item $uint = $device->native_vector_width_double
612 947
613Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s). 948Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
614 949
615=item $uint = $device->native_vector_width_half 950=item $uint = $device->native_vector_width_half
616 951
617Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s). 952Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
618 953
619=item $device_fp_config = $device->double_fp_config 954=item $device_fp_config = $device->double_fp_config
620 955
621Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s). 956Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
622 957
623=item $device_fp_config = $device->half_fp_config 958=item $device_fp_config = $device->half_fp_config
624 959
625Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s). 960Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
626 961
627=item $boolean = $device->host_unified_memory 962=item $boolean = $device->host_unified_memory
628 963
629Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s). 964Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
630 965
631=item $device = $device->parent_device_ext 966=item $device = $device->parent_device_ext
632 967
633Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s). 968Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
634 969
635=item @device_partition_property_exts = $device->partition_types_ext 970=item @device_partition_property_exts = $device->partition_types_ext
636 971
637Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s). 972Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
638 973
639=item @device_partition_property_exts = $device->affinity_domains_ext 974=item @device_partition_property_exts = $device->affinity_domains_ext
640 975
641Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s). 976Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
642 977
643=item $uint = $device->reference_count_ext 978=item $uint = $device->reference_count_ext
644 979
645Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s). 980Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
646 981
647=item @device_partition_property_exts = $device->partition_style_ext 982=item @device_partition_property_exts = $device->partition_style_ext
648 983
649Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s). 984Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
650 985
651=for gengetinfo end device 986=for gengetinfo end device
652 987
653=back 988=back
654 989
655=head2 THE OpenCL::Context CLASS 990=head2 THE OpenCL::Context CLASS
656 991
657=over 4 992=over 4
658 993
994=item $prog = $ctx->build_program ($program, $options = "")
995
996This convenience function tries to build the program on all devices in
997the context. If the build fails, then the function will C<croak> with the
998build log. Otherwise ti returns the program object.
999
1000The C<$program> can either be a C<OpenCL::Program> object or a string
1001containing the program. In the latter case, a program objetc will be
1002created automatically.
1003
1004=cut
1005
1006sub OpenCL::Context::build_program {
1007 my ($self, $prog, $options) = @_;
1008
1009 $prog = $self->program_with_source ($prog)
1010 unless ref $prog;
1011
1012 eval { $prog->build (undef, $options); 1 }
1013 or errno == BUILD_PROGRAM_FAILURE
1014 or errno == INVALID_BINARY # workaround nvidia bug
1015 or Carp::croak "OpenCL::Context->build_program: " . err2str;
1016
1017 # we check status for all devices
1018 for my $dev ($self->devices) {
1019 $prog->build_status ($dev) == BUILD_SUCCESS
1020 or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1021 . $prog->build_log ($dev);
1022 }
1023
1024 $prog
1025}
1026
659=item $queue = $ctx->queue ($device, $properties) 1027=item $queue = $ctx->queue ($device, $properties)
660 1028
661Create a new OpenCL::Queue object from the context and the given device. 1029Create a new OpenCL::Queue object from the context and the given device.
662 1030
663L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 1031L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
664 1032
1033Example: create an out-of-order queue.
1034
1035 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
1036
665=item $ev = $ctx->user_event 1037=item $ev = $ctx->user_event
666 1038
667Creates a new OpenCL::UserEvent object. 1039Creates a new OpenCL::UserEvent object.
668 1040
669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 1041L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
670 1042
671=item $buf = $ctx->buffer ($flags, $len) 1043=item $buf = $ctx->buffer ($flags, $len)
672 1044
673Creates a new OpenCL::Buffer object with the given flags and octet-size. 1045Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1046given flags and octet-size.
674 1047
675L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1048L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
676 1049
677=item $buf = $ctx->buffer_sv ($flags, $data) 1050=item $buf = $ctx->buffer_sv ($flags, $data)
678 1051
679Creates a new OpenCL::Buffer object and initialise it with the given data values. 1052Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1053initialise it with the given data values.
1054
1055=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
1056
1057Creates a new OpenCL::Image object and optionally initialises it with
1058the given data values.
1059
1060L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
680 1061
681=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1062=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
682 1063
683Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 1064Creates a new OpenCL::Image2D object and optionally initialises it with
1065the given data values.
684 1066
685L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 1067L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
686 1068
687=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 1069=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
688 1070
689Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 1071Creates a new OpenCL::Image3D object and optionally initialises it with
1072the given data values.
690 1073
691L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 1074L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
1075
1076=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1077
1078Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1079OpenGL buffer object.
1080
1081http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1082
1083=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1084
1085Creates a new OpenCL::Image object that refers to the given OpenGL
1086texture object or buffer.
1087
1088http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1089
1090=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1091
1092Creates a new OpenCL::Image2D object that refers to the given OpenGL
10932D texture object.
1094
1095http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
1096
1097=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
1098
1099Creates a new OpenCL::Image3D object that refers to the given OpenGL
11003D texture object.
1101
1102http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
1103
1104=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
1105
1106Creates a new OpenCL::Image2D object that refers to the given OpenGL
1107render buffer.
1108
1109http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
692 1110
693=item @formats = $ctx->supported_image_formats ($flags, $image_type) 1111=item @formats = $ctx->supported_image_formats ($flags, $image_type)
694 1112
695Returns a list of matching image formats - each format is an arrayref with 1113Returns a list of matching image formats - each format is an arrayref with
696two values, $channel_order and $channel_type, in it. 1114two values, $channel_order and $channel_type, in it.
… …
717 1135
718=for gengetinfo begin context 1136=for gengetinfo begin context
719 1137
720=item $uint = $context->reference_count 1138=item $uint = $context->reference_count
721 1139
722Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s). 1140Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
723 1141
724=item @devices = $context->devices 1142=item @devices = $context->devices
725 1143
726Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s). 1144Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
727 1145
728=item @property_ints = $context->properties 1146=item @property_ints = $context->properties
729 1147
730Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s). 1148Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
731 1149
732=item $uint = $context->num_devices 1150=item $uint = $context->num_devices
733 1151
734Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s). 1152Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
735 1153
736=for gengetinfo end context 1154=for gengetinfo end context
737 1155
738=back 1156=back
739 1157
740=head2 THE OpenCL::Queue CLASS 1158=head2 THE OpenCL::Queue CLASS
741 1159
742An OpenCL::Queue represents an execution queue for OpenCL. You execute 1160An OpenCL::Queue represents an execution queue for OpenCL. You execute
743requests by calling their respective C<enqueue_xxx> method and waitinf for 1161requests by calling their respective method and waiting for it to complete
744it to complete in some way. 1162in some way.
745 1163
746All the enqueue methods return an event object that can be used to wait 1164Most methods that enqueue some request return an event object that can
747for completion, unless the method is called in void context, in which case 1165be used to wait for completion (optionally using a callback), unless
748no event object is created. 1166the method is called in void context, in which case no event object is
1167created.
749 1168
750They also allow you to specify any number of other event objects that this 1169They 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 1170request has to wait for before it starts executing, by simply passing the
752event objects as extra parameters to the enqueue methods. 1171event objects as extra parameters to the enqueue methods. To simplify
1172program design, this module ignores any C<undef> values in the list of
1173events. This makes it possible to code operations such as this, without
1174having to put a valid event object into C<$event> first:
1175
1176 $event = $queue->xxx (..., $event);
753 1177
754Queues execute in-order by default, without any parallelism, so in most 1178Queues 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 1179cases (i.e. you use only one queue) it's not necessary to wait for or
756create event objects. 1180create event objects, althoguh an our of order queue is often a bit
1181faster.
757 1182
758=over 4 1183=over 4
759 1184
760=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1185=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
761 1186
762Reads data from buffer into the given string. 1187Reads data from buffer into the given string.
763 1188
764L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 1189L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
765 1190
766=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...) 1191=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
767 1192
768Writes data to buffer from the given string. 1193Writes data to buffer from the given string.
769 1194
770L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html> 1195L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
771 1196
772=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1197=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
773 1198
774L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1199L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
775 1200
1201=item $ev = $queue->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...)
1202
1203http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1204
1205=item $ev = $queue->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...)
1206
1207http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1208
776=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1209=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1210
1211L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1212
1213=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
777 1214
778L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1215L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
779 1216
780=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1217=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
781 1218
782L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1219L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
783 1220
1221=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1222
1223L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1224
1225=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1226
1227L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1228
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...) 1229=item $ev = $queue->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 1230
786Yeah. 1231Yeah.
787 1232
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>. 1233L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
793 1234
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...) 1235=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
795 1236
1237Fills the given buffer object with repeated applications of C<$pattern>,
1238starting at C<$offset> for C<$size> octets.
1239
1240L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1241
1242=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1243
1244Fills the given image area with the given rgba colour components. The
1245components are normally floating point values between C<0> and C<1>,
1246except when the image channel data type is a signe dor unsigned
1247unnormalised format, in which case the range is determined by the format.
1248
796L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1249L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
797 1250
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
802=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1251=item $ev = $queue->task ($kernel, $wait_events...)
803 1252
804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1253L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
805 1254
806=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...) 1255=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
807 1256
808Enqueues a kernel execution. 1257Enqueues a kernel execution.
809 1258
810@$global_work_size must be specified as a reference to an array of 1259\@global_work_size must be specified as a reference to an array of
811integers specifying the work sizes (element counts). 1260integers specifying the work sizes (element counts).
812 1261
813@$global_work_offset must be either C<undef> (in which case all offsets 1262\@global_work_offset must be either C<undef> (in which case all offsets
814are C<0>), or a reference to an array of work offsets, with the same number 1263are C<0>), or a reference to an array of work offsets, with the same number
815of elements as @$global_work_size. 1264of elements as \@global_work_size.
816 1265
817@$local_work_size must be either C<undef> (in which case the 1266\@local_work_size must be either C<undef> (in which case the
818implementation is supposed to choose good local work sizes), or a 1267implementation is supposed to choose good local work sizes), or a
819reference to an array of local work sizes, with the same number of 1268reference to an array of local work sizes, with the same number of
820elements as @$global_work_size. 1269elements as \@global_work_size.
821 1270
822L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1271L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
823 1272
824=item $ev = $queue->enqueue_marker 1273=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
825 1274
1275Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1276for subsequent OpenCL usage.
1277
826L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1278L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
827 1279
1280=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1281
1282Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1283for subsequent OpenGL usage.
1284
1285L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1286
828=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1287=item $ev = $queue->wait_for_events ($wait_events...)
829 1288
830L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1289L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
831 1290
832=item $queue->enqueue_barrier 1291=item $ev = $queue->marker ($wait_events...)
833 1292
1293L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1294
1295=item $ev = $queue->barrier ($wait_events...)
1296
834L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1297L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
835 1298
836=item $queue->flush 1299=item $queue->flush
837 1300
838L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1301L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
839 1302
… …
849 1312
850=for gengetinfo begin command_queue 1313=for gengetinfo begin command_queue
851 1314
852=item $ctx = $command_queue->context 1315=item $ctx = $command_queue->context
853 1316
854Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s). 1317Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
855 1318
856=item $device = $command_queue->device 1319=item $device = $command_queue->device
857 1320
858Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s). 1321Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
859 1322
860=item $uint = $command_queue->reference_count 1323=item $uint = $command_queue->reference_count
861 1324
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s). 1325Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
863 1326
864=item $command_queue_properties = $command_queue->properties 1327=item $command_queue_properties = $command_queue->properties
865 1328
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s). 1329Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
867 1330
868=for gengetinfo end command_queue 1331=for gengetinfo end command_queue
869 1332
870=back 1333=back
871 1334
… …
884 1347
885=for gengetinfo begin mem 1348=for gengetinfo begin mem
886 1349
887=item $mem_object_type = $mem->type 1350=item $mem_object_type = $mem->type
888 1351
889Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s). 1352Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
890 1353
891=item $mem_flags = $mem->flags 1354=item $mem_flags = $mem->flags
892 1355
893Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s). 1356Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
894 1357
895=item $int = $mem->size 1358=item $int = $mem->size
896 1359
897Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s). 1360Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
898 1361
899=item $ptr_value = $mem->host_ptr 1362=item $ptr_value = $mem->host_ptr
900 1363
901Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s). 1364Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
902 1365
903=item $uint = $mem->map_count 1366=item $uint = $mem->map_count
904 1367
905Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s). 1368Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
906 1369
907=item $uint = $mem->reference_count 1370=item $uint = $mem->reference_count
908 1371
909Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s). 1372Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
910 1373
911=item $ctx = $mem->context 1374=item $ctx = $mem->context
912 1375
913Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s). 1376Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
914 1377
915=item $mem = $mem->associated_memobject 1378=item $mem = $mem->associated_memobject
916 1379
917Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s). 1380Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
918 1381
919=item $int = $mem->offset 1382=item $int = $mem->offset
920 1383
921Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s). 1384Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
922 1385
923=for gengetinfo end mem 1386=for gengetinfo end mem
924 1387
1388=item ($type, $name) = $mem->gl_object_info
1389
1390Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1391object "name" (e.g. the texture name) used to create this memory object.
1392
1393L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1394
925=back 1395=back
926 1396
1397=head2 THE OpenCL::Buffer CLASS
1398
1399This is a subclass of OpenCL::Memory, and the superclass of
1400OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1401and sub-buffers.
1402
1403=head2 THE OpenCL::BufferObj CLASS
1404
1405This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1406because one cna create sub buffers of OpenLC::BufferObj objects, but not
1407sub buffers from these sub buffers.
1408
1409=over 4
1410
1411=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1412
1413Creates an OpenCL::Buffer objects from this buffer and returns it. The
1414C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1415
1416L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1417
1418=back
1419
927=head2 THE OpenCL::Image CLASS 1420=head2 THE OpenCL::Image CLASS
928 1421
929This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1422This is the superclass of all image objects - OpenCL::Image1D,
1423OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1424OpenCL::Image2DArray and OpenCL::Image3D.
930 1425
931=over 4 1426=over 4
932 1427
933=item $packed_value = $ev->image_info ($name) 1428=item $packed_value = $image->image_info ($name)
934 1429
935See C<< $platform->info >> for details. 1430See C<< $platform->info >> for details.
936 1431
937The reason this method is not called C<info> is that there already is an 1432The reason this method is not called C<info> is that there already is an
938C<< ->info >> method inherited from C<OpenCL::Memory>. 1433C<< ->info >> method inherited from C<OpenCL::Memory>.
939 1434
940L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1435L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
941 1436
1437=item ($channel_order, $channel_data_type) = $image->format
1438
1439Returns the channel order and type used to create the image by calling
1440C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
1441
942=for gengetinfo begin image 1442=for gengetinfo begin image
943 1443
944=item $int = $image->element_size 1444=item $int = $image->element_size
945 1445
946Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s). 1446Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
947 1447
948=item $int = $image->row_pitch 1448=item $int = $image->row_pitch
949 1449
950Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s). 1450Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
951 1451
952=item $int = $image->slice_pitch 1452=item $int = $image->slice_pitch
953 1453
954Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s). 1454Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
955 1455
956=item $int = $image->width 1456=item $int = $image->width
957 1457
958Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s). 1458Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
959 1459
960=item $int = $image->height 1460=item $int = $image->height
961 1461
962Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s). 1462Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
963 1463
964=item $int = $image->depth 1464=item $int = $image->depth
965 1465
966Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s). 1466Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
967 1467
968=for gengetinfo end image 1468=for gengetinfo end image
969 1469
1470=for gengetinfo begin gl_texture
1471
1472=item $GLenum = $gl_texture->target
1473
1474Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1475
1476=item $GLint = $gl_texture->gl_mipmap_level
1477
1478Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1479
1480=for gengetinfo end gl_texture
1481
970=back 1482=back
971 1483
972=head2 THE OpenCL::Sampler CLASS 1484=head2 THE OpenCL::Sampler CLASS
973 1485
974=over 4 1486=over 4
… …
981 1493
982=for gengetinfo begin sampler 1494=for gengetinfo begin sampler
983 1495
984=item $uint = $sampler->reference_count 1496=item $uint = $sampler->reference_count
985 1497
986Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s). 1498Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
987 1499
988=item $ctx = $sampler->context 1500=item $ctx = $sampler->context
989 1501
990Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s). 1502Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
991 1503
992=item $addressing_mode = $sampler->normalized_coords 1504=item $addressing_mode = $sampler->normalized_coords
993 1505
994Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s). 1506Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
995 1507
996=item $filter_mode = $sampler->addressing_mode 1508=item $filter_mode = $sampler->addressing_mode
997 1509
998Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s). 1510Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
999 1511
1000=item $boolean = $sampler->filter_mode 1512=item $boolean = $sampler->filter_mode
1001 1513
1002Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s). 1514Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1003 1515
1004=for gengetinfo end sampler 1516=for gengetinfo end sampler
1005 1517
1006=back 1518=back
1007 1519
1008=head2 THE OpenCL::Program CLASS 1520=head2 THE OpenCL::Program CLASS
1009 1521
1010=over 4 1522=over 4
1011 1523
1012=item $program->build ($device, $options = "") 1524=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1013 1525
1014Tries to build the program with the givne options. 1526Tries to build the program with the given options. See also the
1527C<$ctx->build> convenience function.
1528
1529If a callback is specified, then it will be called when compilation is
1530finished. Note that many OpenCL implementations block your program while
1531compiling whether you use a callback or not. See C<build_async> if you
1532want to make sure the build is done in the background.
1533
1534Note that some OpenCL implementations act up badly, and don't call the
1535callback in some error cases (but call it in others). This implementation
1536assumes the callback will always be called, and leaks memory if this is
1537not so. So best make sure you don't pass in invalid values.
1538
1539Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1540compilation state is successful but some later stage fails.
1015 1541
1016L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1542L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1543
1544=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1545
1546Similar to C<< ->build >>, except it starts a thread, and never fails (you
1547need to check the compilation status form the callback, or by polling).
1017 1548
1018=item $packed_value = $program->build_info ($device, $name) 1549=item $packed_value = $program->build_info ($device, $name)
1019 1550
1020Similar to C<< $platform->info >>, but returns build info for a previous 1551Similar to C<< $platform->info >>, but returns build info for a previous
1021build attempt for the given device. 1552build attempt for the given device.
… …
1027Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1558Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1028the program. 1559the program.
1029 1560
1030L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1561L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1031 1562
1563=item @kernels = $program->kernels_in_program
1564
1565Returns all kernels successfully compiled for all devices in program.
1566
1567http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1568
1032=for gengetinfo begin program_build 1569=for gengetinfo begin program_build
1033 1570
1034=item $build_status = $program->build_status ($device) 1571=item $build_status = $program->build_status ($device)
1035 1572
1036Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s). 1573Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1037 1574
1038=item $string = $program->build_options ($device) 1575=item $string = $program->build_options ($device)
1039 1576
1040Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s). 1577Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1041 1578
1042=item $string = $program->build_log ($device) 1579=item $string = $program->build_log ($device)
1043 1580
1044Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s). 1581Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1045 1582
1046=for gengetinfo end program_build 1583=for gengetinfo end program_build
1047 1584
1048=item $packed_value = $program->info ($name) 1585=item $packed_value = $program->info ($name)
1049 1586
… …
1053 1590
1054=for gengetinfo begin program 1591=for gengetinfo begin program
1055 1592
1056=item $uint = $program->reference_count 1593=item $uint = $program->reference_count
1057 1594
1058Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s). 1595Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1059 1596
1060=item $ctx = $program->context 1597=item $ctx = $program->context
1061 1598
1062Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s). 1599Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1063 1600
1064=item $uint = $program->num_devices 1601=item $uint = $program->num_devices
1065 1602
1066Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s). 1603Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1067 1604
1068=item @devices = $program->devices 1605=item @devices = $program->devices
1069 1606
1070Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s). 1607Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1071 1608
1072=item $string = $program->source 1609=item $string = $program->source
1073 1610
1074Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s). 1611Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1075 1612
1076=item @ints = $program->binary_sizes 1613=item @ints = $program->binary_sizes
1077 1614
1078Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s). 1615Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1079 1616
1080=for gengetinfo end program 1617=for gengetinfo end program
1081 1618
1082=item @blobs = $program->binaries 1619=item @blobs = $program->binaries
1083 1620
… …
1104 1641
1105=for gengetinfo begin kernel 1642=for gengetinfo begin kernel
1106 1643
1107=item $string = $kernel->function_name 1644=item $string = $kernel->function_name
1108 1645
1109Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s). 1646Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1110 1647
1111=item $uint = $kernel->num_args 1648=item $uint = $kernel->num_args
1112 1649
1113Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s). 1650Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1114 1651
1115=item $uint = $kernel->reference_count 1652=item $uint = $kernel->reference_count
1116 1653
1117Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s). 1654Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1118 1655
1119=item $ctx = $kernel->context 1656=item $ctx = $kernel->context
1120 1657
1121Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s). 1658Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1122 1659
1123=item $program = $kernel->program 1660=item $program = $kernel->program
1124 1661
1125Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s). 1662Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1126 1663
1127=for gengetinfo end kernel 1664=for gengetinfo end kernel
1128 1665
1129=item $packed_value = $kernel->work_group_info ($device, $name) 1666=item $packed_value = $kernel->work_group_info ($device, $name)
1130 1667
… …
1137 1674
1138=for gengetinfo begin kernel_work_group 1675=for gengetinfo begin kernel_work_group
1139 1676
1140=item $int = $kernel->work_group_size ($device) 1677=item $int = $kernel->work_group_size ($device)
1141 1678
1142Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s). 1679Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1143 1680
1144=item @ints = $kernel->compile_work_group_size ($device) 1681=item @ints = $kernel->compile_work_group_size ($device)
1145 1682
1146Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s). 1683Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1147 1684
1148=item $ulong = $kernel->local_mem_size ($device) 1685=item $ulong = $kernel->local_mem_size ($device)
1149 1686
1150Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s). 1687Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1151 1688
1152=item $int = $kernel->preferred_work_group_size_multiple ($device) 1689=item $int = $kernel->preferred_work_group_size_multiple ($device)
1153 1690
1154Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s). 1691Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1155 1692
1156=item $ulong = $kernel->private_mem_size ($device) 1693=item $ulong = $kernel->private_mem_size ($device)
1157 1694
1158Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s). 1695Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1159 1696
1160=for gengetinfo end kernel_work_group 1697=for gengetinfo end kernel_work_group
1161 1698
1699=item $kernel->setf ($format, ...)
1700
1701Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1702way to set arguments (and with OpenCL 1.2 it might be rather slow), you
1703need to specify a format argument, much as with C<printf>, to tell OpenCL
1704what type of argument it is.
1705
1706The format arguments are single letters:
1707
1708 c char
1709 C unsigned char
1710 s short
1711 S unsigned short
1712 i int
1713 I unsigned int
1714 l long
1715 L unsigned long
1716
1717 h half float (0..65535)
1718 f float
1719 d double
1720
1721 z local (octet size)
1722
1723 m memory object (buffer or image)
1724 a sampler
1725 e event
1726
1727Space characters in the format string are ignored.
1728
1729Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
1730
1731 $kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
1732
1162=item $kernel->set_TYPE ($index, $value) 1733=item $kernel->set_TYPE ($index, $value)
1163 1734
1735=item $kernel->set_char ($index, $value)
1736
1737=item $kernel->set_uchar ($index, $value)
1738
1739=item $kernel->set_short ($index, $value)
1740
1741=item $kernel->set_ushort ($index, $value)
1742
1743=item $kernel->set_int ($index, $value)
1744
1745=item $kernel->set_uint ($index, $value)
1746
1747=item $kernel->set_long ($index, $value)
1748
1749=item $kernel->set_ulong ($index, $value)
1750
1751=item $kernel->set_half ($index, $value)
1752
1753=item $kernel->set_float ($index, $value)
1754
1755=item $kernel->set_double ($index, $value)
1756
1757=item $kernel->set_memory ($index, $value)
1758
1759=item $kernel->set_buffer ($index, $value)
1760
1761=item $kernel->set_image ($index, $value)
1762
1763=item $kernel->set_sampler ($index, $value)
1764
1765=item $kernel->set_local ($index, $value)
1766
1767=item $kernel->set_event ($index, $value)
1768
1164This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1769This is a family of methods to set the kernel argument with the number
1165 1770C<$index> to the give C<$value>.
1166TYPE 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>,
1168C<image2d>, C<image3d>, C<sampler> or C<event>.
1169 1771
1170Chars and integers (including the half type) are specified as integers, 1772Chars and integers (including the half type) are specified as integers,
1171float and double as floating point values, memory/buffer/image2d/image3d 1773float and double as floating point values, memory/buffer/image must be
1172must be an object of that type or C<undef>, and sampler and event must be 1774an object of that type or C<undef>, local-memory arguments are set by
1173objects of that type. 1775specifying the size, and sampler and event must be objects of that type.
1776
1777Note that C<set_memory> works for all memory objects (all types of buffers
1778and images) - the main purpose of the more specific C<set_TYPE> functions
1779is type checking.
1780
1781Setting an argument for a kernel does NOT keep a reference to the object -
1782for example, if you set an argument to some image object, free the image,
1783and call the kernel, you will run into undefined behaviour.
1174 1784
1175L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1785L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1176 1786
1177=back 1787=back
1178 1788
… …
1187 1797
1188Waits for the event to complete. 1798Waits for the event to complete.
1189 1799
1190L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1800L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1191 1801
1802=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
1803
1804Adds a callback to the callback stack for the given event type. There is
1805no way to remove a callback again.
1806
1807L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
1808
1192=item $packed_value = $ev->info ($name) 1809=item $packed_value = $ev->info ($name)
1193 1810
1194See C<< $platform->info >> for details. 1811See C<< $platform->info >> for details.
1195 1812
1196L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1813L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1197 1814
1198=for gengetinfo begin event 1815=for gengetinfo begin event
1199 1816
1200=item $queue = $event->command_queue 1817=item $queue = $event->command_queue
1201 1818
1202Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s). 1819Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1203 1820
1204=item $command_type = $event->command_type 1821=item $command_type = $event->command_type
1205 1822
1206Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s). 1823Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1207 1824
1208=item $uint = $event->reference_count 1825=item $uint = $event->reference_count
1209 1826
1210Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s). 1827Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1211 1828
1212=item $uint = $event->command_execution_status 1829=item $uint = $event->command_execution_status
1213 1830
1214Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s). 1831Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1215 1832
1216=item $ctx = $event->context 1833=item $ctx = $event->context
1217 1834
1218Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s). 1835Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1219 1836
1220=for gengetinfo end event 1837=for gengetinfo end event
1221 1838
1222=item $packed_value = $ev->profiling_info ($name) 1839=item $packed_value = $ev->profiling_info ($name)
1223 1840
… …
1230 1847
1231=for gengetinfo begin profiling 1848=for gengetinfo begin profiling
1232 1849
1233=item $ulong = $event->profiling_command_queued 1850=item $ulong = $event->profiling_command_queued
1234 1851
1235Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s). 1852Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1236 1853
1237=item $ulong = $event->profiling_command_submit 1854=item $ulong = $event->profiling_command_submit
1238 1855
1239Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s). 1856Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1240 1857
1241=item $ulong = $event->profiling_command_start 1858=item $ulong = $event->profiling_command_start
1242 1859
1243Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s). 1860Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1244 1861
1245=item $ulong = $event->profiling_command_end 1862=item $ulong = $event->profiling_command_end
1246 1863
1247Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s). 1864Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1248 1865
1249=for gengetinfo end profiling 1866=for gengetinfo end profiling
1250 1867
1251=back 1868=back
1252 1869
… …
1256 1873
1257=over 4 1874=over 4
1258 1875
1259=item $ev->set_status ($execution_status) 1876=item $ev->set_status ($execution_status)
1260 1877
1878Sets the execution status of the user event. Can only be called once,
1879either with OpenCL::COMPLETE or a negative number as status.
1880
1261L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 1881L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1262 1882
1263=back 1883=back
1264 1884
1265=cut 1885=cut
1266
1267package OpenCL;
1268
1269use common::sense;
1270
1271BEGIN {
1272 our $VERSION = '0.55';
1273
1274 require XSLoader;
1275 XSLoader::load (__PACKAGE__, $VERSION);
1276
1277 @OpenCL::Buffer::ISA =
1278 @OpenCL::Image::ISA = OpenCL::Memory::;
1279
1280 @OpenCL::Image2D::ISA =
1281 @OpenCL::Image3D::ISA = OpenCL::Image::;
1282
1283 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1284}
1285 1886
12861; 18871;
1287 1888
1288=head1 AUTHOR 1889=head1 AUTHOR
1289 1890

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines