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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.65 by root, Mon Apr 30 23:35:16 2012 UTC vs.
Revision 1.78 by root, Sat May 5 13:07:19 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
… …
95initialised at creation time). 96initialised at creation time).
96 97
97Enqueue the kernel execution. 98Enqueue the kernel execution.
98 99
99Enqueue buffer reads for your output buffer to read results. 100Enqueue buffer reads for your output buffer to read results.
101
102=head1 OPENCL 1.1 VS. OPENCL 1.2
103
104This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
1051.2 interface hasn't been tested much for lack of availability of an
106actual implementation.
107
108Every function or method in this manual page that interfaces to a
109particular OpenCL function has a link to the its C manual page.
110
111If the link contains a F<1.1>, then this function is an OpenCL 1.1
112function. Most but not all also exist in OpenCL 1.2, and this module
113tries to emulate the missing ones for you, when told to do so at
114compiletime. You cna check whether a function was removed in OpenCL 1.2 by
115replacing the F<1.1> component in the URL by F<1.2>.
116
117If the link contains a F<1.2>, then this is a OpenCL 1.2-only
118function. Even if the module was compiled with OpenCL 1.2 header files
119and has an 1.2 OpenCL library, calling such a function on a platform that
120doesn't implement 1.2 causes undefined behaviour, usually a crash (But
121this is not guaranteed).
122
123You can find out whether this module was compiled to prefer 1.1
124functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
1251.1 functions generally are implemented using 1.1 OpenCL functions. If it
126is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
127fucntions.
128
129This is a somewhat sorry state of affairs, but the Khronos group choose to
130make every release of OpenCL source and binary incompatible with previous
131releases.
100 132
101=head1 EXAMPLES 133=head1 EXAMPLES
102 134
103=head2 Enumerate all devices and get contexts for them. 135=head2 Enumerate all devices and get contexts for them.
104 136
… …
210 242
211 # wait for the last event to complete 243 # wait for the last event to complete
212 $ev->wait; 244 $ev->wait;
213 245
214=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia 246=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215set tunnel effect. 247set flight effect.
216 248
217This is quite a long example to get you going - you can download it from 249This is quite a long example to get you going - you can download it from
218L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>. 250L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
219 251
220 use OpenGL ":all"; 252 use OpenGL ":all";
… …
305 glXSwapBuffers; 337 glXSwapBuffers;
306 338
307 select undef, undef, undef, 1/60; 339 select undef, undef, undef, 1/60;
308 } 340 }
309 341
310=item How to modify the previous example to not rely on GL sharing. 342=head2 How to modify the previous example to not rely on GL sharing.
311 343
312For those poor souls with only a sucky CPU OpenCL implementation, you 344For those poor souls with only a sucky CPU OpenCL implementation, you
313currently have to read the image into some perl scalar, and then modify a 345currently have to read the image into some perl scalar, and then modify a
314texture or use glDrawPixels or so). 346texture or use glDrawPixels or so).
315 347
… …
320To use a texture, you would modify the above example by creating an 352To use a texture, you would modify the above example by creating an
321OpenCL::Image manually instead of deriving it from a texture: 353OpenCL::Image manually instead of deriving it from a texture:
322 354
323 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S); 355 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
324 356
325And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you 357And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
326would read the image2d after the kernel has written it: 358would read the image2d after the kernel has written it:
327 359
328 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data); 360 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
329 361
330And then you would upload the pixel data to the texture (or use glDrawPixels): 362And then you would upload the pixel data to the texture (or use glDrawPixels):
331 363
332 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data; 364 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
333 365
334The fully modified example can be found at 366The fully modified example can be found at
335L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>. 367L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
368
369=head2 Julia sets look soooo 80ies.
370
371Then colour them differently, e.g. using orbit traps! Replace the loop and
372colour calculation from the previous examples by this:
373
374 float2 dm = (float2)(1.f, 1.f);
375
376 for (int i = 0; i < 25; ++i)
377 {
378 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
379 dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
380 }
381
382 float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
383
384Also try C<-10.f> instead of C<-1.f>.
336 385
337=head1 DOCUMENTATION 386=head1 DOCUMENTATION
338 387
339=head2 BASIC CONVENTIONS 388=head2 BASIC CONVENTIONS
340 389
… …
416OpenCL can generate a number of (potentially) asynchronous events, for 465OpenCL can generate a number of (potentially) asynchronous events, for
417example, after compiling a program, to signal a context-related error or, 466example, after compiling a program, to signal a context-related error or,
418perhaps most important, to signal completion of queued jobs (by setting 467perhaps most important, to signal completion of queued jobs (by setting
419callbacks on OpenCL::Event objects). 468callbacks on OpenCL::Event objects).
420 469
470The OpenCL module converts all these callbacks into events - you can
471still register callbacks, but they are not executed when your OpenCL
472implementation calls the actual callback, but only later. Therefore, none
473of the limitations of OpenCL callbacks apply to the perl implementation:
474it is perfectly safe to make blocking operations from event callbacks, and
475enqueued operations don't need to be flushed.
476
421To facilitate this, this module maintains an event queue - each 477To facilitate this, this module maintains an event queue - each
422time an asynchronous event happens, it is queued, and perl will be 478time an asynchronous event happens, it is queued, and perl will be
423interrupted. This is implemented via the L<Async::Interrupt> module. In 479interrupted. This is implemented via the L<Async::Interrupt> module. In
424addition, this module has L<AnyEvent> support, so it can seamlessly 480addition, this module has L<AnyEvent> support, so it can seamlessly
425integrate itself into many event loops. 481integrate itself into many event loops.
426 482
427Since this module is a bit hard to understand, here are some case examples: 483Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
428 484
429=head3 Don't use callbacks. 485=head3 Don't use callbacks.
430 486
431When your program never uses any callbacks, then there will never be any 487When your program never uses any callbacks, then there will never be any
432notifications you need to take care of, and therefore no need to worry 488notifications you need to take care of, and therefore no need to worry
… …
529use Async::Interrupt (); 585use Async::Interrupt ();
530 586
531our $POLL_FUNC; # set by XS 587our $POLL_FUNC; # set by XS
532 588
533BEGIN { 589BEGIN {
534 our $VERSION = '0.98'; 590 our $VERSION = '0.99';
535 591
536 require XSLoader; 592 require XSLoader;
537 XSLoader::load (__PACKAGE__, $VERSION); 593 XSLoader::load (__PACKAGE__, $VERSION);
538 594
539 @OpenCL::Platform::ISA = 595 @OpenCL::Platform::ISA =
… …
544 @OpenCL::Sampler::ISA = 600 @OpenCL::Sampler::ISA =
545 @OpenCL::Program::ISA = 601 @OpenCL::Program::ISA =
546 @OpenCL::Kernel::ISA = 602 @OpenCL::Kernel::ISA =
547 @OpenCL::Event::ISA = OpenCL::Object::; 603 @OpenCL::Event::ISA = OpenCL::Object::;
548 604
605 @OpenCL::SubDevice::ISA = OpenCL::Device::;
606
549 @OpenCL::Buffer::ISA = 607 @OpenCL::Buffer::ISA =
550 @OpenCL::Image::ISA = OpenCL::Memory::; 608 @OpenCL::Image::ISA = OpenCL::Memory::;
551 609
552 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 610 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
553 611
… …
557 @OpenCL::Image1D::ISA = 615 @OpenCL::Image1D::ISA =
558 @OpenCL::Image1DArray::ISA = 616 @OpenCL::Image1DArray::ISA =
559 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; 617 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
560 618
561 @OpenCL::UserEvent::ISA = OpenCL::Event::; 619 @OpenCL::UserEvent::ISA = OpenCL::Event::;
620
621 @OpenCL::MappedBuffer::ISA =
622 @OpenCL::MappedImage::ISA = OpenCL::Mapped::;
562} 623}
563 624
564=head2 THE OpenCL PACKAGE 625=head2 THE OpenCL PACKAGE
565 626
566=over 4 627=over 4
… …
590L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 651L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
591 652
592=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr 653=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
593 654
594Tries to create a context from a default device and platform type - never worked for me. 655Tries to create a context from a default device and platform type - never worked for me.
656Consider using C<< $platform->context_from_type >> instead.
657
658type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
659OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
595 660
596L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 661L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
597 662
598=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 663=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
599 664
600Create a new OpenCL::Context object using the given device object(s). This 665Create a new OpenCL::Context object using the given device object(s).
601function isn't implemented yet, use C<< $platform->context >> instead. 666Consider using C<< $platform->context >> instead.
602 667
603L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 668L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
604 669
605=item OpenCL::wait_for_events $wait_events... 670=item OpenCL::wait_for_events $wait_events...
606 671
… …
713 778
714=for gengetinfo begin platform 779=for gengetinfo begin platform
715 780
716=item $string = $platform->profile 781=item $string = $platform->profile
717 782
718Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 783Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
719 784
720=item $string = $platform->version 785=item $string = $platform->version
721 786
722Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 787Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
723 788
724=item $string = $platform->name 789=item $string = $platform->name
725 790
726Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 791Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
727 792
728=item $string = $platform->vendor 793=item $string = $platform->vendor
729 794
730Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 795Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
731 796
732=item $string = $platform->extensions 797=item $string = $platform->extensions
733 798
734Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 799Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
735 800
736=for gengetinfo end platform 801=for gengetinfo end platform
737 802
738=back 803=back
739 804
… …
743 808
744=item $packed_value = $device->info ($name) 809=item $packed_value = $device->info ($name)
745 810
746See C<< $platform->info >> for details. 811See C<< $platform->info >> for details.
747 812
813type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
814OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
815OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
816
817fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
818OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
819OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
820
821mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
822
823local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
824
825exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
826
827command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
828OpenCL::QUEUE_PROFILING_ENABLE.
829
830partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
831OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
832OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
833
834affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
835OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
836OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
837OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
838
748L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 839L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
749 840
841=item @devices = $device->sub_devices (\@properties)
842
843Creates OpencL::SubDevice objects by partitioning an existing device.
844
845L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
846
750=for gengetinfo begin device 847=for gengetinfo begin device
751 848
752=item $device_type = $device->type 849=item $device_type = $device->type
753 850
754Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 851Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
755 852
756=item $uint = $device->vendor_id 853=item $uint = $device->vendor_id
757 854
758Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. 855Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
759 856
760=item $uint = $device->max_compute_units 857=item $uint = $device->max_compute_units
761 858
762Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. 859Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
763 860
764=item $uint = $device->max_work_item_dimensions 861=item $uint = $device->max_work_item_dimensions
765 862
766Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. 863Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
767 864
768=item $int = $device->max_work_group_size 865=item $int = $device->max_work_group_size
769 866
770Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. 867Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
771 868
772=item @ints = $device->max_work_item_sizes 869=item @ints = $device->max_work_item_sizes
773 870
774Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. 871Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
775 872
776=item $uint = $device->preferred_vector_width_char 873=item $uint = $device->preferred_vector_width_char
777 874
778Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. 875Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
779 876
780=item $uint = $device->preferred_vector_width_short 877=item $uint = $device->preferred_vector_width_short
781 878
782Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. 879Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
783 880
784=item $uint = $device->preferred_vector_width_int 881=item $uint = $device->preferred_vector_width_int
785 882
786Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. 883Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
787 884
788=item $uint = $device->preferred_vector_width_long 885=item $uint = $device->preferred_vector_width_long
789 886
790Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. 887Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
791 888
792=item $uint = $device->preferred_vector_width_float 889=item $uint = $device->preferred_vector_width_float
793 890
794Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. 891Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
795 892
796=item $uint = $device->preferred_vector_width_double 893=item $uint = $device->preferred_vector_width_double
797 894
798Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. 895Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
799 896
800=item $uint = $device->max_clock_frequency 897=item $uint = $device->max_clock_frequency
801 898
802Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. 899Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
803 900
804=item $bitfield = $device->address_bits 901=item $bitfield = $device->address_bits
805 902
806Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. 903Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
807 904
808=item $uint = $device->max_read_image_args 905=item $uint = $device->max_read_image_args
809 906
810Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. 907Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
811 908
812=item $uint = $device->max_write_image_args 909=item $uint = $device->max_write_image_args
813 910
814Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. 911Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
815 912
816=item $ulong = $device->max_mem_alloc_size 913=item $ulong = $device->max_mem_alloc_size
817 914
818Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. 915Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
819 916
820=item $int = $device->image2d_max_width 917=item $int = $device->image2d_max_width
821 918
822Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. 919Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
823 920
824=item $int = $device->image2d_max_height 921=item $int = $device->image2d_max_height
825 922
826Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. 923Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
827 924
828=item $int = $device->image3d_max_width 925=item $int = $device->image3d_max_width
829 926
830Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. 927Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
831 928
832=item $int = $device->image3d_max_height 929=item $int = $device->image3d_max_height
833 930
834Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. 931Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
835 932
836=item $int = $device->image3d_max_depth 933=item $int = $device->image3d_max_depth
837 934
838Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. 935Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
839 936
840=item $uint = $device->image_support 937=item $uint = $device->image_support
841 938
842Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. 939Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
843 940
844=item $int = $device->max_parameter_size 941=item $int = $device->max_parameter_size
845 942
846Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. 943Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
847 944
848=item $uint = $device->max_samplers 945=item $uint = $device->max_samplers
849 946
850Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. 947Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
851 948
852=item $uint = $device->mem_base_addr_align 949=item $uint = $device->mem_base_addr_align
853 950
854Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. 951Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
855 952
856=item $uint = $device->min_data_type_align_size 953=item $uint = $device->min_data_type_align_size
857 954
858Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. 955Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
859 956
860=item $device_fp_config = $device->single_fp_config 957=item $device_fp_config = $device->single_fp_config
861 958
862Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. 959Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
863 960
864=item $device_mem_cache_type = $device->global_mem_cache_type 961=item $device_mem_cache_type = $device->global_mem_cache_type
865 962
866Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. 963Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
867 964
868=item $uint = $device->global_mem_cacheline_size 965=item $uint = $device->global_mem_cacheline_size
869 966
870Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. 967Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
871 968
872=item $ulong = $device->global_mem_cache_size 969=item $ulong = $device->global_mem_cache_size
873 970
874Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. 971Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
875 972
876=item $ulong = $device->global_mem_size 973=item $ulong = $device->global_mem_size
877 974
878Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. 975Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
879 976
880=item $ulong = $device->max_constant_buffer_size 977=item $ulong = $device->max_constant_buffer_size
881 978
882Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. 979Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
883 980
884=item $uint = $device->max_constant_args 981=item $uint = $device->max_constant_args
885 982
886Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. 983Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
887 984
888=item $device_local_mem_type = $device->local_mem_type 985=item $device_local_mem_type = $device->local_mem_type
889 986
890Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. 987Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
891 988
892=item $ulong = $device->local_mem_size 989=item $ulong = $device->local_mem_size
893 990
894Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. 991Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
895 992
896=item $boolean = $device->error_correction_support 993=item $boolean = $device->error_correction_support
897 994
898Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. 995Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
899 996
900=item $int = $device->profiling_timer_resolution 997=item $int = $device->profiling_timer_resolution
901 998
902Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. 999Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
903 1000
904=item $boolean = $device->endian_little 1001=item $boolean = $device->endian_little
905 1002
906Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. 1003Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
907 1004
908=item $boolean = $device->available 1005=item $boolean = $device->available
909 1006
910Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 1007Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
911 1008
912=item $boolean = $device->compiler_available 1009=item $boolean = $device->compiler_available
913 1010
914Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. 1011Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
915 1012
916=item $device_exec_capabilities = $device->execution_capabilities 1013=item $device_exec_capabilities = $device->execution_capabilities
917 1014
918Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. 1015Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
919 1016
920=item $command_queue_properties = $device->properties 1017=item $command_queue_properties = $device->properties
921 1018
922Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. 1019Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
923 1020
924=item $ = $device->platform 1021=item $ = $device->platform
925 1022
926Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 1023Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
927 1024
928=item $string = $device->name 1025=item $string = $device->name
929 1026
930Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 1027Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
931 1028
932=item $string = $device->vendor 1029=item $string = $device->vendor
933 1030
934Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 1031Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
935 1032
936=item $string = $device->driver_version 1033=item $string = $device->driver_version
937 1034
938Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 1035Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
939 1036
940=item $string = $device->profile 1037=item $string = $device->profile
941 1038
942Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 1039Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
943 1040
944=item $string = $device->version 1041=item $string = $device->version
945 1042
946Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 1043Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
947 1044
948=item $string = $device->extensions 1045=item $string = $device->extensions
949 1046
950Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 1047Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
951 1048
952=item $uint = $device->preferred_vector_width_half 1049=item $uint = $device->preferred_vector_width_half
953 1050
954Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. 1051Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
955 1052
956=item $uint = $device->native_vector_width_char 1053=item $uint = $device->native_vector_width_char
957 1054
958Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. 1055Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
959 1056
960=item $uint = $device->native_vector_width_short 1057=item $uint = $device->native_vector_width_short
961 1058
962Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. 1059Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
963 1060
964=item $uint = $device->native_vector_width_int 1061=item $uint = $device->native_vector_width_int
965 1062
966Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. 1063Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
967 1064
968=item $uint = $device->native_vector_width_long 1065=item $uint = $device->native_vector_width_long
969 1066
970Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. 1067Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
971 1068
972=item $uint = $device->native_vector_width_float 1069=item $uint = $device->native_vector_width_float
973 1070
974Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. 1071Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
975 1072
976=item $uint = $device->native_vector_width_double 1073=item $uint = $device->native_vector_width_double
977 1074
978Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. 1075Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
979 1076
980=item $uint = $device->native_vector_width_half 1077=item $uint = $device->native_vector_width_half
981 1078
982Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. 1079Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
983 1080
984=item $device_fp_config = $device->double_fp_config 1081=item $device_fp_config = $device->double_fp_config
985 1082
986Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. 1083Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
987 1084
988=item $device_fp_config = $device->half_fp_config 1085=item $device_fp_config = $device->half_fp_config
989 1086
990Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. 1087Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
991 1088
992=item $boolean = $device->host_unified_memory 1089=item $boolean = $device->host_unified_memory
993 1090
994Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. 1091Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
995 1092
996=item $device = $device->parent_device_ext 1093=item $device = $device->parent_device_ext
997 1094
998Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. 1095Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
999 1096
1000=item @device_partition_property_exts = $device->partition_types_ext 1097=item @device_partition_property_exts = $device->partition_types_ext
1001 1098
1002Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. 1099Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
1003 1100
1004=item @device_partition_property_exts = $device->affinity_domains_ext 1101=item @device_partition_property_exts = $device->affinity_domains_ext
1005 1102
1006Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 1103Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
1007 1104
1008=item $uint = $device->reference_count_ext 1105=item $uint = $device->reference_count_ext
1009 1106
1010Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. 1107Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
1011 1108
1012=item @device_partition_property_exts = $device->partition_style_ext 1109=item @device_partition_property_exts = $device->partition_style_ext
1013 1110
1014Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 1111Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
1015 1112
1016=for gengetinfo end device 1113=for gengetinfo end device
1017 1114
1018=back 1115=back
1019 1116
1020=head2 THE OpenCL::Context CLASS 1117=head2 THE OpenCL::Context CLASS
1118
1119An OpenCL::Context is basically a container, or manager, for a number of
1120devices of a platform. It is used to create all sorts of secondary objects
1121such as buffers, queues, programs and so on.
1122
1123All context creation functions and methods take a list of properties
1124(type-value pairs). All property values can be specified as integers -
1125some additionally support other types:
1126
1127=over 4
1128
1129=item OpenCL::CONTEXT_PLATFORM
1130
1131Also accepts OpenCL::Platform objects.
1132
1133=item OpenCL::GLX_DISPLAY_KHR
1134
1135Also accepts C<undef>, in which case a deep and troubling hack is engaged
1136to find the current glx display (see L<GLX SUPPORT>).
1137
1138=item OpenCL::GL_CONTEXT_KHR
1139
1140Also accepts C<undef>, in which case a deep and troubling hack is engaged
1141to find the current glx context (see L<GLX SUPPORT>).
1142
1143=back
1021 1144
1022=over 4 1145=over 4
1023 1146
1024=item $prog = $ctx->build_program ($program, $options = "") 1147=item $prog = $ctx->build_program ($program, $options = "")
1025 1148
… …
1073=item $buf = $ctx->buffer ($flags, $len) 1196=item $buf = $ctx->buffer ($flags, $len)
1074 1197
1075Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1198Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1076given flags and octet-size. 1199given flags and octet-size.
1077 1200
1201flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
1202OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
1203OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
1204
1078L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1205L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1079 1206
1080=item $buf = $ctx->buffer_sv ($flags, $data) 1207=item $buf = $ctx->buffer_sv ($flags, $data)
1081 1208
1082Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1209Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
… …
1085=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) 1212=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)
1086 1213
1087Creates a new OpenCL::Image object and optionally initialises it with 1214Creates a new OpenCL::Image object and optionally initialises it with
1088the given data values. 1215the given data values.
1089 1216
1217channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
1218OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
1219OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
1220
1221channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
1222OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1223OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1224OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1225OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1226
1227type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1228OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1229OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1230OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1231
1090L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> 1232L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1091 1233
1092=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1234=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1093 1235
1094Creates a new OpenCL::Image2D object and optionally initialises it with 1236Creates a new OpenCL::Image2D object and optionally initialises it with
… …
1106=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1248=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1107 1249
1108Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 1250Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1109OpenGL buffer object. 1251OpenGL buffer object.
1110 1252
1253flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1254
1111http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 1255http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1112 1256
1113=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1257=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1114 1258
1115Creates a new OpenCL::Image object that refers to the given OpenGL 1259Creates a new OpenCL::Image object that refers to the given OpenGL
1116texture object or buffer. 1260texture object or buffer.
1117 1261
1262target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
1263GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
1264GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
1265GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
1266GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
1267GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
1268
1118http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html 1269http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1119 1270
1120=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1271=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1121 1272
1122Creates a new OpenCL::Image2D object that refers to the given OpenGL 1273Creates a new OpenCL::Image2D object that refers to the given OpenGL
… …
1147 1298
1148=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1299=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1149 1300
1150Creates a new OpenCL::Sampler object. 1301Creates a new OpenCL::Sampler object.
1151 1302
1303addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
1304OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
1305
1306filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
1307
1152L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> 1308L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1153 1309
1154=item $program = $ctx->program_with_source ($string) 1310=item $program = $ctx->program_with_source ($string)
1155 1311
1156Creates a new OpenCL::Program object from the given source code. 1312Creates a new OpenCL::Program object from the given source code.
1157 1313
1158L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 1314L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1159 1315
1316=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
1317
1318Creates a new OpenCL::Program object from the given binaries.
1319
1320L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
1321
1322Example: clone an existing program object that contains a successfully
1323compiled program, no matter how useless this is.
1324
1325 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
1326
1327=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1328
1329Creates a new OpenCL::Program object from the given built-in kernel names.
1330
1331L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1332
1333=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
1334
1335Links all (already compiled) program objects specified in C<@programs>
1336together and returns a new OpenCL::Program object with the result.
1337
1338L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
1339
1160=item $packed_value = $ctx->info ($name) 1340=item $packed_value = $ctx->info ($name)
1161 1341
1162See C<< $platform->info >> for details. 1342See C<< $platform->info >> for details.
1163 1343
1164L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 1344L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1165 1345
1166=for gengetinfo begin context 1346=for gengetinfo begin context
1167 1347
1168=item $uint = $context->reference_count 1348=item $uint = $context->reference_count
1169 1349
1170Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. 1350Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1171 1351
1172=item @devices = $context->devices 1352=item @devices = $context->devices
1173 1353
1174Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1354Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1175 1355
1176=item @property_ints = $context->properties 1356=item @property_ints = $context->properties
1177 1357
1178Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1358Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1179 1359
1180=item $uint = $context->num_devices 1360=item $uint = $context->num_devices
1181 1361
1182Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. 1362Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1183 1363
1184=for gengetinfo end context 1364=for gengetinfo end context
1185 1365
1186=back 1366=back
1187 1367
… …
1303reference to an array of local work sizes, with the same number of 1483reference to an array of local work sizes, with the same number of
1304elements as \@global_work_size. 1484elements as \@global_work_size.
1305 1485
1306L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1486L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1307 1487
1488=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
1489
1490Migrates a number of OpenCL::Memory objects to or from the device.
1491
1492flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
1493
1494L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
1495
1308=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1496=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1309 1497
1310Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1498Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1311for subsequent OpenCL usage. 1499for subsequent OpenCL usage.
1312 1500
… …
1347 1535
1348=for gengetinfo begin command_queue 1536=for gengetinfo begin command_queue
1349 1537
1350=item $ctx = $command_queue->context 1538=item $ctx = $command_queue->context
1351 1539
1352Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1540Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1353 1541
1354=item $device = $command_queue->device 1542=item $device = $command_queue->device
1355 1543
1356Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1544Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1357 1545
1358=item $uint = $command_queue->reference_count 1546=item $uint = $command_queue->reference_count
1359 1547
1360Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. 1548Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1361 1549
1362=item $command_queue_properties = $command_queue->properties 1550=item $command_queue_properties = $command_queue->properties
1363 1551
1364Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1552Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1365 1553
1366=for gengetinfo end command_queue 1554=for gengetinfo end command_queue
1555
1556=back
1557
1558=head3 MEMORY MAPPED BUFFERS
1559
1560OpenCL allows you to map buffers and images to host memory (read: perl
1561scalars). This is done much like reading or copying a buffer, by enqueuing
1562a map or unmap operation on the command queue.
1563
1564The map operations return an C<OpenCL::Mapped> object - see L<THE
1565OpenCL::Mapped CLASS> section for details on what to do with these
1566objects.
1567
1568The object will be unmapped automatically when the mapped object is
1569destroyed (you can use a barrier to make sure the unmap has finished,
1570before using the buffer in a kernel), but you can also enqueue an unmap
1571operation manually.
1572
1573=over 4
1574
1575=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
1576
1577Maps the given buffer into host memory and returns an
1578C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1579the map will extend to the end of the buffer.
1580
1581map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1582
1583L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1584
1585Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1586
1587 {
1588 my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
1589 substr $$mapped, 0, 4, "abcd";
1590 } # asynchronously unmap because $mapped is destroyed
1591
1592=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...)
1593
1594Maps the given image area into host memory and return an
1595C<OpenCL::MappedImage> object.
1596
1597If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
1598will be replaced by the maximum possible value.
1599
1600L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
1601
1602Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
1603the first channel of the leftmost column to 5, then explicitly unmap
1604it. You are not necessarily meant to do it this way, this example just
1605shows you the accessors to use :)
1606
1607 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
1608
1609 $mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
1610 for 0..$image->height;
1611
1612 $mapped->unmap;.
1613 $mapped->wait; # only needed for out of order queues normally
1614
1615=item $ev = $queue->unmap ($mapped, $wait_events...)
1616
1617Unmaps the data from host memory. You must not call any methods that
1618modify the data, or modify the data scalar directly, after calling this
1619method.
1620
1621The mapped event object will always be passed as part of the
1622$wait_events. The mapped event object will be replaced by the new event
1623object that this request creates.
1367 1624
1368=back 1625=back
1369 1626
1370=head2 THE OpenCL::Memory CLASS 1627=head2 THE OpenCL::Memory CLASS
1371 1628
… …
1382 1639
1383=for gengetinfo begin mem 1640=for gengetinfo begin mem
1384 1641
1385=item $mem_object_type = $mem->type 1642=item $mem_object_type = $mem->type
1386 1643
1387Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1644Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1388 1645
1389=item $mem_flags = $mem->flags 1646=item $mem_flags = $mem->flags
1390 1647
1391Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1648Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1392 1649
1393=item $int = $mem->size 1650=item $int = $mem->size
1394 1651
1395Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1652Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1396 1653
1397=item $ptr_value = $mem->host_ptr 1654=item $ptr_value = $mem->host_ptr
1398 1655
1399Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. 1656Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1400 1657
1401=item $uint = $mem->map_count 1658=item $uint = $mem->map_count
1402 1659
1403Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. 1660Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1404 1661
1405=item $uint = $mem->reference_count 1662=item $uint = $mem->reference_count
1406 1663
1407Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. 1664Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1408 1665
1409=item $ctx = $mem->context 1666=item $ctx = $mem->context
1410 1667
1411Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1668Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1412 1669
1413=item $mem = $mem->associated_memobject 1670=item $mem = $mem->associated_memobject
1414 1671
1415Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. 1672Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1416 1673
1417=item $int = $mem->offset 1674=item $int = $mem->offset
1418 1675
1419Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1676Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1420 1677
1421=for gengetinfo end mem 1678=for gengetinfo end mem
1422 1679
1423=item ($type, $name) = $mem->gl_object_info 1680=item ($type, $name) = $mem->gl_object_info
1424 1681
… …
1476 1733
1477=for gengetinfo begin image 1734=for gengetinfo begin image
1478 1735
1479=item $int = $image->element_size 1736=item $int = $image->element_size
1480 1737
1481Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1738Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1482 1739
1483=item $int = $image->row_pitch 1740=item $int = $image->row_pitch
1484 1741
1485Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. 1742Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1486 1743
1487=item $int = $image->slice_pitch 1744=item $int = $image->slice_pitch
1488 1745
1489Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. 1746Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1490 1747
1491=item $int = $image->width 1748=item $int = $image->width
1492 1749
1493Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1750Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1494 1751
1495=item $int = $image->height 1752=item $int = $image->height
1496 1753
1497Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1754Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1498 1755
1499=item $int = $image->depth 1756=item $int = $image->depth
1500 1757
1501Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1758Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1502 1759
1503=for gengetinfo end image 1760=for gengetinfo end image
1504 1761
1505=for gengetinfo begin gl_texture 1762=for gengetinfo begin gl_texture
1506 1763
1507=item $GLenum = $gl_texture->target 1764=item $GLenum = $gl_texture->target
1508 1765
1509Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. 1766Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1510 1767
1511=item $GLint = $gl_texture->gl_mipmap_level 1768=item $GLint = $gl_texture->gl_mipmap_level
1512 1769
1513Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. 1770Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1514 1771
1515=for gengetinfo end gl_texture 1772=for gengetinfo end gl_texture
1516 1773
1517=back 1774=back
1518 1775
… …
1528 1785
1529=for gengetinfo begin sampler 1786=for gengetinfo begin sampler
1530 1787
1531=item $uint = $sampler->reference_count 1788=item $uint = $sampler->reference_count
1532 1789
1533Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. 1790Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1534 1791
1535=item $ctx = $sampler->context 1792=item $ctx = $sampler->context
1536 1793
1537Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1794Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1538 1795
1539=item $addressing_mode = $sampler->normalized_coords 1796=item $addressing_mode = $sampler->normalized_coords
1540 1797
1541Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. 1798Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1542 1799
1543=item $filter_mode = $sampler->addressing_mode 1800=item $filter_mode = $sampler->addressing_mode
1544 1801
1545Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. 1802Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1546 1803
1547=item $boolean = $sampler->filter_mode 1804=item $boolean = $sampler->filter_mode
1548 1805
1549Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. 1806Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1550 1807
1551=for gengetinfo end sampler 1808=for gengetinfo end sampler
1552 1809
1553=back 1810=back
1554 1811
… …
1572not so. So best make sure you don't pass in invalid values. 1829not so. So best make sure you don't pass in invalid values.
1573 1830
1574Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1831Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1575compilation state is successful but some later stage fails. 1832compilation state is successful but some later stage fails.
1576 1833
1834options: C<-D name>, C<-D name=definition>, C<-I dir>,
1835C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
1836C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
1837C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1838C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1839C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1840C<-create-library>, C<-enable-link-options>.
1841
1842build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
1843OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1844
1577L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1845L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1578 1846
1579=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1847=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1580 1848
1581Similar to C<< ->build >>, except it starts a thread, and never fails (you 1849Similar to C<< ->build >>, except it starts a thread, and never fails (you
1582need to check the compilation status form the callback, or by polling). 1850need to check the compilation status form the callback, or by polling).
1583 1851
1852=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1853
1854Compiles the given program for the given devices (or all devices if
1855undef). If C<$headers> is given, it must be a hashref with include name =>
1856OpenCL::Program pairs.
1857
1858L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1859
1584=item $packed_value = $program->build_info ($device, $name) 1860=item $packed_value = $program->build_info ($device, $name)
1585 1861
1586Similar to C<< $platform->info >>, but returns build info for a previous 1862Similar to C<< $platform->info >>, but returns build info for a previous
1587build attempt for the given device. 1863build attempt for the given device.
1588 1864
1865binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
1866OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
1867OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
1868OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
1869
1589L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html> 1870L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1590 1871
1591=item $kernel = $program->kernel ($function_name) 1872=item $kernel = $program->kernel ($function_name)
1592 1873
1593Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1874Creates an OpenCL::Kernel object out of the named C<__kernel> function in
… …
1603 1884
1604=for gengetinfo begin program_build 1885=for gengetinfo begin program_build
1605 1886
1606=item $build_status = $program->build_status ($device) 1887=item $build_status = $program->build_status ($device)
1607 1888
1608Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. 1889Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1609 1890
1610=item $string = $program->build_options ($device) 1891=item $string = $program->build_options ($device)
1611 1892
1612Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. 1893Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1613 1894
1614=item $string = $program->build_log ($device) 1895=item $string = $program->build_log ($device)
1615 1896
1616Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. 1897Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1617 1898
1618=for gengetinfo end program_build 1899=for gengetinfo end program_build
1619 1900
1620=item $packed_value = $program->info ($name) 1901=item $packed_value = $program->info ($name)
1621 1902
… …
1625 1906
1626=for gengetinfo begin program 1907=for gengetinfo begin program
1627 1908
1628=item $uint = $program->reference_count 1909=item $uint = $program->reference_count
1629 1910
1630Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. 1911Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1631 1912
1632=item $ctx = $program->context 1913=item $ctx = $program->context
1633 1914
1634Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1915Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1635 1916
1636=item $uint = $program->num_devices 1917=item $uint = $program->num_devices
1637 1918
1638Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. 1919Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1639 1920
1640=item @devices = $program->devices 1921=item @devices = $program->devices
1641 1922
1642Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1923Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1643 1924
1644=item $string = $program->source 1925=item $string = $program->source
1645 1926
1646Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1927Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1647 1928
1648=item @ints = $program->binary_sizes 1929=item @ints = $program->binary_sizes
1649 1930
1650Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. 1931Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1651 1932
1652=for gengetinfo end program 1933=for gengetinfo end program
1653 1934
1654=item @blobs = $program->binaries 1935=item @blobs = $program->binaries
1655 1936
… …
1676 1957
1677=for gengetinfo begin kernel 1958=for gengetinfo begin kernel
1678 1959
1679=item $string = $kernel->function_name 1960=item $string = $kernel->function_name
1680 1961
1681Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. 1962Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1682 1963
1683=item $uint = $kernel->num_args 1964=item $uint = $kernel->num_args
1684 1965
1685Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. 1966Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1686 1967
1687=item $uint = $kernel->reference_count 1968=item $uint = $kernel->reference_count
1688 1969
1689Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. 1970Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1690 1971
1691=item $ctx = $kernel->context 1972=item $ctx = $kernel->context
1692 1973
1693Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1974Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1694 1975
1695=item $program = $kernel->program 1976=item $program = $kernel->program
1696 1977
1697Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1978Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1698 1979
1699=for gengetinfo end kernel 1980=for gengetinfo end kernel
1700 1981
1701=item $packed_value = $kernel->work_group_info ($device, $name) 1982=item $packed_value = $kernel->work_group_info ($device, $name)
1702 1983
1703See C<< $platform->info >> for details. 1984See C<< $platform->info >> for details.
1704 1985
1705The reason this method is not called C<info> is that there already is an
1706C<< ->info >> method.
1707
1708L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> 1986L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1709 1987
1710=for gengetinfo begin kernel_work_group 1988=for gengetinfo begin kernel_work_group
1711 1989
1712=item $int = $kernel->work_group_size ($device) 1990=item $int = $kernel->work_group_size ($device)
1713 1991
1714Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. 1992Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1715 1993
1716=item @ints = $kernel->compile_work_group_size ($device) 1994=item @ints = $kernel->compile_work_group_size ($device)
1717 1995
1718Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. 1996Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1719 1997
1720=item $ulong = $kernel->local_mem_size ($device) 1998=item $ulong = $kernel->local_mem_size ($device)
1721 1999
1722Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. 2000Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1723 2001
1724=item $int = $kernel->preferred_work_group_size_multiple ($device) 2002=item $int = $kernel->preferred_work_group_size_multiple ($device)
1725 2003
1726Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. 2004Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1727 2005
1728=item $ulong = $kernel->private_mem_size ($device) 2006=item $ulong = $kernel->private_mem_size ($device)
1729 2007
1730Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. 2008Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1731 2009
1732=for gengetinfo end kernel_work_group 2010=for gengetinfo end kernel_work_group
2011
2012=item $packed_value = $kernel->arg_info ($idx, $name)
2013
2014See C<< $platform->info >> for details.
2015
2016L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
2017
2018=for gengetinfo begin kernel_arg
2019
2020=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
2021
2022Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
2023
2024=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
2025
2026Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
2027
2028=item $string = $kernel->arg_type_name ($idx)
2029
2030Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
2031
2032=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
2033
2034Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
2035
2036=item $string = $kernel->arg_name ($idx)
2037
2038Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
2039
2040=for gengetinfo end kernel_arg
1733 2041
1734=item $kernel->setf ($format, ...) 2042=item $kernel->setf ($format, ...)
1735 2043
1736Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic 2044Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1737way to set arguments (and with OpenCL 1.2 it might be rather slow), you 2045way to set arguments (and with OpenCL 1.2 it might be rather slow), you
… …
1849 2157
1850=for gengetinfo begin event 2158=for gengetinfo begin event
1851 2159
1852=item $queue = $event->command_queue 2160=item $queue = $event->command_queue
1853 2161
1854Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. 2162Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1855 2163
1856=item $command_type = $event->command_type 2164=item $command_type = $event->command_type
1857 2165
1858Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. 2166Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1859 2167
1860=item $uint = $event->reference_count 2168=item $uint = $event->reference_count
1861 2169
1862Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. 2170Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1863 2171
1864=item $uint = $event->command_execution_status 2172=item $uint = $event->command_execution_status
1865 2173
1866Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. 2174Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1867 2175
1868=item $ctx = $event->context 2176=item $ctx = $event->context
1869 2177
1870Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2178Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1871 2179
1872=for gengetinfo end event 2180=for gengetinfo end event
1873 2181
1874=item $packed_value = $ev->profiling_info ($name) 2182=item $packed_value = $ev->profiling_info ($name)
1875 2183
… …
1882 2190
1883=for gengetinfo begin profiling 2191=for gengetinfo begin profiling
1884 2192
1885=item $ulong = $event->profiling_command_queued 2193=item $ulong = $event->profiling_command_queued
1886 2194
1887Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. 2195Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1888 2196
1889=item $ulong = $event->profiling_command_submit 2197=item $ulong = $event->profiling_command_submit
1890 2198
1891Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. 2199Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1892 2200
1893=item $ulong = $event->profiling_command_start 2201=item $ulong = $event->profiling_command_start
1894 2202
1895Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. 2203Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1896 2204
1897=item $ulong = $event->profiling_command_end 2205=item $ulong = $event->profiling_command_end
1898 2206
1899Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. 2207Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1900 2208
1901=for gengetinfo end profiling 2209=for gengetinfo end profiling
1902 2210
1903=back 2211=back
1904 2212
… …
1911=item $ev->set_status ($execution_status) 2219=item $ev->set_status ($execution_status)
1912 2220
1913Sets the execution status of the user event. Can only be called once, 2221Sets the execution status of the user event. Can only be called once,
1914either with OpenCL::COMPLETE or a negative number as status. 2222either with OpenCL::COMPLETE or a negative number as status.
1915 2223
2224execution_status: OpenCL::COMPLETE or a negative integer.
2225
1916L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2226L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1917 2227
1918=back 2228=back
2229
2230=head2 THE OpenCL::Mapped CLASS
2231
2232This class represents objects mapped into host memory. They are
2233represented by a blessed string scalar. The string data is the mapped
2234memory area, that is, if you read or write it, then the mapped object is
2235accessed directly.
2236
2237You must only ever use operations that modify the string in-place - for
2238example, a C<substr> that doesn't change the length, or maybe a regex that
2239doesn't change the length. Any other operation might cause the data to be
2240copied.
2241
2242When the object is destroyed it will enqueue an implicit unmap operation
2243on the queue that was used to create it.
2244
2245Keep in mind that you I<need> to unmap (or destroy) mapped objects before
2246OpenCL sees the changes, even if some implementations don't need this
2247sometimes.
2248
2249Example, replace the first two floats in the mapped buffer by 1 and 2.
2250
2251 my $mapped = $queue->map_buffer ($buf, ...
2252 $mapped->event->wait; # make sure it's there
2253
2254 # now replace first 8 bytes by new data, which is exactly 8 bytes long
2255 # we blindly assume device endianness to equal host endianness
2256 # (and of course, we assume iee 754 single precision floats :)
2257 substr $$mapped, 0, 8, pack "f*", 1, 2;
2258
2259=over 4
2260
2261=item $ev = $mapped->unmap ($wait_events...)
2262
2263Unmaps the mapped memory object, using the queue originally used to create
2264it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
2265
2266=item $bool = $mapped->mapped
2267
2268Returns whether the object is still mapped - true before an C<unmap> is
2269enqueued, false afterwards.
2270
2271=item $ev = $mapped->event
2272
2273Return the event object associated with the mapped object. Initially, this
2274will be the event object created when mapping the object, and after an
2275unmap, this will be the event object that the unmap operation created.
2276
2277=item $mapped->wait
2278
2279Same as C<< $mapped->event->wait >> - makes sure no operations on this
2280mapped object are outstanding.
2281
2282=item $bytes = $mapped->size
2283
2284Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
2285
2286=item $ptr = $mapped->ptr
2287
2288Returns the raw memory address of the mapped area.
2289
2290=item $mapped->set ($offset, $data)
2291
2292Replaces the data at the given C<$offset> in the memory area by the new
2293C<$data>. This method is safer than direct manipulation of C<$mapped>
2294because it does bounds-checking, but also slower.
2295
2296=item $data = $mapped->get ($offset, $length)
2297
2298Returns (without copying) a scalar representing the data at the given
2299C<$offset> and C<$length> in the mapped memory area. This is the same as
2300the following substr, except much slower;
2301
2302 $data = substr $$mapped, $offset, $length
2303
2304=cut
2305
2306sub OpenCL::Mapped::get {
2307 substr ${$_[0]}, $_[1], $_[2]
2308}
2309
2310=back
2311
2312=head2 THE OpenCL::MappedBuffer CLASS
2313
2314This is a subclass of OpenCL::Mapped, representing mapped buffers.
2315
2316=head2 THE OpenCL::MappedImage CLASS
2317
2318This is a subclass of OpenCL::Mapped, representing mapped images.
2319
2320=over 4
2321
2322=item $bytes = $mapped->row_pitch
2323
2324=item $bytes = $mapped->slice_pitch
2325
2326Return the row or slice pitch of the image that has been mapped.
2327
2328=back
2329
1919 2330
1920=cut 2331=cut
1921 2332
19221; 23331;
1923 2334

Diff Legend

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