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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.53 by root, Tue Apr 24 14:30:57 2012 UTC vs.
Revision 1.77 by root, Sat May 5 12:54:03 2012 UTC

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

Diff Legend

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