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

Diff Legend

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