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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.68 by root, Tue May 1 22:25:13 2012 UTC vs.
Revision 1.75 by root, Sat May 5 02:30:27 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";
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
594 621
595=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
596 623
597Tries 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.
598 625
626type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
627OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
628
599L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 629L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
600 630
601=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 631=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
602 632
603Create a new OpenCL::Context object using the given device object(s). This 633Create a new OpenCL::Context object using the given device object(s). This
716 746
717=for gengetinfo begin platform 747=for gengetinfo begin platform
718 748
719=item $string = $platform->profile 749=item $string = $platform->profile
720 750
721Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 751Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
722 752
723=item $string = $platform->version 753=item $string = $platform->version
724 754
725Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 755Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
726 756
727=item $string = $platform->name 757=item $string = $platform->name
728 758
729Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 759Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
730 760
731=item $string = $platform->vendor 761=item $string = $platform->vendor
732 762
733Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 763Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
734 764
735=item $string = $platform->extensions 765=item $string = $platform->extensions
736 766
737Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 767Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
738 768
739=for gengetinfo end platform 769=for gengetinfo end platform
740 770
741=back 771=back
742 772
748 778
749See C<< $platform->info >> for details. 779See C<< $platform->info >> for details.
750 780
751L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 781L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
752 782
783=item @devices = $device->sub_devices (\@properties)
784
785Creates OpencL::SubDevice objects by partitioning an existing device.
786
787L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
788
753=for gengetinfo begin device 789=for gengetinfo begin device
754 790
755=item $device_type = $device->type 791=item $device_type = $device->type
756 792
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 793Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
758 794
759=item $uint = $device->vendor_id 795=item $uint = $device->vendor_id
760 796
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. 797Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
762 798
763=item $uint = $device->max_compute_units 799=item $uint = $device->max_compute_units
764 800
765Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. 801Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
766 802
767=item $uint = $device->max_work_item_dimensions 803=item $uint = $device->max_work_item_dimensions
768 804
769Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. 805Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
770 806
771=item $int = $device->max_work_group_size 807=item $int = $device->max_work_group_size
772 808
773Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. 809Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
774 810
775=item @ints = $device->max_work_item_sizes 811=item @ints = $device->max_work_item_sizes
776 812
777Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. 813Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
778 814
779=item $uint = $device->preferred_vector_width_char 815=item $uint = $device->preferred_vector_width_char
780 816
781Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. 817Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
782 818
783=item $uint = $device->preferred_vector_width_short 819=item $uint = $device->preferred_vector_width_short
784 820
785Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. 821Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
786 822
787=item $uint = $device->preferred_vector_width_int 823=item $uint = $device->preferred_vector_width_int
788 824
789Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. 825Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
790 826
791=item $uint = $device->preferred_vector_width_long 827=item $uint = $device->preferred_vector_width_long
792 828
793Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. 829Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
794 830
795=item $uint = $device->preferred_vector_width_float 831=item $uint = $device->preferred_vector_width_float
796 832
797Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. 833Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
798 834
799=item $uint = $device->preferred_vector_width_double 835=item $uint = $device->preferred_vector_width_double
800 836
801Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. 837Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
802 838
803=item $uint = $device->max_clock_frequency 839=item $uint = $device->max_clock_frequency
804 840
805Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. 841Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
806 842
807=item $bitfield = $device->address_bits 843=item $bitfield = $device->address_bits
808 844
809Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. 845Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
810 846
811=item $uint = $device->max_read_image_args 847=item $uint = $device->max_read_image_args
812 848
813Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. 849Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
814 850
815=item $uint = $device->max_write_image_args 851=item $uint = $device->max_write_image_args
816 852
817Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. 853Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
818 854
819=item $ulong = $device->max_mem_alloc_size 855=item $ulong = $device->max_mem_alloc_size
820 856
821Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. 857Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
822 858
823=item $int = $device->image2d_max_width 859=item $int = $device->image2d_max_width
824 860
825Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. 861Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
826 862
827=item $int = $device->image2d_max_height 863=item $int = $device->image2d_max_height
828 864
829Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. 865Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
830 866
831=item $int = $device->image3d_max_width 867=item $int = $device->image3d_max_width
832 868
833Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. 869Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
834 870
835=item $int = $device->image3d_max_height 871=item $int = $device->image3d_max_height
836 872
837Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. 873Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
838 874
839=item $int = $device->image3d_max_depth 875=item $int = $device->image3d_max_depth
840 876
841Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. 877Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
842 878
843=item $uint = $device->image_support 879=item $uint = $device->image_support
844 880
845Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. 881Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
846 882
847=item $int = $device->max_parameter_size 883=item $int = $device->max_parameter_size
848 884
849Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. 885Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
850 886
851=item $uint = $device->max_samplers 887=item $uint = $device->max_samplers
852 888
853Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. 889Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
854 890
855=item $uint = $device->mem_base_addr_align 891=item $uint = $device->mem_base_addr_align
856 892
857Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. 893Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
858 894
859=item $uint = $device->min_data_type_align_size 895=item $uint = $device->min_data_type_align_size
860 896
861Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. 897Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
862 898
863=item $device_fp_config = $device->single_fp_config 899=item $device_fp_config = $device->single_fp_config
864 900
865Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. 901Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
866 902
867=item $device_mem_cache_type = $device->global_mem_cache_type 903=item $device_mem_cache_type = $device->global_mem_cache_type
868 904
869Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. 905Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
870 906
871=item $uint = $device->global_mem_cacheline_size 907=item $uint = $device->global_mem_cacheline_size
872 908
873Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. 909Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
874 910
875=item $ulong = $device->global_mem_cache_size 911=item $ulong = $device->global_mem_cache_size
876 912
877Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. 913Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
878 914
879=item $ulong = $device->global_mem_size 915=item $ulong = $device->global_mem_size
880 916
881Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. 917Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
882 918
883=item $ulong = $device->max_constant_buffer_size 919=item $ulong = $device->max_constant_buffer_size
884 920
885Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. 921Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
886 922
887=item $uint = $device->max_constant_args 923=item $uint = $device->max_constant_args
888 924
889Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. 925Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
890 926
891=item $device_local_mem_type = $device->local_mem_type 927=item $device_local_mem_type = $device->local_mem_type
892 928
893Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. 929Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
894 930
895=item $ulong = $device->local_mem_size 931=item $ulong = $device->local_mem_size
896 932
897Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. 933Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
898 934
899=item $boolean = $device->error_correction_support 935=item $boolean = $device->error_correction_support
900 936
901Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. 937Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
902 938
903=item $int = $device->profiling_timer_resolution 939=item $int = $device->profiling_timer_resolution
904 940
905Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. 941Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
906 942
907=item $boolean = $device->endian_little 943=item $boolean = $device->endian_little
908 944
909Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. 945Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
910 946
911=item $boolean = $device->available 947=item $boolean = $device->available
912 948
913Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 949Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
914 950
915=item $boolean = $device->compiler_available 951=item $boolean = $device->compiler_available
916 952
917Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. 953Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
918 954
919=item $device_exec_capabilities = $device->execution_capabilities 955=item $device_exec_capabilities = $device->execution_capabilities
920 956
921Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. 957Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
922 958
923=item $command_queue_properties = $device->properties 959=item $command_queue_properties = $device->properties
924 960
925Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. 961Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
926 962
927=item $ = $device->platform 963=item $ = $device->platform
928 964
929Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 965Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
930 966
931=item $string = $device->name 967=item $string = $device->name
932 968
933Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 969Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
934 970
935=item $string = $device->vendor 971=item $string = $device->vendor
936 972
937Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 973Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
938 974
939=item $string = $device->driver_version 975=item $string = $device->driver_version
940 976
941Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 977Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
942 978
943=item $string = $device->profile 979=item $string = $device->profile
944 980
945Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 981Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
946 982
947=item $string = $device->version 983=item $string = $device->version
948 984
949Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 985Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
950 986
951=item $string = $device->extensions 987=item $string = $device->extensions
952 988
953Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 989Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
954 990
955=item $uint = $device->preferred_vector_width_half 991=item $uint = $device->preferred_vector_width_half
956 992
957Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. 993Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
958 994
959=item $uint = $device->native_vector_width_char 995=item $uint = $device->native_vector_width_char
960 996
961Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. 997Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
962 998
963=item $uint = $device->native_vector_width_short 999=item $uint = $device->native_vector_width_short
964 1000
965Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. 1001Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
966 1002
967=item $uint = $device->native_vector_width_int 1003=item $uint = $device->native_vector_width_int
968 1004
969Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. 1005Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
970 1006
971=item $uint = $device->native_vector_width_long 1007=item $uint = $device->native_vector_width_long
972 1008
973Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. 1009Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
974 1010
975=item $uint = $device->native_vector_width_float 1011=item $uint = $device->native_vector_width_float
976 1012
977Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. 1013Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
978 1014
979=item $uint = $device->native_vector_width_double 1015=item $uint = $device->native_vector_width_double
980 1016
981Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. 1017Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
982 1018
983=item $uint = $device->native_vector_width_half 1019=item $uint = $device->native_vector_width_half
984 1020
985Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. 1021Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
986 1022
987=item $device_fp_config = $device->double_fp_config 1023=item $device_fp_config = $device->double_fp_config
988 1024
989Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. 1025Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
990 1026
991=item $device_fp_config = $device->half_fp_config 1027=item $device_fp_config = $device->half_fp_config
992 1028
993Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. 1029Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
994 1030
995=item $boolean = $device->host_unified_memory 1031=item $boolean = $device->host_unified_memory
996 1032
997Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. 1033Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
998 1034
999=item $device = $device->parent_device_ext 1035=item $device = $device->parent_device_ext
1000 1036
1001Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. 1037Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
1002 1038
1003=item @device_partition_property_exts = $device->partition_types_ext 1039=item @device_partition_property_exts = $device->partition_types_ext
1004 1040
1005Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. 1041Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
1006 1042
1007=item @device_partition_property_exts = $device->affinity_domains_ext 1043=item @device_partition_property_exts = $device->affinity_domains_ext
1008 1044
1009Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 1045Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
1010 1046
1011=item $uint = $device->reference_count_ext 1047=item $uint = $device->reference_count_ext
1012 1048
1013Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. 1049Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
1014 1050
1015=item @device_partition_property_exts = $device->partition_style_ext 1051=item @device_partition_property_exts = $device->partition_style_ext
1016 1052
1017Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 1053Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
1018 1054
1019=for gengetinfo end device 1055=for gengetinfo end device
1020 1056
1021=back 1057=back
1022 1058
1023=head2 THE OpenCL::Context CLASS 1059=head2 THE OpenCL::Context CLASS
1060
1061An OpenCL::Context is basically a container, or manager, for a number of
1062devices of a platform. It is used to create all sorts of secondary objects
1063such as buffers, queues, programs and so on.
1064
1065All context creation functions and methods take a list of properties
1066(type-value pairs). All property values can be specified as integers -
1067some additionally support other types:
1068
1069=over 4
1070
1071=item OpenCL::CONTEXT_PLATFORM
1072
1073Also accepts OpenCL::Platform objects.
1074
1075=item OpenCL::GLX_DISPLAY_KHR
1076
1077Also accepts C<undef>, in which case a deep and troubling hack is engaged
1078to find the current glx display (see L<GLX SUPPORT>).
1079
1080=item OpenCL::GL_CONTEXT_KHR
1081
1082Also accepts C<undef>, in which case a deep and troubling hack is engaged
1083to find the current glx context (see L<GLX SUPPORT>).
1084
1085=back
1024 1086
1025=over 4 1087=over 4
1026 1088
1027=item $prog = $ctx->build_program ($program, $options = "") 1089=item $prog = $ctx->build_program ($program, $options = "")
1028 1090
1076=item $buf = $ctx->buffer ($flags, $len) 1138=item $buf = $ctx->buffer ($flags, $len)
1077 1139
1078Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1140Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1079given flags and octet-size. 1141given flags and octet-size.
1080 1142
1143flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
1144OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
1145OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
1146
1081L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1147L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1082 1148
1083=item $buf = $ctx->buffer_sv ($flags, $data) 1149=item $buf = $ctx->buffer_sv ($flags, $data)
1084 1150
1085Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1151Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1088=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) 1154=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)
1089 1155
1090Creates a new OpenCL::Image object and optionally initialises it with 1156Creates a new OpenCL::Image object and optionally initialises it with
1091the given data values. 1157the given data values.
1092 1158
1159channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
1160OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
1161OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
1162
1163channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
1164OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1165OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1166OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1167OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1168
1169
1170type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1171OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1172OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1173OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1174
1093L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> 1175L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1094 1176
1095=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1177=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1096 1178
1097Creates a new OpenCL::Image2D object and optionally initialises it with 1179Creates a new OpenCL::Image2D object and optionally initialises it with
1109=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1191=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1110 1192
1111Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 1193Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1112OpenGL buffer object. 1194OpenGL buffer object.
1113 1195
1196flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1197
1114http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 1198http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1115 1199
1116=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1200=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1117 1201
1118Creates a new OpenCL::Image object that refers to the given OpenGL 1202Creates a new OpenCL::Image object that refers to the given OpenGL
1119texture object or buffer. 1203texture object or buffer.
1120 1204
1205target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
1206GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
1207GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
1208GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
1209GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
1210GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
1211
1121http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html 1212http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1122 1213
1123=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1214=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1124 1215
1125Creates a new OpenCL::Image2D object that refers to the given OpenGL 1216Creates a new OpenCL::Image2D object that refers to the given OpenGL
1150 1241
1151=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1242=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1152 1243
1153Creates a new OpenCL::Sampler object. 1244Creates a new OpenCL::Sampler object.
1154 1245
1246addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
1247OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
1248
1249filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
1250
1155L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> 1251L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1156 1252
1157=item $program = $ctx->program_with_source ($string) 1253=item $program = $ctx->program_with_source ($string)
1158 1254
1159Creates a new OpenCL::Program object from the given source code. 1255Creates a new OpenCL::Program object from the given source code.
1160 1256
1161L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 1257L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1162 1258
1259=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
1260
1261Creates a new OpenCL::Program object from the given binaries.
1262
1263L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
1264
1265Example: clone an existing program object that contains a successfully
1266compiled program, no matter how useless this is.
1267
1268 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
1269
1270=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1271
1272Creates a new OpenCL::Program object from the given built-in kernel names.
1273
1274L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1275
1276=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
1277
1278Links all (already compiled) program objects specified in C<@programs>
1279together and returns a new OpenCL::Program object with the result.
1280
1281L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
1282
1163=item $packed_value = $ctx->info ($name) 1283=item $packed_value = $ctx->info ($name)
1164 1284
1165See C<< $platform->info >> for details. 1285See C<< $platform->info >> for details.
1166 1286
1167L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 1287L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1168 1288
1169=for gengetinfo begin context 1289=for gengetinfo begin context
1170 1290
1171=item $uint = $context->reference_count 1291=item $uint = $context->reference_count
1172 1292
1173Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. 1293Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1174 1294
1175=item @devices = $context->devices 1295=item @devices = $context->devices
1176 1296
1177Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1297Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1178 1298
1179=item @property_ints = $context->properties 1299=item @property_ints = $context->properties
1180 1300
1181Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1301Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1182 1302
1183=item $uint = $context->num_devices 1303=item $uint = $context->num_devices
1184 1304
1185Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. 1305Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1186 1306
1187=for gengetinfo end context 1307=for gengetinfo end context
1188 1308
1189=back 1309=back
1190 1310
1306reference to an array of local work sizes, with the same number of 1426reference to an array of local work sizes, with the same number of
1307elements as \@global_work_size. 1427elements as \@global_work_size.
1308 1428
1309L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1429L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1310 1430
1431=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
1432
1433Migrates a number of OpenCL::Memory objects to or from the device.
1434
1435flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
1436
1437L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
1438
1311=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1439=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1312 1440
1313Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1441Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1314for subsequent OpenCL usage. 1442for subsequent OpenCL usage.
1315 1443
1350 1478
1351=for gengetinfo begin command_queue 1479=for gengetinfo begin command_queue
1352 1480
1353=item $ctx = $command_queue->context 1481=item $ctx = $command_queue->context
1354 1482
1355Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1483Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1356 1484
1357=item $device = $command_queue->device 1485=item $device = $command_queue->device
1358 1486
1359Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1487Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1360 1488
1361=item $uint = $command_queue->reference_count 1489=item $uint = $command_queue->reference_count
1362 1490
1363Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. 1491Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1364 1492
1365=item $command_queue_properties = $command_queue->properties 1493=item $command_queue_properties = $command_queue->properties
1366 1494
1367Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1495Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1368 1496
1369=for gengetinfo end command_queue 1497=for gengetinfo end command_queue
1370 1498
1371=back 1499=back
1372 1500
1374 1502
1375OpenCL allows you to map buffers and images to host memory (read: perl 1503OpenCL allows you to map buffers and images to host memory (read: perl
1376scalars). This is done much like reading or copying a buffer, by enqueuing 1504scalars). This is done much like reading or copying a buffer, by enqueuing
1377a map or unmap operation on the command queue. 1505a map or unmap operation on the command queue.
1378 1506
1379The map operations return a C<OpenCL::Mapped> object - see L<THE 1507The map operations return an C<OpenCL::Mapped> object - see L<THE
1380OpenCL::Mapped CLASS> section for details on what to do with these 1508OpenCL::Mapped CLASS> section for details on what to do with these
1381objects. 1509objects.
1382 1510
1383The object will be unmapped automatically when the mapped object is 1511The object will be unmapped automatically when the mapped object is
1384destroyed (you can use a barrier to make sure the unmap has finished, 1512destroyed (you can use a barrier to make sure the unmap has finished,
1385before using the buffer in a kernel), but you can also enqueue an unmap 1513before using the buffer in a kernel), but you can also enqueue an unmap
1386operation manually. 1514operation manually.
1387 1515
1388=over 4 1516=over 4
1389 1517
1390=item $mapped_buffer = $queue->map_buffer ($buf, $data, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=0, $wait_events...) 1518=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
1391 1519
1392Maps the given buffer into host memory and returns a C<OpenCL::MappedBuffer> object. 1520Maps the given buffer into host memory and returns an
1521C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1522the map will extend to the end of the buffer.
1523
1524map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1393 1525
1394L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html> 1526L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1395 1527
1528Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1529
1530 {
1531 my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
1532 substr $$mapped, 0, 4, "abcd";
1533 } # asynchronously unmap because $mapped is destroyed
1534
1396=item $mapped_image = $queue->map_image ($img, $data, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=0, $height=0, $depth=0, $wait_events...) 1535=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...)
1397 1536
1398Maps the given image area into host memory and return a 1537Maps the given image area into host memory and return an
1399C<OpenCL::MappedImage> object. Although there are default values for most 1538C<OpenCL::MappedImage> object.
1400arguments, you currently have to specify all arguments, otherwise the call 1539
1401will fail. 1540If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
1541will be replaced by the maximum possible value.
1402 1542
1403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html> 1543L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
1544
1545Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
1546the first channel of the leftmost column to 5, then explicitly unmap
1547it. You are not necessarily meant to do it this way, this example just
1548shows you the accessors to use :)
1549
1550 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
1551
1552 $mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
1553 for 0..$image->height;
1554
1555 $mapped->unmap;.
1556 $mapped->wait; # only needed for out of order queues normally
1404 1557
1405=item $ev = $queue->unmap ($mapped, $wait_events...) 1558=item $ev = $queue->unmap ($mapped, $wait_events...)
1406 1559
1407Unmaps the data from host memory. You must not call any methods that 1560Unmaps the data from host memory. You must not call any methods that
1408modify the data, or modify the data scalar directly, after calling this 1561modify the data, or modify the data scalar directly, after calling this
1429 1582
1430=for gengetinfo begin mem 1583=for gengetinfo begin mem
1431 1584
1432=item $mem_object_type = $mem->type 1585=item $mem_object_type = $mem->type
1433 1586
1434Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1587Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1435 1588
1436=item $mem_flags = $mem->flags 1589=item $mem_flags = $mem->flags
1437 1590
1438Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1591Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1439 1592
1440=item $int = $mem->size 1593=item $int = $mem->size
1441 1594
1442Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1595Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1443 1596
1444=item $ptr_value = $mem->host_ptr 1597=item $ptr_value = $mem->host_ptr
1445 1598
1446Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. 1599Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1447 1600
1448=item $uint = $mem->map_count 1601=item $uint = $mem->map_count
1449 1602
1450Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. 1603Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1451 1604
1452=item $uint = $mem->reference_count 1605=item $uint = $mem->reference_count
1453 1606
1454Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. 1607Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1455 1608
1456=item $ctx = $mem->context 1609=item $ctx = $mem->context
1457 1610
1458Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1611Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1459 1612
1460=item $mem = $mem->associated_memobject 1613=item $mem = $mem->associated_memobject
1461 1614
1462Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. 1615Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1463 1616
1464=item $int = $mem->offset 1617=item $int = $mem->offset
1465 1618
1466Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1619Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1467 1620
1468=for gengetinfo end mem 1621=for gengetinfo end mem
1469 1622
1470=item ($type, $name) = $mem->gl_object_info 1623=item ($type, $name) = $mem->gl_object_info
1471 1624
1523 1676
1524=for gengetinfo begin image 1677=for gengetinfo begin image
1525 1678
1526=item $int = $image->element_size 1679=item $int = $image->element_size
1527 1680
1528Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1681Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1529 1682
1530=item $int = $image->row_pitch 1683=item $int = $image->row_pitch
1531 1684
1532Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. 1685Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1533 1686
1534=item $int = $image->slice_pitch 1687=item $int = $image->slice_pitch
1535 1688
1536Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. 1689Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1537 1690
1538=item $int = $image->width 1691=item $int = $image->width
1539 1692
1540Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1693Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1541 1694
1542=item $int = $image->height 1695=item $int = $image->height
1543 1696
1544Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1697Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1545 1698
1546=item $int = $image->depth 1699=item $int = $image->depth
1547 1700
1548Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1701Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1549 1702
1550=for gengetinfo end image 1703=for gengetinfo end image
1551 1704
1552=for gengetinfo begin gl_texture 1705=for gengetinfo begin gl_texture
1553 1706
1554=item $GLenum = $gl_texture->target 1707=item $GLenum = $gl_texture->target
1555 1708
1556Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. 1709Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1557 1710
1558=item $GLint = $gl_texture->gl_mipmap_level 1711=item $GLint = $gl_texture->gl_mipmap_level
1559 1712
1560Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. 1713Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1561 1714
1562=for gengetinfo end gl_texture 1715=for gengetinfo end gl_texture
1563 1716
1564=back 1717=back
1565 1718
1575 1728
1576=for gengetinfo begin sampler 1729=for gengetinfo begin sampler
1577 1730
1578=item $uint = $sampler->reference_count 1731=item $uint = $sampler->reference_count
1579 1732
1580Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. 1733Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1581 1734
1582=item $ctx = $sampler->context 1735=item $ctx = $sampler->context
1583 1736
1584Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1737Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1585 1738
1586=item $addressing_mode = $sampler->normalized_coords 1739=item $addressing_mode = $sampler->normalized_coords
1587 1740
1588Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. 1741Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1589 1742
1590=item $filter_mode = $sampler->addressing_mode 1743=item $filter_mode = $sampler->addressing_mode
1591 1744
1592Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. 1745Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1593 1746
1594=item $boolean = $sampler->filter_mode 1747=item $boolean = $sampler->filter_mode
1595 1748
1596Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. 1749Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1597 1750
1598=for gengetinfo end sampler 1751=for gengetinfo end sampler
1599 1752
1600=back 1753=back
1601 1754
1619not so. So best make sure you don't pass in invalid values. 1772not so. So best make sure you don't pass in invalid values.
1620 1773
1621Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1774Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1622compilation state is successful but some later stage fails. 1775compilation state is successful but some later stage fails.
1623 1776
1777options: C<-D name>, C<-D name=definition>, C<-I dir>,
1778C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
1779C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
1780C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1781C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1782C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1783C<-create-library>, C<-enable-link-options>.
1784
1785build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
1786OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1787
1624L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1788L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1625 1789
1626=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1790=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1627 1791
1628Similar to C<< ->build >>, except it starts a thread, and never fails (you 1792Similar to C<< ->build >>, except it starts a thread, and never fails (you
1629need to check the compilation status form the callback, or by polling). 1793need to check the compilation status form the callback, or by polling).
1630 1794
1795=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1796
1797Compiles the given program for the given devices (or all devices if
1798undef). If C<$headers> is given, it must be a hashref with include name =>
1799OpenCL::Program pairs.
1800
1801L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1802
1631=item $packed_value = $program->build_info ($device, $name) 1803=item $packed_value = $program->build_info ($device, $name)
1632 1804
1633Similar to C<< $platform->info >>, but returns build info for a previous 1805Similar to C<< $platform->info >>, but returns build info for a previous
1634build attempt for the given device. 1806build attempt for the given device.
1635 1807
1650 1822
1651=for gengetinfo begin program_build 1823=for gengetinfo begin program_build
1652 1824
1653=item $build_status = $program->build_status ($device) 1825=item $build_status = $program->build_status ($device)
1654 1826
1655Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. 1827Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1656 1828
1657=item $string = $program->build_options ($device) 1829=item $string = $program->build_options ($device)
1658 1830
1659Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. 1831Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1660 1832
1661=item $string = $program->build_log ($device) 1833=item $string = $program->build_log ($device)
1662 1834
1663Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. 1835Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1664 1836
1665=for gengetinfo end program_build 1837=for gengetinfo end program_build
1666 1838
1667=item $packed_value = $program->info ($name) 1839=item $packed_value = $program->info ($name)
1668 1840
1672 1844
1673=for gengetinfo begin program 1845=for gengetinfo begin program
1674 1846
1675=item $uint = $program->reference_count 1847=item $uint = $program->reference_count
1676 1848
1677Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. 1849Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1678 1850
1679=item $ctx = $program->context 1851=item $ctx = $program->context
1680 1852
1681Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1853Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1682 1854
1683=item $uint = $program->num_devices 1855=item $uint = $program->num_devices
1684 1856
1685Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. 1857Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1686 1858
1687=item @devices = $program->devices 1859=item @devices = $program->devices
1688 1860
1689Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1861Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1690 1862
1691=item $string = $program->source 1863=item $string = $program->source
1692 1864
1693Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1865Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1694 1866
1695=item @ints = $program->binary_sizes 1867=item @ints = $program->binary_sizes
1696 1868
1697Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. 1869Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1698 1870
1699=for gengetinfo end program 1871=for gengetinfo end program
1700 1872
1701=item @blobs = $program->binaries 1873=item @blobs = $program->binaries
1702 1874
1723 1895
1724=for gengetinfo begin kernel 1896=for gengetinfo begin kernel
1725 1897
1726=item $string = $kernel->function_name 1898=item $string = $kernel->function_name
1727 1899
1728Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. 1900Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1729 1901
1730=item $uint = $kernel->num_args 1902=item $uint = $kernel->num_args
1731 1903
1732Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. 1904Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1733 1905
1734=item $uint = $kernel->reference_count 1906=item $uint = $kernel->reference_count
1735 1907
1736Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. 1908Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1737 1909
1738=item $ctx = $kernel->context 1910=item $ctx = $kernel->context
1739 1911
1740Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1912Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1741 1913
1742=item $program = $kernel->program 1914=item $program = $kernel->program
1743 1915
1744Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1916Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1745 1917
1746=for gengetinfo end kernel 1918=for gengetinfo end kernel
1747 1919
1748=item $packed_value = $kernel->work_group_info ($device, $name) 1920=item $packed_value = $kernel->work_group_info ($device, $name)
1749 1921
1750See C<< $platform->info >> for details. 1922See C<< $platform->info >> for details.
1751 1923
1752The reason this method is not called C<info> is that there already is an
1753C<< ->info >> method.
1754
1755L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> 1924L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1756 1925
1757=for gengetinfo begin kernel_work_group 1926=for gengetinfo begin kernel_work_group
1758 1927
1759=item $int = $kernel->work_group_size ($device) 1928=item $int = $kernel->work_group_size ($device)
1760 1929
1761Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. 1930Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1762 1931
1763=item @ints = $kernel->compile_work_group_size ($device) 1932=item @ints = $kernel->compile_work_group_size ($device)
1764 1933
1765Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. 1934Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1766 1935
1767=item $ulong = $kernel->local_mem_size ($device) 1936=item $ulong = $kernel->local_mem_size ($device)
1768 1937
1769Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. 1938Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1770 1939
1771=item $int = $kernel->preferred_work_group_size_multiple ($device) 1940=item $int = $kernel->preferred_work_group_size_multiple ($device)
1772 1941
1773Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. 1942Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1774 1943
1775=item $ulong = $kernel->private_mem_size ($device) 1944=item $ulong = $kernel->private_mem_size ($device)
1776 1945
1777Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. 1946Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1778 1947
1779=for gengetinfo end kernel_work_group 1948=for gengetinfo end kernel_work_group
1949
1950=item $packed_value = $kernel->arg_info ($idx, $name)
1951
1952See C<< $platform->info >> for details.
1953
1954L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
1955
1956=for gengetinfo begin kernel_arg
1957
1958=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
1959
1960Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
1961
1962=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
1963
1964Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
1965
1966=item $string = $kernel->arg_type_name ($idx)
1967
1968Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
1969
1970=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
1971
1972Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
1973
1974=item $string = $kernel->arg_name ($idx)
1975
1976Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
1977
1978=for gengetinfo end kernel_arg
1780 1979
1781=item $kernel->setf ($format, ...) 1980=item $kernel->setf ($format, ...)
1782 1981
1783Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic 1982Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1784way to set arguments (and with OpenCL 1.2 it might be rather slow), you 1983way to set arguments (and with OpenCL 1.2 it might be rather slow), you
1896 2095
1897=for gengetinfo begin event 2096=for gengetinfo begin event
1898 2097
1899=item $queue = $event->command_queue 2098=item $queue = $event->command_queue
1900 2099
1901Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. 2100Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1902 2101
1903=item $command_type = $event->command_type 2102=item $command_type = $event->command_type
1904 2103
1905Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. 2104Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1906 2105
1907=item $uint = $event->reference_count 2106=item $uint = $event->reference_count
1908 2107
1909Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. 2108Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1910 2109
1911=item $uint = $event->command_execution_status 2110=item $uint = $event->command_execution_status
1912 2111
1913Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. 2112Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1914 2113
1915=item $ctx = $event->context 2114=item $ctx = $event->context
1916 2115
1917Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2116Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1918 2117
1919=for gengetinfo end event 2118=for gengetinfo end event
1920 2119
1921=item $packed_value = $ev->profiling_info ($name) 2120=item $packed_value = $ev->profiling_info ($name)
1922 2121
1929 2128
1930=for gengetinfo begin profiling 2129=for gengetinfo begin profiling
1931 2130
1932=item $ulong = $event->profiling_command_queued 2131=item $ulong = $event->profiling_command_queued
1933 2132
1934Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. 2133Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1935 2134
1936=item $ulong = $event->profiling_command_submit 2135=item $ulong = $event->profiling_command_submit
1937 2136
1938Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. 2137Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1939 2138
1940=item $ulong = $event->profiling_command_start 2139=item $ulong = $event->profiling_command_start
1941 2140
1942Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. 2141Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1943 2142
1944=item $ulong = $event->profiling_command_end 2143=item $ulong = $event->profiling_command_end
1945 2144
1946Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. 2145Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1947 2146
1948=for gengetinfo end profiling 2147=for gengetinfo end profiling
1949 2148
1950=back 2149=back
1951 2150
1957 2156
1958=item $ev->set_status ($execution_status) 2157=item $ev->set_status ($execution_status)
1959 2158
1960Sets the execution status of the user event. Can only be called once, 2159Sets the execution status of the user event. Can only be called once,
1961either with OpenCL::COMPLETE or a negative number as status. 2160either with OpenCL::COMPLETE or a negative number as status.
2161
2162execution_status: OpenCL::COMPLETE or a negative integer.
1962 2163
1963L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2164L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1964 2165
1965=back 2166=back
1966 2167

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines