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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC vs.
Revision 1.77 by root, Sat May 5 12:54:03 2012 UTC

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

Diff Legend

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