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.77 by root, Sat May 5 12:54:03 2012 UTC

… …
43 43
44OpenCL::Event objects are used to signal when something is complete. 44OpenCL::Event objects are used to signal when something is complete.
45 45
46=head2 HELPFUL RESOURCES 46=head2 HELPFUL RESOURCES
47 47
48The OpenCL specs used to develop this module: 48The OpenCL specs used to develop this module - download these and keept
49hema round, they are required reference material:
49 50
50 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf 52 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf 53 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53 54
… …
95initialised at creation time). 96initialised at creation time).
96 97
97Enqueue the kernel execution. 98Enqueue the kernel execution.
98 99
99Enqueue buffer reads for your output buffer to read results. 100Enqueue buffer reads for your output buffer to read results.
101
102=head1 OPENCL 1.1 VS. OPENCL 1.2
103
104This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
1051.2 interface hasn't been tested much for lack of availability of an
106actual implementation.
107
108Every function or method in this manual page that interfaces to a
109particular OpenCL function has a link to the its C manual page.
110
111If the link contains a F<1.1>, then this function is an OpenCL 1.1
112function. Most but not all also exist in OpenCL 1.2, and this module
113tries to emulate the missing ones for you, when told to do so at
114compiletime. You cna check whether a function was removed in OpenCL 1.2 by
115replacing the F<1.1> component in the URL by F<1.2>.
116
117If the link contains a F<1.2>, then this is a OpenCL 1.2-only
118function. Even if the module was compiled with OpenCL 1.2 header files
119and has an 1.2 OpenCL library, calling such a function on a platform that
120doesn't implement 1.2 causes undefined behaviour, usually a crash (But
121this is not guaranteed).
122
123You can find out whether this module was compiled to prefer 1.1
124functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
1251.1 functions generally are implemented using 1.1 OpenCL functions. If it
126is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
127fucntions.
128
129This is a somewhat sorry state of affairs, but the Khronos group choose to
130make every release of OpenCL source and binary incompatible with previous
131releases.
100 132
101=head1 EXAMPLES 133=head1 EXAMPLES
102 134
103=head2 Enumerate all devices and get contexts for them. 135=head2 Enumerate all devices and get contexts for them.
104 136
… …
210 242
211 # wait for the last event to complete 243 # wait for the last event to complete
212 $ev->wait; 244 $ev->wait;
213 245
214=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia 246=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215set tunnel effect. 247set flight effect.
216 248
217This is quite a long example to get you going - you can download it from 249This is quite a long example to get you going - you can download it from
218L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>. 250L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
219 251
220 use OpenGL ":all"; 252 use OpenGL ":all";
… …
320To use a texture, you would modify the above example by creating an 352To use a texture, you would modify the above example by creating an
321OpenCL::Image manually instead of deriving it from a texture: 353OpenCL::Image manually instead of deriving it from a texture:
322 354
323 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S); 355 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
324 356
325And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you 357And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
326would read the image2d after the kernel has written it: 358would read the image2d after the kernel has written it:
327 359
328 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data); 360 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
329 361
330And then you would upload the pixel data to the texture (or use glDrawPixels): 362And then you would upload the pixel data to the texture (or use glDrawPixels):
331 363
332 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data; 364 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
333 365
334The fully modified example can be found at 366The fully modified example can be found at
335L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>. 367L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
368
369=head2 Julia sets look soooo 80ies.
370
371Then colour them differently, e.g. using orbit traps! Replace the loop and
372colour calculation from the previous examples by this:
373
374 float2 dm = (float2)(1.f, 1.f);
375
376 for (int i = 0; i < 25; ++i)
377 {
378 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
379 dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
380 }
381
382 float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
383
384Also try C<-10.f> instead of C<-1.f>.
336 385
337=head1 DOCUMENTATION 386=head1 DOCUMENTATION
338 387
339=head2 BASIC CONVENTIONS 388=head2 BASIC CONVENTIONS
340 389
… …
416OpenCL can generate a number of (potentially) asynchronous events, for 465OpenCL can generate a number of (potentially) asynchronous events, for
417example, after compiling a program, to signal a context-related error or, 466example, after compiling a program, to signal a context-related error or,
418perhaps most important, to signal completion of queued jobs (by setting 467perhaps most important, to signal completion of queued jobs (by setting
419callbacks on OpenCL::Event objects). 468callbacks on OpenCL::Event objects).
420 469
470The OpenCL module converts all these callbacks into events - you can
471still register callbacks, but they are not executed when your OpenCL
472implementation calls the actual callback, but only later. Therefore, none
473of the limitations of OpenCL callbacks apply to the perl implementation:
474it is perfectly safe to make blocking operations from event callbacks, and
475enqueued operations don't need to be flushed.
476
421To facilitate this, this module maintains an event queue - each 477To facilitate this, this module maintains an event queue - each
422time an asynchronous event happens, it is queued, and perl will be 478time an asynchronous event happens, it is queued, and perl will be
423interrupted. This is implemented via the L<Async::Interrupt> module. In 479interrupted. This is implemented via the L<Async::Interrupt> module. In
424addition, this module has L<AnyEvent> support, so it can seamlessly 480addition, this module has L<AnyEvent> support, so it can seamlessly
425integrate itself into many event loops. 481integrate itself into many event loops.
426 482
427Since this module is a bit hard to understand, here are some case examples: 483Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
428 484
429=head3 Don't use callbacks. 485=head3 Don't use callbacks.
430 486
431When your program never uses any callbacks, then there will never be any 487When your program never uses any callbacks, then there will never be any
432notifications you need to take care of, and therefore no need to worry 488notifications you need to take care of, and therefore no need to worry
… …
544 @OpenCL::Sampler::ISA = 600 @OpenCL::Sampler::ISA =
545 @OpenCL::Program::ISA = 601 @OpenCL::Program::ISA =
546 @OpenCL::Kernel::ISA = 602 @OpenCL::Kernel::ISA =
547 @OpenCL::Event::ISA = OpenCL::Object::; 603 @OpenCL::Event::ISA = OpenCL::Object::;
548 604
605 @OpenCL::SubDevice::ISA = OpenCL::Device::;
606
549 @OpenCL::Buffer::ISA = 607 @OpenCL::Buffer::ISA =
550 @OpenCL::Image::ISA = OpenCL::Memory::; 608 @OpenCL::Image::ISA = OpenCL::Memory::;
551 609
552 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 610 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
553 611
… …
593L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 651L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
594 652
595=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr 653=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
596 654
597Tries to create a context from a default device and platform type - never worked for me. 655Tries to create a context from a default device and platform type - never worked for me.
656Consider using C<< $platform->context_from_type >> instead.
657
658type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
659OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
598 660
599L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 661L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
600 662
601=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 663=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
602 664
603Create a new OpenCL::Context object using the given device object(s). This 665Create a new OpenCL::Context object using the given device object(s).
604function isn't implemented yet, use C<< $platform->context >> instead. 666Consider using C<< $platform->context >> instead.
605 667
606L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 668L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
607 669
608=item OpenCL::wait_for_events $wait_events... 670=item OpenCL::wait_for_events $wait_events...
609 671
… …
716 778
717=for gengetinfo begin platform 779=for gengetinfo begin platform
718 780
719=item $string = $platform->profile 781=item $string = $platform->profile
720 782
721Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 783Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
722 784
723=item $string = $platform->version 785=item $string = $platform->version
724 786
725Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 787Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
726 788
727=item $string = $platform->name 789=item $string = $platform->name
728 790
729Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 791Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
730 792
731=item $string = $platform->vendor 793=item $string = $platform->vendor
732 794
733Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 795Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
734 796
735=item $string = $platform->extensions 797=item $string = $platform->extensions
736 798
737Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 799Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
738 800
739=for gengetinfo end platform 801=for gengetinfo end platform
740 802
741=back 803=back
742 804
… …
748 810
749See C<< $platform->info >> for details. 811See C<< $platform->info >> for details.
750 812
751L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 813L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
752 814
815=item @devices = $device->sub_devices (\@properties)
816
817Creates OpencL::SubDevice objects by partitioning an existing device.
818
819L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
820
753=for gengetinfo begin device 821=for gengetinfo begin device
754 822
755=item $device_type = $device->type 823=item $device_type = $device->type
756 824
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 825Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
758 826
759=item $uint = $device->vendor_id 827=item $uint = $device->vendor_id
760 828
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. 829Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
762 830
763=item $uint = $device->max_compute_units 831=item $uint = $device->max_compute_units
764 832
765Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. 833Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
766 834
767=item $uint = $device->max_work_item_dimensions 835=item $uint = $device->max_work_item_dimensions
768 836
769Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. 837Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
770 838
771=item $int = $device->max_work_group_size 839=item $int = $device->max_work_group_size
772 840
773Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. 841Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
774 842
775=item @ints = $device->max_work_item_sizes 843=item @ints = $device->max_work_item_sizes
776 844
777Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. 845Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
778 846
779=item $uint = $device->preferred_vector_width_char 847=item $uint = $device->preferred_vector_width_char
780 848
781Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. 849Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
782 850
783=item $uint = $device->preferred_vector_width_short 851=item $uint = $device->preferred_vector_width_short
784 852
785Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. 853Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
786 854
787=item $uint = $device->preferred_vector_width_int 855=item $uint = $device->preferred_vector_width_int
788 856
789Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. 857Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
790 858
791=item $uint = $device->preferred_vector_width_long 859=item $uint = $device->preferred_vector_width_long
792 860
793Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. 861Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
794 862
795=item $uint = $device->preferred_vector_width_float 863=item $uint = $device->preferred_vector_width_float
796 864
797Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. 865Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
798 866
799=item $uint = $device->preferred_vector_width_double 867=item $uint = $device->preferred_vector_width_double
800 868
801Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. 869Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
802 870
803=item $uint = $device->max_clock_frequency 871=item $uint = $device->max_clock_frequency
804 872
805Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. 873Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
806 874
807=item $bitfield = $device->address_bits 875=item $bitfield = $device->address_bits
808 876
809Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. 877Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
810 878
811=item $uint = $device->max_read_image_args 879=item $uint = $device->max_read_image_args
812 880
813Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. 881Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
814 882
815=item $uint = $device->max_write_image_args 883=item $uint = $device->max_write_image_args
816 884
817Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. 885Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
818 886
819=item $ulong = $device->max_mem_alloc_size 887=item $ulong = $device->max_mem_alloc_size
820 888
821Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. 889Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
822 890
823=item $int = $device->image2d_max_width 891=item $int = $device->image2d_max_width
824 892
825Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. 893Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
826 894
827=item $int = $device->image2d_max_height 895=item $int = $device->image2d_max_height
828 896
829Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. 897Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
830 898
831=item $int = $device->image3d_max_width 899=item $int = $device->image3d_max_width
832 900
833Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. 901Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
834 902
835=item $int = $device->image3d_max_height 903=item $int = $device->image3d_max_height
836 904
837Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. 905Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
838 906
839=item $int = $device->image3d_max_depth 907=item $int = $device->image3d_max_depth
840 908
841Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. 909Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
842 910
843=item $uint = $device->image_support 911=item $uint = $device->image_support
844 912
845Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. 913Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
846 914
847=item $int = $device->max_parameter_size 915=item $int = $device->max_parameter_size
848 916
849Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. 917Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
850 918
851=item $uint = $device->max_samplers 919=item $uint = $device->max_samplers
852 920
853Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. 921Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
854 922
855=item $uint = $device->mem_base_addr_align 923=item $uint = $device->mem_base_addr_align
856 924
857Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. 925Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
858 926
859=item $uint = $device->min_data_type_align_size 927=item $uint = $device->min_data_type_align_size
860 928
861Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. 929Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
862 930
863=item $device_fp_config = $device->single_fp_config 931=item $device_fp_config = $device->single_fp_config
864 932
865Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. 933Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
866 934
867=item $device_mem_cache_type = $device->global_mem_cache_type 935=item $device_mem_cache_type = $device->global_mem_cache_type
868 936
869Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. 937Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
870 938
871=item $uint = $device->global_mem_cacheline_size 939=item $uint = $device->global_mem_cacheline_size
872 940
873Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. 941Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
874 942
875=item $ulong = $device->global_mem_cache_size 943=item $ulong = $device->global_mem_cache_size
876 944
877Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. 945Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
878 946
879=item $ulong = $device->global_mem_size 947=item $ulong = $device->global_mem_size
880 948
881Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. 949Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
882 950
883=item $ulong = $device->max_constant_buffer_size 951=item $ulong = $device->max_constant_buffer_size
884 952
885Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. 953Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
886 954
887=item $uint = $device->max_constant_args 955=item $uint = $device->max_constant_args
888 956
889Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. 957Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
890 958
891=item $device_local_mem_type = $device->local_mem_type 959=item $device_local_mem_type = $device->local_mem_type
892 960
893Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. 961Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
894 962
895=item $ulong = $device->local_mem_size 963=item $ulong = $device->local_mem_size
896 964
897Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. 965Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
898 966
899=item $boolean = $device->error_correction_support 967=item $boolean = $device->error_correction_support
900 968
901Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. 969Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
902 970
903=item $int = $device->profiling_timer_resolution 971=item $int = $device->profiling_timer_resolution
904 972
905Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. 973Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
906 974
907=item $boolean = $device->endian_little 975=item $boolean = $device->endian_little
908 976
909Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. 977Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
910 978
911=item $boolean = $device->available 979=item $boolean = $device->available
912 980
913Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 981Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
914 982
915=item $boolean = $device->compiler_available 983=item $boolean = $device->compiler_available
916 984
917Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. 985Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
918 986
919=item $device_exec_capabilities = $device->execution_capabilities 987=item $device_exec_capabilities = $device->execution_capabilities
920 988
921Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. 989Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
922 990
923=item $command_queue_properties = $device->properties 991=item $command_queue_properties = $device->properties
924 992
925Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. 993Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
926 994
927=item $ = $device->platform 995=item $ = $device->platform
928 996
929Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 997Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
930 998
931=item $string = $device->name 999=item $string = $device->name
932 1000
933Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 1001Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
934 1002
935=item $string = $device->vendor 1003=item $string = $device->vendor
936 1004
937Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 1005Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
938 1006
939=item $string = $device->driver_version 1007=item $string = $device->driver_version
940 1008
941Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 1009Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
942 1010
943=item $string = $device->profile 1011=item $string = $device->profile
944 1012
945Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 1013Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
946 1014
947=item $string = $device->version 1015=item $string = $device->version
948 1016
949Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 1017Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
950 1018
951=item $string = $device->extensions 1019=item $string = $device->extensions
952 1020
953Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 1021Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
954 1022
955=item $uint = $device->preferred_vector_width_half 1023=item $uint = $device->preferred_vector_width_half
956 1024
957Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. 1025Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
958 1026
959=item $uint = $device->native_vector_width_char 1027=item $uint = $device->native_vector_width_char
960 1028
961Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. 1029Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
962 1030
963=item $uint = $device->native_vector_width_short 1031=item $uint = $device->native_vector_width_short
964 1032
965Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. 1033Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
966 1034
967=item $uint = $device->native_vector_width_int 1035=item $uint = $device->native_vector_width_int
968 1036
969Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. 1037Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
970 1038
971=item $uint = $device->native_vector_width_long 1039=item $uint = $device->native_vector_width_long
972 1040
973Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. 1041Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
974 1042
975=item $uint = $device->native_vector_width_float 1043=item $uint = $device->native_vector_width_float
976 1044
977Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. 1045Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
978 1046
979=item $uint = $device->native_vector_width_double 1047=item $uint = $device->native_vector_width_double
980 1048
981Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. 1049Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
982 1050
983=item $uint = $device->native_vector_width_half 1051=item $uint = $device->native_vector_width_half
984 1052
985Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. 1053Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
986 1054
987=item $device_fp_config = $device->double_fp_config 1055=item $device_fp_config = $device->double_fp_config
988 1056
989Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. 1057Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
990 1058
991=item $device_fp_config = $device->half_fp_config 1059=item $device_fp_config = $device->half_fp_config
992 1060
993Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. 1061Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
994 1062
995=item $boolean = $device->host_unified_memory 1063=item $boolean = $device->host_unified_memory
996 1064
997Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. 1065Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
998 1066
999=item $device = $device->parent_device_ext 1067=item $device = $device->parent_device_ext
1000 1068
1001Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. 1069Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
1002 1070
1003=item @device_partition_property_exts = $device->partition_types_ext 1071=item @device_partition_property_exts = $device->partition_types_ext
1004 1072
1005Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. 1073Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
1006 1074
1007=item @device_partition_property_exts = $device->affinity_domains_ext 1075=item @device_partition_property_exts = $device->affinity_domains_ext
1008 1076
1009Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 1077Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
1010 1078
1011=item $uint = $device->reference_count_ext 1079=item $uint = $device->reference_count_ext
1012 1080
1013Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. 1081Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
1014 1082
1015=item @device_partition_property_exts = $device->partition_style_ext 1083=item @device_partition_property_exts = $device->partition_style_ext
1016 1084
1017Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 1085Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
1018 1086
1019=for gengetinfo end device 1087=for gengetinfo end device
1020 1088
1021=back 1089=back
1022 1090
1023=head2 THE OpenCL::Context CLASS 1091=head2 THE OpenCL::Context CLASS
1092
1093An OpenCL::Context is basically a container, or manager, for a number of
1094devices of a platform. It is used to create all sorts of secondary objects
1095such as buffers, queues, programs and so on.
1096
1097All context creation functions and methods take a list of properties
1098(type-value pairs). All property values can be specified as integers -
1099some additionally support other types:
1100
1101=over 4
1102
1103=item OpenCL::CONTEXT_PLATFORM
1104
1105Also accepts OpenCL::Platform objects.
1106
1107=item OpenCL::GLX_DISPLAY_KHR
1108
1109Also accepts C<undef>, in which case a deep and troubling hack is engaged
1110to find the current glx display (see L<GLX SUPPORT>).
1111
1112=item OpenCL::GL_CONTEXT_KHR
1113
1114Also accepts C<undef>, in which case a deep and troubling hack is engaged
1115to find the current glx context (see L<GLX SUPPORT>).
1116
1117=back
1024 1118
1025=over 4 1119=over 4
1026 1120
1027=item $prog = $ctx->build_program ($program, $options = "") 1121=item $prog = $ctx->build_program ($program, $options = "")
1028 1122
… …
1076=item $buf = $ctx->buffer ($flags, $len) 1170=item $buf = $ctx->buffer ($flags, $len)
1077 1171
1078Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1172Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1079given flags and octet-size. 1173given flags and octet-size.
1080 1174
1175flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
1176OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
1177OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
1178
1081L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1179L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1082 1180
1083=item $buf = $ctx->buffer_sv ($flags, $data) 1181=item $buf = $ctx->buffer_sv ($flags, $data)
1084 1182
1085Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1183Creates 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) 1186=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 1187
1090Creates a new OpenCL::Image object and optionally initialises it with 1188Creates a new OpenCL::Image object and optionally initialises it with
1091the given data values. 1189the given data values.
1092 1190
1191channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
1192OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
1193OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
1194
1195channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
1196OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1197OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1198OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1199OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1200
1201
1202type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1203OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1204OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1205OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1206
1093L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> 1207L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1094 1208
1095=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1209=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1096 1210
1097Creates a new OpenCL::Image2D object and optionally initialises it with 1211Creates a new OpenCL::Image2D object and optionally initialises it with
… …
1109=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1223=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1110 1224
1111Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 1225Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1112OpenGL buffer object. 1226OpenGL buffer object.
1113 1227
1228flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1229
1114http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 1230http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1115 1231
1116=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1232=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1117 1233
1118Creates a new OpenCL::Image object that refers to the given OpenGL 1234Creates a new OpenCL::Image object that refers to the given OpenGL
1119texture object or buffer. 1235texture object or buffer.
1120 1236
1237target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
1238GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
1239GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
1240GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
1241GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
1242GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
1243
1121http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html 1244http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1122 1245
1123=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1246=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1124 1247
1125Creates a new OpenCL::Image2D object that refers to the given OpenGL 1248Creates a new OpenCL::Image2D object that refers to the given OpenGL
… …
1150 1273
1151=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1274=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1152 1275
1153Creates a new OpenCL::Sampler object. 1276Creates a new OpenCL::Sampler object.
1154 1277
1278addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
1279OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
1280
1281filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
1282
1155L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> 1283L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1156 1284
1157=item $program = $ctx->program_with_source ($string) 1285=item $program = $ctx->program_with_source ($string)
1158 1286
1159Creates a new OpenCL::Program object from the given source code. 1287Creates a new OpenCL::Program object from the given source code.
… …
1169Example: clone an existing program object that contains a successfully 1297Example: clone an existing program object that contains a successfully
1170compiled program, no matter how useless this is. 1298compiled program, no matter how useless this is.
1171 1299
1172 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]); 1300 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
1173 1301
1302=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1303
1304Creates a new OpenCL::Program object from the given built-in kernel names.
1305
1306L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1307
1308=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
1309
1310Links all (already compiled) program objects specified in C<@programs>
1311together and returns a new OpenCL::Program object with the result.
1312
1313L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
1314
1174=item $packed_value = $ctx->info ($name) 1315=item $packed_value = $ctx->info ($name)
1175 1316
1176See C<< $platform->info >> for details. 1317See C<< $platform->info >> for details.
1177 1318
1178L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 1319L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1179 1320
1180=for gengetinfo begin context 1321=for gengetinfo begin context
1181 1322
1182=item $uint = $context->reference_count 1323=item $uint = $context->reference_count
1183 1324
1184Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. 1325Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1185 1326
1186=item @devices = $context->devices 1327=item @devices = $context->devices
1187 1328
1188Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1329Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1189 1330
1190=item @property_ints = $context->properties 1331=item @property_ints = $context->properties
1191 1332
1192Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1333Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1193 1334
1194=item $uint = $context->num_devices 1335=item $uint = $context->num_devices
1195 1336
1196Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. 1337Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1197 1338
1198=for gengetinfo end context 1339=for gengetinfo end context
1199 1340
1200=back 1341=back
1201 1342
… …
1317reference to an array of local work sizes, with the same number of 1458reference to an array of local work sizes, with the same number of
1318elements as \@global_work_size. 1459elements as \@global_work_size.
1319 1460
1320L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1461L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1321 1462
1463=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
1464
1465Migrates a number of OpenCL::Memory objects to or from the device.
1466
1467flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
1468
1469L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
1470
1322=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1471=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1323 1472
1324Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1473Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1325for subsequent OpenCL usage. 1474for subsequent OpenCL usage.
1326 1475
… …
1361 1510
1362=for gengetinfo begin command_queue 1511=for gengetinfo begin command_queue
1363 1512
1364=item $ctx = $command_queue->context 1513=item $ctx = $command_queue->context
1365 1514
1366Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1515Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1367 1516
1368=item $device = $command_queue->device 1517=item $device = $command_queue->device
1369 1518
1370Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1519Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1371 1520
1372=item $uint = $command_queue->reference_count 1521=item $uint = $command_queue->reference_count
1373 1522
1374Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. 1523Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1375 1524
1376=item $command_queue_properties = $command_queue->properties 1525=item $command_queue_properties = $command_queue->properties
1377 1526
1378Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1527Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1379 1528
1380=for gengetinfo end command_queue 1529=for gengetinfo end command_queue
1381 1530
1382=back 1531=back
1383 1532
… …
1402 1551
1403Maps the given buffer into host memory and returns an 1552Maps the given buffer into host memory and returns an
1404C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then 1553C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1405the map will extend to the end of the buffer. 1554the map will extend to the end of the buffer.
1406 1555
1556map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1557
1407L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html> 1558L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1408 1559
1409Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap. 1560Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1410 1561
1411 { 1562 {
… …
1463 1614
1464=for gengetinfo begin mem 1615=for gengetinfo begin mem
1465 1616
1466=item $mem_object_type = $mem->type 1617=item $mem_object_type = $mem->type
1467 1618
1468Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1619Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1469 1620
1470=item $mem_flags = $mem->flags 1621=item $mem_flags = $mem->flags
1471 1622
1472Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1623Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1473 1624
1474=item $int = $mem->size 1625=item $int = $mem->size
1475 1626
1476Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1627Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1477 1628
1478=item $ptr_value = $mem->host_ptr 1629=item $ptr_value = $mem->host_ptr
1479 1630
1480Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. 1631Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1481 1632
1482=item $uint = $mem->map_count 1633=item $uint = $mem->map_count
1483 1634
1484Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. 1635Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1485 1636
1486=item $uint = $mem->reference_count 1637=item $uint = $mem->reference_count
1487 1638
1488Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. 1639Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1489 1640
1490=item $ctx = $mem->context 1641=item $ctx = $mem->context
1491 1642
1492Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1643Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1493 1644
1494=item $mem = $mem->associated_memobject 1645=item $mem = $mem->associated_memobject
1495 1646
1496Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. 1647Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1497 1648
1498=item $int = $mem->offset 1649=item $int = $mem->offset
1499 1650
1500Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1651Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1501 1652
1502=for gengetinfo end mem 1653=for gengetinfo end mem
1503 1654
1504=item ($type, $name) = $mem->gl_object_info 1655=item ($type, $name) = $mem->gl_object_info
1505 1656
… …
1557 1708
1558=for gengetinfo begin image 1709=for gengetinfo begin image
1559 1710
1560=item $int = $image->element_size 1711=item $int = $image->element_size
1561 1712
1562Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1713Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1563 1714
1564=item $int = $image->row_pitch 1715=item $int = $image->row_pitch
1565 1716
1566Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. 1717Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1567 1718
1568=item $int = $image->slice_pitch 1719=item $int = $image->slice_pitch
1569 1720
1570Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. 1721Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1571 1722
1572=item $int = $image->width 1723=item $int = $image->width
1573 1724
1574Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1725Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1575 1726
1576=item $int = $image->height 1727=item $int = $image->height
1577 1728
1578Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1729Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1579 1730
1580=item $int = $image->depth 1731=item $int = $image->depth
1581 1732
1582Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1733Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1583 1734
1584=for gengetinfo end image 1735=for gengetinfo end image
1585 1736
1586=for gengetinfo begin gl_texture 1737=for gengetinfo begin gl_texture
1587 1738
1588=item $GLenum = $gl_texture->target 1739=item $GLenum = $gl_texture->target
1589 1740
1590Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. 1741Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1591 1742
1592=item $GLint = $gl_texture->gl_mipmap_level 1743=item $GLint = $gl_texture->gl_mipmap_level
1593 1744
1594Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. 1745Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1595 1746
1596=for gengetinfo end gl_texture 1747=for gengetinfo end gl_texture
1597 1748
1598=back 1749=back
1599 1750
… …
1609 1760
1610=for gengetinfo begin sampler 1761=for gengetinfo begin sampler
1611 1762
1612=item $uint = $sampler->reference_count 1763=item $uint = $sampler->reference_count
1613 1764
1614Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. 1765Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1615 1766
1616=item $ctx = $sampler->context 1767=item $ctx = $sampler->context
1617 1768
1618Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1769Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1619 1770
1620=item $addressing_mode = $sampler->normalized_coords 1771=item $addressing_mode = $sampler->normalized_coords
1621 1772
1622Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. 1773Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1623 1774
1624=item $filter_mode = $sampler->addressing_mode 1775=item $filter_mode = $sampler->addressing_mode
1625 1776
1626Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. 1777Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1627 1778
1628=item $boolean = $sampler->filter_mode 1779=item $boolean = $sampler->filter_mode
1629 1780
1630Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. 1781Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1631 1782
1632=for gengetinfo end sampler 1783=for gengetinfo end sampler
1633 1784
1634=back 1785=back
1635 1786
… …
1653not so. So best make sure you don't pass in invalid values. 1804not so. So best make sure you don't pass in invalid values.
1654 1805
1655Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1806Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1656compilation state is successful but some later stage fails. 1807compilation state is successful but some later stage fails.
1657 1808
1809options: C<-D name>, C<-D name=definition>, C<-I dir>,
1810C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
1811C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
1812C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1813C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1814C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1815C<-create-library>, C<-enable-link-options>.
1816
1817build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
1818OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1819
1658L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1820L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1659 1821
1660=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1822=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1661 1823
1662Similar to C<< ->build >>, except it starts a thread, and never fails (you 1824Similar to C<< ->build >>, except it starts a thread, and never fails (you
1663need to check the compilation status form the callback, or by polling). 1825need to check the compilation status form the callback, or by polling).
1664 1826
1827=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1828
1829Compiles the given program for the given devices (or all devices if
1830undef). If C<$headers> is given, it must be a hashref with include name =>
1831OpenCL::Program pairs.
1832
1833L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1834
1665=item $packed_value = $program->build_info ($device, $name) 1835=item $packed_value = $program->build_info ($device, $name)
1666 1836
1667Similar to C<< $platform->info >>, but returns build info for a previous 1837Similar to C<< $platform->info >>, but returns build info for a previous
1668build attempt for the given device. 1838build attempt for the given device.
1669 1839
… …
1684 1854
1685=for gengetinfo begin program_build 1855=for gengetinfo begin program_build
1686 1856
1687=item $build_status = $program->build_status ($device) 1857=item $build_status = $program->build_status ($device)
1688 1858
1689Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. 1859Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1690 1860
1691=item $string = $program->build_options ($device) 1861=item $string = $program->build_options ($device)
1692 1862
1693Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. 1863Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1694 1864
1695=item $string = $program->build_log ($device) 1865=item $string = $program->build_log ($device)
1696 1866
1697Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. 1867Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1698 1868
1699=for gengetinfo end program_build 1869=for gengetinfo end program_build
1700 1870
1701=item $packed_value = $program->info ($name) 1871=item $packed_value = $program->info ($name)
1702 1872
… …
1706 1876
1707=for gengetinfo begin program 1877=for gengetinfo begin program
1708 1878
1709=item $uint = $program->reference_count 1879=item $uint = $program->reference_count
1710 1880
1711Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. 1881Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1712 1882
1713=item $ctx = $program->context 1883=item $ctx = $program->context
1714 1884
1715Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1885Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1716 1886
1717=item $uint = $program->num_devices 1887=item $uint = $program->num_devices
1718 1888
1719Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. 1889Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1720 1890
1721=item @devices = $program->devices 1891=item @devices = $program->devices
1722 1892
1723Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1893Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1724 1894
1725=item $string = $program->source 1895=item $string = $program->source
1726 1896
1727Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1897Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1728 1898
1729=item @ints = $program->binary_sizes 1899=item @ints = $program->binary_sizes
1730 1900
1731Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. 1901Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1732 1902
1733=for gengetinfo end program 1903=for gengetinfo end program
1734 1904
1735=item @blobs = $program->binaries 1905=item @blobs = $program->binaries
1736 1906
… …
1757 1927
1758=for gengetinfo begin kernel 1928=for gengetinfo begin kernel
1759 1929
1760=item $string = $kernel->function_name 1930=item $string = $kernel->function_name
1761 1931
1762Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. 1932Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1763 1933
1764=item $uint = $kernel->num_args 1934=item $uint = $kernel->num_args
1765 1935
1766Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. 1936Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1767 1937
1768=item $uint = $kernel->reference_count 1938=item $uint = $kernel->reference_count
1769 1939
1770Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. 1940Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1771 1941
1772=item $ctx = $kernel->context 1942=item $ctx = $kernel->context
1773 1943
1774Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1944Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1775 1945
1776=item $program = $kernel->program 1946=item $program = $kernel->program
1777 1947
1778Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1948Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1779 1949
1780=for gengetinfo end kernel 1950=for gengetinfo end kernel
1781 1951
1782=item $packed_value = $kernel->work_group_info ($device, $name) 1952=item $packed_value = $kernel->work_group_info ($device, $name)
1783 1953
1784See C<< $platform->info >> for details. 1954See C<< $platform->info >> for details.
1785 1955
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> 1956L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1790 1957
1791=for gengetinfo begin kernel_work_group 1958=for gengetinfo begin kernel_work_group
1792 1959
1793=item $int = $kernel->work_group_size ($device) 1960=item $int = $kernel->work_group_size ($device)
1794 1961
1795Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. 1962Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1796 1963
1797=item @ints = $kernel->compile_work_group_size ($device) 1964=item @ints = $kernel->compile_work_group_size ($device)
1798 1965
1799Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. 1966Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1800 1967
1801=item $ulong = $kernel->local_mem_size ($device) 1968=item $ulong = $kernel->local_mem_size ($device)
1802 1969
1803Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. 1970Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1804 1971
1805=item $int = $kernel->preferred_work_group_size_multiple ($device) 1972=item $int = $kernel->preferred_work_group_size_multiple ($device)
1806 1973
1807Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. 1974Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1808 1975
1809=item $ulong = $kernel->private_mem_size ($device) 1976=item $ulong = $kernel->private_mem_size ($device)
1810 1977
1811Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. 1978Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1812 1979
1813=for gengetinfo end kernel_work_group 1980=for gengetinfo end kernel_work_group
1981
1982=item $packed_value = $kernel->arg_info ($idx, $name)
1983
1984See C<< $platform->info >> for details.
1985
1986L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
1987
1988=for gengetinfo begin kernel_arg
1989
1990=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
1991
1992Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
1993
1994=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
1995
1996Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
1997
1998=item $string = $kernel->arg_type_name ($idx)
1999
2000Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
2001
2002=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
2003
2004Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
2005
2006=item $string = $kernel->arg_name ($idx)
2007
2008Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
2009
2010=for gengetinfo end kernel_arg
1814 2011
1815=item $kernel->setf ($format, ...) 2012=item $kernel->setf ($format, ...)
1816 2013
1817Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic 2014Sets 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 2015way to set arguments (and with OpenCL 1.2 it might be rather slow), you
… …
1930 2127
1931=for gengetinfo begin event 2128=for gengetinfo begin event
1932 2129
1933=item $queue = $event->command_queue 2130=item $queue = $event->command_queue
1934 2131
1935Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. 2132Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1936 2133
1937=item $command_type = $event->command_type 2134=item $command_type = $event->command_type
1938 2135
1939Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. 2136Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1940 2137
1941=item $uint = $event->reference_count 2138=item $uint = $event->reference_count
1942 2139
1943Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. 2140Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1944 2141
1945=item $uint = $event->command_execution_status 2142=item $uint = $event->command_execution_status
1946 2143
1947Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. 2144Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1948 2145
1949=item $ctx = $event->context 2146=item $ctx = $event->context
1950 2147
1951Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2148Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1952 2149
1953=for gengetinfo end event 2150=for gengetinfo end event
1954 2151
1955=item $packed_value = $ev->profiling_info ($name) 2152=item $packed_value = $ev->profiling_info ($name)
1956 2153
… …
1963 2160
1964=for gengetinfo begin profiling 2161=for gengetinfo begin profiling
1965 2162
1966=item $ulong = $event->profiling_command_queued 2163=item $ulong = $event->profiling_command_queued
1967 2164
1968Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. 2165Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1969 2166
1970=item $ulong = $event->profiling_command_submit 2167=item $ulong = $event->profiling_command_submit
1971 2168
1972Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. 2169Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1973 2170
1974=item $ulong = $event->profiling_command_start 2171=item $ulong = $event->profiling_command_start
1975 2172
1976Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. 2173Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1977 2174
1978=item $ulong = $event->profiling_command_end 2175=item $ulong = $event->profiling_command_end
1979 2176
1980Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. 2177Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1981 2178
1982=for gengetinfo end profiling 2179=for gengetinfo end profiling
1983 2180
1984=back 2181=back
1985 2182
… …
1991 2188
1992=item $ev->set_status ($execution_status) 2189=item $ev->set_status ($execution_status)
1993 2190
1994Sets the execution status of the user event. Can only be called once, 2191Sets the execution status of the user event. Can only be called once,
1995either with OpenCL::COMPLETE or a negative number as status. 2192either with OpenCL::COMPLETE or a negative number as status.
2193
2194execution_status: OpenCL::COMPLETE or a negative integer.
1996 2195
1997L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2196L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1998 2197
1999=back 2198=back
2000 2199

Diff Legend

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