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.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 - you can download it from 218This is quite a long example to get you going - you can download it from
218L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>. 219L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
219 220
220 use OpenGL ":all"; 221 use OpenGL ":all";
… …
305 glXSwapBuffers; 306 glXSwapBuffers;
306 307
307 select undef, undef, undef, 1/60; 308 select undef, undef, undef, 1/60;
308 } 309 }
309 310
310=item How to modify the previous example to not rely on GL sharing. 311=head2 How to modify the previous example to not rely on GL sharing.
311 312
312For those poor souls with only a sucky CPU OpenCL implementation, you 313For 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 314currently have to read the image into some perl scalar, and then modify a
314texture or use glDrawPixels or so). 315texture or use glDrawPixels or so).
315 316
… …
320To use a texture, you would modify the above example by creating an 321To use a texture, you would modify the above example by creating an
321OpenCL::Image manually instead of deriving it from a texture: 322OpenCL::Image manually instead of deriving it from a texture:
322 323
323 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S); 324 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
324 325
325And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you 326And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
326would read the image2d after the kernel has written it: 327would read the image2d after the kernel has written it:
327 328
328 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data); 329 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
329 330
330And then you would upload the pixel data to the texture (or use glDrawPixels): 331And then you would upload the pixel data to the texture (or use glDrawPixels):
331 332
332 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data; 333 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
333 334
334The fully modified example can be found at 335The fully modified example can be found at
335L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>. 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>.
336 354
337=head1 DOCUMENTATION 355=head1 DOCUMENTATION
338 356
339=head2 BASIC CONVENTIONS 357=head2 BASIC CONVENTIONS
340 358
… …
416OpenCL can generate a number of (potentially) asynchronous events, for 434OpenCL can generate a number of (potentially) asynchronous events, for
417example, after compiling a program, to signal a context-related error or, 435example, after compiling a program, to signal a context-related error or,
418perhaps most important, to signal completion of queued jobs (by setting 436perhaps most important, to signal completion of queued jobs (by setting
419callbacks on OpenCL::Event objects). 437callbacks on OpenCL::Event objects).
420 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
421To facilitate this, this module maintains an event queue - each 446To facilitate this, this module maintains an event queue - each
422time an asynchronous event happens, it is queued, and perl will be 447time an asynchronous event happens, it is queued, and perl will be
423interrupted. This is implemented via the L<Async::Interrupt> module. In 448interrupted. This is implemented via the L<Async::Interrupt> module. In
424addition, this module has L<AnyEvent> support, so it can seamlessly 449addition, this module has L<AnyEvent> support, so it can seamlessly
425integrate itself into many event loops. 450integrate itself into many event loops.
426 451
427Since 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:
428 453
429=head3 Don't use callbacks. 454=head3 Don't use callbacks.
430 455
431When 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
432notifications 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
… …
529use Async::Interrupt (); 554use Async::Interrupt ();
530 555
531our $POLL_FUNC; # set by XS 556our $POLL_FUNC; # set by XS
532 557
533BEGIN { 558BEGIN {
534 our $VERSION = '0.98'; 559 our $VERSION = '0.99';
535 560
536 require XSLoader; 561 require XSLoader;
537 XSLoader::load (__PACKAGE__, $VERSION); 562 XSLoader::load (__PACKAGE__, $VERSION);
538 563
539 @OpenCL::Platform::ISA = 564 @OpenCL::Platform::ISA =
… …
544 @OpenCL::Sampler::ISA = 569 @OpenCL::Sampler::ISA =
545 @OpenCL::Program::ISA = 570 @OpenCL::Program::ISA =
546 @OpenCL::Kernel::ISA = 571 @OpenCL::Kernel::ISA =
547 @OpenCL::Event::ISA = OpenCL::Object::; 572 @OpenCL::Event::ISA = OpenCL::Object::;
548 573
574 @OpenCL::SubDevice::ISA = OpenCL::Device::;
575
549 @OpenCL::Buffer::ISA = 576 @OpenCL::Buffer::ISA =
550 @OpenCL::Image::ISA = OpenCL::Memory::; 577 @OpenCL::Image::ISA = OpenCL::Memory::;
551 578
552 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 579 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
553 580
… …
557 @OpenCL::Image1D::ISA = 584 @OpenCL::Image1D::ISA =
558 @OpenCL::Image1DArray::ISA = 585 @OpenCL::Image1DArray::ISA =
559 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; 586 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
560 587
561 @OpenCL::UserEvent::ISA = OpenCL::Event::; 588 @OpenCL::UserEvent::ISA = OpenCL::Event::;
589
590 @OpenCL::MappedBuffer::ISA =
591 @OpenCL::MappedImage::ISA = OpenCL::Mapped::;
562} 592}
563 593
564=head2 THE OpenCL PACKAGE 594=head2 THE OpenCL PACKAGE
565 595
566=over 4 596=over 4
… …
590L<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>
591 621
592=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
593 623
594Tries 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.
595 629
596L<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>
597 631
598=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 632=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
599 633
600Create a new OpenCL::Context object using the given device object(s). This 634Create a new OpenCL::Context object using the given device object(s).
601function isn't implemented yet, use C<< $platform->context >> instead. 635Consider using C<< $platform->context >> instead.
602 636
603L<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>
604 638
605=item OpenCL::wait_for_events $wait_events... 639=item OpenCL::wait_for_events $wait_events...
606 640
… …
713 747
714=for gengetinfo begin platform 748=for gengetinfo begin platform
715 749
716=item $string = $platform->profile 750=item $string = $platform->profile
717 751
718Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 752Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
719 753
720=item $string = $platform->version 754=item $string = $platform->version
721 755
722Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 756Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
723 757
724=item $string = $platform->name 758=item $string = $platform->name
725 759
726Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 760Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
727 761
728=item $string = $platform->vendor 762=item $string = $platform->vendor
729 763
730Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 764Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
731 765
732=item $string = $platform->extensions 766=item $string = $platform->extensions
733 767
734Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 768Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
735 769
736=for gengetinfo end platform 770=for gengetinfo end platform
737 771
738=back 772=back
739 773
… …
745 779
746See C<< $platform->info >> for details. 780See C<< $platform->info >> for details.
747 781
748L<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>
749 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
750=for gengetinfo begin device 790=for gengetinfo begin device
751 791
752=item $device_type = $device->type 792=item $device_type = $device->type
753 793
754Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 794Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
755 795
756=item $uint = $device->vendor_id 796=item $uint = $device->vendor_id
757 797
758Calls 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.
759 799
760=item $uint = $device->max_compute_units 800=item $uint = $device->max_compute_units
761 801
762Calls 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.
763 803
764=item $uint = $device->max_work_item_dimensions 804=item $uint = $device->max_work_item_dimensions
765 805
766Calls 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.
767 807
768=item $int = $device->max_work_group_size 808=item $int = $device->max_work_group_size
769 809
770Calls 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.
771 811
772=item @ints = $device->max_work_item_sizes 812=item @ints = $device->max_work_item_sizes
773 813
774Calls 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.
775 815
776=item $uint = $device->preferred_vector_width_char 816=item $uint = $device->preferred_vector_width_char
777 817
778Calls 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.
779 819
780=item $uint = $device->preferred_vector_width_short 820=item $uint = $device->preferred_vector_width_short
781 821
782Calls 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.
783 823
784=item $uint = $device->preferred_vector_width_int 824=item $uint = $device->preferred_vector_width_int
785 825
786Calls 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.
787 827
788=item $uint = $device->preferred_vector_width_long 828=item $uint = $device->preferred_vector_width_long
789 829
790Calls 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.
791 831
792=item $uint = $device->preferred_vector_width_float 832=item $uint = $device->preferred_vector_width_float
793 833
794Calls 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.
795 835
796=item $uint = $device->preferred_vector_width_double 836=item $uint = $device->preferred_vector_width_double
797 837
798Calls 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.
799 839
800=item $uint = $device->max_clock_frequency 840=item $uint = $device->max_clock_frequency
801 841
802Calls 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.
803 843
804=item $bitfield = $device->address_bits 844=item $bitfield = $device->address_bits
805 845
806Calls 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.
807 847
808=item $uint = $device->max_read_image_args 848=item $uint = $device->max_read_image_args
809 849
810Calls 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.
811 851
812=item $uint = $device->max_write_image_args 852=item $uint = $device->max_write_image_args
813 853
814Calls 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.
815 855
816=item $ulong = $device->max_mem_alloc_size 856=item $ulong = $device->max_mem_alloc_size
817 857
818Calls 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.
819 859
820=item $int = $device->image2d_max_width 860=item $int = $device->image2d_max_width
821 861
822Calls 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.
823 863
824=item $int = $device->image2d_max_height 864=item $int = $device->image2d_max_height
825 865
826Calls 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.
827 867
828=item $int = $device->image3d_max_width 868=item $int = $device->image3d_max_width
829 869
830Calls 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.
831 871
832=item $int = $device->image3d_max_height 872=item $int = $device->image3d_max_height
833 873
834Calls 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.
835 875
836=item $int = $device->image3d_max_depth 876=item $int = $device->image3d_max_depth
837 877
838Calls 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.
839 879
840=item $uint = $device->image_support 880=item $uint = $device->image_support
841 881
842Calls 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.
843 883
844=item $int = $device->max_parameter_size 884=item $int = $device->max_parameter_size
845 885
846Calls 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.
847 887
848=item $uint = $device->max_samplers 888=item $uint = $device->max_samplers
849 889
850Calls 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.
851 891
852=item $uint = $device->mem_base_addr_align 892=item $uint = $device->mem_base_addr_align
853 893
854Calls 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.
855 895
856=item $uint = $device->min_data_type_align_size 896=item $uint = $device->min_data_type_align_size
857 897
858Calls 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.
859 899
860=item $device_fp_config = $device->single_fp_config 900=item $device_fp_config = $device->single_fp_config
861 901
862Calls 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.
863 903
864=item $device_mem_cache_type = $device->global_mem_cache_type 904=item $device_mem_cache_type = $device->global_mem_cache_type
865 905
866Calls 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.
867 907
868=item $uint = $device->global_mem_cacheline_size 908=item $uint = $device->global_mem_cacheline_size
869 909
870Calls 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.
871 911
872=item $ulong = $device->global_mem_cache_size 912=item $ulong = $device->global_mem_cache_size
873 913
874Calls 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.
875 915
876=item $ulong = $device->global_mem_size 916=item $ulong = $device->global_mem_size
877 917
878Calls 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.
879 919
880=item $ulong = $device->max_constant_buffer_size 920=item $ulong = $device->max_constant_buffer_size
881 921
882Calls 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.
883 923
884=item $uint = $device->max_constant_args 924=item $uint = $device->max_constant_args
885 925
886Calls 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.
887 927
888=item $device_local_mem_type = $device->local_mem_type 928=item $device_local_mem_type = $device->local_mem_type
889 929
890Calls 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.
891 931
892=item $ulong = $device->local_mem_size 932=item $ulong = $device->local_mem_size
893 933
894Calls 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.
895 935
896=item $boolean = $device->error_correction_support 936=item $boolean = $device->error_correction_support
897 937
898Calls 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.
899 939
900=item $int = $device->profiling_timer_resolution 940=item $int = $device->profiling_timer_resolution
901 941
902Calls 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.
903 943
904=item $boolean = $device->endian_little 944=item $boolean = $device->endian_little
905 945
906Calls 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.
907 947
908=item $boolean = $device->available 948=item $boolean = $device->available
909 949
910Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 950Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
911 951
912=item $boolean = $device->compiler_available 952=item $boolean = $device->compiler_available
913 953
914Calls 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.
915 955
916=item $device_exec_capabilities = $device->execution_capabilities 956=item $device_exec_capabilities = $device->execution_capabilities
917 957
918Calls 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.
919 959
920=item $command_queue_properties = $device->properties 960=item $command_queue_properties = $device->properties
921 961
922Calls 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.
923 963
924=item $ = $device->platform 964=item $ = $device->platform
925 965
926Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 966Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
927 967
928=item $string = $device->name 968=item $string = $device->name
929 969
930Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 970Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
931 971
932=item $string = $device->vendor 972=item $string = $device->vendor
933 973
934Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 974Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
935 975
936=item $string = $device->driver_version 976=item $string = $device->driver_version
937 977
938Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 978Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
939 979
940=item $string = $device->profile 980=item $string = $device->profile
941 981
942Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 982Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
943 983
944=item $string = $device->version 984=item $string = $device->version
945 985
946Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 986Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
947 987
948=item $string = $device->extensions 988=item $string = $device->extensions
949 989
950Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 990Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
951 991
952=item $uint = $device->preferred_vector_width_half 992=item $uint = $device->preferred_vector_width_half
953 993
954Calls 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.
955 995
956=item $uint = $device->native_vector_width_char 996=item $uint = $device->native_vector_width_char
957 997
958Calls 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.
959 999
960=item $uint = $device->native_vector_width_short 1000=item $uint = $device->native_vector_width_short
961 1001
962Calls 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.
963 1003
964=item $uint = $device->native_vector_width_int 1004=item $uint = $device->native_vector_width_int
965 1005
966Calls 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.
967 1007
968=item $uint = $device->native_vector_width_long 1008=item $uint = $device->native_vector_width_long
969 1009
970Calls 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.
971 1011
972=item $uint = $device->native_vector_width_float 1012=item $uint = $device->native_vector_width_float
973 1013
974Calls 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.
975 1015
976=item $uint = $device->native_vector_width_double 1016=item $uint = $device->native_vector_width_double
977 1017
978Calls 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.
979 1019
980=item $uint = $device->native_vector_width_half 1020=item $uint = $device->native_vector_width_half
981 1021
982Calls 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.
983 1023
984=item $device_fp_config = $device->double_fp_config 1024=item $device_fp_config = $device->double_fp_config
985 1025
986Calls 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.
987 1027
988=item $device_fp_config = $device->half_fp_config 1028=item $device_fp_config = $device->half_fp_config
989 1029
990Calls 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.
991 1031
992=item $boolean = $device->host_unified_memory 1032=item $boolean = $device->host_unified_memory
993 1033
994Calls 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.
995 1035
996=item $device = $device->parent_device_ext 1036=item $device = $device->parent_device_ext
997 1037
998Calls 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.
999 1039
1000=item @device_partition_property_exts = $device->partition_types_ext 1040=item @device_partition_property_exts = $device->partition_types_ext
1001 1041
1002Calls 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.
1003 1043
1004=item @device_partition_property_exts = $device->affinity_domains_ext 1044=item @device_partition_property_exts = $device->affinity_domains_ext
1005 1045
1006Calls 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.
1007 1047
1008=item $uint = $device->reference_count_ext 1048=item $uint = $device->reference_count_ext
1009 1049
1010Calls 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.
1011 1051
1012=item @device_partition_property_exts = $device->partition_style_ext 1052=item @device_partition_property_exts = $device->partition_style_ext
1013 1053
1014Calls 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.
1015 1055
1016=for gengetinfo end device 1056=for gengetinfo end device
1017 1057
1018=back 1058=back
1019 1059
1020=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
1021 1087
1022=over 4 1088=over 4
1023 1089
1024=item $prog = $ctx->build_program ($program, $options = "") 1090=item $prog = $ctx->build_program ($program, $options = "")
1025 1091
… …
1073=item $buf = $ctx->buffer ($flags, $len) 1139=item $buf = $ctx->buffer ($flags, $len)
1074 1140
1075Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1141Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1076given flags and octet-size. 1142given flags and octet-size.
1077 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
1078L<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>
1079 1149
1080=item $buf = $ctx->buffer_sv ($flags, $data) 1150=item $buf = $ctx->buffer_sv ($flags, $data)
1081 1151
1082Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1152Creates 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) 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)
1086 1156
1087Creates a new OpenCL::Image object and optionally initialises it with 1157Creates a new OpenCL::Image object and optionally initialises it with
1088the given data values. 1158the given data values.
1089 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
1090L<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>
1091 1177
1092=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)
1093 1179
1094Creates a new OpenCL::Image2D object and optionally initialises it with 1180Creates a new OpenCL::Image2D object and optionally initialises it with
… …
1106=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1192=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1107 1193
1108Creates 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
1109OpenGL buffer object. 1195OpenGL buffer object.
1110 1196
1197flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1198
1111http://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
1112 1200
1113=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1201=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1114 1202
1115Creates a new OpenCL::Image object that refers to the given OpenGL 1203Creates a new OpenCL::Image object that refers to the given OpenGL
1116texture object or buffer. 1204texture object or buffer.
1117 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
1118http://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
1119 1214
1120=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1215=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1121 1216
1122Creates a new OpenCL::Image2D object that refers to the given OpenGL 1217Creates a new OpenCL::Image2D object that refers to the given OpenGL
… …
1147 1242
1148=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1243=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1149 1244
1150Creates a new OpenCL::Sampler object. 1245Creates a new OpenCL::Sampler object.
1151 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
1152L<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>
1153 1253
1154=item $program = $ctx->program_with_source ($string) 1254=item $program = $ctx->program_with_source ($string)
1155 1255
1156Creates a new OpenCL::Program object from the given source code. 1256Creates a new OpenCL::Program object from the given source code.
1157 1257
1158L<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>
1159 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
1160=item $packed_value = $ctx->info ($name) 1284=item $packed_value = $ctx->info ($name)
1161 1285
1162See C<< $platform->info >> for details. 1286See C<< $platform->info >> for details.
1163 1287
1164L<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>
1165 1289
1166=for gengetinfo begin context 1290=for gengetinfo begin context
1167 1291
1168=item $uint = $context->reference_count 1292=item $uint = $context->reference_count
1169 1293
1170Calls 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.
1171 1295
1172=item @devices = $context->devices 1296=item @devices = $context->devices
1173 1297
1174Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1298Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1175 1299
1176=item @property_ints = $context->properties 1300=item @property_ints = $context->properties
1177 1301
1178Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1302Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1179 1303
1180=item $uint = $context->num_devices 1304=item $uint = $context->num_devices
1181 1305
1182Calls 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.
1183 1307
1184=for gengetinfo end context 1308=for gengetinfo end context
1185 1309
1186=back 1310=back
1187 1311
… …
1303reference 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
1304elements as \@global_work_size. 1428elements as \@global_work_size.
1305 1429
1306L<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>
1307 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
1308=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1440=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1309 1441
1310Enqueues 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
1311for subsequent OpenCL usage. 1443for subsequent OpenCL usage.
1312 1444
… …
1347 1479
1348=for gengetinfo begin command_queue 1480=for gengetinfo begin command_queue
1349 1481
1350=item $ctx = $command_queue->context 1482=item $ctx = $command_queue->context
1351 1483
1352Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1484Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1353 1485
1354=item $device = $command_queue->device 1486=item $device = $command_queue->device
1355 1487
1356Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1488Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1357 1489
1358=item $uint = $command_queue->reference_count 1490=item $uint = $command_queue->reference_count
1359 1491
1360Calls 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.
1361 1493
1362=item $command_queue_properties = $command_queue->properties 1494=item $command_queue_properties = $command_queue->properties
1363 1495
1364Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1496Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1365 1497
1366=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.
1367 1568
1368=back 1569=back
1369 1570
1370=head2 THE OpenCL::Memory CLASS 1571=head2 THE OpenCL::Memory CLASS
1371 1572
… …
1382 1583
1383=for gengetinfo begin mem 1584=for gengetinfo begin mem
1384 1585
1385=item $mem_object_type = $mem->type 1586=item $mem_object_type = $mem->type
1386 1587
1387Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1588Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1388 1589
1389=item $mem_flags = $mem->flags 1590=item $mem_flags = $mem->flags
1390 1591
1391Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1592Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1392 1593
1393=item $int = $mem->size 1594=item $int = $mem->size
1394 1595
1395Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1596Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1396 1597
1397=item $ptr_value = $mem->host_ptr 1598=item $ptr_value = $mem->host_ptr
1398 1599
1399Calls 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.
1400 1601
1401=item $uint = $mem->map_count 1602=item $uint = $mem->map_count
1402 1603
1403Calls 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.
1404 1605
1405=item $uint = $mem->reference_count 1606=item $uint = $mem->reference_count
1406 1607
1407Calls 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.
1408 1609
1409=item $ctx = $mem->context 1610=item $ctx = $mem->context
1410 1611
1411Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1612Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1412 1613
1413=item $mem = $mem->associated_memobject 1614=item $mem = $mem->associated_memobject
1414 1615
1415Calls 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.
1416 1617
1417=item $int = $mem->offset 1618=item $int = $mem->offset
1418 1619
1419Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1620Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1420 1621
1421=for gengetinfo end mem 1622=for gengetinfo end mem
1422 1623
1423=item ($type, $name) = $mem->gl_object_info 1624=item ($type, $name) = $mem->gl_object_info
1424 1625
… …
1476 1677
1477=for gengetinfo begin image 1678=for gengetinfo begin image
1478 1679
1479=item $int = $image->element_size 1680=item $int = $image->element_size
1480 1681
1481Calls 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.
1482 1683
1483=item $int = $image->row_pitch 1684=item $int = $image->row_pitch
1484 1685
1485Calls 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.
1486 1687
1487=item $int = $image->slice_pitch 1688=item $int = $image->slice_pitch
1488 1689
1489Calls 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.
1490 1691
1491=item $int = $image->width 1692=item $int = $image->width
1492 1693
1493Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1694Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1494 1695
1495=item $int = $image->height 1696=item $int = $image->height
1496 1697
1497Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1698Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1498 1699
1499=item $int = $image->depth 1700=item $int = $image->depth
1500 1701
1501Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1702Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1502 1703
1503=for gengetinfo end image 1704=for gengetinfo end image
1504 1705
1505=for gengetinfo begin gl_texture 1706=for gengetinfo begin gl_texture
1506 1707
1507=item $GLenum = $gl_texture->target 1708=item $GLenum = $gl_texture->target
1508 1709
1509Calls 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.
1510 1711
1511=item $GLint = $gl_texture->gl_mipmap_level 1712=item $GLint = $gl_texture->gl_mipmap_level
1512 1713
1513Calls 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.
1514 1715
1515=for gengetinfo end gl_texture 1716=for gengetinfo end gl_texture
1516 1717
1517=back 1718=back
1518 1719
… …
1528 1729
1529=for gengetinfo begin sampler 1730=for gengetinfo begin sampler
1530 1731
1531=item $uint = $sampler->reference_count 1732=item $uint = $sampler->reference_count
1532 1733
1533Calls 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.
1534 1735
1535=item $ctx = $sampler->context 1736=item $ctx = $sampler->context
1536 1737
1537Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1738Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1538 1739
1539=item $addressing_mode = $sampler->normalized_coords 1740=item $addressing_mode = $sampler->normalized_coords
1540 1741
1541Calls 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.
1542 1743
1543=item $filter_mode = $sampler->addressing_mode 1744=item $filter_mode = $sampler->addressing_mode
1544 1745
1545Calls 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.
1546 1747
1547=item $boolean = $sampler->filter_mode 1748=item $boolean = $sampler->filter_mode
1548 1749
1549Calls 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.
1550 1751
1551=for gengetinfo end sampler 1752=for gengetinfo end sampler
1552 1753
1553=back 1754=back
1554 1755
… …
1572not 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.
1573 1774
1574Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1775Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1575compilation state is successful but some later stage fails. 1776compilation state is successful but some later stage fails.
1576 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
1577L<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>
1578 1790
1579=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1791=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1580 1792
1581Similar 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
1582need to check the compilation status form the callback, or by polling). 1794need to check the compilation status form the callback, or by polling).
1583 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
1584=item $packed_value = $program->build_info ($device, $name) 1804=item $packed_value = $program->build_info ($device, $name)
1585 1805
1586Similar to C<< $platform->info >>, but returns build info for a previous 1806Similar to C<< $platform->info >>, but returns build info for a previous
1587build attempt for the given device. 1807build attempt for the given device.
1588 1808
… …
1603 1823
1604=for gengetinfo begin program_build 1824=for gengetinfo begin program_build
1605 1825
1606=item $build_status = $program->build_status ($device) 1826=item $build_status = $program->build_status ($device)
1607 1827
1608Calls 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.
1609 1829
1610=item $string = $program->build_options ($device) 1830=item $string = $program->build_options ($device)
1611 1831
1612Calls 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.
1613 1833
1614=item $string = $program->build_log ($device) 1834=item $string = $program->build_log ($device)
1615 1835
1616Calls 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.
1617 1837
1618=for gengetinfo end program_build 1838=for gengetinfo end program_build
1619 1839
1620=item $packed_value = $program->info ($name) 1840=item $packed_value = $program->info ($name)
1621 1841
… …
1625 1845
1626=for gengetinfo begin program 1846=for gengetinfo begin program
1627 1847
1628=item $uint = $program->reference_count 1848=item $uint = $program->reference_count
1629 1849
1630Calls 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.
1631 1851
1632=item $ctx = $program->context 1852=item $ctx = $program->context
1633 1853
1634Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1854Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1635 1855
1636=item $uint = $program->num_devices 1856=item $uint = $program->num_devices
1637 1857
1638Calls 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.
1639 1859
1640=item @devices = $program->devices 1860=item @devices = $program->devices
1641 1861
1642Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1862Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1643 1863
1644=item $string = $program->source 1864=item $string = $program->source
1645 1865
1646Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1866Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1647 1867
1648=item @ints = $program->binary_sizes 1868=item @ints = $program->binary_sizes
1649 1869
1650Calls 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.
1651 1871
1652=for gengetinfo end program 1872=for gengetinfo end program
1653 1873
1654=item @blobs = $program->binaries 1874=item @blobs = $program->binaries
1655 1875
… …
1676 1896
1677=for gengetinfo begin kernel 1897=for gengetinfo begin kernel
1678 1898
1679=item $string = $kernel->function_name 1899=item $string = $kernel->function_name
1680 1900
1681Calls 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.
1682 1902
1683=item $uint = $kernel->num_args 1903=item $uint = $kernel->num_args
1684 1904
1685Calls 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.
1686 1906
1687=item $uint = $kernel->reference_count 1907=item $uint = $kernel->reference_count
1688 1908
1689Calls 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.
1690 1910
1691=item $ctx = $kernel->context 1911=item $ctx = $kernel->context
1692 1912
1693Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1913Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1694 1914
1695=item $program = $kernel->program 1915=item $program = $kernel->program
1696 1916
1697Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1917Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1698 1918
1699=for gengetinfo end kernel 1919=for gengetinfo end kernel
1700 1920
1701=item $packed_value = $kernel->work_group_info ($device, $name) 1921=item $packed_value = $kernel->work_group_info ($device, $name)
1702 1922
1703See C<< $platform->info >> for details. 1923See C<< $platform->info >> for details.
1704 1924
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> 1925L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1709 1926
1710=for gengetinfo begin kernel_work_group 1927=for gengetinfo begin kernel_work_group
1711 1928
1712=item $int = $kernel->work_group_size ($device) 1929=item $int = $kernel->work_group_size ($device)
1713 1930
1714Calls 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.
1715 1932
1716=item @ints = $kernel->compile_work_group_size ($device) 1933=item @ints = $kernel->compile_work_group_size ($device)
1717 1934
1718Calls 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.
1719 1936
1720=item $ulong = $kernel->local_mem_size ($device) 1937=item $ulong = $kernel->local_mem_size ($device)
1721 1938
1722Calls 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.
1723 1940
1724=item $int = $kernel->preferred_work_group_size_multiple ($device) 1941=item $int = $kernel->preferred_work_group_size_multiple ($device)
1725 1942
1726Calls 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.
1727 1944
1728=item $ulong = $kernel->private_mem_size ($device) 1945=item $ulong = $kernel->private_mem_size ($device)
1729 1946
1730Calls 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.
1731 1948
1732=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
1733 1980
1734=item $kernel->setf ($format, ...) 1981=item $kernel->setf ($format, ...)
1735 1982
1736Sets 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
1737way 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
… …
1849 2096
1850=for gengetinfo begin event 2097=for gengetinfo begin event
1851 2098
1852=item $queue = $event->command_queue 2099=item $queue = $event->command_queue
1853 2100
1854Calls 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.
1855 2102
1856=item $command_type = $event->command_type 2103=item $command_type = $event->command_type
1857 2104
1858Calls 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.
1859 2106
1860=item $uint = $event->reference_count 2107=item $uint = $event->reference_count
1861 2108
1862Calls 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.
1863 2110
1864=item $uint = $event->command_execution_status 2111=item $uint = $event->command_execution_status
1865 2112
1866Calls 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.
1867 2114
1868=item $ctx = $event->context 2115=item $ctx = $event->context
1869 2116
1870Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2117Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1871 2118
1872=for gengetinfo end event 2119=for gengetinfo end event
1873 2120
1874=item $packed_value = $ev->profiling_info ($name) 2121=item $packed_value = $ev->profiling_info ($name)
1875 2122
… …
1882 2129
1883=for gengetinfo begin profiling 2130=for gengetinfo begin profiling
1884 2131
1885=item $ulong = $event->profiling_command_queued 2132=item $ulong = $event->profiling_command_queued
1886 2133
1887Calls 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.
1888 2135
1889=item $ulong = $event->profiling_command_submit 2136=item $ulong = $event->profiling_command_submit
1890 2137
1891Calls 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.
1892 2139
1893=item $ulong = $event->profiling_command_start 2140=item $ulong = $event->profiling_command_start
1894 2141
1895Calls 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.
1896 2143
1897=item $ulong = $event->profiling_command_end 2144=item $ulong = $event->profiling_command_end
1898 2145
1899Calls 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.
1900 2147
1901=for gengetinfo end profiling 2148=for gengetinfo end profiling
1902 2149
1903=back 2150=back
1904 2151
… …
1911=item $ev->set_status ($execution_status) 2158=item $ev->set_status ($execution_status)
1912 2159
1913Sets 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,
1914either with OpenCL::COMPLETE or a negative number as status. 2161either with OpenCL::COMPLETE or a negative number as status.
1915 2162
2163execution_status: OpenCL::COMPLETE or a negative integer.
2164
1916L<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>
1917 2166
1918=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
1919 2269
1920=cut 2270=cut
1921 2271
19221; 22721;
1923 2273

Diff Legend

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