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.61 by root, Sat Apr 28 13:31:40 2012 UTC

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

Diff Legend

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