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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.69 by root, Thu May 3 23:30:08 2012 UTC vs.
Revision 1.76 by root, Sat May 5 02:45:38 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines