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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.70 by root, Thu May 3 23:32:47 2012 UTC vs.
Revision 1.71 by root, Fri May 4 14:29:35 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
… …
544 @OpenCL::Sampler::ISA = 562 @OpenCL::Sampler::ISA =
545 @OpenCL::Program::ISA = 563 @OpenCL::Program::ISA =
546 @OpenCL::Kernel::ISA = 564 @OpenCL::Kernel::ISA =
547 @OpenCL::Event::ISA = OpenCL::Object::; 565 @OpenCL::Event::ISA = OpenCL::Object::;
548 566
567 @OpenCL::SubDevice::ISA = OpenCL::Device::;
568
549 @OpenCL::Buffer::ISA = 569 @OpenCL::Buffer::ISA =
550 @OpenCL::Image::ISA = OpenCL::Memory::; 570 @OpenCL::Image::ISA = OpenCL::Memory::;
551 571
552 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 572 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
553 573
… …
594 614
595=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr 615=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
596 616
597Tries to create a context from a default device and platform type - never worked for me. 617Tries to create a context from a default device and platform type - never worked for me.
598 618
619type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
620OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
621
599L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 622L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
600 623
601=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 624=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
602 625
603Create a new OpenCL::Context object using the given device object(s). This 626Create a new OpenCL::Context object using the given device object(s). This
… …
716 739
717=for gengetinfo begin platform 740=for gengetinfo begin platform
718 741
719=item $string = $platform->profile 742=item $string = $platform->profile
720 743
721Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 744Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
722 745
723=item $string = $platform->version 746=item $string = $platform->version
724 747
725Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 748Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
726 749
727=item $string = $platform->name 750=item $string = $platform->name
728 751
729Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 752Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
730 753
731=item $string = $platform->vendor 754=item $string = $platform->vendor
732 755
733Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 756Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
734 757
735=item $string = $platform->extensions 758=item $string = $platform->extensions
736 759
737Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 760Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
738 761
739=for gengetinfo end platform 762=for gengetinfo end platform
740 763
741=back 764=back
742 765
… …
748 771
749See C<< $platform->info >> for details. 772See C<< $platform->info >> for details.
750 773
751L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 774L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
752 775
776=item @devices = $device->sub_devices (\@properties)
777
778Creates OpencL::SubDevice objects by partitioning an existing device.
779
780L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
781
753=for gengetinfo begin device 782=for gengetinfo begin device
754 783
755=item $device_type = $device->type 784=item $device_type = $device->type
756 785
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 786Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
758 787
759=item $uint = $device->vendor_id 788=item $uint = $device->vendor_id
760 789
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. 790Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
762 791
763=item $uint = $device->max_compute_units 792=item $uint = $device->max_compute_units
764 793
765Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. 794Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
766 795
767=item $uint = $device->max_work_item_dimensions 796=item $uint = $device->max_work_item_dimensions
768 797
769Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. 798Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
770 799
771=item $int = $device->max_work_group_size 800=item $int = $device->max_work_group_size
772 801
773Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. 802Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
774 803
775=item @ints = $device->max_work_item_sizes 804=item @ints = $device->max_work_item_sizes
776 805
777Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. 806Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
778 807
779=item $uint = $device->preferred_vector_width_char 808=item $uint = $device->preferred_vector_width_char
780 809
781Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. 810Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
782 811
783=item $uint = $device->preferred_vector_width_short 812=item $uint = $device->preferred_vector_width_short
784 813
785Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. 814Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
786 815
787=item $uint = $device->preferred_vector_width_int 816=item $uint = $device->preferred_vector_width_int
788 817
789Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. 818Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
790 819
791=item $uint = $device->preferred_vector_width_long 820=item $uint = $device->preferred_vector_width_long
792 821
793Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. 822Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
794 823
795=item $uint = $device->preferred_vector_width_float 824=item $uint = $device->preferred_vector_width_float
796 825
797Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. 826Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
798 827
799=item $uint = $device->preferred_vector_width_double 828=item $uint = $device->preferred_vector_width_double
800 829
801Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. 830Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
802 831
803=item $uint = $device->max_clock_frequency 832=item $uint = $device->max_clock_frequency
804 833
805Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. 834Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
806 835
807=item $bitfield = $device->address_bits 836=item $bitfield = $device->address_bits
808 837
809Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. 838Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
810 839
811=item $uint = $device->max_read_image_args 840=item $uint = $device->max_read_image_args
812 841
813Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. 842Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
814 843
815=item $uint = $device->max_write_image_args 844=item $uint = $device->max_write_image_args
816 845
817Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. 846Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
818 847
819=item $ulong = $device->max_mem_alloc_size 848=item $ulong = $device->max_mem_alloc_size
820 849
821Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. 850Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
822 851
823=item $int = $device->image2d_max_width 852=item $int = $device->image2d_max_width
824 853
825Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. 854Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
826 855
827=item $int = $device->image2d_max_height 856=item $int = $device->image2d_max_height
828 857
829Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. 858Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
830 859
831=item $int = $device->image3d_max_width 860=item $int = $device->image3d_max_width
832 861
833Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. 862Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
834 863
835=item $int = $device->image3d_max_height 864=item $int = $device->image3d_max_height
836 865
837Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. 866Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
838 867
839=item $int = $device->image3d_max_depth 868=item $int = $device->image3d_max_depth
840 869
841Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. 870Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
842 871
843=item $uint = $device->image_support 872=item $uint = $device->image_support
844 873
845Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. 874Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
846 875
847=item $int = $device->max_parameter_size 876=item $int = $device->max_parameter_size
848 877
849Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. 878Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
850 879
851=item $uint = $device->max_samplers 880=item $uint = $device->max_samplers
852 881
853Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. 882Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
854 883
855=item $uint = $device->mem_base_addr_align 884=item $uint = $device->mem_base_addr_align
856 885
857Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. 886Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
858 887
859=item $uint = $device->min_data_type_align_size 888=item $uint = $device->min_data_type_align_size
860 889
861Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. 890Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
862 891
863=item $device_fp_config = $device->single_fp_config 892=item $device_fp_config = $device->single_fp_config
864 893
865Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. 894Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
866 895
867=item $device_mem_cache_type = $device->global_mem_cache_type 896=item $device_mem_cache_type = $device->global_mem_cache_type
868 897
869Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. 898Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
870 899
871=item $uint = $device->global_mem_cacheline_size 900=item $uint = $device->global_mem_cacheline_size
872 901
873Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. 902Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
874 903
875=item $ulong = $device->global_mem_cache_size 904=item $ulong = $device->global_mem_cache_size
876 905
877Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. 906Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
878 907
879=item $ulong = $device->global_mem_size 908=item $ulong = $device->global_mem_size
880 909
881Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. 910Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
882 911
883=item $ulong = $device->max_constant_buffer_size 912=item $ulong = $device->max_constant_buffer_size
884 913
885Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. 914Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
886 915
887=item $uint = $device->max_constant_args 916=item $uint = $device->max_constant_args
888 917
889Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. 918Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
890 919
891=item $device_local_mem_type = $device->local_mem_type 920=item $device_local_mem_type = $device->local_mem_type
892 921
893Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. 922Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
894 923
895=item $ulong = $device->local_mem_size 924=item $ulong = $device->local_mem_size
896 925
897Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. 926Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
898 927
899=item $boolean = $device->error_correction_support 928=item $boolean = $device->error_correction_support
900 929
901Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. 930Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
902 931
903=item $int = $device->profiling_timer_resolution 932=item $int = $device->profiling_timer_resolution
904 933
905Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. 934Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
906 935
907=item $boolean = $device->endian_little 936=item $boolean = $device->endian_little
908 937
909Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. 938Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
910 939
911=item $boolean = $device->available 940=item $boolean = $device->available
912 941
913Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 942Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
914 943
915=item $boolean = $device->compiler_available 944=item $boolean = $device->compiler_available
916 945
917Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. 946Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
918 947
919=item $device_exec_capabilities = $device->execution_capabilities 948=item $device_exec_capabilities = $device->execution_capabilities
920 949
921Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. 950Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
922 951
923=item $command_queue_properties = $device->properties 952=item $command_queue_properties = $device->properties
924 953
925Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. 954Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
926 955
927=item $ = $device->platform 956=item $ = $device->platform
928 957
929Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 958Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
930 959
931=item $string = $device->name 960=item $string = $device->name
932 961
933Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 962Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
934 963
935=item $string = $device->vendor 964=item $string = $device->vendor
936 965
937Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 966Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
938 967
939=item $string = $device->driver_version 968=item $string = $device->driver_version
940 969
941Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 970Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
942 971
943=item $string = $device->profile 972=item $string = $device->profile
944 973
945Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 974Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
946 975
947=item $string = $device->version 976=item $string = $device->version
948 977
949Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 978Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
950 979
951=item $string = $device->extensions 980=item $string = $device->extensions
952 981
953Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 982Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
954 983
955=item $uint = $device->preferred_vector_width_half 984=item $uint = $device->preferred_vector_width_half
956 985
957Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. 986Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
958 987
959=item $uint = $device->native_vector_width_char 988=item $uint = $device->native_vector_width_char
960 989
961Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. 990Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
962 991
963=item $uint = $device->native_vector_width_short 992=item $uint = $device->native_vector_width_short
964 993
965Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. 994Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
966 995
967=item $uint = $device->native_vector_width_int 996=item $uint = $device->native_vector_width_int
968 997
969Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. 998Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
970 999
971=item $uint = $device->native_vector_width_long 1000=item $uint = $device->native_vector_width_long
972 1001
973Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. 1002Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
974 1003
975=item $uint = $device->native_vector_width_float 1004=item $uint = $device->native_vector_width_float
976 1005
977Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. 1006Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
978 1007
979=item $uint = $device->native_vector_width_double 1008=item $uint = $device->native_vector_width_double
980 1009
981Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. 1010Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
982 1011
983=item $uint = $device->native_vector_width_half 1012=item $uint = $device->native_vector_width_half
984 1013
985Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. 1014Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
986 1015
987=item $device_fp_config = $device->double_fp_config 1016=item $device_fp_config = $device->double_fp_config
988 1017
989Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. 1018Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
990 1019
991=item $device_fp_config = $device->half_fp_config 1020=item $device_fp_config = $device->half_fp_config
992 1021
993Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. 1022Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
994 1023
995=item $boolean = $device->host_unified_memory 1024=item $boolean = $device->host_unified_memory
996 1025
997Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. 1026Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
998 1027
999=item $device = $device->parent_device_ext 1028=item $device = $device->parent_device_ext
1000 1029
1001Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. 1030Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
1002 1031
1003=item @device_partition_property_exts = $device->partition_types_ext 1032=item @device_partition_property_exts = $device->partition_types_ext
1004 1033
1005Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. 1034Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
1006 1035
1007=item @device_partition_property_exts = $device->affinity_domains_ext 1036=item @device_partition_property_exts = $device->affinity_domains_ext
1008 1037
1009Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 1038Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
1010 1039
1011=item $uint = $device->reference_count_ext 1040=item $uint = $device->reference_count_ext
1012 1041
1013Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. 1042Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
1014 1043
1015=item @device_partition_property_exts = $device->partition_style_ext 1044=item @device_partition_property_exts = $device->partition_style_ext
1016 1045
1017Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 1046Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
1018 1047
1019=for gengetinfo end device 1048=for gengetinfo end device
1020 1049
1021=back 1050=back
1022 1051
1023=head2 THE OpenCL::Context CLASS 1052=head2 THE OpenCL::Context CLASS
1053
1054An OpenCL::Context is basically a container, or manager, for a number of
1055devices of a platform. It is used to create all sorts of secondary objects
1056such as buffers, queues, programs and so on.
1057
1058All context creation functions and methods take a list of properties
1059(type-value pairs). All property values can be specified as integers -
1060some additionally support other types:
1061
1062=over 4
1063
1064=item OpenCL::CONTEXT_PLATFORM
1065
1066Also accepts OpenCL::Platform objects.
1067
1068=item OpenCL::GLX_DISPLAY_KHR
1069
1070Also accepts C<undef>, in which case a deep and troubling hack is engaged
1071to find the current glx display (see L<GLX SUPPORT>).
1072
1073=item OpenCL::GL_CONTEXT_KHR
1074
1075Also accepts C<undef>, in which case a deep and troubling hack is engaged
1076to find the current glx context (see L<GLX SUPPORT>).
1077
1078=back
1024 1079
1025=over 4 1080=over 4
1026 1081
1027=item $prog = $ctx->build_program ($program, $options = "") 1082=item $prog = $ctx->build_program ($program, $options = "")
1028 1083
… …
1076=item $buf = $ctx->buffer ($flags, $len) 1131=item $buf = $ctx->buffer ($flags, $len)
1077 1132
1078Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1133Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1079given flags and octet-size. 1134given flags and octet-size.
1080 1135
1136flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
1137OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
1138OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
1139
1081L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1140L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1082 1141
1083=item $buf = $ctx->buffer_sv ($flags, $data) 1142=item $buf = $ctx->buffer_sv ($flags, $data)
1084 1143
1085Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1144Creates 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) 1147=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 1148
1090Creates a new OpenCL::Image object and optionally initialises it with 1149Creates a new OpenCL::Image object and optionally initialises it with
1091the given data values. 1150the given data values.
1092 1151
1152channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
1153OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
1154OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
1155
1156channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
1157OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1158OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1159OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1160OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1161
1162
1163type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1164OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1165OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1166OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1167
1093L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> 1168L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1094 1169
1095=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1170=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1096 1171
1097Creates a new OpenCL::Image2D object and optionally initialises it with 1172Creates a new OpenCL::Image2D object and optionally initialises it with
… …
1109=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1184=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1110 1185
1111Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 1186Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1112OpenGL buffer object. 1187OpenGL buffer object.
1113 1188
1189flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1190
1114http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 1191http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1115 1192
1116=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1193=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1117 1194
1118Creates a new OpenCL::Image object that refers to the given OpenGL 1195Creates a new OpenCL::Image object that refers to the given OpenGL
1119texture object or buffer. 1196texture object or buffer.
1120 1197
1198target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
1199GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
1200GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
1201GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
1202GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
1203GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
1204
1121http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html 1205http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1122 1206
1123=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1207=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1124 1208
1125Creates a new OpenCL::Image2D object that refers to the given OpenGL 1209Creates a new OpenCL::Image2D object that refers to the given OpenGL
… …
1150 1234
1151=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1235=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1152 1236
1153Creates a new OpenCL::Sampler object. 1237Creates a new OpenCL::Sampler object.
1154 1238
1239addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
1240OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
1241
1242filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
1243
1155L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> 1244L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1156 1245
1157=item $program = $ctx->program_with_source ($string) 1246=item $program = $ctx->program_with_source ($string)
1158 1247
1159Creates a new OpenCL::Program object from the given source code. 1248Creates a new OpenCL::Program object from the given source code.
… …
1169Example: clone an existing program object that contains a successfully 1258Example: clone an existing program object that contains a successfully
1170compiled program, no matter how useless this is. 1259compiled program, no matter how useless this is.
1171 1260
1172 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]); 1261 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
1173 1262
1263=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1264
1265Creates a new OpenCL::Program object from the given built-in kernel names.
1266
1267L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1268
1174=item $packed_value = $ctx->info ($name) 1269=item $packed_value = $ctx->info ($name)
1175 1270
1176See C<< $platform->info >> for details. 1271See C<< $platform->info >> for details.
1177 1272
1178L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 1273L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1179 1274
1180=for gengetinfo begin context 1275=for gengetinfo begin context
1181 1276
1182=item $uint = $context->reference_count 1277=item $uint = $context->reference_count
1183 1278
1184Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. 1279Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1185 1280
1186=item @devices = $context->devices 1281=item @devices = $context->devices
1187 1282
1188Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1283Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1189 1284
1190=item @property_ints = $context->properties 1285=item @property_ints = $context->properties
1191 1286
1192Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1287Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1193 1288
1194=item $uint = $context->num_devices 1289=item $uint = $context->num_devices
1195 1290
1196Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. 1291Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1197 1292
1198=for gengetinfo end context 1293=for gengetinfo end context
1199 1294
1200=back 1295=back
1201 1296
… …
1317reference to an array of local work sizes, with the same number of 1412reference to an array of local work sizes, with the same number of
1318elements as \@global_work_size. 1413elements as \@global_work_size.
1319 1414
1320L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1415L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1321 1416
1417=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
1418
1419Migrates a number of OpenCL::Memory objects to or from the device.
1420
1421flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
1422
1423L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
1424
1322=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1425=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1323 1426
1324Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1427Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1325for subsequent OpenCL usage. 1428for subsequent OpenCL usage.
1326 1429
… …
1361 1464
1362=for gengetinfo begin command_queue 1465=for gengetinfo begin command_queue
1363 1466
1364=item $ctx = $command_queue->context 1467=item $ctx = $command_queue->context
1365 1468
1366Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1469Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1367 1470
1368=item $device = $command_queue->device 1471=item $device = $command_queue->device
1369 1472
1370Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1473Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1371 1474
1372=item $uint = $command_queue->reference_count 1475=item $uint = $command_queue->reference_count
1373 1476
1374Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. 1477Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1375 1478
1376=item $command_queue_properties = $command_queue->properties 1479=item $command_queue_properties = $command_queue->properties
1377 1480
1378Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1481Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1379 1482
1380=for gengetinfo end command_queue 1483=for gengetinfo end command_queue
1381 1484
1382=back 1485=back
1383 1486
… …
1402 1505
1403Maps the given buffer into host memory and returns an 1506Maps the given buffer into host memory and returns an
1404C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then 1507C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1405the map will extend to the end of the buffer. 1508the map will extend to the end of the buffer.
1406 1509
1510map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1511
1407L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html> 1512L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1408 1513
1409Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap. 1514Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1410 1515
1411 { 1516 {
… …
1463 1568
1464=for gengetinfo begin mem 1569=for gengetinfo begin mem
1465 1570
1466=item $mem_object_type = $mem->type 1571=item $mem_object_type = $mem->type
1467 1572
1468Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1573Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1469 1574
1470=item $mem_flags = $mem->flags 1575=item $mem_flags = $mem->flags
1471 1576
1472Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1577Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1473 1578
1474=item $int = $mem->size 1579=item $int = $mem->size
1475 1580
1476Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1581Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1477 1582
1478=item $ptr_value = $mem->host_ptr 1583=item $ptr_value = $mem->host_ptr
1479 1584
1480Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. 1585Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1481 1586
1482=item $uint = $mem->map_count 1587=item $uint = $mem->map_count
1483 1588
1484Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. 1589Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1485 1590
1486=item $uint = $mem->reference_count 1591=item $uint = $mem->reference_count
1487 1592
1488Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. 1593Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1489 1594
1490=item $ctx = $mem->context 1595=item $ctx = $mem->context
1491 1596
1492Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1597Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1493 1598
1494=item $mem = $mem->associated_memobject 1599=item $mem = $mem->associated_memobject
1495 1600
1496Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. 1601Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1497 1602
1498=item $int = $mem->offset 1603=item $int = $mem->offset
1499 1604
1500Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1605Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1501 1606
1502=for gengetinfo end mem 1607=for gengetinfo end mem
1503 1608
1504=item ($type, $name) = $mem->gl_object_info 1609=item ($type, $name) = $mem->gl_object_info
1505 1610
… …
1557 1662
1558=for gengetinfo begin image 1663=for gengetinfo begin image
1559 1664
1560=item $int = $image->element_size 1665=item $int = $image->element_size
1561 1666
1562Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1667Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1563 1668
1564=item $int = $image->row_pitch 1669=item $int = $image->row_pitch
1565 1670
1566Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. 1671Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1567 1672
1568=item $int = $image->slice_pitch 1673=item $int = $image->slice_pitch
1569 1674
1570Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. 1675Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1571 1676
1572=item $int = $image->width 1677=item $int = $image->width
1573 1678
1574Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1679Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1575 1680
1576=item $int = $image->height 1681=item $int = $image->height
1577 1682
1578Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1683Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1579 1684
1580=item $int = $image->depth 1685=item $int = $image->depth
1581 1686
1582Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1687Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1583 1688
1584=for gengetinfo end image 1689=for gengetinfo end image
1585 1690
1586=for gengetinfo begin gl_texture 1691=for gengetinfo begin gl_texture
1587 1692
1588=item $GLenum = $gl_texture->target 1693=item $GLenum = $gl_texture->target
1589 1694
1590Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. 1695Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1591 1696
1592=item $GLint = $gl_texture->gl_mipmap_level 1697=item $GLint = $gl_texture->gl_mipmap_level
1593 1698
1594Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. 1699Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1595 1700
1596=for gengetinfo end gl_texture 1701=for gengetinfo end gl_texture
1597 1702
1598=back 1703=back
1599 1704
… …
1609 1714
1610=for gengetinfo begin sampler 1715=for gengetinfo begin sampler
1611 1716
1612=item $uint = $sampler->reference_count 1717=item $uint = $sampler->reference_count
1613 1718
1614Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. 1719Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1615 1720
1616=item $ctx = $sampler->context 1721=item $ctx = $sampler->context
1617 1722
1618Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1723Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1619 1724
1620=item $addressing_mode = $sampler->normalized_coords 1725=item $addressing_mode = $sampler->normalized_coords
1621 1726
1622Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. 1727Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1623 1728
1624=item $filter_mode = $sampler->addressing_mode 1729=item $filter_mode = $sampler->addressing_mode
1625 1730
1626Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. 1731Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1627 1732
1628=item $boolean = $sampler->filter_mode 1733=item $boolean = $sampler->filter_mode
1629 1734
1630Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. 1735Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1631 1736
1632=for gengetinfo end sampler 1737=for gengetinfo end sampler
1633 1738
1634=back 1739=back
1635 1740
… …
1653not so. So best make sure you don't pass in invalid values. 1758not so. So best make sure you don't pass in invalid values.
1654 1759
1655Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1760Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1656compilation state is successful but some later stage fails. 1761compilation state is successful but some later stage fails.
1657 1762
1763options: C<-D name>, C<-D name=definition>, C<-I dir>,
1764C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
1765C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
1766C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1767C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1768C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1769C<-create-library>, C<-enable-link-options>.
1770
1658L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1771L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1659 1772
1660=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1773=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1661 1774
1662Similar to C<< ->build >>, except it starts a thread, and never fails (you 1775Similar to C<< ->build >>, except it starts a thread, and never fails (you
… …
1684 1797
1685=for gengetinfo begin program_build 1798=for gengetinfo begin program_build
1686 1799
1687=item $build_status = $program->build_status ($device) 1800=item $build_status = $program->build_status ($device)
1688 1801
1689Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. 1802Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1803
1804build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
1805OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1690 1806
1691=item $string = $program->build_options ($device) 1807=item $string = $program->build_options ($device)
1692 1808
1693Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. 1809Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1694 1810
1695=item $string = $program->build_log ($device) 1811=item $string = $program->build_log ($device)
1696 1812
1697Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. 1813Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1698 1814
1699=for gengetinfo end program_build 1815=for gengetinfo end program_build
1700 1816
1701=item $packed_value = $program->info ($name) 1817=item $packed_value = $program->info ($name)
1702 1818
… …
1706 1822
1707=for gengetinfo begin program 1823=for gengetinfo begin program
1708 1824
1709=item $uint = $program->reference_count 1825=item $uint = $program->reference_count
1710 1826
1711Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. 1827Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1712 1828
1713=item $ctx = $program->context 1829=item $ctx = $program->context
1714 1830
1715Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1831Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1716 1832
1717=item $uint = $program->num_devices 1833=item $uint = $program->num_devices
1718 1834
1719Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. 1835Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1720 1836
1721=item @devices = $program->devices 1837=item @devices = $program->devices
1722 1838
1723Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1839Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1724 1840
1725=item $string = $program->source 1841=item $string = $program->source
1726 1842
1727Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1843Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1728 1844
1729=item @ints = $program->binary_sizes 1845=item @ints = $program->binary_sizes
1730 1846
1731Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. 1847Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1732 1848
1733=for gengetinfo end program 1849=for gengetinfo end program
1734 1850
1735=item @blobs = $program->binaries 1851=item @blobs = $program->binaries
1736 1852
… …
1757 1873
1758=for gengetinfo begin kernel 1874=for gengetinfo begin kernel
1759 1875
1760=item $string = $kernel->function_name 1876=item $string = $kernel->function_name
1761 1877
1762Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. 1878Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1763 1879
1764=item $uint = $kernel->num_args 1880=item $uint = $kernel->num_args
1765 1881
1766Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. 1882Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1767 1883
1768=item $uint = $kernel->reference_count 1884=item $uint = $kernel->reference_count
1769 1885
1770Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. 1886Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1771 1887
1772=item $ctx = $kernel->context 1888=item $ctx = $kernel->context
1773 1889
1774Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1890Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1775 1891
1776=item $program = $kernel->program 1892=item $program = $kernel->program
1777 1893
1778Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1894Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1779 1895
1780=for gengetinfo end kernel 1896=for gengetinfo end kernel
1781 1897
1782=item $packed_value = $kernel->work_group_info ($device, $name) 1898=item $packed_value = $kernel->work_group_info ($device, $name)
1783 1899
… …
1790 1906
1791=for gengetinfo begin kernel_work_group 1907=for gengetinfo begin kernel_work_group
1792 1908
1793=item $int = $kernel->work_group_size ($device) 1909=item $int = $kernel->work_group_size ($device)
1794 1910
1795Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. 1911Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1796 1912
1797=item @ints = $kernel->compile_work_group_size ($device) 1913=item @ints = $kernel->compile_work_group_size ($device)
1798 1914
1799Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. 1915Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1800 1916
1801=item $ulong = $kernel->local_mem_size ($device) 1917=item $ulong = $kernel->local_mem_size ($device)
1802 1918
1803Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. 1919Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1804 1920
1805=item $int = $kernel->preferred_work_group_size_multiple ($device) 1921=item $int = $kernel->preferred_work_group_size_multiple ($device)
1806 1922
1807Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. 1923Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1808 1924
1809=item $ulong = $kernel->private_mem_size ($device) 1925=item $ulong = $kernel->private_mem_size ($device)
1810 1926
1811Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. 1927Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1812 1928
1813=for gengetinfo end kernel_work_group 1929=for gengetinfo end kernel_work_group
1814 1930
1815=item $kernel->setf ($format, ...) 1931=item $kernel->setf ($format, ...)
1816 1932
… …
1930 2046
1931=for gengetinfo begin event 2047=for gengetinfo begin event
1932 2048
1933=item $queue = $event->command_queue 2049=item $queue = $event->command_queue
1934 2050
1935Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. 2051Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1936 2052
1937=item $command_type = $event->command_type 2053=item $command_type = $event->command_type
1938 2054
1939Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. 2055Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1940 2056
1941=item $uint = $event->reference_count 2057=item $uint = $event->reference_count
1942 2058
1943Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. 2059Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1944 2060
1945=item $uint = $event->command_execution_status 2061=item $uint = $event->command_execution_status
1946 2062
1947Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. 2063Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1948 2064
1949=item $ctx = $event->context 2065=item $ctx = $event->context
1950 2066
1951Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2067Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1952 2068
1953=for gengetinfo end event 2069=for gengetinfo end event
1954 2070
1955=item $packed_value = $ev->profiling_info ($name) 2071=item $packed_value = $ev->profiling_info ($name)
1956 2072
… …
1963 2079
1964=for gengetinfo begin profiling 2080=for gengetinfo begin profiling
1965 2081
1966=item $ulong = $event->profiling_command_queued 2082=item $ulong = $event->profiling_command_queued
1967 2083
1968Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. 2084Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1969 2085
1970=item $ulong = $event->profiling_command_submit 2086=item $ulong = $event->profiling_command_submit
1971 2087
1972Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. 2088Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1973 2089
1974=item $ulong = $event->profiling_command_start 2090=item $ulong = $event->profiling_command_start
1975 2091
1976Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. 2092Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1977 2093
1978=item $ulong = $event->profiling_command_end 2094=item $ulong = $event->profiling_command_end
1979 2095
1980Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. 2096Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1981 2097
1982=for gengetinfo end profiling 2098=for gengetinfo end profiling
1983 2099
1984=back 2100=back
1985 2101
… …
1991 2107
1992=item $ev->set_status ($execution_status) 2108=item $ev->set_status ($execution_status)
1993 2109
1994Sets the execution status of the user event. Can only be called once, 2110Sets the execution status of the user event. Can only be called once,
1995either with OpenCL::COMPLETE or a negative number as status. 2111either with OpenCL::COMPLETE or a negative number as status.
2112
2113execution_status: OpenCL::COMPLETE or a negative integer.
1996 2114
1997L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2115L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1998 2116
1999=back 2117=back
2000 2118

Diff Legend

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