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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC vs.
Revision 1.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
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, $callback->($err, $pvt) = $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 type - 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>
562 662
563=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 663=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
564 664
565Create a new OpenCL::Context object using the given device object(s). This 665Create a new OpenCL::Context object using the given device object(s).
566function isn't implemented yet, use C<< $platform->context >> instead. 666Consider using C<< $platform->context >> instead.
567 667
568L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 668L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
569 669
570=item OpenCL::wait_for_events $wait_events... 670=item OpenCL::wait_for_events $wait_events...
571 671
678 778
679=for gengetinfo begin platform 779=for gengetinfo begin platform
680 780
681=item $string = $platform->profile 781=item $string = $platform->profile
682 782
683Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 783Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
684 784
685=item $string = $platform->version 785=item $string = $platform->version
686 786
687Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 787Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
688 788
689=item $string = $platform->name 789=item $string = $platform->name
690 790
691Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 791Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
692 792
693=item $string = $platform->vendor 793=item $string = $platform->vendor
694 794
695Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 795Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
696 796
697=item $string = $platform->extensions 797=item $string = $platform->extensions
698 798
699Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 799Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
700 800
701=for gengetinfo end platform 801=for gengetinfo end platform
702 802
703=back 803=back
704 804
710 810
711See C<< $platform->info >> for details. 811See C<< $platform->info >> for details.
712 812
713L<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>
714 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
715=for gengetinfo begin device 821=for gengetinfo begin device
716 822
717=item $device_type = $device->type 823=item $device_type = $device->type
718 824
719Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 825Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
720 826
721=item $uint = $device->vendor_id 827=item $uint = $device->vendor_id
722 828
723Calls 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.
724 830
725=item $uint = $device->max_compute_units 831=item $uint = $device->max_compute_units
726 832
727Calls 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.
728 834
729=item $uint = $device->max_work_item_dimensions 835=item $uint = $device->max_work_item_dimensions
730 836
731Calls 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.
732 838
733=item $int = $device->max_work_group_size 839=item $int = $device->max_work_group_size
734 840
735Calls 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.
736 842
737=item @ints = $device->max_work_item_sizes 843=item @ints = $device->max_work_item_sizes
738 844
739Calls 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.
740 846
741=item $uint = $device->preferred_vector_width_char 847=item $uint = $device->preferred_vector_width_char
742 848
743Calls 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.
744 850
745=item $uint = $device->preferred_vector_width_short 851=item $uint = $device->preferred_vector_width_short
746 852
747Calls 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.
748 854
749=item $uint = $device->preferred_vector_width_int 855=item $uint = $device->preferred_vector_width_int
750 856
751Calls 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.
752 858
753=item $uint = $device->preferred_vector_width_long 859=item $uint = $device->preferred_vector_width_long
754 860
755Calls 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.
756 862
757=item $uint = $device->preferred_vector_width_float 863=item $uint = $device->preferred_vector_width_float
758 864
759Calls 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.
760 866
761=item $uint = $device->preferred_vector_width_double 867=item $uint = $device->preferred_vector_width_double
762 868
763Calls 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.
764 870
765=item $uint = $device->max_clock_frequency 871=item $uint = $device->max_clock_frequency
766 872
767Calls 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.
768 874
769=item $bitfield = $device->address_bits 875=item $bitfield = $device->address_bits
770 876
771Calls 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.
772 878
773=item $uint = $device->max_read_image_args 879=item $uint = $device->max_read_image_args
774 880
775Calls 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.
776 882
777=item $uint = $device->max_write_image_args 883=item $uint = $device->max_write_image_args
778 884
779Calls 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.
780 886
781=item $ulong = $device->max_mem_alloc_size 887=item $ulong = $device->max_mem_alloc_size
782 888
783Calls 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.
784 890
785=item $int = $device->image2d_max_width 891=item $int = $device->image2d_max_width
786 892
787Calls 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.
788 894
789=item $int = $device->image2d_max_height 895=item $int = $device->image2d_max_height
790 896
791Calls 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.
792 898
793=item $int = $device->image3d_max_width 899=item $int = $device->image3d_max_width
794 900
795Calls 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.
796 902
797=item $int = $device->image3d_max_height 903=item $int = $device->image3d_max_height
798 904
799Calls 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.
800 906
801=item $int = $device->image3d_max_depth 907=item $int = $device->image3d_max_depth
802 908
803Calls 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.
804 910
805=item $uint = $device->image_support 911=item $uint = $device->image_support
806 912
807Calls 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.
808 914
809=item $int = $device->max_parameter_size 915=item $int = $device->max_parameter_size
810 916
811Calls 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.
812 918
813=item $uint = $device->max_samplers 919=item $uint = $device->max_samplers
814 920
815Calls 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.
816 922
817=item $uint = $device->mem_base_addr_align 923=item $uint = $device->mem_base_addr_align
818 924
819Calls 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.
820 926
821=item $uint = $device->min_data_type_align_size 927=item $uint = $device->min_data_type_align_size
822 928
823Calls 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.
824 930
825=item $device_fp_config = $device->single_fp_config 931=item $device_fp_config = $device->single_fp_config
826 932
827Calls 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.
828 934
829=item $device_mem_cache_type = $device->global_mem_cache_type 935=item $device_mem_cache_type = $device->global_mem_cache_type
830 936
831Calls 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.
832 938
833=item $uint = $device->global_mem_cacheline_size 939=item $uint = $device->global_mem_cacheline_size
834 940
835Calls 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.
836 942
837=item $ulong = $device->global_mem_cache_size 943=item $ulong = $device->global_mem_cache_size
838 944
839Calls 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.
840 946
841=item $ulong = $device->global_mem_size 947=item $ulong = $device->global_mem_size
842 948
843Calls 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.
844 950
845=item $ulong = $device->max_constant_buffer_size 951=item $ulong = $device->max_constant_buffer_size
846 952
847Calls 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.
848 954
849=item $uint = $device->max_constant_args 955=item $uint = $device->max_constant_args
850 956
851Calls 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.
852 958
853=item $device_local_mem_type = $device->local_mem_type 959=item $device_local_mem_type = $device->local_mem_type
854 960
855Calls 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.
856 962
857=item $ulong = $device->local_mem_size 963=item $ulong = $device->local_mem_size
858 964
859Calls 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.
860 966
861=item $boolean = $device->error_correction_support 967=item $boolean = $device->error_correction_support
862 968
863Calls 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.
864 970
865=item $int = $device->profiling_timer_resolution 971=item $int = $device->profiling_timer_resolution
866 972
867Calls 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.
868 974
869=item $boolean = $device->endian_little 975=item $boolean = $device->endian_little
870 976
871Calls 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.
872 978
873=item $boolean = $device->available 979=item $boolean = $device->available
874 980
875Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 981Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
876 982
877=item $boolean = $device->compiler_available 983=item $boolean = $device->compiler_available
878 984
879Calls 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.
880 986
881=item $device_exec_capabilities = $device->execution_capabilities 987=item $device_exec_capabilities = $device->execution_capabilities
882 988
883Calls 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.
884 990
885=item $command_queue_properties = $device->properties 991=item $command_queue_properties = $device->properties
886 992
887Calls 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.
888 994
889=item $ = $device->platform 995=item $ = $device->platform
890 996
891Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 997Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
892 998
893=item $string = $device->name 999=item $string = $device->name
894 1000
895Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 1001Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
896 1002
897=item $string = $device->vendor 1003=item $string = $device->vendor
898 1004
899Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 1005Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
900 1006
901=item $string = $device->driver_version 1007=item $string = $device->driver_version
902 1008
903Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 1009Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
904 1010
905=item $string = $device->profile 1011=item $string = $device->profile
906 1012
907Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 1013Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
908 1014
909=item $string = $device->version 1015=item $string = $device->version
910 1016
911Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 1017Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
912 1018
913=item $string = $device->extensions 1019=item $string = $device->extensions
914 1020
915Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 1021Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
916 1022
917=item $uint = $device->preferred_vector_width_half 1023=item $uint = $device->preferred_vector_width_half
918 1024
919Calls 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.
920 1026
921=item $uint = $device->native_vector_width_char 1027=item $uint = $device->native_vector_width_char
922 1028
923Calls 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.
924 1030
925=item $uint = $device->native_vector_width_short 1031=item $uint = $device->native_vector_width_short
926 1032
927Calls 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.
928 1034
929=item $uint = $device->native_vector_width_int 1035=item $uint = $device->native_vector_width_int
930 1036
931Calls 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.
932 1038
933=item $uint = $device->native_vector_width_long 1039=item $uint = $device->native_vector_width_long
934 1040
935Calls 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.
936 1042
937=item $uint = $device->native_vector_width_float 1043=item $uint = $device->native_vector_width_float
938 1044
939Calls 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.
940 1046
941=item $uint = $device->native_vector_width_double 1047=item $uint = $device->native_vector_width_double
942 1048
943Calls 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.
944 1050
945=item $uint = $device->native_vector_width_half 1051=item $uint = $device->native_vector_width_half
946 1052
947Calls 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.
948 1054
949=item $device_fp_config = $device->double_fp_config 1055=item $device_fp_config = $device->double_fp_config
950 1056
951Calls 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.
952 1058
953=item $device_fp_config = $device->half_fp_config 1059=item $device_fp_config = $device->half_fp_config
954 1060
955Calls 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.
956 1062
957=item $boolean = $device->host_unified_memory 1063=item $boolean = $device->host_unified_memory
958 1064
959Calls 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.
960 1066
961=item $device = $device->parent_device_ext 1067=item $device = $device->parent_device_ext
962 1068
963Calls 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.
964 1070
965=item @device_partition_property_exts = $device->partition_types_ext 1071=item @device_partition_property_exts = $device->partition_types_ext
966 1072
967Calls 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.
968 1074
969=item @device_partition_property_exts = $device->affinity_domains_ext 1075=item @device_partition_property_exts = $device->affinity_domains_ext
970 1076
971Calls 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.
972 1078
973=item $uint = $device->reference_count_ext 1079=item $uint = $device->reference_count_ext
974 1080
975Calls 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.
976 1082
977=item @device_partition_property_exts = $device->partition_style_ext 1083=item @device_partition_property_exts = $device->partition_style_ext
978 1084
979Calls 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.
980 1086
981=for gengetinfo end device 1087=for gengetinfo end device
982 1088
983=back 1089=back
984 1090
985=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
986 1118
987=over 4 1119=over 4
988 1120
989=item $prog = $ctx->build_program ($program, $options = "") 1121=item $prog = $ctx->build_program ($program, $options = "")
990 1122
999=cut 1131=cut
1000 1132
1001sub OpenCL::Context::build_program { 1133sub OpenCL::Context::build_program {
1002 my ($self, $prog, $options) = @_; 1134 my ($self, $prog, $options) = @_;
1003 1135
1004 require Carp;
1005
1006 $prog = $self->program_with_source ($prog) 1136 $prog = $self->program_with_source ($prog)
1007 unless ref $prog; 1137 unless ref $prog;
1008 1138
1009 # 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
1010 for my $dev ($self->devices) { 1145 for my $dev ($self->devices) {
1011 eval { $prog->build ([$dev], $options); 1 } 1146 $prog->build_status ($dev) == BUILD_SUCCESS
1012 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"
1013 . $prog->build_log ($dev)); 1148 . $prog->build_log ($dev);
1014 } 1149 }
1015 1150
1016 $prog 1151 $prog
1017} 1152}
1018 1153
1035=item $buf = $ctx->buffer ($flags, $len) 1170=item $buf = $ctx->buffer ($flags, $len)
1036 1171
1037Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1172Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1038given flags and octet-size. 1173given flags and octet-size.
1039 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
1040L<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>
1041 1180
1042=item $buf = $ctx->buffer_sv ($flags, $data) 1181=item $buf = $ctx->buffer_sv ($flags, $data)
1043 1182
1044Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1183Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1045initialise it with the given data values. 1184initialise it with the given data values.
1046 1185
1047=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef) 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)
1048 1187
1049Creates a new OpenCL::Image object and optionally initialises it with 1188Creates a new OpenCL::Image object and optionally initialises it with
1050the given data values. 1189the given data values.
1051 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
1052L<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>
1053 1208
1054=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)
1055 1210
1056Creates a new OpenCL::Image2D object and optionally initialises it with 1211Creates a new OpenCL::Image2D object and optionally initialises it with
1068=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1223=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1069 1224
1070Creates 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
1071OpenGL buffer object. 1226OpenGL buffer object.
1072 1227
1228flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1229
1073http://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
1074 1231
1075=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1232=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1076 1233
1077Creates a new OpenCL::Image object that refers to the given OpenGL 1234Creates a new OpenCL::Image object that refers to the given OpenGL
1078texture object or buffer. 1235texture object or buffer.
1079 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
1080http://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
1081 1245
1082=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1246=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1083 1247
1084Creates a new OpenCL::Image2D object that refers to the given OpenGL 1248Creates a new OpenCL::Image2D object that refers to the given OpenGL
1109 1273
1110=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1274=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1111 1275
1112Creates a new OpenCL::Sampler object. 1276Creates a new OpenCL::Sampler object.
1113 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
1114L<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>
1115 1284
1116=item $program = $ctx->program_with_source ($string) 1285=item $program = $ctx->program_with_source ($string)
1117 1286
1118Creates a new OpenCL::Program object from the given source code. 1287Creates a new OpenCL::Program object from the given source code.
1119 1288
1120L<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>
1121 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
1122=item $packed_value = $ctx->info ($name) 1315=item $packed_value = $ctx->info ($name)
1123 1316
1124See C<< $platform->info >> for details. 1317See C<< $platform->info >> for details.
1125 1318
1126L<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>
1127 1320
1128=for gengetinfo begin context 1321=for gengetinfo begin context
1129 1322
1130=item $uint = $context->reference_count 1323=item $uint = $context->reference_count
1131 1324
1132Calls 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.
1133 1326
1134=item @devices = $context->devices 1327=item @devices = $context->devices
1135 1328
1136Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1329Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1137 1330
1138=item @property_ints = $context->properties 1331=item @property_ints = $context->properties
1139 1332
1140Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1333Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1141 1334
1142=item $uint = $context->num_devices 1335=item $uint = $context->num_devices
1143 1336
1144Calls 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.
1145 1338
1146=for gengetinfo end context 1339=for gengetinfo end context
1147 1340
1148=back 1341=back
1149 1342
1150=head2 THE OpenCL::Queue CLASS 1343=head2 THE OpenCL::Queue CLASS
1151 1344
1152An OpenCL::Queue represents an execution queue for OpenCL. You execute 1345An OpenCL::Queue represents an execution queue for OpenCL. You execute
1153requests by calling their respective C<enqueue_xxx> method and waitinf for 1346requests by calling their respective method and waiting for it to complete
1154it to complete in some way. 1347in some way.
1155 1348
1156All 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
1157for completion, unless the method is called in void context, in which case 1350be used to wait for completion (optionally using a callback), unless
1158no event object is created. 1351the method is called in void context, in which case no event object is
1352created.
1159 1353
1160They 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
1161request 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
1162event objects as extra parameters to the enqueue methods. To simplify 1356event objects as extra parameters to the enqueue methods. To simplify
1163program 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
1164events. This makes it possible to code operations such as this, without 1358events. This makes it possible to code operations such as this, without
1165having to put a valid event object into C<$event> first: 1359having to put a valid event object into C<$event> first:
1166 1360
1167 $event = $queue->enqueue_xxx (..., $event); 1361 $event = $queue->xxx (..., $event);
1168 1362
1169Queues execute in-order by default, without any parallelism, so in most 1363Queues execute in-order by default, without any parallelism, so in most
1170cases (i.e. you use only one queue) it's not necessary to wait for or 1364cases (i.e. you use only one queue) it's not necessary to wait for or
1171create event objects, althoguh an our of order queue is often a bit 1365create event objects, althoguh an our of order queue is often a bit
1172faster. 1366faster.
1173 1367
1174=over 4 1368=over 4
1175 1369
1176=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...)
1177 1371
1178Reads data from buffer into the given string. 1372Reads data from buffer into the given string.
1179 1373
1180L<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>
1181 1375
1182=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...) 1376=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1183 1377
1184Writes data to buffer from the given string. 1378Writes data to buffer from the given string.
1185 1379
1186L<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>
1187 1381
1188=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...)
1189 1383
1190L<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>
1191 1385
1192=item $ev = $queue->enqueue_read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...) 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...)
1193 1387
1194http://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
1195 1389
1196=item $ev = $queue->enqueue_write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...) 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...)
1197 1391
1198http://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
1199 1393
1200=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1201
1202L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1203
1204=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) 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.
1205 1402
1206L<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>
1207 1404
1208=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...)
1209 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.
1210L<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>
1211 1410
1212=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) 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...)
1213 1412
1214L<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>
1215 1414
1216=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...) 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...)
1217 1416
1218L<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>
1219 1418
1220=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...) 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...)
1221 1420
1222Yeah. 1421Yeah.
1223 1422
1224L<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>.
1225 1424
1226=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...) 1425=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1227 1426
1228Fills the given buffer object with repeated applications of C<$pattern>, 1427Fills the given buffer object with repeated applications of C<$pattern>,
1229starting at C<$offset> for C<$size> octets. 1428starting at C<$offset> for C<$size> octets.
1230 1429
1231L<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>
1232 1431
1233=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, ...)
1234 1433
1235Fills the given image area with the given rgba colour components. The 1434Fills the given image area with the given rgba colour components. The
1236components are normally floating point values between C<0> and C<1>, 1435components are normally floating point values between C<0> and C<1>,
1237except when the image channel data type is a signe dor unsigned 1436except when the image channel data type is a signe dor unsigned
1238unnormalised format, in which case the range is determined by the format. 1437unnormalised format, in which case the range is determined by the format.
1239 1438
1240L<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>
1241 1440
1242=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1441=item $ev = $queue->task ($kernel, $wait_events...)
1243 1442
1244L<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>
1245 1444
1246=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...)
1247 1446
1248Enqueues a kernel execution. 1447Enqueues a kernel execution.
1249 1448
1250@$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
1251integers specifying the work sizes (element counts). 1450integers specifying the work sizes (element counts).
1252 1451
1253@$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
1254are 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
1255of elements as @$global_work_size. 1454of elements as \@global_work_size.
1256 1455
1257@$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
1258implementation is supposed to choose good local work sizes), or a 1457implementation is supposed to choose good local work sizes), or a
1259reference 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
1260elements as @$global_work_size. 1459elements as \@global_work_size.
1261 1460
1262L<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>
1263 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
1264=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...) 1471=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1265 1472
1266Enqueues 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
1267for subsequent OpenCL usage. 1474for subsequent OpenCL usage.
1268 1475
1269L<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>
1270 1477
1271=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...) 1478=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1272 1479
1273Enqueues 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
1274for subsequent OpenGL usage. 1481for subsequent OpenGL usage.
1275 1482
1276L<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>
1277 1484
1278=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1485=item $ev = $queue->wait_for_events ($wait_events...)
1279 1486
1280L<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>
1281 1488
1282=item $ev = $queue->enqueue_marker ($wait_events...) 1489=item $ev = $queue->marker ($wait_events...)
1283 1490
1284L<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>
1285 1492
1286=item $ev = $queue->enqueue_barrier ($wait_events...) 1493=item $ev = $queue->barrier ($wait_events...)
1287 1494
1288L<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>
1289 1496
1290=item $queue->flush 1497=item $queue->flush
1291 1498
1303 1510
1304=for gengetinfo begin command_queue 1511=for gengetinfo begin command_queue
1305 1512
1306=item $ctx = $command_queue->context 1513=item $ctx = $command_queue->context
1307 1514
1308Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1515Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1309 1516
1310=item $device = $command_queue->device 1517=item $device = $command_queue->device
1311 1518
1312Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1519Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1313 1520
1314=item $uint = $command_queue->reference_count 1521=item $uint = $command_queue->reference_count
1315 1522
1316Calls 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.
1317 1524
1318=item $command_queue_properties = $command_queue->properties 1525=item $command_queue_properties = $command_queue->properties
1319 1526
1320Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1527Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1321 1528
1322=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.
1323 1599
1324=back 1600=back
1325 1601
1326=head2 THE OpenCL::Memory CLASS 1602=head2 THE OpenCL::Memory CLASS
1327 1603
1338 1614
1339=for gengetinfo begin mem 1615=for gengetinfo begin mem
1340 1616
1341=item $mem_object_type = $mem->type 1617=item $mem_object_type = $mem->type
1342 1618
1343Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1619Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1344 1620
1345=item $mem_flags = $mem->flags 1621=item $mem_flags = $mem->flags
1346 1622
1347Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1623Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1348 1624
1349=item $int = $mem->size 1625=item $int = $mem->size
1350 1626
1351Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1627Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1352 1628
1353=item $ptr_value = $mem->host_ptr 1629=item $ptr_value = $mem->host_ptr
1354 1630
1355Calls 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.
1356 1632
1357=item $uint = $mem->map_count 1633=item $uint = $mem->map_count
1358 1634
1359Calls 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.
1360 1636
1361=item $uint = $mem->reference_count 1637=item $uint = $mem->reference_count
1362 1638
1363Calls 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.
1364 1640
1365=item $ctx = $mem->context 1641=item $ctx = $mem->context
1366 1642
1367Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1643Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1368 1644
1369=item $mem = $mem->associated_memobject 1645=item $mem = $mem->associated_memobject
1370 1646
1371Calls 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.
1372 1648
1373=item $int = $mem->offset 1649=item $int = $mem->offset
1374 1650
1375Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1651Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1376 1652
1377=for gengetinfo end mem 1653=for gengetinfo end mem
1378 1654
1379=item ($type, $name) = $mem->gl_object_info 1655=item ($type, $name) = $mem->gl_object_info
1380 1656
1432 1708
1433=for gengetinfo begin image 1709=for gengetinfo begin image
1434 1710
1435=item $int = $image->element_size 1711=item $int = $image->element_size
1436 1712
1437Calls 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.
1438 1714
1439=item $int = $image->row_pitch 1715=item $int = $image->row_pitch
1440 1716
1441Calls 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.
1442 1718
1443=item $int = $image->slice_pitch 1719=item $int = $image->slice_pitch
1444 1720
1445Calls 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.
1446 1722
1447=item $int = $image->width 1723=item $int = $image->width
1448 1724
1449Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1725Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1450 1726
1451=item $int = $image->height 1727=item $int = $image->height
1452 1728
1453Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1729Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1454 1730
1455=item $int = $image->depth 1731=item $int = $image->depth
1456 1732
1457Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1733Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1458 1734
1459=for gengetinfo end image 1735=for gengetinfo end image
1460 1736
1461=for gengetinfo begin gl_texture 1737=for gengetinfo begin gl_texture
1462 1738
1463=item $GLenum = $gl_texture->target 1739=item $GLenum = $gl_texture->target
1464 1740
1465Calls 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.
1466 1742
1467=item $GLint = $gl_texture->gl_mipmap_level 1743=item $GLint = $gl_texture->gl_mipmap_level
1468 1744
1469Calls 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.
1470 1746
1471=for gengetinfo end gl_texture 1747=for gengetinfo end gl_texture
1472 1748
1473=back 1749=back
1474 1750
1484 1760
1485=for gengetinfo begin sampler 1761=for gengetinfo begin sampler
1486 1762
1487=item $uint = $sampler->reference_count 1763=item $uint = $sampler->reference_count
1488 1764
1489Calls 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.
1490 1766
1491=item $ctx = $sampler->context 1767=item $ctx = $sampler->context
1492 1768
1493Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1769Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1494 1770
1495=item $addressing_mode = $sampler->normalized_coords 1771=item $addressing_mode = $sampler->normalized_coords
1496 1772
1497Calls 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.
1498 1774
1499=item $filter_mode = $sampler->addressing_mode 1775=item $filter_mode = $sampler->addressing_mode
1500 1776
1501Calls 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.
1502 1778
1503=item $boolean = $sampler->filter_mode 1779=item $boolean = $sampler->filter_mode
1504 1780
1505Calls 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.
1506 1782
1507=for gengetinfo end sampler 1783=for gengetinfo end sampler
1508 1784
1509=back 1785=back
1510 1786
1520If 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
1521finished. Note that many OpenCL implementations block your program while 1797finished. Note that many OpenCL implementations block your program while
1522compiling 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
1523want to make sure the build is done in the background. 1799want to make sure the build is done in the background.
1524 1800
1525Note 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
1526callback in some error cases (but call it in others). This implementation 1802callback in some error cases (but call it in others). This implementation
1527assumes 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
1528not 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.
1529 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
1530L<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>
1531 1821
1532=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1822=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1533 1823
1534Similar 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
1535need to check the compilation status form the callback, or by polling). 1825need to check the compilation status form the callback, or by polling).
1536 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
1537=item $packed_value = $program->build_info ($device, $name) 1835=item $packed_value = $program->build_info ($device, $name)
1538 1836
1539Similar to C<< $platform->info >>, but returns build info for a previous 1837Similar to C<< $platform->info >>, but returns build info for a previous
1540build attempt for the given device. 1838build attempt for the given device.
1541 1839
1556 1854
1557=for gengetinfo begin program_build 1855=for gengetinfo begin program_build
1558 1856
1559=item $build_status = $program->build_status ($device) 1857=item $build_status = $program->build_status ($device)
1560 1858
1561Calls 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.
1562 1860
1563=item $string = $program->build_options ($device) 1861=item $string = $program->build_options ($device)
1564 1862
1565Calls 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.
1566 1864
1567=item $string = $program->build_log ($device) 1865=item $string = $program->build_log ($device)
1568 1866
1569Calls 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.
1570 1868
1571=for gengetinfo end program_build 1869=for gengetinfo end program_build
1572 1870
1573=item $packed_value = $program->info ($name) 1871=item $packed_value = $program->info ($name)
1574 1872
1578 1876
1579=for gengetinfo begin program 1877=for gengetinfo begin program
1580 1878
1581=item $uint = $program->reference_count 1879=item $uint = $program->reference_count
1582 1880
1583Calls 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.
1584 1882
1585=item $ctx = $program->context 1883=item $ctx = $program->context
1586 1884
1587Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1885Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1588 1886
1589=item $uint = $program->num_devices 1887=item $uint = $program->num_devices
1590 1888
1591Calls 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.
1592 1890
1593=item @devices = $program->devices 1891=item @devices = $program->devices
1594 1892
1595Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1893Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1596 1894
1597=item $string = $program->source 1895=item $string = $program->source
1598 1896
1599Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1897Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1600 1898
1601=item @ints = $program->binary_sizes 1899=item @ints = $program->binary_sizes
1602 1900
1603Calls 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.
1604 1902
1605=for gengetinfo end program 1903=for gengetinfo end program
1606 1904
1607=item @blobs = $program->binaries 1905=item @blobs = $program->binaries
1608 1906
1629 1927
1630=for gengetinfo begin kernel 1928=for gengetinfo begin kernel
1631 1929
1632=item $string = $kernel->function_name 1930=item $string = $kernel->function_name
1633 1931
1634Calls 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.
1635 1933
1636=item $uint = $kernel->num_args 1934=item $uint = $kernel->num_args
1637 1935
1638Calls 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.
1639 1937
1640=item $uint = $kernel->reference_count 1938=item $uint = $kernel->reference_count
1641 1939
1642Calls 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.
1643 1941
1644=item $ctx = $kernel->context 1942=item $ctx = $kernel->context
1645 1943
1646Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1944Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1647 1945
1648=item $program = $kernel->program 1946=item $program = $kernel->program
1649 1947
1650Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1948Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1651 1949
1652=for gengetinfo end kernel 1950=for gengetinfo end kernel
1653 1951
1654=item $packed_value = $kernel->work_group_info ($device, $name) 1952=item $packed_value = $kernel->work_group_info ($device, $name)
1655 1953
1656See C<< $platform->info >> for details. 1954See C<< $platform->info >> for details.
1657 1955
1658The reason this method is not called C<info> is that there already is an
1659C<< ->info >> method.
1660
1661L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> 1956L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1662 1957
1663=for gengetinfo begin kernel_work_group 1958=for gengetinfo begin kernel_work_group
1664 1959
1665=item $int = $kernel->work_group_size ($device) 1960=item $int = $kernel->work_group_size ($device)
1666 1961
1667Calls 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.
1668 1963
1669=item @ints = $kernel->compile_work_group_size ($device) 1964=item @ints = $kernel->compile_work_group_size ($device)
1670 1965
1671Calls 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.
1672 1967
1673=item $ulong = $kernel->local_mem_size ($device) 1968=item $ulong = $kernel->local_mem_size ($device)
1674 1969
1675Calls 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.
1676 1971
1677=item $int = $kernel->preferred_work_group_size_multiple ($device) 1972=item $int = $kernel->preferred_work_group_size_multiple ($device)
1678 1973
1679Calls 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.
1680 1975
1681=item $ulong = $kernel->private_mem_size ($device) 1976=item $ulong = $kernel->private_mem_size ($device)
1682 1977
1683Calls 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.
1684 1979
1685=for gengetinfo end kernel_work_group 1980=for gengetinfo end kernel_work_group
1686 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
1687=item $kernel->set_TYPE ($index, $value) 2046=item $kernel->set_TYPE ($index, $value)
1688 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
1689This 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
1690 2083C<$index> to the give C<$value>.
1691TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1692C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1693C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1694 2084
1695Chars and integers (including the half type) are specified as integers, 2085Chars and integers (including the half type) are specified as integers,
1696float and double as floating point values, memory/buffer/image2d/image3d 2086float and double as floating point values, memory/buffer/image must be
1697must be an object of that type or C<undef>, local-memory arguments are 2087an object of that type or C<undef>, local-memory arguments are set by
1698set by specifying the size, and sampler and event must be objects of that 2088specifying the size, and sampler and event must be objects of that type.
1699type. 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.
1700 2093
1701Setting 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 -
1702for 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,
1703and call the kernel, you will run into undefined behaviour. 2096and call the kernel, you will run into undefined behaviour.
1704 2097
1734 2127
1735=for gengetinfo begin event 2128=for gengetinfo begin event
1736 2129
1737=item $queue = $event->command_queue 2130=item $queue = $event->command_queue
1738 2131
1739Calls 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.
1740 2133
1741=item $command_type = $event->command_type 2134=item $command_type = $event->command_type
1742 2135
1743Calls 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.
1744 2137
1745=item $uint = $event->reference_count 2138=item $uint = $event->reference_count
1746 2139
1747Calls 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.
1748 2141
1749=item $uint = $event->command_execution_status 2142=item $uint = $event->command_execution_status
1750 2143
1751Calls 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.
1752 2145
1753=item $ctx = $event->context 2146=item $ctx = $event->context
1754 2147
1755Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2148Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1756 2149
1757=for gengetinfo end event 2150=for gengetinfo end event
1758 2151
1759=item $packed_value = $ev->profiling_info ($name) 2152=item $packed_value = $ev->profiling_info ($name)
1760 2153
1767 2160
1768=for gengetinfo begin profiling 2161=for gengetinfo begin profiling
1769 2162
1770=item $ulong = $event->profiling_command_queued 2163=item $ulong = $event->profiling_command_queued
1771 2164
1772Calls 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.
1773 2166
1774=item $ulong = $event->profiling_command_submit 2167=item $ulong = $event->profiling_command_submit
1775 2168
1776Calls 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.
1777 2170
1778=item $ulong = $event->profiling_command_start 2171=item $ulong = $event->profiling_command_start
1779 2172
1780Calls 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.
1781 2174
1782=item $ulong = $event->profiling_command_end 2175=item $ulong = $event->profiling_command_end
1783 2176
1784Calls 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.
1785 2178
1786=for gengetinfo end profiling 2179=for gengetinfo end profiling
1787 2180
1788=back 2181=back
1789 2182
1796=item $ev->set_status ($execution_status) 2189=item $ev->set_status ($execution_status)
1797 2190
1798Sets 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,
1799either with OpenCL::COMPLETE or a negative number as status. 2192either with OpenCL::COMPLETE or a negative number as status.
1800 2193
2194execution_status: OpenCL::COMPLETE or a negative integer.
2195
1801L<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>
1802 2197
1803=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
1804 2300
1805=cut 2301=cut
1806 2302
18071; 23031;
1808 2304

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines