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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines