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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC vs.
Revision 1.82 by root, Sat May 5 14:18:35 2012 UTC

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

Diff Legend

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