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.87 by root, Mon May 7 01:01:33 2012 UTC

28specific device ("compiling and linking"), also binary programs. For each 28specific device ("compiling and linking"), also binary programs. For each
29kernel function in a program you can then create an OpenCL::Kernel object 29kernel function in a program you can then create an OpenCL::Kernel object
30which represents basically a function call with argument values. 30which represents basically a function call with argument values.
31 31
32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat 32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d 33memory areas, think arrays or structs) and OpenCL::Image objects (think 2D
34or 3d array) for bulk data and input and output for kernels. 34or 3D array) for bulk data and input and output for kernels.
35 35
36OpenCL::Sampler objects, which are kind of like texture filter modes in 36OpenCL::Sampler objects, which are kind of like texture filter modes in
37OpenGL. 37OpenGL.
38 38
39OpenCL::Queue objects - command queues, which allow you to submit memory 39OpenCL::Queue objects - command queues, which allow you to submit memory
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 - download these and keept
49no implementation was available to me :). 49hema round, they are required reference material:
50 50
51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
52 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
53 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
52 54
53OpenCL manpages: 55OpenCL manpages:
54 56
55 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ 57 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
58 http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
56 59
57If you are into UML class diagrams, the following diagram might help - if 60If you are into UML class diagrams, the following diagram might help - if
58not, it will be mildly cobfusing: 61not, it will be mildly confusing (also, the class hierarchy of this module
62is much more fine-grained):
59 63
60 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html 64 http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/classDiagram.html
61 65
62Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it 66Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
63is, but at least it's free of charge: 67is, but at least it's free of charge:
64 68
65 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf 69 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
101 105
102Best run this once to get a feel for the platforms and devices in your 106Best run this once to get a feel for the platforms and devices in your
103system. 107system.
104 108
105 for my $platform (OpenCL::platforms) { 109 for my $platform (OpenCL::platforms) {
106 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 110 printf "platform: %s\n", $platform->name;
107 printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); 111 printf "extensions: %s\n", $platform->extensions;
108 for my $device ($platform->devices) { 112 for my $device ($platform->devices) {
109 printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); 113 printf "+ device: %s\n", $device->name;
110 my $ctx = $device->context; 114 my $ctx = $platform->context (undef, [$device]);
111 # do stuff 115 # do stuff
112 } 116 }
113 } 117 }
114 118
115=head2 Get a useful context and a command queue. 119=head2 Get a useful context and a command queue.
138=head2 Create a buffer with some predefined data, read it back synchronously, 142=head2 Create a buffer with some predefined data, read it back synchronously,
139then asynchronously. 143then asynchronously.
140 144
141 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut"); 145 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
142 146
143 $queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data); 147 $queue->read_buffer ($buf, 1, 1, 3, my $data);
144 print "$data\n"; 148 print "$data\n";
145 149
146 my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data); 150 my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
147 $ev->wait; 151 $ev->wait;
148 print "$data\n"; # prints "elm" 152 print "$data\n"; # prints "elm"
149 153
150=head2 Create and build a program, then create a kernel out of one of its 154=head2 Create and build a program, then create a kernel out of one of its
151functions. 155functions.
152 156
153 my $src = ' 157 my $src = '
154 __kernel void 158 kernel void
155 squareit (__global float *input, __global float *output) 159 squareit (global float *input, global float *output)
156 { 160 {
157 $id = get_global_id (0); 161 $id = get_global_id (0);
158 output [id] = input [id] * input [id]; 162 output [id] = input [id] * input [id];
159 } 163 }
160 '; 164 ';
161 165
162 my $prog = $ctx->program_with_source ($src); 166 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"); 167 my $kernel = $prog->kernel ("squareit");
169 168
170=head2 Create some input and output float buffers, then call the 169=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them. 170'squareit' kernel on them.
172 171
176 # set buffer 175 # set buffer
177 $kernel->set_buffer (0, $input); 176 $kernel->set_buffer (0, $input);
178 $kernel->set_buffer (1, $output); 177 $kernel->set_buffer (1, $output);
179 178
180 # execute it for all 4 numbers 179 # execute it for all 4 numbers
181 $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 180 $queue->nd_range_kernel ($kernel, undef, [4], undef);
182 181
183 # enqueue a synchronous read 182 # enqueue a synchronous read
184 $queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 183 $queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
185 184
186 # print the results: 185 # print the results:
187 printf "%s\n", join ", ", unpack "f*", $data; 186 printf "%s\n", join ", ", unpack "f*", $data;
188 187
189=head2 The same enqueue operations as before, but assuming an out-of-order queue, 188=head2 The same enqueue operations as before, but assuming an out-of-order queue,
190showing off barriers. 189showing off barriers.
191 190
192 # execute it for all 4 numbers 191 # execute it for all 4 numbers
193 $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 192 $queue->nd_range_kernel ($kernel, undef, [4], undef);
194 193
195 # enqueue a barrier to ensure in-order execution 194 # enqueue a barrier to ensure in-order execution
196 $queue->enqueue_barrier; 195 $queue->barrier;
197 196
198 # enqueue an async read 197 # enqueue an async read
199 $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 198 $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
200 199
201 # wait for all requests to finish 200 # wait for all requests to finish
202 $queue->finish; 201 $queue->finish;
203 202
204=head2 The same enqueue operations as before, but assuming an out-of-order queue, 203=head2 The same enqueue operations as before, but assuming an out-of-order queue,
205showing off event objects and wait lists. 204showing off event objects and wait lists.
206 205
207 # execute it for all 4 numbers 206 # execute it for all 4 numbers
208 my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 207 my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
209 208
210 # enqueue an async read 209 # enqueue an async read
211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 210 $ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212 211
213 # wait for the last event to complete 212 # wait for the last event to complete
214 $ev->wait; 213 $ev->wait;
214
215=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
216set flight effect.
217
218This is quite a long example to get you going - you can also download it
219from L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
220
221 use OpenGL ":all";
222 use OpenCL;
223
224 my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
225
226 # open a window and create a gl texture
227 OpenGL::glpOpenWindow width => $S, height => $S;
228 my $texid = glGenTextures_p 1;
229 glBindTexture GL_TEXTURE_2D, $texid;
230 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
231
232 # find and use the first opencl device that let's us get a shared opengl context
233 my $platform;
234 my $dev;
235 my $ctx;
236
237 for (OpenCL::platforms) {
238 $platform = $_;
239 for ($platform->devices) {
240 $dev = $_;
241 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
242 and last;
243 }
244 }
245
246 $ctx
247 or die "cannot find suitable OpenCL device\n";
248
249 my $queue = $ctx->queue ($dev);
250
251 # now attach an opencl image2d object to the opengl texture
252 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
253
254 # now the boring opencl code
255 my $src = <<EOF;
256 kernel void
257 juliatunnel (write_only image2d_t img, float time)
258 {
259 int2 xy = (int2)(get_global_id (0), get_global_id (1));
260 float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
261
262 float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
263 m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
264
265 float2 z = m;
266 float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
267
268 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
269 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
270
271 float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
272 write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
273 }
274 EOF
275
276 my $prog = $ctx->build_program ($src);
277 my $kernel = $prog->kernel ("juliatunnel");
278
279 # program compiled, kernel ready, now draw and loop
280
281 for (my $time; ; ++$time) {
282 # acquire objects from opengl
283 $queue->acquire_gl_objects ([$tex]);
284
285 # configure and run our kernel
286 $kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
287 $queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
288
289 # release objects to opengl again
290 $queue->release_gl_objects ([$tex]);
291
292 # wait
293 $queue->finish;
294
295 # now draw the texture, the defaults should be all right
296 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
297
298 glEnable GL_TEXTURE_2D;
299 glBegin GL_QUADS;
300 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
301 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
302 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
303 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
304 glEnd;
305
306 glXSwapBuffers;
307
308 select undef, undef, undef, 1/60;
309 }
310
311=head2 How to modify the previous example to not rely on GL sharing.
312
313For those poor souls with only a sucky CPU OpenCL implementation, you
314currently have to read the image into some perl scalar, and then modify a
315texture or use glDrawPixels or so).
316
317First, when you don't need gl sharing, you can create the context much simpler:
318
319 $ctx = $platform->context (undef, [$dev])
320
321To use a texture, you would modify the above example by creating an
322OpenCL::Image manually instead of deriving it from a texture:
323
324 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
325
326And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
327would read the image2d after the kernel has written it:
328
329 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
330
331And then you would upload the pixel data to the texture (or use glDrawPixels):
332
333 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
334
335The fully modified example can be found at
336L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
337
338=head2 Julia sets look soooo 80ies.
339
340Then colour them differently, e.g. using orbit traps! Replace the loop and
341colour calculation from the previous examples by this:
342
343 float2 dm = (float2)(1.f, 1.f);
344
345 for (int i = 0; i < 25; ++i)
346 {
347 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
348 dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
349 }
350
351 float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
352
353Also try C<-10.f> instead of C<-1.f>.
215 354
216=head1 DOCUMENTATION 355=head1 DOCUMENTATION
217 356
218=head2 BASIC CONVENTIONS 357=head2 BASIC CONVENTIONS
219 358
241=item * Structures are often specified by flattening out their components 380=item * Structures are often specified by flattening out their components
242as with short vectors, and returned as arrayrefs. 381as with short vectors, and returned as arrayrefs.
243 382
244=item * When enqueuing commands, the wait list is specified by adding 383=item * When enqueuing commands, the wait list is specified by adding
245extra arguments to the function - anywhere a C<$wait_events...> argument 384extra arguments to the function - anywhere a C<$wait_events...> argument
246is documented this can be any number of event objects. 385is documented this can be any number of event objects. As an extsnion
386implemented by this module, C<undef> values will be ignored in the event
387list.
247 388
248=item * When enqueuing commands, if the enqueue method is called in void 389=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 390context, no event is created. In all other contexts an event is returned
250by the method. 391by the method.
251 392
252=item * This module expects all functions to return C<CL_SUCCESS>. If any 393=item * This module expects all functions to return C<OpenCL::SUCCESS>. If any
253other status is returned the function will throw an exception, so you 394other status is returned the function will throw an exception, so you
254don't normally have to to any error checking. 395don't normally have to to any error checking.
255 396
256=back 397=back
398
399=head2 CONSTANTS
400
401All C<CL_xxx> constants that this module supports are always available
402in the C<OpenCL> namespace as C<OpenCL::xxx> (i.e. without the C<CL_>
403prefix). Constants which are not defined in the header files used during
404compilation, or otherwise are not available, will have the value C<0> (in
405some cases, this will make them indistinguishable from real constants,
406sorry).
407
408The latest version of this module knows and exports the constants
409listed in L<http://cvs.schmorp.de/OpenCL/constiv.h>.
410
411=head2 OPENCL 1.1 VS. OPENCL 1.2
412
413This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
4141.2 interface hasn't been tested much for lack of availability of an
415actual implementation.
416
417Every function or method in this manual page that interfaces to a
418particular OpenCL function has a link to the its C manual page.
419
420If the link contains a F<1.1>, then this function is an OpenCL 1.1
421function. Most but not all also exist in OpenCL 1.2, and this module
422tries to emulate the missing ones for you, when told to do so at
423compiletime. You can check whether a function was removed in OpenCL 1.2 by
424replacing the F<1.1> component in the URL by F<1.2>.
425
426If the link contains a F<1.2>, then this is a OpenCL 1.2-only
427function. Even if the module was compiled with OpenCL 1.2 header files
428and has an 1.2 OpenCL library, calling such a function on a platform that
429doesn't implement 1.2 causes undefined behaviour, usually a crash (But
430this is not guaranteed).
431
432You can find out whether this module was compiled to prefer 1.1
433functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
4341.1 functions generally are implemented using 1.1 OpenCL functions. If it
435is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
436fucntions.
437
438This is a somewhat sorry state of affairs, but the Khronos group choose to
439make every release of OpenCL source and binary incompatible with previous
440releases.
257 441
258=head2 PERL AND OPENCL TYPES 442=head2 PERL AND OPENCL TYPES
259 443
260This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack 444This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
261format equivalents: 445format equivalents:
271 ulong IV - Q 455 ulong IV - Q
272 float NV float f 456 float NV float f
273 half IV ushort S 457 half IV ushort S
274 double NV double d 458 double NV double d
275 459
460=head2 GLX SUPPORT
461
462Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
463module, which has little to no documentation and has little to no support
464for glX), this module, as a special extension, treats context creation
465properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
466specially: If either or both of these are C<undef>, then the OpenCL
467module tries to dynamically resolve C<glXGetCurrentDisplay> and
468C<glXGetCurrentContext>, call these functions and use their return values
469instead.
470
471For this to work, the OpenGL library must be loaded, a GLX context must
472have been created and be made current, and C<dlsym> must be available and
473capable of finding the function via C<RTLD_DEFAULT>.
474
475=head2 EVENT SYSTEM
476
477OpenCL can generate a number of (potentially) asynchronous events, for
478example, after compiling a program, to signal a context-related error or,
479perhaps most important, to signal completion of queued jobs (by setting
480callbacks on OpenCL::Event objects).
481
482The OpenCL module converts all these callbacks into events - you can
483still register callbacks, but they are not executed when your OpenCL
484implementation calls the actual callback, but only later. Therefore, none
485of the limitations of OpenCL callbacks apply to the perl implementation:
486it is perfectly safe to make blocking operations from event callbacks, and
487enqueued operations don't need to be flushed.
488
489To facilitate this, this module maintains an event queue - each
490time an asynchronous event happens, it is queued, and perl will be
491interrupted. This is implemented via the L<Async::Interrupt> module. In
492addition, this module has L<AnyEvent> support, so it can seamlessly
493integrate itself into many event loops.
494
495Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
496
497=head3 Don't use callbacks.
498
499When your program never uses any callbacks, then there will never be any
500notifications you need to take care of, and therefore no need to worry
501about all this.
502
503You can achieve a great deal by explicitly waiting for events, or using
504barriers and flush calls. In many programs, there is no need at all to
505tinker with asynchronous events.
506
507=head3 Use AnyEvent
508
509This module automatically registers a watcher that invokes all outstanding
510event callbacks when AnyEvent is initialised (and block asynchronous
511interruptions). Using this mode of operations is the safest and most
512recommended one.
513
514To use this, simply use AnyEvent and this module normally, make sure you
515have an event loop running:
516
517 use Gtk2 -init;
518 use AnyEvent;
519
520 # initialise AnyEvent, by creating a watcher, or:
521 AnyEvent::detect;
522
523 my $e = $queue->marker;
524 $e->cb (sub {
525 warn "opencl is finished\n";
526 })
527
528 main Gtk2;
529
530Note that this module will not initialise AnyEvent for you. Before
531AnyEvent is initialised, the module will asynchronously interrupt perl
532instead. To avoid any surprises, it's best to explicitly initialise
533AnyEvent.
534
535You can temporarily enable asynchronous interruptions (see next paragraph)
536by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
537calling C<$OpenCL::INTERRUPT->block>.
538
539=head3 Let yourself be interrupted at any time
540
541This mode is the default unless AnyEvent is loaded and initialised. In
542this mode, OpenCL asynchronously interrupts a running perl program. The
543emphasis is on both I<asynchronously> and I<running> here.
544
545Asynchronously means that perl might execute your callbacks at any
546time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
547the C<until> loop following the marker call will be interrupted by the
548callback:
549
550 my $e = $queue->marker;
551 my $flag;
552 $e->cb (sub { $flag = 1 });
553 1 until $flag;
554 # $flag is now 1
555
556The reason why you shouldn't blindly copy the above code is that
557busy waiting is a really really bad thing, and really really bad for
558performance.
559
560While at first this asynchronous business might look exciting, it can be
561really hard, because you need to be prepared for the callback code to be
562executed at any time, which limits the amount of things the callback code
563can do safely.
564
565This can be mitigated somewhat by using C<<
566$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
567documentation for details).
568
569The other problem is that your program must be actively I<running> to be
570interrupted. When you calculate stuff, your program is running. When you
571hang in some C functions or other block execution (by calling C<sleep>,
572C<select>, running an event loop and so on), your program is waiting, not
573running.
574
575One way around that would be to attach a read watcher to your event loop,
576listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
577dummy callback (C<sub { }>) to temporarily execute some perl code.
578
579That is then awfully close to using the built-in AnyEvent support above,
580though, so consider that one instead.
581
582=head3 Be creative
583
584OpenCL exports the L<Async::Interrupt> object it uses in the global
585variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
586
587So if you want to feel like a real pro, err, wait, if you feel no risk
588menas no fun, you can experiment by implementing your own mode of
589operations.
590
591=cut
592
593package OpenCL;
594
595use common::sense;
596use Carp ();
597use Async::Interrupt ();
598
599our $POLL_FUNC; # set by XS
600
601BEGIN {
602 our $VERSION = '1.01';
603
604 require XSLoader;
605 XSLoader::load (__PACKAGE__, $VERSION);
606
607 @OpenCL::Platform::ISA =
608 @OpenCL::Device::ISA =
609 @OpenCL::Context::ISA =
610 @OpenCL::Queue::ISA =
611 @OpenCL::Memory::ISA =
612 @OpenCL::Sampler::ISA =
613 @OpenCL::Program::ISA =
614 @OpenCL::Kernel::ISA =
615 @OpenCL::Event::ISA = OpenCL::Object::;
616
617 @OpenCL::SubDevice::ISA = OpenCL::Device::;
618
619 @OpenCL::Buffer::ISA =
620 @OpenCL::Image::ISA = OpenCL::Memory::;
621
622 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
623
624 @OpenCL::Image2D::ISA =
625 @OpenCL::Image3D::ISA =
626 @OpenCL::Image2DArray::ISA =
627 @OpenCL::Image1D::ISA =
628 @OpenCL::Image1DArray::ISA =
629 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
630
631 @OpenCL::UserEvent::ISA = OpenCL::Event::;
632
633 @OpenCL::MappedBuffer::ISA =
634 @OpenCL::MappedImage::ISA = OpenCL::Mapped::;
635}
636
276=head2 THE OpenCL PACKAGE 637=head2 THE OpenCL PACKAGE
277 638
278=over 4 639=over 4
279 640
280=item $int = OpenCL::errno 641=item $int = OpenCL::errno
281 642
282The last error returned by a function - it's only valid after an error occured 643The last error returned by a function - it's only valid after an error occured
283and before calling another OpenCL function. 644and before calling another OpenCL function.
284 645
285=item $str = OpenCL::err2str $errval 646=item $str = OpenCL::err2str [$errval]
286 647
287Comverts an error value into a human readable string. 648Converts an error value into a human readable string. If no error value is
649given, then the last error will be used (as returned by OpenCL::errno).
650
651The latest version of this module knows the error constants
652listed in L<http://cvs.schmorp.de/OpenCL/errstr.h>.
288 653
289=item $str = OpenCL::enum2str $enum 654=item $str = OpenCL::enum2str $enum
290 655
291Converts most enum values (inof parameter names, image format constants, 656Converts most enum values (of parameter names, image format constants,
292object types, addressing and filter modes, command types etc.) into a 657object types, addressing and filter modes, command types etc.) into a
293human readbale string. When confronted with some random integer it can be 658human readable string. When confronted with some random integer it can be
294very helpful to pass it through this function to maybe get some readable 659very helpful to pass it through this function to maybe get some readable
295string out of it. 660string out of it.
296 661
662The latest version of this module knows the enumaration constants
663listed in L<http://cvs.schmorp.de/OpenCL/enumstr.h>.
664
297=item @platforms = OpenCL::platforms 665=item @platforms = OpenCL::platforms
298 666
299Returns all available OpenCL::Platform objects. 667Returns all available OpenCL::Platform objects.
300 668
301L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
302 670
303=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef 671=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
304 672
305Tries to create a context from a default device and platform - never worked for me. 673Tries to create a context from a default device and platform type - never worked for me.
674Consider using C<< $platform->context_from_type >> instead.
675
676type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
677OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
306 678
307L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 679L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
308 680
681=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
682
683Create a new OpenCL::Context object using the given device object(s).
684Consider using C<< $platform->context >> instead.
685
686L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
687
309=item OpenCL::wait_for_events $wait_events... 688=item OpenCL::wait_for_events $wait_events...
310 689
311Waits for all events to complete. 690Waits for all events to complete.
312 691
313L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 692L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314 693
694=item OpenCL::poll
695
696Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
697invokes their callbacks.
698
699=item $OpenCL::INTERRUPT
700
701The L<Async::Interrupt> object used to signal asynchronous events (see
702L<EVENT SYSTEM>).
703
704=cut
705
706our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
707
708&_eq_initialise ($INTERRUPT->signal_func);
709
710=item $OpenCL::WATCHER
711
712The L<AnyEvent> watcher object used to watch for asynchronous events (see
713L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
714loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
715
716=cut
717
718our $WATCHER;
719
720sub _init_anyevent {
721 $INTERRUPT->block;
722 $WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
723}
724
725if (defined $AnyEvent::MODEL) {
726 _init_anyevent;
727} else {
728 push @AnyEvent::post_detect, \&_init_anyevent;
729}
730
315=back 731=back
316 732
733=head2 THE OpenCL::Object CLASS
734
735This is the base class for all objects in the OpenCL module. The only
736method it implements is the C<id> method, which is only useful if you want
737to interface to OpenCL on the C level.
738
739=over 4
740
741=item $iv = $obj->id
742
743OpenCL objects are represented by pointers or integers on the C level. If
744you want to interface to an OpenCL object directly on the C level, then
745you need this value, which is returned by this method. You should use an
746C<IV> type in your code and cast that to the correct type.
747
748=cut
749
750sub OpenCL::Object::id {
751 ref $_[0] eq "SCALAR"
752 ? ${ $_[0] }
753 : $_[0][0]
754}
755
756=back
757
317=head2 THE OpenCL::Platform CLASS 758=head2 THE OpenCL::Platform CLASS
318 759
319=over 4 760=over 4
320 761
321=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 762=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322 763
323Returns a list of matching OpenCL::Device objects. 764Returns a list of matching OpenCL::Device objects.
324 765
325=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 766=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
326 767
327Tries to create a context. Never worked for me, and you need devices explitly anyway. 768Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 769
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 770L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 771
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 772=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
332 773
333Create a new OpenCL::Context object using the given device object(s)- a 774Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 775OpenCL::CONTEXT_PLATFORM property is supplied automatically.
335 776
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 777L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
337 778
338=item $packed_value = $platform->info ($name) 779=item $packed_value = $platform->info ($name)
339 780
340Calls C<clGetPlatformInfo> and returns the packed, raw value - for 781Calls C<clGetPlatformInfo> and returns the packed, raw value - for
341strings, this will be the string, for other values you probably need to 782strings, this will be the string (possibly including terminating \0), for
342use the correct C<unpack>. 783other values you probably need to use the correct C<unpack>.
343 784
344It's best to avoid this method and use one of the predefined C<get_*> 785It's best to avoid this method and use one of the following convenience
345methods. 786wrappers.
346 787
347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 788L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348 789
790=item $platform->unload_compiler
791
792Attempts to unload the compiler for this platform, for endless
793profit. Does nothing on OpenCL 1.1.
794
795L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
796
349=for gengetinfo begin platform 797=for gengetinfo begin platform
350 798
351
352=item $string = $platform->profile 799=item $string = $platform->profile
353 800
354Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s). 801Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
355 802
356=item $string = $platform->version 803=item $string = $platform->version
357 804
358Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s). 805Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
359 806
360=item $string = $platform->name 807=item $string = $platform->name
361 808
362Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s). 809Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
363 810
364=item $string = $platform->vendor 811=item $string = $platform->vendor
365 812
366Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s). 813Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
367 814
368=item $string = $platform->extensions 815=item $string = $platform->extensions
369 816
370Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s). 817Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
371 818
372=for gengetinfo end platform 819=for gengetinfo end platform
373 820
374=back 821=back
375 822
379 826
380=item $packed_value = $device->info ($name) 827=item $packed_value = $device->info ($name)
381 828
382See C<< $platform->info >> for details. 829See C<< $platform->info >> for details.
383 830
831type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
832OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
833OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
834
835fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
836OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
837OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
838
839mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
840
841local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
842
843exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
844
845command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
846OpenCL::QUEUE_PROFILING_ENABLE.
847
848partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
849OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
850OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
851
852affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
853OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
854OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
855OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
856
384L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 857L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
385 858
859=item @devices = $device->sub_devices (\@properties)
860
861Creates OpencL::SubDevice objects by partitioning an existing device.
862
863L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
864
386=for gengetinfo begin device 865=for gengetinfo begin device
387 866
388
389=item $device_type = $device->type 867=item $device_type = $device->type
390 868
391Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s). 869Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
392 870
393=item $uint = $device->vendor_id 871=item $uint = $device->vendor_id
394 872
395Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s). 873Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
396 874
397=item $uint = $device->max_compute_units 875=item $uint = $device->max_compute_units
398 876
399Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s). 877Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
400 878
401=item $uint = $device->max_work_item_dimensions 879=item $uint = $device->max_work_item_dimensions
402 880
403Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s). 881Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
404 882
405=item $int = $device->max_work_group_size 883=item $int = $device->max_work_group_size
406 884
407Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s). 885Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
408 886
409=item @ints = $device->max_work_item_sizes 887=item @ints = $device->max_work_item_sizes
410 888
411Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s). 889Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
412 890
413=item $uint = $device->preferred_vector_width_char 891=item $uint = $device->preferred_vector_width_char
414 892
415Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s). 893Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
416 894
417=item $uint = $device->preferred_vector_width_short 895=item $uint = $device->preferred_vector_width_short
418 896
419Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s). 897Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
420 898
421=item $uint = $device->preferred_vector_width_int 899=item $uint = $device->preferred_vector_width_int
422 900
423Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s). 901Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
424 902
425=item $uint = $device->preferred_vector_width_long 903=item $uint = $device->preferred_vector_width_long
426 904
427Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s). 905Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
428 906
429=item $uint = $device->preferred_vector_width_float 907=item $uint = $device->preferred_vector_width_float
430 908
431Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s). 909Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
432 910
433=item $uint = $device->preferred_vector_width_double 911=item $uint = $device->preferred_vector_width_double
434 912
435Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s). 913Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
436 914
437=item $uint = $device->max_clock_frequency 915=item $uint = $device->max_clock_frequency
438 916
439Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s). 917Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
440 918
441=item $bitfield = $device->address_bits 919=item $bitfield = $device->address_bits
442 920
443Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s). 921Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
444 922
445=item $uint = $device->max_read_image_args 923=item $uint = $device->max_read_image_args
446 924
447Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s). 925Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
448 926
449=item $uint = $device->max_write_image_args 927=item $uint = $device->max_write_image_args
450 928
451Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s). 929Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
452 930
453=item $ulong = $device->max_mem_alloc_size 931=item $ulong = $device->max_mem_alloc_size
454 932
455Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s). 933Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
456 934
457=item $int = $device->image2d_max_width 935=item $int = $device->image2d_max_width
458 936
459Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s). 937Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
460 938
461=item $int = $device->image2d_max_height 939=item $int = $device->image2d_max_height
462 940
463Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s). 941Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
464 942
465=item $int = $device->image3d_max_width 943=item $int = $device->image3d_max_width
466 944
467Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s). 945Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
468 946
469=item $int = $device->image3d_max_height 947=item $int = $device->image3d_max_height
470 948
471Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s). 949Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
472 950
473=item $int = $device->image3d_max_depth 951=item $int = $device->image3d_max_depth
474 952
475Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s). 953Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
476 954
477=item $uint = $device->image_support 955=item $uint = $device->image_support
478 956
479Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s). 957Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
480 958
481=item $int = $device->max_parameter_size 959=item $int = $device->max_parameter_size
482 960
483Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s). 961Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
484 962
485=item $uint = $device->max_samplers 963=item $uint = $device->max_samplers
486 964
487Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s). 965Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
488 966
489=item $uint = $device->mem_base_addr_align 967=item $uint = $device->mem_base_addr_align
490 968
491Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s). 969Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
492 970
493=item $uint = $device->min_data_type_align_size 971=item $uint = $device->min_data_type_align_size
494 972
495Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s). 973Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
496 974
497=item $device_fp_config = $device->single_fp_config 975=item $device_fp_config = $device->single_fp_config
498 976
499Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s). 977Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
500 978
501=item $device_mem_cache_type = $device->global_mem_cache_type 979=item $device_mem_cache_type = $device->global_mem_cache_type
502 980
503Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s). 981Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
504 982
505=item $uint = $device->global_mem_cacheline_size 983=item $uint = $device->global_mem_cacheline_size
506 984
507Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s). 985Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
508 986
509=item $ulong = $device->global_mem_cache_size 987=item $ulong = $device->global_mem_cache_size
510 988
511Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s). 989Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
512 990
513=item $ulong = $device->global_mem_size 991=item $ulong = $device->global_mem_size
514 992
515Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s). 993Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
516 994
517=item $ulong = $device->max_constant_buffer_size 995=item $ulong = $device->max_constant_buffer_size
518 996
519Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s). 997Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
520 998
521=item $uint = $device->max_constant_args 999=item $uint = $device->max_constant_args
522 1000
523Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s). 1001Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
524 1002
525=item $device_local_mem_type = $device->local_mem_type 1003=item $device_local_mem_type = $device->local_mem_type
526 1004
527Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s). 1005Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
528 1006
529=item $ulong = $device->local_mem_size 1007=item $ulong = $device->local_mem_size
530 1008
531Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s). 1009Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
532 1010
533=item $boolean = $device->error_correction_support 1011=item $boolean = $device->error_correction_support
534 1012
535Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s). 1013Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
536 1014
537=item $int = $device->profiling_timer_resolution 1015=item $int = $device->profiling_timer_resolution
538 1016
539Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s). 1017Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
540 1018
541=item $boolean = $device->endian_little 1019=item $boolean = $device->endian_little
542 1020
543Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s). 1021Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
544 1022
545=item $boolean = $device->available 1023=item $boolean = $device->available
546 1024
547Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s). 1025Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
548 1026
549=item $boolean = $device->compiler_available 1027=item $boolean = $device->compiler_available
550 1028
551Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s). 1029Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
552 1030
553=item $device_exec_capabilities = $device->execution_capabilities 1031=item $device_exec_capabilities = $device->execution_capabilities
554 1032
555Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s). 1033Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
556 1034
557=item $command_queue_properties = $device->properties 1035=item $command_queue_properties = $device->properties
558 1036
559Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s). 1037Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
560 1038
561=item $ = $device->platform 1039=item $ = $device->platform
562 1040
563Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s). 1041Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
564 1042
565=item $string = $device->name 1043=item $string = $device->name
566 1044
567Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s). 1045Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
568 1046
569=item $string = $device->vendor 1047=item $string = $device->vendor
570 1048
571Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s). 1049Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
572 1050
573=item $string = $device->driver_version 1051=item $string = $device->driver_version
574 1052
575Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s). 1053Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
576 1054
577=item $string = $device->profile 1055=item $string = $device->profile
578 1056
579Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s). 1057Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
580 1058
581=item $string = $device->version 1059=item $string = $device->version
582 1060
583Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s). 1061Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
584 1062
585=item $string = $device->extensions 1063=item $string = $device->extensions
586 1064
587Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s). 1065Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
588 1066
589=item $uint = $device->preferred_vector_width_half 1067=item $uint = $device->preferred_vector_width_half
590 1068
591Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s). 1069Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
592 1070
593=item $uint = $device->native_vector_width_char 1071=item $uint = $device->native_vector_width_char
594 1072
595Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s). 1073Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
596 1074
597=item $uint = $device->native_vector_width_short 1075=item $uint = $device->native_vector_width_short
598 1076
599Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s). 1077Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
600 1078
601=item $uint = $device->native_vector_width_int 1079=item $uint = $device->native_vector_width_int
602 1080
603Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s). 1081Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
604 1082
605=item $uint = $device->native_vector_width_long 1083=item $uint = $device->native_vector_width_long
606 1084
607Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s). 1085Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
608 1086
609=item $uint = $device->native_vector_width_float 1087=item $uint = $device->native_vector_width_float
610 1088
611Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s). 1089Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
612 1090
613=item $uint = $device->native_vector_width_double 1091=item $uint = $device->native_vector_width_double
614 1092
615Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s). 1093Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
616 1094
617=item $uint = $device->native_vector_width_half 1095=item $uint = $device->native_vector_width_half
618 1096
619Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s). 1097Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
620 1098
621=item $device_fp_config = $device->double_fp_config 1099=item $device_fp_config = $device->double_fp_config
622 1100
623Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s). 1101Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
624 1102
625=item $device_fp_config = $device->half_fp_config 1103=item $device_fp_config = $device->half_fp_config
626 1104
627Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s). 1105Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
628 1106
629=item $boolean = $device->host_unified_memory 1107=item $boolean = $device->host_unified_memory
630 1108
631Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s). 1109Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
632 1110
633=item $device = $device->parent_device_ext 1111=item $device = $device->parent_device_ext
634 1112
635Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s). 1113Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
636 1114
637=item @device_partition_property_exts = $device->partition_types_ext 1115=item @device_partition_property_exts = $device->partition_types_ext
638 1116
639Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s). 1117Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
640 1118
641=item @device_partition_property_exts = $device->affinity_domains_ext 1119=item @device_partition_property_exts = $device->affinity_domains_ext
642 1120
643Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s). 1121Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
644 1122
645=item $uint = $device->reference_count_ext 1123=item $uint = $device->reference_count_ext
646 1124
647Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s). 1125Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
648 1126
649=item @device_partition_property_exts = $device->partition_style_ext 1127=item @device_partition_property_exts = $device->partition_style_ext
650 1128
651Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s). 1129Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
652 1130
653=for gengetinfo end device 1131=for gengetinfo end device
654 1132
655=back 1133=back
656 1134
657=head2 THE OpenCL::Context CLASS 1135=head2 THE OpenCL::Context CLASS
658 1136
1137An OpenCL::Context is basically a container, or manager, for a number of
1138devices of a platform. It is used to create all sorts of secondary objects
1139such as buffers, queues, programs and so on.
1140
1141All context creation functions and methods take a list of properties
1142(type-value pairs). All property values can be specified as integers -
1143some additionally support other types:
1144
659=over 4 1145=over 4
660 1146
1147=item OpenCL::CONTEXT_PLATFORM
1148
1149Also accepts OpenCL::Platform objects.
1150
1151=item OpenCL::GLX_DISPLAY_KHR
1152
1153Also accepts C<undef>, in which case a deep and troubling hack is engaged
1154to find the current glx display (see L<GLX SUPPORT>).
1155
1156=item OpenCL::GL_CONTEXT_KHR
1157
1158Also accepts C<undef>, in which case a deep and troubling hack is engaged
1159to find the current glx context (see L<GLX SUPPORT>).
1160
1161=back
1162
1163=over 4
1164
1165=item $prog = $ctx->build_program ($program, $options = "")
1166
1167This convenience function tries to build the program on all devices in
1168the context. If the build fails, then the function will C<croak> with the
1169build log. Otherwise ti returns the program object.
1170
1171The C<$program> can either be a C<OpenCL::Program> object or a string
1172containing the program. In the latter case, a program objetc will be
1173created automatically.
1174
1175=cut
1176
1177sub OpenCL::Context::build_program {
1178 my ($self, $prog, $options) = @_;
1179
1180 $prog = $self->program_with_source ($prog)
1181 unless ref $prog;
1182
1183 eval { $prog->build (undef, $options); 1 }
1184 or errno == BUILD_PROGRAM_FAILURE
1185 or errno == INVALID_BINARY # workaround nvidia bug
1186 or Carp::croak "OpenCL::Context->build_program: " . err2str;
1187
1188 # we check status for all devices
1189 for my $dev ($self->devices) {
1190 $prog->build_status ($dev) == BUILD_SUCCESS
1191 or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1192 . $prog->build_log ($dev);
1193 }
1194
1195 $prog
1196}
1197
661=item $queue = $ctx->queue ($device, $properties) 1198=item $queue = $ctx->queue ($device, $properties)
662 1199
663Create a new OpenCL::Queue object from the context and the given device. 1200Create a new OpenCL::Queue object from the context and the given device.
664 1201
665L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 1202L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
666 1203
1204Example: create an out-of-order queue.
1205
1206 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
1207
667=item $ev = $ctx->user_event 1208=item $ev = $ctx->user_event
668 1209
669Creates a new OpenCL::UserEvent object. 1210Creates a new OpenCL::UserEvent object.
670 1211
671L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 1212L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
672 1213
673=item $buf = $ctx->buffer ($flags, $len) 1214=item $buf = $ctx->buffer ($flags, $len)
674 1215
675Creates a new OpenCL::Buffer object with the given flags and octet-size. 1216Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1217given flags and octet-size.
1218
1219flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
1220OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
1221OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
676 1222
677L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1223L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
678 1224
679=item $buf = $ctx->buffer_sv ($flags, $data) 1225=item $buf = $ctx->buffer_sv ($flags, $data)
680 1226
681Creates a new OpenCL::Buffer object and initialise it with the given data values. 1227Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1228initialise it with the given data values.
1229
1230=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)
1231
1232Creates a new OpenCL::Image object and optionally initialises it with
1233the given data values.
1234
1235channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
1236OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
1237OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
1238
1239channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
1240OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1241OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1242OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1243OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1244
1245type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1246OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1247OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1248OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1249
1250L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
682 1251
683=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1252=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
684 1253
685Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 1254Creates a new OpenCL::Image2D object and optionally initialises it with
1255the given data values.
686 1256
687L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 1257L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
688 1258
689=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 1259=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
690 1260
691Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 1261Creates a new OpenCL::Image3D object and optionally initialises it with
1262the given data values.
692 1263
693L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 1264L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
1265
1266=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1267
1268Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1269OpenGL buffer object.
1270
1271flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1272
1273http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1274
1275=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1276
1277Creates a new OpenCL::Image object that refers to the given OpenGL
1278texture object or buffer.
1279
1280target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
1281GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
1282GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
1283GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
1284GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
1285GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
1286
1287http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1288
1289=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1290
1291Creates a new OpenCL::Image2D object that refers to the given OpenGL
12922D texture object.
1293
1294http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
1295
1296=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
1297
1298Creates a new OpenCL::Image3D object that refers to the given OpenGL
12993D texture object.
1300
1301http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
1302
1303=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
1304
1305Creates a new OpenCL::Image2D object that refers to the given OpenGL
1306render buffer.
1307
1308http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
694 1309
695=item @formats = $ctx->supported_image_formats ($flags, $image_type) 1310=item @formats = $ctx->supported_image_formats ($flags, $image_type)
696 1311
697Returns a list of matching image formats - each format is an arrayref with 1312Returns a list of matching image formats - each format is an arrayref with
698two values, $channel_order and $channel_type, in it. 1313two values, $channel_order and $channel_type, in it.
701 1316
702=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1317=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
703 1318
704Creates a new OpenCL::Sampler object. 1319Creates a new OpenCL::Sampler object.
705 1320
1321addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
1322OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
1323
1324filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
1325
706L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> 1326L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
707 1327
708=item $program = $ctx->program_with_source ($string) 1328=item $program = $ctx->program_with_source ($string)
709 1329
710Creates a new OpenCL::Program object from the given source code. 1330Creates a new OpenCL::Program object from the given source code.
711 1331
712L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 1332L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
713 1333
1334=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
1335
1336Creates a new OpenCL::Program object from the given binaries.
1337
1338L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
1339
1340Example: clone an existing program object that contains a successfully
1341compiled program, no matter how useless this is.
1342
1343 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
1344
1345=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1346
1347Creates a new OpenCL::Program object from the given built-in kernel names.
1348
1349L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1350
1351=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
1352
1353Links all (already compiled) program objects specified in C<@programs>
1354together and returns a new OpenCL::Program object with the result.
1355
1356L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
1357
714=item $packed_value = $ctx->info ($name) 1358=item $packed_value = $ctx->info ($name)
715 1359
716See C<< $platform->info >> for details. 1360See C<< $platform->info >> for details.
717 1361
718L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 1362L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
719 1363
720=for gengetinfo begin context 1364=for gengetinfo begin context
721 1365
722
723=item $uint = $context->reference_count 1366=item $uint = $context->reference_count
724 1367
725Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s). 1368Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
726 1369
727=item @devices = $context->devices 1370=item @devices = $context->devices
728 1371
729Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s). 1372Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
730 1373
731=item @property_ints = $context->properties 1374=item @property_ints = $context->properties
732 1375
733Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s). 1376Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
734 1377
735=item $uint = $context->num_devices 1378=item $uint = $context->num_devices
736 1379
737Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s). 1380Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
738 1381
739=for gengetinfo end context 1382=for gengetinfo end context
740 1383
741=back 1384=back
742 1385
743=head2 THE OpenCL::Queue CLASS 1386=head2 THE OpenCL::Queue CLASS
744 1387
745An OpenCL::Queue represents an execution queue for OpenCL. You execute 1388An OpenCL::Queue represents an execution queue for OpenCL. You execute
746requests by calling their respective C<enqueue_xxx> method and waitinf for 1389requests by calling their respective method and waiting for it to complete
747it to complete in some way. 1390in some way.
748 1391
749All the enqueue methods return an event object that can be used to wait 1392Most methods that enqueue some request return an event object that can
750for completion, unless the method is called in void context, in which case 1393be used to wait for completion (optionally using a callback), unless
751no event object is created. 1394the method is called in void context, in which case no event object is
1395created.
752 1396
753They also allow you to specify any number of other event objects that this 1397They 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 1398request has to wait for before it starts executing, by simply passing the
755event objects as extra parameters to the enqueue methods. 1399event objects as extra parameters to the enqueue methods. To simplify
1400program design, this module ignores any C<undef> values in the list of
1401events. This makes it possible to code operations such as this, without
1402having to put a valid event object into C<$event> first:
1403
1404 $event = $queue->xxx (..., $event);
756 1405
757Queues execute in-order by default, without any parallelism, so in most 1406Queues 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 1407cases (i.e. you use only one queue) it's not necessary to wait for or
759create event objects. 1408create event objects, althoguh an our of order queue is often a bit
1409faster.
760 1410
761=over 4 1411=over 4
762 1412
763=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1413=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
764 1414
765Reads data from buffer into the given string. 1415Reads data from buffer into the given string.
766 1416
767L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 1417L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
768 1418
769=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...) 1419=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
770 1420
771Writes data to buffer from the given string. 1421Writes data to buffer from the given string.
772 1422
773L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html> 1423L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
774 1424
775=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1425=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
776 1426
777L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1427L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
778 1428
1429$eue->read_buffer_rect ($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...)
1430
1431http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1432
1433=item $ev = $queue->write_buffer_rect ($buf, $blocking, $buf_y, $host_x, $host_z, $height, $buf_row_pitch, $host_row_pitch, $data, $wait_events...)
1434
1435http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1436
1437=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1438
1439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
1440
779=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1441=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1442
1443C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1444module uses the image width (and height) to supply default values.
780 1445
781L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1446L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
782 1447
783=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1448=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
784 1449
1450C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1451module uses the image width (and height) to supply default values.
785L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1452L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
786 1453
1454=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...)
1455
1456L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1457
1458=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1459
1460L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1461
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...) 1462=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 1463
789Yeah. 1464Yeah.
790 1465
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>. 1466L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
796 1467
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...) 1468=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
798 1469
1470Fills the given buffer object with repeated applications of C<$pattern>,
1471starting at C<$offset> for C<$size> octets.
1472
1473L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1474
1475=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1476
1477Fills the given image area with the given rgba colour components. The
1478components are normally floating point values between C<0> and C<1>,
1479except when the image channel data type is a signe dor unsigned
1480unnormalised format, in which case the range is determined by the format.
1481
799L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1482L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
800 1483
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...) 1484=item $ev = $queue->task ($kernel, $wait_events...)
806 1485
807L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1486L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
808 1487
809=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...) 1488=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
810 1489
811Enqueues a kernel execution. 1490Enqueues a kernel execution.
812 1491
813@$global_work_size must be specified as a reference to an array of 1492\@global_work_size must be specified as a reference to an array of
814integers specifying the work sizes (element counts). 1493integers specifying the work sizes (element counts).
815 1494
816@$global_work_offset must be either C<undef> (in which case all offsets 1495\@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 1496are C<0>), or a reference to an array of work offsets, with the same number
818of elements as @$global_work_size. 1497of elements as \@global_work_size.
819 1498
820@$local_work_size must be either C<undef> (in which case the 1499\@local_work_size must be either C<undef> (in which case the
821implementation is supposed to choose good local work sizes), or a 1500implementation is supposed to choose good local work sizes), or a
822reference to an array of local work sizes, with the same number of 1501reference to an array of local work sizes, with the same number of
823elements as @$global_work_size. 1502elements as \@global_work_size.
824 1503
825L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1504L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
826 1505
827=item $ev = $queue->enqueue_marker 1506=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
828 1507
1508Migrates a number of OpenCL::Memory objects to or from the device.
1509
1510flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
1511
1512L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
1513
1514=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1515
1516Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1517for subsequent OpenCL usage.
1518
829L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1519L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
830 1520
1521=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1522
1523Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1524for subsequent OpenGL usage.
1525
1526L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1527
831=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1528=item $ev = $queue->wait_for_events ($wait_events...)
832 1529
833L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1530L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
834 1531
835=item $queue->enqueue_barrier 1532=item $ev = $queue->marker ($wait_events...)
836 1533
1534L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1535
1536=item $ev = $queue->barrier ($wait_events...)
1537
837L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1538L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
838 1539
839=item $queue->flush 1540=item $queue->flush
840 1541
841L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1542L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
842 1543
850 1551
851L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html> 1552L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
852 1553
853=for gengetinfo begin command_queue 1554=for gengetinfo begin command_queue
854 1555
855
856=item $ctx = $command_queue->context 1556=item $ctx = $command_queue->context
857 1557
858Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s). 1558Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
859 1559
860=item $device = $command_queue->device 1560=item $device = $command_queue->device
861 1561
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s). 1562Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
863 1563
864=item $uint = $command_queue->reference_count 1564=item $uint = $command_queue->reference_count
865 1565
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s). 1566Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
867 1567
868=item $command_queue_properties = $command_queue->properties 1568=item $command_queue_properties = $command_queue->properties
869 1569
870Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s). 1570Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
871 1571
872=for gengetinfo end command_queue 1572=for gengetinfo end command_queue
1573
1574=back
1575
1576=head3 MEMORY MAPPED BUFFERS
1577
1578OpenCL allows you to map buffers and images to host memory (read: perl
1579scalars). This is done much like reading or copying a buffer, by enqueuing
1580a map or unmap operation on the command queue.
1581
1582The map operations return an C<OpenCL::Mapped> object - see L<THE
1583OpenCL::Mapped CLASS> section for details on what to do with these
1584objects.
1585
1586The object will be unmapped automatically when the mapped object is
1587destroyed (you can use a barrier to make sure the unmap has finished,
1588before using the buffer in a kernel), but you can also enqueue an unmap
1589operation manually.
1590
1591=over 4
1592
1593=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
1594
1595Maps the given buffer into host memory and returns an
1596C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1597the map will extend to the end of the buffer.
1598
1599map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1600
1601L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1602
1603Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1604
1605 {
1606 my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
1607 substr $$mapped, 0, 4, "abcd";
1608 } # asynchronously unmap because $mapped is destroyed
1609
1610=item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...)
1611
1612Maps the given image area into host memory and return an
1613C<OpenCL::MappedImage> object.
1614
1615If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
1616will be replaced by the maximum possible value.
1617
1618L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
1619
1620Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
1621the first channel of the leftmost column to 5, then explicitly unmap
1622it. You are not necessarily meant to do it this way, this example just
1623shows you the accessors to use :)
1624
1625 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
1626
1627 $mapped->write ($_ * $mapped->row_pitch, pack "C", 5)
1628 for 0 .. $mapped->height - 1;
1629
1630 $mapped->unmap;.
1631 $mapped->wait; # only needed for out of order queues normally
1632
1633=item $ev = $queue->unmap ($mapped, $wait_events...)
1634
1635Unmaps the data from host memory. You must not call any methods that
1636modify the data, or modify the data scalar directly, after calling this
1637method.
1638
1639The mapped event object will always be passed as part of the
1640$wait_events. The mapped event object will be replaced by the new event
1641object that this request creates.
873 1642
874=back 1643=back
875 1644
876=head2 THE OpenCL::Memory CLASS 1645=head2 THE OpenCL::Memory CLASS
877 1646
884 1653
885See C<< $platform->info >> for details. 1654See C<< $platform->info >> for details.
886 1655
887L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1656L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
888 1657
1658=item $memory->destructor_callback ($cb->())
1659
1660Sets a callback that will be invoked after the memory object is destructed.
1661
1662L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetMemObjectDestructorCallback.html>
1663
889=for gengetinfo begin mem 1664=for gengetinfo begin mem
890 1665
891
892=item $mem_object_type = $mem->type 1666=item $mem_object_type = $mem->type
893 1667
894Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s). 1668Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
895 1669
896=item $mem_flags = $mem->flags 1670=item $mem_flags = $mem->flags
897 1671
898Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s). 1672Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
899 1673
900=item $int = $mem->size 1674=item $int = $mem->size
901 1675
902Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s). 1676Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
903 1677
904=item $ptr_value = $mem->host_ptr 1678=item $ptr_value = $mem->host_ptr
905 1679
906Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s). 1680Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
907 1681
908=item $uint = $mem->map_count 1682=item $uint = $mem->map_count
909 1683
910Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s). 1684Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
911 1685
912=item $uint = $mem->reference_count 1686=item $uint = $mem->reference_count
913 1687
914Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s). 1688Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
915 1689
916=item $ctx = $mem->context 1690=item $ctx = $mem->context
917 1691
918Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s). 1692Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
919 1693
920=item $mem = $mem->associated_memobject 1694=item $mem = $mem->associated_memobject
921 1695
922Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s). 1696Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
923 1697
924=item $int = $mem->offset 1698=item $int = $mem->offset
925 1699
926Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s). 1700Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
927 1701
928=for gengetinfo end mem 1702=for gengetinfo end mem
929 1703
1704=item ($type, $name) = $mem->gl_object_info
1705
1706Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1707object "name" (e.g. the texture name) used to create this memory object.
1708
1709L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1710
930=back 1711=back
931 1712
1713=head2 THE OpenCL::Buffer CLASS
1714
1715This is a subclass of OpenCL::Memory, and the superclass of
1716OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1717and sub-buffers.
1718
1719=head2 THE OpenCL::BufferObj CLASS
1720
1721This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1722because one cna create sub buffers of OpenLC::BufferObj objects, but not
1723sub buffers from these sub buffers.
1724
1725=over 4
1726
1727=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1728
1729Creates an OpenCL::Buffer objects from this buffer and returns it. The
1730C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1731
1732L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1733
1734=back
1735
932=head2 THE OpenCL::Image CLASS 1736=head2 THE OpenCL::Image CLASS
933 1737
934This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1738This is the superclass of all image objects - OpenCL::Image1D,
1739OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1740OpenCL::Image2DArray and OpenCL::Image3D.
935 1741
936=over 4 1742=over 4
937 1743
938=item $packed_value = $ev->image_info ($name) 1744=item $packed_value = $image->image_info ($name)
939 1745
940See C<< $platform->info >> for details. 1746See C<< $platform->info >> for details.
941 1747
942The reason this method is not called C<info> is that there already is an 1748The reason this method is not called C<info> is that there already is an
943C<< ->info >> method inherited from C<OpenCL::Memory>. 1749C<< ->info >> method inherited from C<OpenCL::Memory>.
944 1750
945L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1751L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
946 1752
1753=item ($channel_order, $channel_data_type) = $image->format
1754
1755Returns the channel order and type used to create the image by calling
1756C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1757
947=for gengetinfo begin image 1758=for gengetinfo begin image
948 1759
949
950=item $int = $image->element_size 1760=item $int = $image->element_size
951 1761
952Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s). 1762Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
953 1763
954=item $int = $image->row_pitch 1764=item $int = $image->row_pitch
955 1765
956Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s). 1766Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
957 1767
958=item $int = $image->slice_pitch 1768=item $int = $image->slice_pitch
959 1769
960Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s). 1770Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
961 1771
962=item $int = $image->width 1772=item $int = $image->width
963 1773
964Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s). 1774Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
965 1775
966=item $int = $image->height 1776=item $int = $image->height
967 1777
968Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s). 1778Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
969 1779
970=item $int = $image->depth 1780=item $int = $image->depth
971 1781
972Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s). 1782Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
973 1783
974=for gengetinfo end image 1784=for gengetinfo end image
975 1785
1786=for gengetinfo begin gl_texture
1787
1788=item $GLenum = $gl_texture->target
1789
1790Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1791
1792=item $GLint = $gl_texture->gl_mipmap_level
1793
1794Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1795
1796=for gengetinfo end gl_texture
1797
976=back 1798=back
977 1799
978=head2 THE OpenCL::Sampler CLASS 1800=head2 THE OpenCL::Sampler CLASS
979 1801
980=over 4 1802=over 4
985 1807
986L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1808L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
987 1809
988=for gengetinfo begin sampler 1810=for gengetinfo begin sampler
989 1811
990
991=item $uint = $sampler->reference_count 1812=item $uint = $sampler->reference_count
992 1813
993Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s). 1814Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
994 1815
995=item $ctx = $sampler->context 1816=item $ctx = $sampler->context
996 1817
997Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s). 1818Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
998 1819
999=item $addressing_mode = $sampler->normalized_coords 1820=item $addressing_mode = $sampler->normalized_coords
1000 1821
1001Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s). 1822Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1002 1823
1003=item $filter_mode = $sampler->addressing_mode 1824=item $filter_mode = $sampler->addressing_mode
1004 1825
1005Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s). 1826Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1006 1827
1007=item $boolean = $sampler->filter_mode 1828=item $boolean = $sampler->filter_mode
1008 1829
1009Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s). 1830Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1010 1831
1011=for gengetinfo end sampler 1832=for gengetinfo end sampler
1012 1833
1013=back 1834=back
1014 1835
1015=head2 THE OpenCL::Program CLASS 1836=head2 THE OpenCL::Program CLASS
1016 1837
1017=over 4 1838=over 4
1018 1839
1019=item $program->build ($device, $options = "") 1840=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1020 1841
1021Tries to build the program with the givne options. 1842Tries to build the program with the given options. See also the
1843C<$ctx->build> convenience function.
1844
1845If a callback is specified, then it will be called when compilation is
1846finished. Note that many OpenCL implementations block your program while
1847compiling whether you use a callback or not. See C<build_async> if you
1848want to make sure the build is done in the background.
1849
1850Note that some OpenCL implementations act up badly, and don't call the
1851callback in some error cases (but call it in others). This implementation
1852assumes the callback will always be called, and leaks memory if this is
1853not so. So best make sure you don't pass in invalid values.
1854
1855Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1856compilation state is successful but some later stage fails.
1857
1858options: C<-D name>, C<-D name=definition>, C<-I dir>,
1859C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
1860C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
1861C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1862C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1863C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1864C<-create-library>, C<-enable-link-options>.
1865
1866build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
1867OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1022 1868
1023L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1869L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1870
1871=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1872
1873Similar to C<< ->build >>, except it starts a thread, and never fails (you
1874need to check the compilation status form the callback, or by polling).
1875
1876=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1877
1878Compiles the given program for the given devices (or all devices if
1879undef). If C<$headers> is given, it must be a hashref with include name =>
1880OpenCL::Program pairs.
1881
1882L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1024 1883
1025=item $packed_value = $program->build_info ($device, $name) 1884=item $packed_value = $program->build_info ($device, $name)
1026 1885
1027Similar to C<< $platform->info >>, but returns build info for a previous 1886Similar to C<< $platform->info >>, but returns build info for a previous
1028build attempt for the given device. 1887build attempt for the given device.
1029 1888
1889binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
1890OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
1891OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
1892OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
1893
1030L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html> 1894L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1031 1895
1032=item $kernel = $program->kernel ($function_name) 1896=item $kernel = $program->kernel ($function_name)
1033 1897
1034Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1898Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1035the program. 1899the program.
1036 1900
1037L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1901L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1038 1902
1903=item @kernels = $program->kernels_in_program
1904
1905Returns all kernels successfully compiled for all devices in program.
1906
1907http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1908
1039=for gengetinfo begin program_build 1909=for gengetinfo begin program_build
1040 1910
1041
1042=item $build_status = $program->build_status ($device) 1911=item $build_status = $program->build_status ($device)
1043 1912
1044Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s). 1913Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1045 1914
1046=item $string = $program->build_options ($device) 1915=item $string = $program->build_options ($device)
1047 1916
1048Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s). 1917Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1049 1918
1050=item $string = $program->build_log ($device) 1919=item $string = $program->build_log ($device)
1051 1920
1052Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s). 1921Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1922
1923=item $binary_type = $program->binary_type ($device)
1924
1925Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1053 1926
1054=for gengetinfo end program_build 1927=for gengetinfo end program_build
1055 1928
1056=item $packed_value = $program->info ($name) 1929=item $packed_value = $program->info ($name)
1057 1930
1059 1932
1060L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> 1933L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1061 1934
1062=for gengetinfo begin program 1935=for gengetinfo begin program
1063 1936
1064
1065=item $uint = $program->reference_count 1937=item $uint = $program->reference_count
1066 1938
1067Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s). 1939Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1068 1940
1069=item $ctx = $program->context 1941=item $ctx = $program->context
1070 1942
1071Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s). 1943Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1072 1944
1073=item $uint = $program->num_devices 1945=item $uint = $program->num_devices
1074 1946
1075Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s). 1947Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1076 1948
1077=item @devices = $program->devices 1949=item @devices = $program->devices
1078 1950
1079Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s). 1951Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1080 1952
1081=item $string = $program->source 1953=item $string = $program->source
1082 1954
1083Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s). 1955Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1084 1956
1085=item @ints = $program->binary_sizes 1957=item @ints = $program->binary_sizes
1086 1958
1087Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s). 1959Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1088 1960
1089=for gengetinfo end program 1961=for gengetinfo end program
1090 1962
1963=item @blobs = $program->binaries
1964
1965Returns a string for the compiled binary for every device associated with
1966the program, empty strings indicate missing programs, and an empty result
1967means no program binaries are available.
1968
1969These "binaries" are often, in fact, informative low-level assembly
1970sources.
1971
1972L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1973
1091=back 1974=back
1092 1975
1093=head2 THE OpenCL::Kernel CLASS 1976=head2 THE OpenCL::Kernel CLASS
1094 1977
1095=over 4 1978=over 4
1100 1983
1101L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1984L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1102 1985
1103=for gengetinfo begin kernel 1986=for gengetinfo begin kernel
1104 1987
1105
1106=item $string = $kernel->function_name 1988=item $string = $kernel->function_name
1107 1989
1108Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s). 1990Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1109 1991
1110=item $uint = $kernel->num_args 1992=item $uint = $kernel->num_args
1111 1993
1112Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s). 1994Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1113 1995
1114=item $uint = $kernel->reference_count 1996=item $uint = $kernel->reference_count
1115 1997
1116Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s). 1998Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1117 1999
1118=item $ctx = $kernel->context 2000=item $ctx = $kernel->context
1119 2001
1120Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s). 2002Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1121 2003
1122=item $program = $kernel->program 2004=item $program = $kernel->program
1123 2005
1124Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s). 2006Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1125 2007
1126=for gengetinfo end kernel 2008=for gengetinfo end kernel
1127 2009
1128=item $packed_value = $kernel->work_group_info ($device, $name) 2010=item $packed_value = $kernel->work_group_info ($device, $name)
2011
2012See C<< $platform->info >> for details.
2013
2014L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
2015
2016=for gengetinfo begin kernel_work_group
2017
2018=item $int = $kernel->work_group_size ($device)
2019
2020Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
2021
2022=item @ints = $kernel->compile_work_group_size ($device)
2023
2024Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
2025
2026=item $ulong = $kernel->local_mem_size ($device)
2027
2028Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
2029
2030=item $int = $kernel->preferred_work_group_size_multiple ($device)
2031
2032Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
2033
2034=item $ulong = $kernel->private_mem_size ($device)
2035
2036Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
2037
2038=for gengetinfo end kernel_work_group
2039
2040=item $packed_value = $kernel->arg_info ($idx, $name)
2041
2042See C<< $platform->info >> for details.
2043
2044L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
2045
2046=for gengetinfo begin kernel_arg
2047
2048=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
2049
2050Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
2051
2052=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
2053
2054Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
2055
2056=item $string = $kernel->arg_type_name ($idx)
2057
2058Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
2059
2060=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
2061
2062Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
2063
2064=item $string = $kernel->arg_name ($idx)
2065
2066Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
2067
2068=for gengetinfo end kernel_arg
2069
2070=item $kernel->setf ($format, ...)
2071
2072Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
2073way to set arguments (and with OpenCL 1.2 it might be rather slow), you
2074need to specify a format argument, much as with C<printf>, to tell OpenCL
2075what type of argument it is.
2076
2077The format arguments are single letters:
2078
2079 c char
2080 C unsigned char
2081 s short
2082 S unsigned short
2083 i int
2084 I unsigned int
2085 l long
2086 L unsigned long
2087
2088 h half float (0..65535)
2089 f float
2090 d double
2091
2092 z local (octet size)
2093
2094 m memory object (buffer or image)
2095 a sampler
2096 e event
2097
2098Space characters in the format string are ignored.
2099
2100Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
2101
2102 $kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
2103
2104=item $kernel->set_TYPE ($index, $value)
2105
2106=item $kernel->set_char ($index, $value)
2107
2108=item $kernel->set_uchar ($index, $value)
2109
2110=item $kernel->set_short ($index, $value)
2111
2112=item $kernel->set_ushort ($index, $value)
2113
2114=item $kernel->set_int ($index, $value)
2115
2116=item $kernel->set_uint ($index, $value)
2117
2118=item $kernel->set_long ($index, $value)
2119
2120=item $kernel->set_ulong ($index, $value)
2121
2122=item $kernel->set_half ($index, $value)
2123
2124=item $kernel->set_float ($index, $value)
2125
2126=item $kernel->set_double ($index, $value)
2127
2128=item $kernel->set_memory ($index, $value)
2129
2130=item $kernel->set_buffer ($index, $value)
2131
2132=item $kernel->set_image ($index, $value)
2133
2134=item $kernel->set_sampler ($index, $value)
2135
2136=item $kernel->set_local ($index, $value)
2137
2138=item $kernel->set_event ($index, $value)
2139
2140This is a family of methods to set the kernel argument with the number
2141C<$index> to the give C<$value>.
2142
2143Chars and integers (including the half type) are specified as integers,
2144float and double as floating point values, memory/buffer/image must be
2145an object of that type or C<undef>, local-memory arguments are set by
2146specifying the size, and sampler and event must be objects of that type.
2147
2148Note that C<set_memory> works for all memory objects (all types of buffers
2149and images) - the main purpose of the more specific C<set_TYPE> functions
2150is type checking.
2151
2152Setting an argument for a kernel does NOT keep a reference to the object -
2153for example, if you set an argument to some image object, free the image,
2154and call the kernel, you will run into undefined behaviour.
2155
2156L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
2157
2158=back
2159
2160=head2 THE OpenCL::Event CLASS
2161
2162This is the superclass for all event objects (including OpenCL::UserEvent
2163objects).
2164
2165=over 4
2166
2167=item $ev->wait
2168
2169Waits for the event to complete.
2170
2171L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
2172
2173=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
2174
2175Adds a callback to the callback stack for the given event type. There is
2176no way to remove a callback again.
2177
2178L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
2179
2180=item $packed_value = $ev->info ($name)
2181
2182See C<< $platform->info >> for details.
2183
2184L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
2185
2186=for gengetinfo begin event
2187
2188=item $queue = $event->command_queue
2189
2190Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
2191
2192=item $command_type = $event->command_type
2193
2194Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
2195
2196=item $uint = $event->reference_count
2197
2198Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
2199
2200=item $uint = $event->command_execution_status
2201
2202Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
2203
2204=item $ctx = $event->context
2205
2206Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
2207
2208=for gengetinfo end event
2209
2210=item $packed_value = $ev->profiling_info ($name)
1129 2211
1130See C<< $platform->info >> for details. 2212See C<< $platform->info >> for details.
1131 2213
1132The reason this method is not called C<info> is that there already is an 2214The reason this method is not called C<info> is that there already is an
1133C<< ->info >> method. 2215C<< ->info >> method.
1134 2216
1135L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1136
1137=for gengetinfo begin kernel_work_group
1138
1139
1140=item $int = $kernel->work_group_size ($device)
1141
1142Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s).
1143
1144=item @ints = $kernel->compile_work_group_size ($device)
1145
1146Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s).
1147
1148=item $ulong = $kernel->local_mem_size ($device)
1149
1150Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s).
1151
1152=item $int = $kernel->preferred_work_group_size_multiple ($device)
1153
1154Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s).
1155
1156=item $ulong = $kernel->private_mem_size ($device)
1157
1158Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s).
1159
1160=for gengetinfo end kernel_work_group
1161
1162=item $kernel->set_TYPE ($index, $value)
1163
1164This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1165
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
1170Chars and integers (including the half type) are specified as integers,
1171float and double as floating point values, memory/buffer/image2d/image3d
1172must be an object of that type or C<undef>, and sampler and event must be
1173objects of that type.
1174
1175L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 2217L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
2218
2219=for gengetinfo begin profiling
2220
2221=item $ulong = $event->profiling_command_queued
2222
2223Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
2224
2225=item $ulong = $event->profiling_command_submit
2226
2227Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
2228
2229=item $ulong = $event->profiling_command_start
2230
2231Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
2232
2233=item $ulong = $event->profiling_command_end
2234
2235Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
2236
2237=for gengetinfo end profiling
1176 2238
1177=back 2239=back
1178 2240
1179=head2 THE OpenCL::Event CLASS 2241=head2 THE OpenCL::UserEvent CLASS
1180 2242
1181This is the superclass for all event objects (including OpenCL::UserEvent 2243This is a subclass of OpenCL::Event.
1182objects).
1183 2244
1184=over 4 2245=over 4
1185 2246
1186=item $ev->wait 2247=item $ev->set_status ($execution_status)
1187 2248
1188Waits for the event to complete. 2249Sets the execution status of the user event. Can only be called once,
2250either with OpenCL::COMPLETE or a negative number as status.
1189 2251
2252execution_status: OpenCL::COMPLETE or a negative integer.
2253
1190L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 2254L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1191
1192=item $packed_value = $ev->info ($name)
1193
1194See C<< $platform->info >> for details.
1195
1196L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1197
1198=for gengetinfo begin event
1199
1200
1201=item $queue = $event->command_queue
1202
1203Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s).
1204
1205=item $command_type = $event->command_type
1206
1207Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s).
1208
1209=item $uint = $event->reference_count
1210
1211Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s).
1212
1213=item $uint = $event->command_execution_status
1214
1215Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s).
1216
1217=item $ctx = $event->context
1218
1219Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s).
1220
1221=for gengetinfo end event
1222
1223=item $packed_value = $ev->profiling_info ($name)
1224
1225See C<< $platform->info >> for details.
1226
1227The reason this method is not called C<info> is that there already is an
1228C<< ->info >> method.
1229
1230L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1231
1232=for gengetinfo begin profiling
1233
1234
1235=item $ulong = $event->profiling_command_queued
1236
1237Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s).
1238
1239=item $ulong = $event->profiling_command_submit
1240
1241Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s).
1242
1243=item $ulong = $event->profiling_command_start
1244
1245Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s).
1246
1247=item $ulong = $event->profiling_command_end
1248
1249Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s).
1250
1251=for gengetinfo end profiling
1252 2255
1253=back 2256=back
1254 2257
1255=head2 THE OpenCL::UserEvent CLASS 2258=head2 THE OpenCL::Mapped CLASS
1256 2259
1257This is a subclass of OpenCL::Event. 2260This class represents objects mapped into host memory. They are
2261represented by a blessed string scalar. The string data is the mapped
2262memory area, that is, if you read or write it, then the mapped object is
2263accessed directly.
2264
2265You must only ever use operations that modify the string in-place - for
2266example, a C<substr> that doesn't change the length, or maybe a regex that
2267doesn't change the length. Any other operation might cause the data to be
2268copied.
2269
2270When the object is destroyed it will enqueue an implicit unmap operation
2271on the queue that was used to create it.
2272
2273Keep in mind that you I<need> to unmap (or destroy) mapped objects before
2274OpenCL sees the changes, even if some implementations don't need this
2275sometimes.
2276
2277Example, replace the first two floats in the mapped buffer by 1 and 2.
2278
2279 my $mapped = $queue->map_buffer ($buf, ...
2280 $mapped->event->wait; # make sure it's there
2281
2282 # now replace first 8 bytes by new data, which is exactly 8 bytes long
2283 # we blindly assume device endianness to equal host endianness
2284 # (and of course, we assume iee 754 single precision floats :)
2285 substr $$mapped, 0, 8, pack "f*", 1, 2;
1258 2286
1259=over 4 2287=over 4
1260 2288
1261=item $ev->set_status ($execution_status) 2289=item $ev = $mapped->unmap ($wait_events...)
1262 2290
1263L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2291Unmaps the mapped memory object, using the queue originally used to create
2292it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
2293
2294=item $bool = $mapped->mapped
2295
2296Returns whether the object is still mapped - true before an C<unmap> is
2297enqueued, false afterwards.
2298
2299=item $ev = $mapped->event
2300
2301Return the event object associated with the mapped object. Initially, this
2302will be the event object created when mapping the object, and after an
2303unmap, this will be the event object that the unmap operation created.
2304
2305=item $mapped->wait
2306
2307Same as C<< $mapped->event->wait >> - makes sure no operations on this
2308mapped object are outstanding.
2309
2310=item $bytes = $mapped->size
2311
2312Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
2313
2314=item $ptr = $mapped->ptr
2315
2316Returns the raw memory address of the mapped area.
2317
2318=item $mapped->set ($offset, $data)
2319
2320Replaces the data at the given C<$offset> in the memory area by the new
2321C<$data>. This method is safer than direct manipulation of C<$mapped>
2322because it does bounds-checking, but also slower.
2323
2324=item $data = $mapped->get ($offset, $length)
2325
2326Returns (without copying) a scalar representing the data at the given
2327C<$offset> and C<$length> in the mapped memory area. This is the same as
2328the following substr, except much slower;
2329
2330 $data = substr $$mapped, $offset, $length
2331
2332=cut
2333
2334sub OpenCL::Mapped::get {
2335 substr ${$_[0]}, $_[1], $_[2]
2336}
1264 2337
1265=back 2338=back
1266 2339
2340=head2 THE OpenCL::MappedBuffer CLASS
2341
2342This is a subclass of OpenCL::Mapped, representing mapped buffers.
2343
2344=head2 THE OpenCL::MappedImage CLASS
2345
2346This is a subclass of OpenCL::Mapped, representing mapped images.
2347
2348=over 4
2349
2350=item $pixels = $mapped->width
2351
2352=item $pixels = $mapped->height
2353
2354=item $pixels = $mapped->depth
2355
2356Return the width/height/depth of the mapped image region, in pixels.
2357
2358=item $bytes = $mapped->row_pitch
2359
2360=item $bytes = $mapped->slice_pitch
2361
2362Return the row or slice pitch of the image that has been mapped.
2363
2364=item $bytes = $mapped->element_size
2365
2366Return the size of a single pixel.
2367
2368=item $data = $mapped->get_row ($count, $x=0, $y=0, $z=0)
2369
2370Return C<$count> pixels from the given coordinates. The pixel data must
2371be completely contained within a single row.
2372
2373If C<$count> is C<undef>, then all the remaining pixels in that row are
2374returned.
2375
2376=item $mapped->set_row ($data, $x=0, $y=0, $z=0)
2377
2378Write the given pixel data at the given coordinate. The pixel data must
2379be completely contained within a single row.
2380
2381=back
2382
1267=cut 2383=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 2384
12881; 23851;
1289 2386
1290=head1 AUTHOR 2387=head1 AUTHOR
1291 2388

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines