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.78 by root, Sat May 5 13:07:19 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
… …
746 808
747=item $packed_value = $device->info ($name) 809=item $packed_value = $device->info ($name)
748 810
749See C<< $platform->info >> for details. 811See C<< $platform->info >> for details.
750 812
813type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
814OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
815OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
816
817fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
818OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
819OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
820
821mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
822
823local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
824
825exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
826
827command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
828OpenCL::QUEUE_PROFILING_ENABLE.
829
830partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
831OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
832OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
833
834affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
835OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
836OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
837OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
838
751L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 839L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
752 840
841=item @devices = $device->sub_devices (\@properties)
842
843Creates OpencL::SubDevice objects by partitioning an existing device.
844
845L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
846
753=for gengetinfo begin device 847=for gengetinfo begin device
754 848
755=item $device_type = $device->type 849=item $device_type = $device->type
756 850
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 851Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
758 852
759=item $uint = $device->vendor_id 853=item $uint = $device->vendor_id
760 854
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. 855Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
762 856
763=item $uint = $device->max_compute_units 857=item $uint = $device->max_compute_units
764 858
765Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. 859Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
766 860
767=item $uint = $device->max_work_item_dimensions 861=item $uint = $device->max_work_item_dimensions
768 862
769Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. 863Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
770 864
771=item $int = $device->max_work_group_size 865=item $int = $device->max_work_group_size
772 866
773Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. 867Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
774 868
775=item @ints = $device->max_work_item_sizes 869=item @ints = $device->max_work_item_sizes
776 870
777Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. 871Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
778 872
779=item $uint = $device->preferred_vector_width_char 873=item $uint = $device->preferred_vector_width_char
780 874
781Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. 875Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
782 876
783=item $uint = $device->preferred_vector_width_short 877=item $uint = $device->preferred_vector_width_short
784 878
785Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. 879Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
786 880
787=item $uint = $device->preferred_vector_width_int 881=item $uint = $device->preferred_vector_width_int
788 882
789Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. 883Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
790 884
791=item $uint = $device->preferred_vector_width_long 885=item $uint = $device->preferred_vector_width_long
792 886
793Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. 887Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
794 888
795=item $uint = $device->preferred_vector_width_float 889=item $uint = $device->preferred_vector_width_float
796 890
797Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. 891Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
798 892
799=item $uint = $device->preferred_vector_width_double 893=item $uint = $device->preferred_vector_width_double
800 894
801Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. 895Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
802 896
803=item $uint = $device->max_clock_frequency 897=item $uint = $device->max_clock_frequency
804 898
805Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. 899Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
806 900
807=item $bitfield = $device->address_bits 901=item $bitfield = $device->address_bits
808 902
809Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. 903Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
810 904
811=item $uint = $device->max_read_image_args 905=item $uint = $device->max_read_image_args
812 906
813Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. 907Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
814 908
815=item $uint = $device->max_write_image_args 909=item $uint = $device->max_write_image_args
816 910
817Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. 911Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
818 912
819=item $ulong = $device->max_mem_alloc_size 913=item $ulong = $device->max_mem_alloc_size
820 914
821Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. 915Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
822 916
823=item $int = $device->image2d_max_width 917=item $int = $device->image2d_max_width
824 918
825Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. 919Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
826 920
827=item $int = $device->image2d_max_height 921=item $int = $device->image2d_max_height
828 922
829Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. 923Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
830 924
831=item $int = $device->image3d_max_width 925=item $int = $device->image3d_max_width
832 926
833Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. 927Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
834 928
835=item $int = $device->image3d_max_height 929=item $int = $device->image3d_max_height
836 930
837Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. 931Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
838 932
839=item $int = $device->image3d_max_depth 933=item $int = $device->image3d_max_depth
840 934
841Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. 935Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
842 936
843=item $uint = $device->image_support 937=item $uint = $device->image_support
844 938
845Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. 939Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
846 940
847=item $int = $device->max_parameter_size 941=item $int = $device->max_parameter_size
848 942
849Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. 943Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
850 944
851=item $uint = $device->max_samplers 945=item $uint = $device->max_samplers
852 946
853Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. 947Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
854 948
855=item $uint = $device->mem_base_addr_align 949=item $uint = $device->mem_base_addr_align
856 950
857Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. 951Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
858 952
859=item $uint = $device->min_data_type_align_size 953=item $uint = $device->min_data_type_align_size
860 954
861Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. 955Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
862 956
863=item $device_fp_config = $device->single_fp_config 957=item $device_fp_config = $device->single_fp_config
864 958
865Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. 959Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
866 960
867=item $device_mem_cache_type = $device->global_mem_cache_type 961=item $device_mem_cache_type = $device->global_mem_cache_type
868 962
869Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. 963Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
870 964
871=item $uint = $device->global_mem_cacheline_size 965=item $uint = $device->global_mem_cacheline_size
872 966
873Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. 967Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
874 968
875=item $ulong = $device->global_mem_cache_size 969=item $ulong = $device->global_mem_cache_size
876 970
877Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. 971Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
878 972
879=item $ulong = $device->global_mem_size 973=item $ulong = $device->global_mem_size
880 974
881Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. 975Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
882 976
883=item $ulong = $device->max_constant_buffer_size 977=item $ulong = $device->max_constant_buffer_size
884 978
885Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. 979Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
886 980
887=item $uint = $device->max_constant_args 981=item $uint = $device->max_constant_args
888 982
889Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. 983Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
890 984
891=item $device_local_mem_type = $device->local_mem_type 985=item $device_local_mem_type = $device->local_mem_type
892 986
893Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. 987Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
894 988
895=item $ulong = $device->local_mem_size 989=item $ulong = $device->local_mem_size
896 990
897Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. 991Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
898 992
899=item $boolean = $device->error_correction_support 993=item $boolean = $device->error_correction_support
900 994
901Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. 995Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
902 996
903=item $int = $device->profiling_timer_resolution 997=item $int = $device->profiling_timer_resolution
904 998
905Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. 999Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
906 1000
907=item $boolean = $device->endian_little 1001=item $boolean = $device->endian_little
908 1002
909Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. 1003Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
910 1004
911=item $boolean = $device->available 1005=item $boolean = $device->available
912 1006
913Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 1007Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
914 1008
915=item $boolean = $device->compiler_available 1009=item $boolean = $device->compiler_available
916 1010
917Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. 1011Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
918 1012
919=item $device_exec_capabilities = $device->execution_capabilities 1013=item $device_exec_capabilities = $device->execution_capabilities
920 1014
921Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. 1015Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
922 1016
923=item $command_queue_properties = $device->properties 1017=item $command_queue_properties = $device->properties
924 1018
925Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. 1019Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
926 1020
927=item $ = $device->platform 1021=item $ = $device->platform
928 1022
929Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 1023Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
930 1024
931=item $string = $device->name 1025=item $string = $device->name
932 1026
933Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 1027Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
934 1028
935=item $string = $device->vendor 1029=item $string = $device->vendor
936 1030
937Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 1031Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
938 1032
939=item $string = $device->driver_version 1033=item $string = $device->driver_version
940 1034
941Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 1035Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
942 1036
943=item $string = $device->profile 1037=item $string = $device->profile
944 1038
945Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 1039Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
946 1040
947=item $string = $device->version 1041=item $string = $device->version
948 1042
949Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 1043Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
950 1044
951=item $string = $device->extensions 1045=item $string = $device->extensions
952 1046
953Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 1047Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
954 1048
955=item $uint = $device->preferred_vector_width_half 1049=item $uint = $device->preferred_vector_width_half
956 1050
957Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. 1051Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
958 1052
959=item $uint = $device->native_vector_width_char 1053=item $uint = $device->native_vector_width_char
960 1054
961Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. 1055Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
962 1056
963=item $uint = $device->native_vector_width_short 1057=item $uint = $device->native_vector_width_short
964 1058
965Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. 1059Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
966 1060
967=item $uint = $device->native_vector_width_int 1061=item $uint = $device->native_vector_width_int
968 1062
969Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. 1063Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
970 1064
971=item $uint = $device->native_vector_width_long 1065=item $uint = $device->native_vector_width_long
972 1066
973Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. 1067Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
974 1068
975=item $uint = $device->native_vector_width_float 1069=item $uint = $device->native_vector_width_float
976 1070
977Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. 1071Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
978 1072
979=item $uint = $device->native_vector_width_double 1073=item $uint = $device->native_vector_width_double
980 1074
981Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. 1075Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
982 1076
983=item $uint = $device->native_vector_width_half 1077=item $uint = $device->native_vector_width_half
984 1078
985Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. 1079Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
986 1080
987=item $device_fp_config = $device->double_fp_config 1081=item $device_fp_config = $device->double_fp_config
988 1082
989Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. 1083Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
990 1084
991=item $device_fp_config = $device->half_fp_config 1085=item $device_fp_config = $device->half_fp_config
992 1086
993Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. 1087Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
994 1088
995=item $boolean = $device->host_unified_memory 1089=item $boolean = $device->host_unified_memory
996 1090
997Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. 1091Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
998 1092
999=item $device = $device->parent_device_ext 1093=item $device = $device->parent_device_ext
1000 1094
1001Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. 1095Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
1002 1096
1003=item @device_partition_property_exts = $device->partition_types_ext 1097=item @device_partition_property_exts = $device->partition_types_ext
1004 1098
1005Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. 1099Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
1006 1100
1007=item @device_partition_property_exts = $device->affinity_domains_ext 1101=item @device_partition_property_exts = $device->affinity_domains_ext
1008 1102
1009Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 1103Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
1010 1104
1011=item $uint = $device->reference_count_ext 1105=item $uint = $device->reference_count_ext
1012 1106
1013Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. 1107Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
1014 1108
1015=item @device_partition_property_exts = $device->partition_style_ext 1109=item @device_partition_property_exts = $device->partition_style_ext
1016 1110
1017Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 1111Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
1018 1112
1019=for gengetinfo end device 1113=for gengetinfo end device
1020 1114
1021=back 1115=back
1022 1116
1023=head2 THE OpenCL::Context CLASS 1117=head2 THE OpenCL::Context CLASS
1118
1119An OpenCL::Context is basically a container, or manager, for a number of
1120devices of a platform. It is used to create all sorts of secondary objects
1121such as buffers, queues, programs and so on.
1122
1123All context creation functions and methods take a list of properties
1124(type-value pairs). All property values can be specified as integers -
1125some additionally support other types:
1126
1127=over 4
1128
1129=item OpenCL::CONTEXT_PLATFORM
1130
1131Also accepts OpenCL::Platform objects.
1132
1133=item OpenCL::GLX_DISPLAY_KHR
1134
1135Also accepts C<undef>, in which case a deep and troubling hack is engaged
1136to find the current glx display (see L<GLX SUPPORT>).
1137
1138=item OpenCL::GL_CONTEXT_KHR
1139
1140Also accepts C<undef>, in which case a deep and troubling hack is engaged
1141to find the current glx context (see L<GLX SUPPORT>).
1142
1143=back
1024 1144
1025=over 4 1145=over 4
1026 1146
1027=item $prog = $ctx->build_program ($program, $options = "") 1147=item $prog = $ctx->build_program ($program, $options = "")
1028 1148
… …
1076=item $buf = $ctx->buffer ($flags, $len) 1196=item $buf = $ctx->buffer ($flags, $len)
1077 1197
1078Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1198Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1079given flags and octet-size. 1199given flags and octet-size.
1080 1200
1201flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
1202OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
1203OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
1204
1081L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1205L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1082 1206
1083=item $buf = $ctx->buffer_sv ($flags, $data) 1207=item $buf = $ctx->buffer_sv ($flags, $data)
1084 1208
1085Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1209Creates 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) 1212=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 1213
1090Creates a new OpenCL::Image object and optionally initialises it with 1214Creates a new OpenCL::Image object and optionally initialises it with
1091the given data values. 1215the given data values.
1092 1216
1217channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
1218OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
1219OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
1220
1221channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
1222OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1223OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1224OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1225OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1226
1227type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1228OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1229OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1230OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1231
1093L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> 1232L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1094 1233
1095=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1234=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1096 1235
1097Creates a new OpenCL::Image2D object and optionally initialises it with 1236Creates a new OpenCL::Image2D object and optionally initialises it with
… …
1109=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1248=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1110 1249
1111Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 1250Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1112OpenGL buffer object. 1251OpenGL buffer object.
1113 1252
1253flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1254
1114http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 1255http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1115 1256
1116=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1257=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1117 1258
1118Creates a new OpenCL::Image object that refers to the given OpenGL 1259Creates a new OpenCL::Image object that refers to the given OpenGL
1119texture object or buffer. 1260texture object or buffer.
1120 1261
1262target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
1263GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
1264GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
1265GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
1266GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
1267GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
1268
1121http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html 1269http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1122 1270
1123=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1271=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1124 1272
1125Creates a new OpenCL::Image2D object that refers to the given OpenGL 1273Creates a new OpenCL::Image2D object that refers to the given OpenGL
… …
1150 1298
1151=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1299=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1152 1300
1153Creates a new OpenCL::Sampler object. 1301Creates a new OpenCL::Sampler object.
1154 1302
1303addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
1304OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
1305
1306filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
1307
1155L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> 1308L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1156 1309
1157=item $program = $ctx->program_with_source ($string) 1310=item $program = $ctx->program_with_source ($string)
1158 1311
1159Creates a new OpenCL::Program object from the given source code. 1312Creates a new OpenCL::Program object from the given source code.
… …
1169Example: clone an existing program object that contains a successfully 1322Example: clone an existing program object that contains a successfully
1170compiled program, no matter how useless this is. 1323compiled program, no matter how useless this is.
1171 1324
1172 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]); 1325 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
1173 1326
1327=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1328
1329Creates a new OpenCL::Program object from the given built-in kernel names.
1330
1331L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1332
1333=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
1334
1335Links all (already compiled) program objects specified in C<@programs>
1336together and returns a new OpenCL::Program object with the result.
1337
1338L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
1339
1174=item $packed_value = $ctx->info ($name) 1340=item $packed_value = $ctx->info ($name)
1175 1341
1176See C<< $platform->info >> for details. 1342See C<< $platform->info >> for details.
1177 1343
1178L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 1344L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1179 1345
1180=for gengetinfo begin context 1346=for gengetinfo begin context
1181 1347
1182=item $uint = $context->reference_count 1348=item $uint = $context->reference_count
1183 1349
1184Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. 1350Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1185 1351
1186=item @devices = $context->devices 1352=item @devices = $context->devices
1187 1353
1188Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1354Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1189 1355
1190=item @property_ints = $context->properties 1356=item @property_ints = $context->properties
1191 1357
1192Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1358Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1193 1359
1194=item $uint = $context->num_devices 1360=item $uint = $context->num_devices
1195 1361
1196Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. 1362Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1197 1363
1198=for gengetinfo end context 1364=for gengetinfo end context
1199 1365
1200=back 1366=back
1201 1367
… …
1317reference to an array of local work sizes, with the same number of 1483reference to an array of local work sizes, with the same number of
1318elements as \@global_work_size. 1484elements as \@global_work_size.
1319 1485
1320L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1486L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1321 1487
1488=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
1489
1490Migrates a number of OpenCL::Memory objects to or from the device.
1491
1492flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
1493
1494L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
1495
1322=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1496=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1323 1497
1324Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1498Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1325for subsequent OpenCL usage. 1499for subsequent OpenCL usage.
1326 1500
… …
1361 1535
1362=for gengetinfo begin command_queue 1536=for gengetinfo begin command_queue
1363 1537
1364=item $ctx = $command_queue->context 1538=item $ctx = $command_queue->context
1365 1539
1366Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1540Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1367 1541
1368=item $device = $command_queue->device 1542=item $device = $command_queue->device
1369 1543
1370Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1544Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1371 1545
1372=item $uint = $command_queue->reference_count 1546=item $uint = $command_queue->reference_count
1373 1547
1374Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. 1548Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1375 1549
1376=item $command_queue_properties = $command_queue->properties 1550=item $command_queue_properties = $command_queue->properties
1377 1551
1378Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1552Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1379 1553
1380=for gengetinfo end command_queue 1554=for gengetinfo end command_queue
1381 1555
1382=back 1556=back
1383 1557
… …
1402 1576
1403Maps the given buffer into host memory and returns an 1577Maps the given buffer into host memory and returns an
1404C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then 1578C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1405the map will extend to the end of the buffer. 1579the map will extend to the end of the buffer.
1406 1580
1581map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1582
1407L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html> 1583L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1408 1584
1409Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap. 1585Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1410 1586
1411 { 1587 {
… …
1463 1639
1464=for gengetinfo begin mem 1640=for gengetinfo begin mem
1465 1641
1466=item $mem_object_type = $mem->type 1642=item $mem_object_type = $mem->type
1467 1643
1468Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1644Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1469 1645
1470=item $mem_flags = $mem->flags 1646=item $mem_flags = $mem->flags
1471 1647
1472Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1648Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1473 1649
1474=item $int = $mem->size 1650=item $int = $mem->size
1475 1651
1476Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1652Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1477 1653
1478=item $ptr_value = $mem->host_ptr 1654=item $ptr_value = $mem->host_ptr
1479 1655
1480Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. 1656Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1481 1657
1482=item $uint = $mem->map_count 1658=item $uint = $mem->map_count
1483 1659
1484Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. 1660Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1485 1661
1486=item $uint = $mem->reference_count 1662=item $uint = $mem->reference_count
1487 1663
1488Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. 1664Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1489 1665
1490=item $ctx = $mem->context 1666=item $ctx = $mem->context
1491 1667
1492Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1668Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1493 1669
1494=item $mem = $mem->associated_memobject 1670=item $mem = $mem->associated_memobject
1495 1671
1496Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. 1672Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1497 1673
1498=item $int = $mem->offset 1674=item $int = $mem->offset
1499 1675
1500Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1676Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1501 1677
1502=for gengetinfo end mem 1678=for gengetinfo end mem
1503 1679
1504=item ($type, $name) = $mem->gl_object_info 1680=item ($type, $name) = $mem->gl_object_info
1505 1681
… …
1557 1733
1558=for gengetinfo begin image 1734=for gengetinfo begin image
1559 1735
1560=item $int = $image->element_size 1736=item $int = $image->element_size
1561 1737
1562Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1738Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1563 1739
1564=item $int = $image->row_pitch 1740=item $int = $image->row_pitch
1565 1741
1566Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. 1742Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1567 1743
1568=item $int = $image->slice_pitch 1744=item $int = $image->slice_pitch
1569 1745
1570Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. 1746Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1571 1747
1572=item $int = $image->width 1748=item $int = $image->width
1573 1749
1574Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1750Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1575 1751
1576=item $int = $image->height 1752=item $int = $image->height
1577 1753
1578Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1754Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1579 1755
1580=item $int = $image->depth 1756=item $int = $image->depth
1581 1757
1582Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1758Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1583 1759
1584=for gengetinfo end image 1760=for gengetinfo end image
1585 1761
1586=for gengetinfo begin gl_texture 1762=for gengetinfo begin gl_texture
1587 1763
1588=item $GLenum = $gl_texture->target 1764=item $GLenum = $gl_texture->target
1589 1765
1590Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. 1766Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1591 1767
1592=item $GLint = $gl_texture->gl_mipmap_level 1768=item $GLint = $gl_texture->gl_mipmap_level
1593 1769
1594Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. 1770Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1595 1771
1596=for gengetinfo end gl_texture 1772=for gengetinfo end gl_texture
1597 1773
1598=back 1774=back
1599 1775
… …
1609 1785
1610=for gengetinfo begin sampler 1786=for gengetinfo begin sampler
1611 1787
1612=item $uint = $sampler->reference_count 1788=item $uint = $sampler->reference_count
1613 1789
1614Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. 1790Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1615 1791
1616=item $ctx = $sampler->context 1792=item $ctx = $sampler->context
1617 1793
1618Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1794Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1619 1795
1620=item $addressing_mode = $sampler->normalized_coords 1796=item $addressing_mode = $sampler->normalized_coords
1621 1797
1622Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. 1798Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1623 1799
1624=item $filter_mode = $sampler->addressing_mode 1800=item $filter_mode = $sampler->addressing_mode
1625 1801
1626Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. 1802Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1627 1803
1628=item $boolean = $sampler->filter_mode 1804=item $boolean = $sampler->filter_mode
1629 1805
1630Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. 1806Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1631 1807
1632=for gengetinfo end sampler 1808=for gengetinfo end sampler
1633 1809
1634=back 1810=back
1635 1811
… …
1653not so. So best make sure you don't pass in invalid values. 1829not so. So best make sure you don't pass in invalid values.
1654 1830
1655Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1831Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1656compilation state is successful but some later stage fails. 1832compilation state is successful but some later stage fails.
1657 1833
1834options: C<-D name>, C<-D name=definition>, C<-I dir>,
1835C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
1836C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
1837C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1838C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1839C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1840C<-create-library>, C<-enable-link-options>.
1841
1842build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
1843OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1844
1658L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1845L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1659 1846
1660=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1847=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1661 1848
1662Similar to C<< ->build >>, except it starts a thread, and never fails (you 1849Similar to C<< ->build >>, except it starts a thread, and never fails (you
1663need to check the compilation status form the callback, or by polling). 1850need to check the compilation status form the callback, or by polling).
1664 1851
1852=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1853
1854Compiles the given program for the given devices (or all devices if
1855undef). If C<$headers> is given, it must be a hashref with include name =>
1856OpenCL::Program pairs.
1857
1858L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1859
1665=item $packed_value = $program->build_info ($device, $name) 1860=item $packed_value = $program->build_info ($device, $name)
1666 1861
1667Similar to C<< $platform->info >>, but returns build info for a previous 1862Similar to C<< $platform->info >>, but returns build info for a previous
1668build attempt for the given device. 1863build attempt for the given device.
1669 1864
1865binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
1866OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
1867OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
1868OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
1869
1670L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html> 1870L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1671 1871
1672=item $kernel = $program->kernel ($function_name) 1872=item $kernel = $program->kernel ($function_name)
1673 1873
1674Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1874Creates an OpenCL::Kernel object out of the named C<__kernel> function in
… …
1684 1884
1685=for gengetinfo begin program_build 1885=for gengetinfo begin program_build
1686 1886
1687=item $build_status = $program->build_status ($device) 1887=item $build_status = $program->build_status ($device)
1688 1888
1689Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. 1889Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1690 1890
1691=item $string = $program->build_options ($device) 1891=item $string = $program->build_options ($device)
1692 1892
1693Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. 1893Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1694 1894
1695=item $string = $program->build_log ($device) 1895=item $string = $program->build_log ($device)
1696 1896
1697Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. 1897Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1698 1898
1699=for gengetinfo end program_build 1899=for gengetinfo end program_build
1700 1900
1701=item $packed_value = $program->info ($name) 1901=item $packed_value = $program->info ($name)
1702 1902
… …
1706 1906
1707=for gengetinfo begin program 1907=for gengetinfo begin program
1708 1908
1709=item $uint = $program->reference_count 1909=item $uint = $program->reference_count
1710 1910
1711Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. 1911Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1712 1912
1713=item $ctx = $program->context 1913=item $ctx = $program->context
1714 1914
1715Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1915Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1716 1916
1717=item $uint = $program->num_devices 1917=item $uint = $program->num_devices
1718 1918
1719Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. 1919Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1720 1920
1721=item @devices = $program->devices 1921=item @devices = $program->devices
1722 1922
1723Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1923Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1724 1924
1725=item $string = $program->source 1925=item $string = $program->source
1726 1926
1727Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1927Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1728 1928
1729=item @ints = $program->binary_sizes 1929=item @ints = $program->binary_sizes
1730 1930
1731Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. 1931Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1732 1932
1733=for gengetinfo end program 1933=for gengetinfo end program
1734 1934
1735=item @blobs = $program->binaries 1935=item @blobs = $program->binaries
1736 1936
… …
1757 1957
1758=for gengetinfo begin kernel 1958=for gengetinfo begin kernel
1759 1959
1760=item $string = $kernel->function_name 1960=item $string = $kernel->function_name
1761 1961
1762Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. 1962Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1763 1963
1764=item $uint = $kernel->num_args 1964=item $uint = $kernel->num_args
1765 1965
1766Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. 1966Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1767 1967
1768=item $uint = $kernel->reference_count 1968=item $uint = $kernel->reference_count
1769 1969
1770Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. 1970Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1771 1971
1772=item $ctx = $kernel->context 1972=item $ctx = $kernel->context
1773 1973
1774Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1974Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1775 1975
1776=item $program = $kernel->program 1976=item $program = $kernel->program
1777 1977
1778Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1978Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1779 1979
1780=for gengetinfo end kernel 1980=for gengetinfo end kernel
1781 1981
1782=item $packed_value = $kernel->work_group_info ($device, $name) 1982=item $packed_value = $kernel->work_group_info ($device, $name)
1783 1983
1784See C<< $platform->info >> for details. 1984See C<< $platform->info >> for details.
1785 1985
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> 1986L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1790 1987
1791=for gengetinfo begin kernel_work_group 1988=for gengetinfo begin kernel_work_group
1792 1989
1793=item $int = $kernel->work_group_size ($device) 1990=item $int = $kernel->work_group_size ($device)
1794 1991
1795Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. 1992Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1796 1993
1797=item @ints = $kernel->compile_work_group_size ($device) 1994=item @ints = $kernel->compile_work_group_size ($device)
1798 1995
1799Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. 1996Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1800 1997
1801=item $ulong = $kernel->local_mem_size ($device) 1998=item $ulong = $kernel->local_mem_size ($device)
1802 1999
1803Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. 2000Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1804 2001
1805=item $int = $kernel->preferred_work_group_size_multiple ($device) 2002=item $int = $kernel->preferred_work_group_size_multiple ($device)
1806 2003
1807Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. 2004Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1808 2005
1809=item $ulong = $kernel->private_mem_size ($device) 2006=item $ulong = $kernel->private_mem_size ($device)
1810 2007
1811Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. 2008Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1812 2009
1813=for gengetinfo end kernel_work_group 2010=for gengetinfo end kernel_work_group
2011
2012=item $packed_value = $kernel->arg_info ($idx, $name)
2013
2014See C<< $platform->info >> for details.
2015
2016L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
2017
2018=for gengetinfo begin kernel_arg
2019
2020=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
2021
2022Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
2023
2024=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
2025
2026Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
2027
2028=item $string = $kernel->arg_type_name ($idx)
2029
2030Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
2031
2032=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
2033
2034Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
2035
2036=item $string = $kernel->arg_name ($idx)
2037
2038Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
2039
2040=for gengetinfo end kernel_arg
1814 2041
1815=item $kernel->setf ($format, ...) 2042=item $kernel->setf ($format, ...)
1816 2043
1817Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic 2044Sets 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 2045way to set arguments (and with OpenCL 1.2 it might be rather slow), you
… …
1930 2157
1931=for gengetinfo begin event 2158=for gengetinfo begin event
1932 2159
1933=item $queue = $event->command_queue 2160=item $queue = $event->command_queue
1934 2161
1935Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. 2162Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1936 2163
1937=item $command_type = $event->command_type 2164=item $command_type = $event->command_type
1938 2165
1939Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. 2166Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1940 2167
1941=item $uint = $event->reference_count 2168=item $uint = $event->reference_count
1942 2169
1943Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. 2170Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1944 2171
1945=item $uint = $event->command_execution_status 2172=item $uint = $event->command_execution_status
1946 2173
1947Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. 2174Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1948 2175
1949=item $ctx = $event->context 2176=item $ctx = $event->context
1950 2177
1951Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2178Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1952 2179
1953=for gengetinfo end event 2180=for gengetinfo end event
1954 2181
1955=item $packed_value = $ev->profiling_info ($name) 2182=item $packed_value = $ev->profiling_info ($name)
1956 2183
… …
1963 2190
1964=for gengetinfo begin profiling 2191=for gengetinfo begin profiling
1965 2192
1966=item $ulong = $event->profiling_command_queued 2193=item $ulong = $event->profiling_command_queued
1967 2194
1968Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. 2195Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1969 2196
1970=item $ulong = $event->profiling_command_submit 2197=item $ulong = $event->profiling_command_submit
1971 2198
1972Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. 2199Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1973 2200
1974=item $ulong = $event->profiling_command_start 2201=item $ulong = $event->profiling_command_start
1975 2202
1976Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. 2203Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1977 2204
1978=item $ulong = $event->profiling_command_end 2205=item $ulong = $event->profiling_command_end
1979 2206
1980Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. 2207Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1981 2208
1982=for gengetinfo end profiling 2209=for gengetinfo end profiling
1983 2210
1984=back 2211=back
1985 2212
… …
1991 2218
1992=item $ev->set_status ($execution_status) 2219=item $ev->set_status ($execution_status)
1993 2220
1994Sets the execution status of the user event. Can only be called once, 2221Sets the execution status of the user event. Can only be called once,
1995either with OpenCL::COMPLETE or a negative number as status. 2222either with OpenCL::COMPLETE or a negative number as status.
2223
2224execution_status: OpenCL::COMPLETE or a negative integer.
1996 2225
1997L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2226L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1998 2227
1999=back 2228=back
2000 2229

Diff Legend

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