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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.61 by root, Sat Apr 28 13:31:40 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 specs used to develop this module: 48The OpenCL specs used to develop this module - download these and keept
49hema round, they are required reference material:
49 50
50 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf 52 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf 53 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53 54
… …
210 211
211 # wait for the last event to complete 212 # wait for the last event to complete
212 $ev->wait; 213 $ev->wait;
213 214
214=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
215set tunnel effect. 216set flight effect.
216 217
217This 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>.
218 220
219 use OpenGL ":all"; 221 use OpenGL ":all";
220 use OpenCL; 222 use OpenCL;
221 223
224 my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
225
222 # open a window and create a gl texture 226 # open a window and create a gl texture
223 OpenGL::glpOpenWindow width => 256, height => 256; 227 OpenGL::glpOpenWindow width => $S, height => $S;
224 my $texid = glGenTextures_p 1; 228 my $texid = glGenTextures_p 1;
225 glBindTexture GL_TEXTURE_2D, $texid; 229 glBindTexture GL_TEXTURE_2D, $texid;
226 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;
227 231
228 # 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
229 my $platform; 233 my $platform;
230 my $dev; 234 my $dev;
231 my $ctx; 235 my $ctx;
… …
250 # now the boring opencl code 254 # now the boring opencl code
251 my $src = <<EOF; 255 my $src = <<EOF;
252 kernel void 256 kernel void
253 juliatunnel (write_only image2d_t img, float time) 257 juliatunnel (write_only image2d_t img, float time)
254 { 258 {
255 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;
256 261
257 float2 m = (float2)(1.f, p.y) / fabs (p.x); 262 float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
258 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);
259 264
260 float2 z = m; 265 float2 z = m;
261 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001)); 266 float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
262 267
263 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
264 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;
265 270
266 float3 colour = (float3)(z.x, z.y, z.x * z.y); 271 float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
267 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.));
268 } 273 }
269 EOF 274 EOF
270 275
271 my $prog = $ctx->build_program ($src); 276 my $prog = $ctx->build_program ($src);
272 my $kernel = $prog->kernel ("juliatunnel"); 277 my $kernel = $prog->kernel ("juliatunnel");
… …
276 for (my $time; ; ++$time) { 281 for (my $time; ; ++$time) {
277 # acquire objects from opengl 282 # acquire objects from opengl
278 $queue->acquire_gl_objects ([$tex]); 283 $queue->acquire_gl_objects ([$tex]);
279 284
280 # configure and run our kernel 285 # configure and run our kernel
281 $kernel->set_image2d (0, $tex); 286 $kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
282 $kernel->set_float (1, $time);
283 $queue->nd_range_kernel ($kernel, undef, [256, 256], undef); 287 $queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
284 288
285 # release objects to opengl again 289 # release objects to opengl again
286 $queue->release_gl_objects ([$tex]); 290 $queue->release_gl_objects ([$tex]);
287 291
288 # wait 292 # wait
… …
301 305
302 glXSwapBuffers; 306 glXSwapBuffers;
303 307
304 select undef, undef, undef, 1/60; 308 select undef, undef, undef, 1/60;
305 } 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>.
306 354
307=head1 DOCUMENTATION 355=head1 DOCUMENTATION
308 356
309=head2 BASIC CONVENTIONS 357=head2 BASIC CONVENTIONS
310 358
… …
386OpenCL can generate a number of (potentially) asynchronous events, for 434OpenCL can generate a number of (potentially) asynchronous events, for
387example, after compiling a program, to signal a context-related error or, 435example, after compiling a program, to signal a context-related error or,
388perhaps most important, to signal completion of queued jobs (by setting 436perhaps most important, to signal completion of queued jobs (by setting
389callbacks on OpenCL::Event objects). 437callbacks on OpenCL::Event objects).
390 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
391To facilitate this, this module maintains an event queue - each 446To facilitate this, this module maintains an event queue - each
392time an asynchronous event happens, it is queued, and perl will be 447time an asynchronous event happens, it is queued, and perl will be
393interrupted. This is implemented via the L<Async::Interrupt> module. In 448interrupted. This is implemented via the L<Async::Interrupt> module. In
394addition, this module has L<AnyEvent> support, so it can seamlessly 449addition, this module has L<AnyEvent> support, so it can seamlessly
395integrate itself into many event loops. 450integrate itself into many event loops.
396 451
397Since 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:
398 453
399=head3 Don't use callbacks. 454=head3 Don't use callbacks.
400 455
401When 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
402notifications 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
… …
493=cut 548=cut
494 549
495package OpenCL; 550package OpenCL;
496 551
497use common::sense; 552use common::sense;
553use Carp ();
498use Async::Interrupt (); 554use Async::Interrupt ();
499 555
500our $POLL_FUNC; # set by XS 556our $POLL_FUNC; # set by XS
501 557
502BEGIN { 558BEGIN {
503 our $VERSION = '0.97'; 559 our $VERSION = '0.99';
504 560
505 require XSLoader; 561 require XSLoader;
506 XSLoader::load (__PACKAGE__, $VERSION); 562 XSLoader::load (__PACKAGE__, $VERSION);
507 563
508 @OpenCL::Platform::ISA = 564 @OpenCL::Platform::ISA =
… …
513 @OpenCL::Sampler::ISA = 569 @OpenCL::Sampler::ISA =
514 @OpenCL::Program::ISA = 570 @OpenCL::Program::ISA =
515 @OpenCL::Kernel::ISA = 571 @OpenCL::Kernel::ISA =
516 @OpenCL::Event::ISA = OpenCL::Object::; 572 @OpenCL::Event::ISA = OpenCL::Object::;
517 573
574 @OpenCL::SubDevice::ISA = OpenCL::Device::;
575
518 @OpenCL::Buffer::ISA = 576 @OpenCL::Buffer::ISA =
519 @OpenCL::Image::ISA = OpenCL::Memory::; 577 @OpenCL::Image::ISA = OpenCL::Memory::;
520 578
521 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 579 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
522 580
… …
526 @OpenCL::Image1D::ISA = 584 @OpenCL::Image1D::ISA =
527 @OpenCL::Image1DArray::ISA = 585 @OpenCL::Image1DArray::ISA =
528 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; 586 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
529 587
530 @OpenCL::UserEvent::ISA = OpenCL::Event::; 588 @OpenCL::UserEvent::ISA = OpenCL::Event::;
589
590 @OpenCL::MappedBuffer::ISA =
591 @OpenCL::MappedImage::ISA = OpenCL::Mapped::;
531} 592}
532 593
533=head2 THE OpenCL PACKAGE 594=head2 THE OpenCL PACKAGE
534 595
535=over 4 596=over 4
… …
559L<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>
560 621
561=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
562 623
563Tries 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.
564 629
565L<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>
566 631
567=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 632=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
568 633
569Create a new OpenCL::Context object using the given device object(s). This 634Create a new OpenCL::Context object using the given device object(s).
570function isn't implemented yet, use C<< $platform->context >> instead. 635Consider using C<< $platform->context >> instead.
571 636
572L<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>
573 638
574=item OpenCL::wait_for_events $wait_events... 639=item OpenCL::wait_for_events $wait_events...
575 640
… …
682 747
683=for gengetinfo begin platform 748=for gengetinfo begin platform
684 749
685=item $string = $platform->profile 750=item $string = $platform->profile
686 751
687Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 752Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
688 753
689=item $string = $platform->version 754=item $string = $platform->version
690 755
691Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 756Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
692 757
693=item $string = $platform->name 758=item $string = $platform->name
694 759
695Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 760Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
696 761
697=item $string = $platform->vendor 762=item $string = $platform->vendor
698 763
699Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 764Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
700 765
701=item $string = $platform->extensions 766=item $string = $platform->extensions
702 767
703Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 768Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
704 769
705=for gengetinfo end platform 770=for gengetinfo end platform
706 771
707=back 772=back
708 773
… …
714 779
715See C<< $platform->info >> for details. 780See C<< $platform->info >> for details.
716 781
717L<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>
718 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
719=for gengetinfo begin device 790=for gengetinfo begin device
720 791
721=item $device_type = $device->type 792=item $device_type = $device->type
722 793
723Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 794Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
724 795
725=item $uint = $device->vendor_id 796=item $uint = $device->vendor_id
726 797
727Calls 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.
728 799
729=item $uint = $device->max_compute_units 800=item $uint = $device->max_compute_units
730 801
731Calls 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.
732 803
733=item $uint = $device->max_work_item_dimensions 804=item $uint = $device->max_work_item_dimensions
734 805
735Calls 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.
736 807
737=item $int = $device->max_work_group_size 808=item $int = $device->max_work_group_size
738 809
739Calls 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.
740 811
741=item @ints = $device->max_work_item_sizes 812=item @ints = $device->max_work_item_sizes
742 813
743Calls 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.
744 815
745=item $uint = $device->preferred_vector_width_char 816=item $uint = $device->preferred_vector_width_char
746 817
747Calls 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.
748 819
749=item $uint = $device->preferred_vector_width_short 820=item $uint = $device->preferred_vector_width_short
750 821
751Calls 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.
752 823
753=item $uint = $device->preferred_vector_width_int 824=item $uint = $device->preferred_vector_width_int
754 825
755Calls 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.
756 827
757=item $uint = $device->preferred_vector_width_long 828=item $uint = $device->preferred_vector_width_long
758 829
759Calls 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.
760 831
761=item $uint = $device->preferred_vector_width_float 832=item $uint = $device->preferred_vector_width_float
762 833
763Calls 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.
764 835
765=item $uint = $device->preferred_vector_width_double 836=item $uint = $device->preferred_vector_width_double
766 837
767Calls 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.
768 839
769=item $uint = $device->max_clock_frequency 840=item $uint = $device->max_clock_frequency
770 841
771Calls 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.
772 843
773=item $bitfield = $device->address_bits 844=item $bitfield = $device->address_bits
774 845
775Calls 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.
776 847
777=item $uint = $device->max_read_image_args 848=item $uint = $device->max_read_image_args
778 849
779Calls 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.
780 851
781=item $uint = $device->max_write_image_args 852=item $uint = $device->max_write_image_args
782 853
783Calls 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.
784 855
785=item $ulong = $device->max_mem_alloc_size 856=item $ulong = $device->max_mem_alloc_size
786 857
787Calls 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.
788 859
789=item $int = $device->image2d_max_width 860=item $int = $device->image2d_max_width
790 861
791Calls 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.
792 863
793=item $int = $device->image2d_max_height 864=item $int = $device->image2d_max_height
794 865
795Calls 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.
796 867
797=item $int = $device->image3d_max_width 868=item $int = $device->image3d_max_width
798 869
799Calls 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.
800 871
801=item $int = $device->image3d_max_height 872=item $int = $device->image3d_max_height
802 873
803Calls 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.
804 875
805=item $int = $device->image3d_max_depth 876=item $int = $device->image3d_max_depth
806 877
807Calls 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.
808 879
809=item $uint = $device->image_support 880=item $uint = $device->image_support
810 881
811Calls 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.
812 883
813=item $int = $device->max_parameter_size 884=item $int = $device->max_parameter_size
814 885
815Calls 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.
816 887
817=item $uint = $device->max_samplers 888=item $uint = $device->max_samplers
818 889
819Calls 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.
820 891
821=item $uint = $device->mem_base_addr_align 892=item $uint = $device->mem_base_addr_align
822 893
823Calls 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.
824 895
825=item $uint = $device->min_data_type_align_size 896=item $uint = $device->min_data_type_align_size
826 897
827Calls 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.
828 899
829=item $device_fp_config = $device->single_fp_config 900=item $device_fp_config = $device->single_fp_config
830 901
831Calls 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.
832 903
833=item $device_mem_cache_type = $device->global_mem_cache_type 904=item $device_mem_cache_type = $device->global_mem_cache_type
834 905
835Calls 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.
836 907
837=item $uint = $device->global_mem_cacheline_size 908=item $uint = $device->global_mem_cacheline_size
838 909
839Calls 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.
840 911
841=item $ulong = $device->global_mem_cache_size 912=item $ulong = $device->global_mem_cache_size
842 913
843Calls 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.
844 915
845=item $ulong = $device->global_mem_size 916=item $ulong = $device->global_mem_size
846 917
847Calls 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.
848 919
849=item $ulong = $device->max_constant_buffer_size 920=item $ulong = $device->max_constant_buffer_size
850 921
851Calls 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.
852 923
853=item $uint = $device->max_constant_args 924=item $uint = $device->max_constant_args
854 925
855Calls 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.
856 927
857=item $device_local_mem_type = $device->local_mem_type 928=item $device_local_mem_type = $device->local_mem_type
858 929
859Calls 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.
860 931
861=item $ulong = $device->local_mem_size 932=item $ulong = $device->local_mem_size
862 933
863Calls 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.
864 935
865=item $boolean = $device->error_correction_support 936=item $boolean = $device->error_correction_support
866 937
867Calls 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.
868 939
869=item $int = $device->profiling_timer_resolution 940=item $int = $device->profiling_timer_resolution
870 941
871Calls 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.
872 943
873=item $boolean = $device->endian_little 944=item $boolean = $device->endian_little
874 945
875Calls 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.
876 947
877=item $boolean = $device->available 948=item $boolean = $device->available
878 949
879Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 950Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
880 951
881=item $boolean = $device->compiler_available 952=item $boolean = $device->compiler_available
882 953
883Calls 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.
884 955
885=item $device_exec_capabilities = $device->execution_capabilities 956=item $device_exec_capabilities = $device->execution_capabilities
886 957
887Calls 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.
888 959
889=item $command_queue_properties = $device->properties 960=item $command_queue_properties = $device->properties
890 961
891Calls 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.
892 963
893=item $ = $device->platform 964=item $ = $device->platform
894 965
895Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 966Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
896 967
897=item $string = $device->name 968=item $string = $device->name
898 969
899Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 970Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
900 971
901=item $string = $device->vendor 972=item $string = $device->vendor
902 973
903Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 974Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
904 975
905=item $string = $device->driver_version 976=item $string = $device->driver_version
906 977
907Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 978Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
908 979
909=item $string = $device->profile 980=item $string = $device->profile
910 981
911Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 982Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
912 983
913=item $string = $device->version 984=item $string = $device->version
914 985
915Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 986Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
916 987
917=item $string = $device->extensions 988=item $string = $device->extensions
918 989
919Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 990Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
920 991
921=item $uint = $device->preferred_vector_width_half 992=item $uint = $device->preferred_vector_width_half
922 993
923Calls 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.
924 995
925=item $uint = $device->native_vector_width_char 996=item $uint = $device->native_vector_width_char
926 997
927Calls 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.
928 999
929=item $uint = $device->native_vector_width_short 1000=item $uint = $device->native_vector_width_short
930 1001
931Calls 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.
932 1003
933=item $uint = $device->native_vector_width_int 1004=item $uint = $device->native_vector_width_int
934 1005
935Calls 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.
936 1007
937=item $uint = $device->native_vector_width_long 1008=item $uint = $device->native_vector_width_long
938 1009
939Calls 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.
940 1011
941=item $uint = $device->native_vector_width_float 1012=item $uint = $device->native_vector_width_float
942 1013
943Calls 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.
944 1015
945=item $uint = $device->native_vector_width_double 1016=item $uint = $device->native_vector_width_double
946 1017
947Calls 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.
948 1019
949=item $uint = $device->native_vector_width_half 1020=item $uint = $device->native_vector_width_half
950 1021
951Calls 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.
952 1023
953=item $device_fp_config = $device->double_fp_config 1024=item $device_fp_config = $device->double_fp_config
954 1025
955Calls 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.
956 1027
957=item $device_fp_config = $device->half_fp_config 1028=item $device_fp_config = $device->half_fp_config
958 1029
959Calls 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.
960 1031
961=item $boolean = $device->host_unified_memory 1032=item $boolean = $device->host_unified_memory
962 1033
963Calls 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.
964 1035
965=item $device = $device->parent_device_ext 1036=item $device = $device->parent_device_ext
966 1037
967Calls 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.
968 1039
969=item @device_partition_property_exts = $device->partition_types_ext 1040=item @device_partition_property_exts = $device->partition_types_ext
970 1041
971Calls 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.
972 1043
973=item @device_partition_property_exts = $device->affinity_domains_ext 1044=item @device_partition_property_exts = $device->affinity_domains_ext
974 1045
975Calls 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.
976 1047
977=item $uint = $device->reference_count_ext 1048=item $uint = $device->reference_count_ext
978 1049
979Calls 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.
980 1051
981=item @device_partition_property_exts = $device->partition_style_ext 1052=item @device_partition_property_exts = $device->partition_style_ext
982 1053
983Calls 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.
984 1055
985=for gengetinfo end device 1056=for gengetinfo end device
986 1057
987=back 1058=back
988 1059
989=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
990 1087
991=over 4 1088=over 4
992 1089
993=item $prog = $ctx->build_program ($program, $options = "") 1090=item $prog = $ctx->build_program ($program, $options = "")
994 1091
… …
1003=cut 1100=cut
1004 1101
1005sub OpenCL::Context::build_program { 1102sub OpenCL::Context::build_program {
1006 my ($self, $prog, $options) = @_; 1103 my ($self, $prog, $options) = @_;
1007 1104
1008 require Carp;
1009
1010 $prog = $self->program_with_source ($prog) 1105 $prog = $self->program_with_source ($prog)
1011 unless ref $prog; 1106 unless ref $prog;
1012 1107
1013 eval { $prog->build (undef, $options); 1 } 1108 eval { $prog->build (undef, $options); 1 }
1014 or errno == BUILD_PROGRAM_FAILURE 1109 or errno == BUILD_PROGRAM_FAILURE
1110 or errno == INVALID_BINARY # workaround nvidia bug
1015 or Carp::croak "OpenCL::Context->build_program: " . err2str; 1111 or Carp::croak "OpenCL::Context->build_program: " . err2str;
1016 1112
1017 # we check status for all devices 1113 # we check status for all devices
1018 for my $dev ($self->devices) { 1114 for my $dev ($self->devices) {
1019 $prog->build_status ($dev) == BUILD_SUCCESS 1115 $prog->build_status ($dev) == BUILD_SUCCESS
1020 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"
1021 . $prog->build_log ($dev)); 1117 . $prog->build_log ($dev);
1022 } 1118 }
1023 1119
1024 $prog 1120 $prog
1025} 1121}
1026 1122
… …
1043=item $buf = $ctx->buffer ($flags, $len) 1139=item $buf = $ctx->buffer ($flags, $len)
1044 1140
1045Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1141Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1046given flags and octet-size. 1142given flags and octet-size.
1047 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
1048L<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>
1049 1149
1050=item $buf = $ctx->buffer_sv ($flags, $data) 1150=item $buf = $ctx->buffer_sv ($flags, $data)
1051 1151
1052Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1152Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
… …
1055=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) 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)
1056 1156
1057Creates a new OpenCL::Image object and optionally initialises it with 1157Creates a new OpenCL::Image object and optionally initialises it with
1058the given data values. 1158the given data values.
1059 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
1060L<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>
1061 1177
1062=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)
1063 1179
1064Creates a new OpenCL::Image2D object and optionally initialises it with 1180Creates a new OpenCL::Image2D object and optionally initialises it with
… …
1076=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1192=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1077 1193
1078Creates 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
1079OpenGL buffer object. 1195OpenGL buffer object.
1080 1196
1197flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1198
1081http://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
1082 1200
1083=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1201=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1084 1202
1085Creates a new OpenCL::Image object that refers to the given OpenGL 1203Creates a new OpenCL::Image object that refers to the given OpenGL
1086texture object or buffer. 1204texture object or buffer.
1087 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
1088http://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
1089 1214
1090=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1215=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1091 1216
1092Creates a new OpenCL::Image2D object that refers to the given OpenGL 1217Creates a new OpenCL::Image2D object that refers to the given OpenGL
… …
1117 1242
1118=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1243=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1119 1244
1120Creates a new OpenCL::Sampler object. 1245Creates a new OpenCL::Sampler object.
1121 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
1122L<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>
1123 1253
1124=item $program = $ctx->program_with_source ($string) 1254=item $program = $ctx->program_with_source ($string)
1125 1255
1126Creates a new OpenCL::Program object from the given source code. 1256Creates a new OpenCL::Program object from the given source code.
1127 1257
1128L<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>
1129 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
1130=item $packed_value = $ctx->info ($name) 1284=item $packed_value = $ctx->info ($name)
1131 1285
1132See C<< $platform->info >> for details. 1286See C<< $platform->info >> for details.
1133 1287
1134L<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>
1135 1289
1136=for gengetinfo begin context 1290=for gengetinfo begin context
1137 1291
1138=item $uint = $context->reference_count 1292=item $uint = $context->reference_count
1139 1293
1140Calls 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.
1141 1295
1142=item @devices = $context->devices 1296=item @devices = $context->devices
1143 1297
1144Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1298Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1145 1299
1146=item @property_ints = $context->properties 1300=item @property_ints = $context->properties
1147 1301
1148Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1302Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1149 1303
1150=item $uint = $context->num_devices 1304=item $uint = $context->num_devices
1151 1305
1152Calls 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.
1153 1307
1154=for gengetinfo end context 1308=for gengetinfo end context
1155 1309
1156=back 1310=back
1157 1311
… …
1204 1358
1205=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...) 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...)
1206 1360
1207http://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
1208 1362
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
1209=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1367=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1210 1368
1211L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> 1369C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1212 1370module uses the image width (and height) to supply default values.
1213=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1214 1371
1215L<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>
1216 1373
1217=item $ev = $queue->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...)
1218 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.
1219L<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>
1220 1379
1221=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...) 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...)
1222 1381
1223L<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>
… …
1268reference 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
1269elements as \@global_work_size. 1428elements as \@global_work_size.
1270 1429
1271L<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>
1272 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
1273=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1440=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1274 1441
1275Enqueues 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
1276for subsequent OpenCL usage. 1443for subsequent OpenCL usage.
1277 1444
… …
1312 1479
1313=for gengetinfo begin command_queue 1480=for gengetinfo begin command_queue
1314 1481
1315=item $ctx = $command_queue->context 1482=item $ctx = $command_queue->context
1316 1483
1317Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1484Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1318 1485
1319=item $device = $command_queue->device 1486=item $device = $command_queue->device
1320 1487
1321Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1488Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1322 1489
1323=item $uint = $command_queue->reference_count 1490=item $uint = $command_queue->reference_count
1324 1491
1325Calls 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.
1326 1493
1327=item $command_queue_properties = $command_queue->properties 1494=item $command_queue_properties = $command_queue->properties
1328 1495
1329Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1496Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1330 1497
1331=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.
1332 1568
1333=back 1569=back
1334 1570
1335=head2 THE OpenCL::Memory CLASS 1571=head2 THE OpenCL::Memory CLASS
1336 1572
… …
1347 1583
1348=for gengetinfo begin mem 1584=for gengetinfo begin mem
1349 1585
1350=item $mem_object_type = $mem->type 1586=item $mem_object_type = $mem->type
1351 1587
1352Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1588Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1353 1589
1354=item $mem_flags = $mem->flags 1590=item $mem_flags = $mem->flags
1355 1591
1356Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1592Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1357 1593
1358=item $int = $mem->size 1594=item $int = $mem->size
1359 1595
1360Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1596Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1361 1597
1362=item $ptr_value = $mem->host_ptr 1598=item $ptr_value = $mem->host_ptr
1363 1599
1364Calls 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.
1365 1601
1366=item $uint = $mem->map_count 1602=item $uint = $mem->map_count
1367 1603
1368Calls 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.
1369 1605
1370=item $uint = $mem->reference_count 1606=item $uint = $mem->reference_count
1371 1607
1372Calls 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.
1373 1609
1374=item $ctx = $mem->context 1610=item $ctx = $mem->context
1375 1611
1376Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1612Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1377 1613
1378=item $mem = $mem->associated_memobject 1614=item $mem = $mem->associated_memobject
1379 1615
1380Calls 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.
1381 1617
1382=item $int = $mem->offset 1618=item $int = $mem->offset
1383 1619
1384Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1620Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1385 1621
1386=for gengetinfo end mem 1622=for gengetinfo end mem
1387 1623
1388=item ($type, $name) = $mem->gl_object_info 1624=item ($type, $name) = $mem->gl_object_info
1389 1625
… …
1441 1677
1442=for gengetinfo begin image 1678=for gengetinfo begin image
1443 1679
1444=item $int = $image->element_size 1680=item $int = $image->element_size
1445 1681
1446Calls 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.
1447 1683
1448=item $int = $image->row_pitch 1684=item $int = $image->row_pitch
1449 1685
1450Calls 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.
1451 1687
1452=item $int = $image->slice_pitch 1688=item $int = $image->slice_pitch
1453 1689
1454Calls 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.
1455 1691
1456=item $int = $image->width 1692=item $int = $image->width
1457 1693
1458Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1694Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1459 1695
1460=item $int = $image->height 1696=item $int = $image->height
1461 1697
1462Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1698Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1463 1699
1464=item $int = $image->depth 1700=item $int = $image->depth
1465 1701
1466Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1702Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1467 1703
1468=for gengetinfo end image 1704=for gengetinfo end image
1469 1705
1470=for gengetinfo begin gl_texture 1706=for gengetinfo begin gl_texture
1471 1707
1472=item $GLenum = $gl_texture->target 1708=item $GLenum = $gl_texture->target
1473 1709
1474Calls 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.
1475 1711
1476=item $GLint = $gl_texture->gl_mipmap_level 1712=item $GLint = $gl_texture->gl_mipmap_level
1477 1713
1478Calls 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.
1479 1715
1480=for gengetinfo end gl_texture 1716=for gengetinfo end gl_texture
1481 1717
1482=back 1718=back
1483 1719
… …
1493 1729
1494=for gengetinfo begin sampler 1730=for gengetinfo begin sampler
1495 1731
1496=item $uint = $sampler->reference_count 1732=item $uint = $sampler->reference_count
1497 1733
1498Calls 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.
1499 1735
1500=item $ctx = $sampler->context 1736=item $ctx = $sampler->context
1501 1737
1502Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1738Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1503 1739
1504=item $addressing_mode = $sampler->normalized_coords 1740=item $addressing_mode = $sampler->normalized_coords
1505 1741
1506Calls 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.
1507 1743
1508=item $filter_mode = $sampler->addressing_mode 1744=item $filter_mode = $sampler->addressing_mode
1509 1745
1510Calls 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.
1511 1747
1512=item $boolean = $sampler->filter_mode 1748=item $boolean = $sampler->filter_mode
1513 1749
1514Calls 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.
1515 1751
1516=for gengetinfo end sampler 1752=for gengetinfo end sampler
1517 1753
1518=back 1754=back
1519 1755
… …
1529If 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
1530finished. Note that many OpenCL implementations block your program while 1766finished. Note that many OpenCL implementations block your program while
1531compiling 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
1532want to make sure the build is done in the background. 1768want to make sure the build is done in the background.
1533 1769
1534Note 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
1535callback in some error cases (but call it in others). This implementation 1771callback in some error cases (but call it in others). This implementation
1536assumes 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
1537not 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.
1538 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
1539L<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>
1540 1790
1541=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1791=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1542 1792
1543Similar 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
1544need to check the compilation status form the callback, or by polling). 1794need to check the compilation status form the callback, or by polling).
1545 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
1546=item $packed_value = $program->build_info ($device, $name) 1804=item $packed_value = $program->build_info ($device, $name)
1547 1805
1548Similar to C<< $platform->info >>, but returns build info for a previous 1806Similar to C<< $platform->info >>, but returns build info for a previous
1549build attempt for the given device. 1807build attempt for the given device.
1550 1808
… …
1565 1823
1566=for gengetinfo begin program_build 1824=for gengetinfo begin program_build
1567 1825
1568=item $build_status = $program->build_status ($device) 1826=item $build_status = $program->build_status ($device)
1569 1827
1570Calls 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.
1571 1829
1572=item $string = $program->build_options ($device) 1830=item $string = $program->build_options ($device)
1573 1831
1574Calls 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.
1575 1833
1576=item $string = $program->build_log ($device) 1834=item $string = $program->build_log ($device)
1577 1835
1578Calls 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.
1579 1837
1580=for gengetinfo end program_build 1838=for gengetinfo end program_build
1581 1839
1582=item $packed_value = $program->info ($name) 1840=item $packed_value = $program->info ($name)
1583 1841
… …
1587 1845
1588=for gengetinfo begin program 1846=for gengetinfo begin program
1589 1847
1590=item $uint = $program->reference_count 1848=item $uint = $program->reference_count
1591 1849
1592Calls 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.
1593 1851
1594=item $ctx = $program->context 1852=item $ctx = $program->context
1595 1853
1596Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1854Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1597 1855
1598=item $uint = $program->num_devices 1856=item $uint = $program->num_devices
1599 1857
1600Calls 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.
1601 1859
1602=item @devices = $program->devices 1860=item @devices = $program->devices
1603 1861
1604Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1862Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1605 1863
1606=item $string = $program->source 1864=item $string = $program->source
1607 1865
1608Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1866Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1609 1867
1610=item @ints = $program->binary_sizes 1868=item @ints = $program->binary_sizes
1611 1869
1612Calls 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.
1613 1871
1614=for gengetinfo end program 1872=for gengetinfo end program
1615 1873
1616=item @blobs = $program->binaries 1874=item @blobs = $program->binaries
1617 1875
… …
1638 1896
1639=for gengetinfo begin kernel 1897=for gengetinfo begin kernel
1640 1898
1641=item $string = $kernel->function_name 1899=item $string = $kernel->function_name
1642 1900
1643Calls 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.
1644 1902
1645=item $uint = $kernel->num_args 1903=item $uint = $kernel->num_args
1646 1904
1647Calls 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.
1648 1906
1649=item $uint = $kernel->reference_count 1907=item $uint = $kernel->reference_count
1650 1908
1651Calls 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.
1652 1910
1653=item $ctx = $kernel->context 1911=item $ctx = $kernel->context
1654 1912
1655Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1913Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1656 1914
1657=item $program = $kernel->program 1915=item $program = $kernel->program
1658 1916
1659Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1917Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1660 1918
1661=for gengetinfo end kernel 1919=for gengetinfo end kernel
1662 1920
1663=item $packed_value = $kernel->work_group_info ($device, $name) 1921=item $packed_value = $kernel->work_group_info ($device, $name)
1664 1922
1665See C<< $platform->info >> for details. 1923See C<< $platform->info >> for details.
1666 1924
1667The reason this method is not called C<info> is that there already is an
1668C<< ->info >> method.
1669
1670L<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>
1671 1926
1672=for gengetinfo begin kernel_work_group 1927=for gengetinfo begin kernel_work_group
1673 1928
1674=item $int = $kernel->work_group_size ($device) 1929=item $int = $kernel->work_group_size ($device)
1675 1930
1676Calls 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.
1677 1932
1678=item @ints = $kernel->compile_work_group_size ($device) 1933=item @ints = $kernel->compile_work_group_size ($device)
1679 1934
1680Calls 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.
1681 1936
1682=item $ulong = $kernel->local_mem_size ($device) 1937=item $ulong = $kernel->local_mem_size ($device)
1683 1938
1684Calls 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.
1685 1940
1686=item $int = $kernel->preferred_work_group_size_multiple ($device) 1941=item $int = $kernel->preferred_work_group_size_multiple ($device)
1687 1942
1688Calls 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.
1689 1944
1690=item $ulong = $kernel->private_mem_size ($device) 1945=item $ulong = $kernel->private_mem_size ($device)
1691 1946
1692Calls 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.
1693 1948
1694=for gengetinfo end kernel_work_group 1949=for gengetinfo end kernel_work_group
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
1695 1980
1696=item $kernel->setf ($format, ...) 1981=item $kernel->setf ($format, ...)
1697 1982
1698Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic 1983Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1699way to set arguments (and with OpenCL 1.2 it might be rather slow), you 1984way to set arguments (and with OpenCL 1.2 it might be rather slow), you
… …
1811 2096
1812=for gengetinfo begin event 2097=for gengetinfo begin event
1813 2098
1814=item $queue = $event->command_queue 2099=item $queue = $event->command_queue
1815 2100
1816Calls 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.
1817 2102
1818=item $command_type = $event->command_type 2103=item $command_type = $event->command_type
1819 2104
1820Calls 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.
1821 2106
1822=item $uint = $event->reference_count 2107=item $uint = $event->reference_count
1823 2108
1824Calls 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.
1825 2110
1826=item $uint = $event->command_execution_status 2111=item $uint = $event->command_execution_status
1827 2112
1828Calls 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.
1829 2114
1830=item $ctx = $event->context 2115=item $ctx = $event->context
1831 2116
1832Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2117Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1833 2118
1834=for gengetinfo end event 2119=for gengetinfo end event
1835 2120
1836=item $packed_value = $ev->profiling_info ($name) 2121=item $packed_value = $ev->profiling_info ($name)
1837 2122
… …
1844 2129
1845=for gengetinfo begin profiling 2130=for gengetinfo begin profiling
1846 2131
1847=item $ulong = $event->profiling_command_queued 2132=item $ulong = $event->profiling_command_queued
1848 2133
1849Calls 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.
1850 2135
1851=item $ulong = $event->profiling_command_submit 2136=item $ulong = $event->profiling_command_submit
1852 2137
1853Calls 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.
1854 2139
1855=item $ulong = $event->profiling_command_start 2140=item $ulong = $event->profiling_command_start
1856 2141
1857Calls 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.
1858 2143
1859=item $ulong = $event->profiling_command_end 2144=item $ulong = $event->profiling_command_end
1860 2145
1861Calls 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.
1862 2147
1863=for gengetinfo end profiling 2148=for gengetinfo end profiling
1864 2149
1865=back 2150=back
1866 2151
… …
1873=item $ev->set_status ($execution_status) 2158=item $ev->set_status ($execution_status)
1874 2159
1875Sets 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,
1876either with OpenCL::COMPLETE or a negative number as status. 2161either with OpenCL::COMPLETE or a negative number as status.
1877 2162
2163execution_status: OpenCL::COMPLETE or a negative integer.
2164
1878L<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>
1879 2166
1880=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
1881 2269
1882=cut 2270=cut
1883 2271
18841; 22721;
1885 2273

Diff Legend

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