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

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

Diff Legend

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