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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.64 by root, Mon Apr 30 23:12:43 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";
304 336
305 glXSwapBuffers; 337 glXSwapBuffers;
306 338
307 select undef, undef, undef, 1/60; 339 select undef, undef, undef, 1/60;
308 } 340 }
341
342=head2 How to modify the previous example to not rely on GL sharing.
343
344For those poor souls with only a sucky CPU OpenCL implementation, you
345currently have to read the image into some perl scalar, and then modify a
346texture or use glDrawPixels or so).
347
348First, when you don't need gl sharing, you can create the context much simpler:
349
350 $ctx = $platform->context (undef, [$dev])
351
352To use a texture, you would modify the above example by creating an
353OpenCL::Image manually instead of deriving it from a texture:
354
355 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
356
357And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
358would read the image2d after the kernel has written it:
359
360 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
361
362And then you would upload the pixel data to the texture (or use glDrawPixels):
363
364 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
365
366The fully modified example can be found at
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>.
309 385
310=head1 DOCUMENTATION 386=head1 DOCUMENTATION
311 387
312=head2 BASIC CONVENTIONS 388=head2 BASIC CONVENTIONS
313 389
389OpenCL can generate a number of (potentially) asynchronous events, for 465OpenCL can generate a number of (potentially) asynchronous events, for
390example, after compiling a program, to signal a context-related error or, 466example, after compiling a program, to signal a context-related error or,
391perhaps most important, to signal completion of queued jobs (by setting 467perhaps most important, to signal completion of queued jobs (by setting
392callbacks on OpenCL::Event objects). 468callbacks on OpenCL::Event objects).
393 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
394To facilitate this, this module maintains an event queue - each 477To facilitate this, this module maintains an event queue - each
395time an asynchronous event happens, it is queued, and perl will be 478time an asynchronous event happens, it is queued, and perl will be
396interrupted. This is implemented via the L<Async::Interrupt> module. In 479interrupted. This is implemented via the L<Async::Interrupt> module. In
397addition, this module has L<AnyEvent> support, so it can seamlessly 480addition, this module has L<AnyEvent> support, so it can seamlessly
398integrate itself into many event loops. 481integrate itself into many event loops.
399 482
400Since 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:
401 484
402=head3 Don't use callbacks. 485=head3 Don't use callbacks.
403 486
404When 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
405notifications 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
502use Async::Interrupt (); 585use Async::Interrupt ();
503 586
504our $POLL_FUNC; # set by XS 587our $POLL_FUNC; # set by XS
505 588
506BEGIN { 589BEGIN {
507 our $VERSION = '0.98'; 590 our $VERSION = '0.99';
508 591
509 require XSLoader; 592 require XSLoader;
510 XSLoader::load (__PACKAGE__, $VERSION); 593 XSLoader::load (__PACKAGE__, $VERSION);
511 594
512 @OpenCL::Platform::ISA = 595 @OpenCL::Platform::ISA =
517 @OpenCL::Sampler::ISA = 600 @OpenCL::Sampler::ISA =
518 @OpenCL::Program::ISA = 601 @OpenCL::Program::ISA =
519 @OpenCL::Kernel::ISA = 602 @OpenCL::Kernel::ISA =
520 @OpenCL::Event::ISA = OpenCL::Object::; 603 @OpenCL::Event::ISA = OpenCL::Object::;
521 604
605 @OpenCL::SubDevice::ISA = OpenCL::Device::;
606
522 @OpenCL::Buffer::ISA = 607 @OpenCL::Buffer::ISA =
523 @OpenCL::Image::ISA = OpenCL::Memory::; 608 @OpenCL::Image::ISA = OpenCL::Memory::;
524 609
525 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 610 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
526 611
530 @OpenCL::Image1D::ISA = 615 @OpenCL::Image1D::ISA =
531 @OpenCL::Image1DArray::ISA = 616 @OpenCL::Image1DArray::ISA =
532 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; 617 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
533 618
534 @OpenCL::UserEvent::ISA = OpenCL::Event::; 619 @OpenCL::UserEvent::ISA = OpenCL::Event::;
620
621 @OpenCL::MappedBuffer::ISA =
622 @OpenCL::MappedImage::ISA = OpenCL::Mapped::;
535} 623}
536 624
537=head2 THE OpenCL PACKAGE 625=head2 THE OpenCL PACKAGE
538 626
539=over 4 627=over 4
563L<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>
564 652
565=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
566 654
567Tries 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.
568 660
569L<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>
570 662
571=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 663=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
572 664
573Create a new OpenCL::Context object using the given device object(s). This 665Create a new OpenCL::Context object using the given device object(s).
574function isn't implemented yet, use C<< $platform->context >> instead. 666Consider using C<< $platform->context >> instead.
575 667
576L<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>
577 669
578=item OpenCL::wait_for_events $wait_events... 670=item OpenCL::wait_for_events $wait_events...
579 671
686 778
687=for gengetinfo begin platform 779=for gengetinfo begin platform
688 780
689=item $string = $platform->profile 781=item $string = $platform->profile
690 782
691Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 783Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
692 784
693=item $string = $platform->version 785=item $string = $platform->version
694 786
695Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 787Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
696 788
697=item $string = $platform->name 789=item $string = $platform->name
698 790
699Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 791Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
700 792
701=item $string = $platform->vendor 793=item $string = $platform->vendor
702 794
703Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 795Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
704 796
705=item $string = $platform->extensions 797=item $string = $platform->extensions
706 798
707Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 799Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
708 800
709=for gengetinfo end platform 801=for gengetinfo end platform
710 802
711=back 803=back
712 804
716 808
717=item $packed_value = $device->info ($name) 809=item $packed_value = $device->info ($name)
718 810
719See C<< $platform->info >> for details. 811See C<< $platform->info >> for details.
720 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
721L<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>
722 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
723=for gengetinfo begin device 847=for gengetinfo begin device
724 848
725=item $device_type = $device->type 849=item $device_type = $device->type
726 850
727Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 851Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
728 852
729=item $uint = $device->vendor_id 853=item $uint = $device->vendor_id
730 854
731Calls 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.
732 856
733=item $uint = $device->max_compute_units 857=item $uint = $device->max_compute_units
734 858
735Calls 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.
736 860
737=item $uint = $device->max_work_item_dimensions 861=item $uint = $device->max_work_item_dimensions
738 862
739Calls 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.
740 864
741=item $int = $device->max_work_group_size 865=item $int = $device->max_work_group_size
742 866
743Calls 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.
744 868
745=item @ints = $device->max_work_item_sizes 869=item @ints = $device->max_work_item_sizes
746 870
747Calls 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.
748 872
749=item $uint = $device->preferred_vector_width_char 873=item $uint = $device->preferred_vector_width_char
750 874
751Calls 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.
752 876
753=item $uint = $device->preferred_vector_width_short 877=item $uint = $device->preferred_vector_width_short
754 878
755Calls 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.
756 880
757=item $uint = $device->preferred_vector_width_int 881=item $uint = $device->preferred_vector_width_int
758 882
759Calls 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.
760 884
761=item $uint = $device->preferred_vector_width_long 885=item $uint = $device->preferred_vector_width_long
762 886
763Calls 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.
764 888
765=item $uint = $device->preferred_vector_width_float 889=item $uint = $device->preferred_vector_width_float
766 890
767Calls 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.
768 892
769=item $uint = $device->preferred_vector_width_double 893=item $uint = $device->preferred_vector_width_double
770 894
771Calls 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.
772 896
773=item $uint = $device->max_clock_frequency 897=item $uint = $device->max_clock_frequency
774 898
775Calls 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.
776 900
777=item $bitfield = $device->address_bits 901=item $bitfield = $device->address_bits
778 902
779Calls 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.
780 904
781=item $uint = $device->max_read_image_args 905=item $uint = $device->max_read_image_args
782 906
783Calls 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.
784 908
785=item $uint = $device->max_write_image_args 909=item $uint = $device->max_write_image_args
786 910
787Calls 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.
788 912
789=item $ulong = $device->max_mem_alloc_size 913=item $ulong = $device->max_mem_alloc_size
790 914
791Calls 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.
792 916
793=item $int = $device->image2d_max_width 917=item $int = $device->image2d_max_width
794 918
795Calls 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.
796 920
797=item $int = $device->image2d_max_height 921=item $int = $device->image2d_max_height
798 922
799Calls 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.
800 924
801=item $int = $device->image3d_max_width 925=item $int = $device->image3d_max_width
802 926
803Calls 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.
804 928
805=item $int = $device->image3d_max_height 929=item $int = $device->image3d_max_height
806 930
807Calls 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.
808 932
809=item $int = $device->image3d_max_depth 933=item $int = $device->image3d_max_depth
810 934
811Calls 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.
812 936
813=item $uint = $device->image_support 937=item $uint = $device->image_support
814 938
815Calls 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.
816 940
817=item $int = $device->max_parameter_size 941=item $int = $device->max_parameter_size
818 942
819Calls 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.
820 944
821=item $uint = $device->max_samplers 945=item $uint = $device->max_samplers
822 946
823Calls 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.
824 948
825=item $uint = $device->mem_base_addr_align 949=item $uint = $device->mem_base_addr_align
826 950
827Calls 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.
828 952
829=item $uint = $device->min_data_type_align_size 953=item $uint = $device->min_data_type_align_size
830 954
831Calls 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.
832 956
833=item $device_fp_config = $device->single_fp_config 957=item $device_fp_config = $device->single_fp_config
834 958
835Calls 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.
836 960
837=item $device_mem_cache_type = $device->global_mem_cache_type 961=item $device_mem_cache_type = $device->global_mem_cache_type
838 962
839Calls 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.
840 964
841=item $uint = $device->global_mem_cacheline_size 965=item $uint = $device->global_mem_cacheline_size
842 966
843Calls 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.
844 968
845=item $ulong = $device->global_mem_cache_size 969=item $ulong = $device->global_mem_cache_size
846 970
847Calls 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.
848 972
849=item $ulong = $device->global_mem_size 973=item $ulong = $device->global_mem_size
850 974
851Calls 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.
852 976
853=item $ulong = $device->max_constant_buffer_size 977=item $ulong = $device->max_constant_buffer_size
854 978
855Calls 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.
856 980
857=item $uint = $device->max_constant_args 981=item $uint = $device->max_constant_args
858 982
859Calls 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.
860 984
861=item $device_local_mem_type = $device->local_mem_type 985=item $device_local_mem_type = $device->local_mem_type
862 986
863Calls 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.
864 988
865=item $ulong = $device->local_mem_size 989=item $ulong = $device->local_mem_size
866 990
867Calls 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.
868 992
869=item $boolean = $device->error_correction_support 993=item $boolean = $device->error_correction_support
870 994
871Calls 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.
872 996
873=item $int = $device->profiling_timer_resolution 997=item $int = $device->profiling_timer_resolution
874 998
875Calls 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.
876 1000
877=item $boolean = $device->endian_little 1001=item $boolean = $device->endian_little
878 1002
879Calls 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.
880 1004
881=item $boolean = $device->available 1005=item $boolean = $device->available
882 1006
883Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 1007Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
884 1008
885=item $boolean = $device->compiler_available 1009=item $boolean = $device->compiler_available
886 1010
887Calls 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.
888 1012
889=item $device_exec_capabilities = $device->execution_capabilities 1013=item $device_exec_capabilities = $device->execution_capabilities
890 1014
891Calls 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.
892 1016
893=item $command_queue_properties = $device->properties 1017=item $command_queue_properties = $device->properties
894 1018
895Calls 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.
896 1020
897=item $ = $device->platform 1021=item $ = $device->platform
898 1022
899Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 1023Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
900 1024
901=item $string = $device->name 1025=item $string = $device->name
902 1026
903Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 1027Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
904 1028
905=item $string = $device->vendor 1029=item $string = $device->vendor
906 1030
907Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 1031Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
908 1032
909=item $string = $device->driver_version 1033=item $string = $device->driver_version
910 1034
911Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 1035Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
912 1036
913=item $string = $device->profile 1037=item $string = $device->profile
914 1038
915Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 1039Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
916 1040
917=item $string = $device->version 1041=item $string = $device->version
918 1042
919Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 1043Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
920 1044
921=item $string = $device->extensions 1045=item $string = $device->extensions
922 1046
923Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 1047Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
924 1048
925=item $uint = $device->preferred_vector_width_half 1049=item $uint = $device->preferred_vector_width_half
926 1050
927Calls 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.
928 1052
929=item $uint = $device->native_vector_width_char 1053=item $uint = $device->native_vector_width_char
930 1054
931Calls 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.
932 1056
933=item $uint = $device->native_vector_width_short 1057=item $uint = $device->native_vector_width_short
934 1058
935Calls 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.
936 1060
937=item $uint = $device->native_vector_width_int 1061=item $uint = $device->native_vector_width_int
938 1062
939Calls 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.
940 1064
941=item $uint = $device->native_vector_width_long 1065=item $uint = $device->native_vector_width_long
942 1066
943Calls 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.
944 1068
945=item $uint = $device->native_vector_width_float 1069=item $uint = $device->native_vector_width_float
946 1070
947Calls 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.
948 1072
949=item $uint = $device->native_vector_width_double 1073=item $uint = $device->native_vector_width_double
950 1074
951Calls 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.
952 1076
953=item $uint = $device->native_vector_width_half 1077=item $uint = $device->native_vector_width_half
954 1078
955Calls 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.
956 1080
957=item $device_fp_config = $device->double_fp_config 1081=item $device_fp_config = $device->double_fp_config
958 1082
959Calls 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.
960 1084
961=item $device_fp_config = $device->half_fp_config 1085=item $device_fp_config = $device->half_fp_config
962 1086
963Calls 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.
964 1088
965=item $boolean = $device->host_unified_memory 1089=item $boolean = $device->host_unified_memory
966 1090
967Calls 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.
968 1092
969=item $device = $device->parent_device_ext 1093=item $device = $device->parent_device_ext
970 1094
971Calls 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.
972 1096
973=item @device_partition_property_exts = $device->partition_types_ext 1097=item @device_partition_property_exts = $device->partition_types_ext
974 1098
975Calls 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.
976 1100
977=item @device_partition_property_exts = $device->affinity_domains_ext 1101=item @device_partition_property_exts = $device->affinity_domains_ext
978 1102
979Calls 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.
980 1104
981=item $uint = $device->reference_count_ext 1105=item $uint = $device->reference_count_ext
982 1106
983Calls 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.
984 1108
985=item @device_partition_property_exts = $device->partition_style_ext 1109=item @device_partition_property_exts = $device->partition_style_ext
986 1110
987Calls 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.
988 1112
989=for gengetinfo end device 1113=for gengetinfo end device
990 1114
991=back 1115=back
992 1116
993=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
994 1144
995=over 4 1145=over 4
996 1146
997=item $prog = $ctx->build_program ($program, $options = "") 1147=item $prog = $ctx->build_program ($program, $options = "")
998 1148
1046=item $buf = $ctx->buffer ($flags, $len) 1196=item $buf = $ctx->buffer ($flags, $len)
1047 1197
1048Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1198Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1049given flags and octet-size. 1199given flags and octet-size.
1050 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
1051L<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>
1052 1206
1053=item $buf = $ctx->buffer_sv ($flags, $data) 1207=item $buf = $ctx->buffer_sv ($flags, $data)
1054 1208
1055Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1209Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1058=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)
1059 1213
1060Creates a new OpenCL::Image object and optionally initialises it with 1214Creates a new OpenCL::Image object and optionally initialises it with
1061the given data values. 1215the given data values.
1062 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
1063L<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>
1064 1233
1065=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)
1066 1235
1067Creates a new OpenCL::Image2D object and optionally initialises it with 1236Creates a new OpenCL::Image2D object and optionally initialises it with
1079=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1248=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1080 1249
1081Creates 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
1082OpenGL buffer object. 1251OpenGL buffer object.
1083 1252
1253flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1254
1084http://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
1085 1256
1086=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1257=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1087 1258
1088Creates a new OpenCL::Image object that refers to the given OpenGL 1259Creates a new OpenCL::Image object that refers to the given OpenGL
1089texture object or buffer. 1260texture object or buffer.
1090 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
1091http://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
1092 1270
1093=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1271=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1094 1272
1095Creates a new OpenCL::Image2D object that refers to the given OpenGL 1273Creates a new OpenCL::Image2D object that refers to the given OpenGL
1120 1298
1121=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1299=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1122 1300
1123Creates a new OpenCL::Sampler object. 1301Creates a new OpenCL::Sampler object.
1124 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
1125L<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>
1126 1309
1127=item $program = $ctx->program_with_source ($string) 1310=item $program = $ctx->program_with_source ($string)
1128 1311
1129Creates a new OpenCL::Program object from the given source code. 1312Creates a new OpenCL::Program object from the given source code.
1130 1313
1131L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 1314L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1132 1315
1316=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
1317
1318Creates a new OpenCL::Program object from the given binaries.
1319
1320L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
1321
1322Example: clone an existing program object that contains a successfully
1323compiled program, no matter how useless this is.
1324
1325 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
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
1133=item $packed_value = $ctx->info ($name) 1340=item $packed_value = $ctx->info ($name)
1134 1341
1135See C<< $platform->info >> for details. 1342See C<< $platform->info >> for details.
1136 1343
1137L<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>
1138 1345
1139=for gengetinfo begin context 1346=for gengetinfo begin context
1140 1347
1141=item $uint = $context->reference_count 1348=item $uint = $context->reference_count
1142 1349
1143Calls 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.
1144 1351
1145=item @devices = $context->devices 1352=item @devices = $context->devices
1146 1353
1147Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1354Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1148 1355
1149=item @property_ints = $context->properties 1356=item @property_ints = $context->properties
1150 1357
1151Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1358Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1152 1359
1153=item $uint = $context->num_devices 1360=item $uint = $context->num_devices
1154 1361
1155Calls 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.
1156 1363
1157=for gengetinfo end context 1364=for gengetinfo end context
1158 1365
1159=back 1366=back
1160 1367
1207 1414
1208=item $ev = $queue->write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...) 1415=item $ev = $queue->write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
1209 1416
1210http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html 1417http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1211 1418
1419=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1420
1421L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
1422
1212=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1423=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1213 1424
1214L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> 1425C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1215 1426module uses the image width (and height) to supply default values.
1216=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1217 1427
1218L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1428L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1219 1429
1220=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1430=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1221 1431
1432C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1433module uses the image width (and height) to supply default values.
1222L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1434L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1223 1435
1224=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) 1436=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1225 1437
1226L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1438L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1271reference 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
1272elements as \@global_work_size. 1484elements as \@global_work_size.
1273 1485
1274L<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>
1275 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
1276=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1496=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1277 1497
1278Enqueues 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
1279for subsequent OpenCL usage. 1499for subsequent OpenCL usage.
1280 1500
1315 1535
1316=for gengetinfo begin command_queue 1536=for gengetinfo begin command_queue
1317 1537
1318=item $ctx = $command_queue->context 1538=item $ctx = $command_queue->context
1319 1539
1320Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1540Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1321 1541
1322=item $device = $command_queue->device 1542=item $device = $command_queue->device
1323 1543
1324Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1544Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1325 1545
1326=item $uint = $command_queue->reference_count 1546=item $uint = $command_queue->reference_count
1327 1547
1328Calls 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.
1329 1549
1330=item $command_queue_properties = $command_queue->properties 1550=item $command_queue_properties = $command_queue->properties
1331 1551
1332Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1552Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1333 1553
1334=for gengetinfo end command_queue 1554=for gengetinfo end command_queue
1555
1556=back
1557
1558=head3 MEMORY MAPPED BUFFERS
1559
1560OpenCL allows you to map buffers and images to host memory (read: perl
1561scalars). This is done much like reading or copying a buffer, by enqueuing
1562a map or unmap operation on the command queue.
1563
1564The map operations return an C<OpenCL::Mapped> object - see L<THE
1565OpenCL::Mapped CLASS> section for details on what to do with these
1566objects.
1567
1568The object will be unmapped automatically when the mapped object is
1569destroyed (you can use a barrier to make sure the unmap has finished,
1570before using the buffer in a kernel), but you can also enqueue an unmap
1571operation manually.
1572
1573=over 4
1574
1575=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
1576
1577Maps the given buffer into host memory and returns an
1578C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1579the map will extend to the end of the buffer.
1580
1581map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1582
1583L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1584
1585Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1586
1587 {
1588 my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
1589 substr $$mapped, 0, 4, "abcd";
1590 } # asynchronously unmap because $mapped is destroyed
1591
1592=item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...)
1593
1594Maps the given image area into host memory and return an
1595C<OpenCL::MappedImage> object.
1596
1597If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
1598will be replaced by the maximum possible value.
1599
1600L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
1601
1602Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
1603the first channel of the leftmost column to 5, then explicitly unmap
1604it. You are not necessarily meant to do it this way, this example just
1605shows you the accessors to use :)
1606
1607 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
1608
1609 $mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
1610 for 0..$image->height;
1611
1612 $mapped->unmap;.
1613 $mapped->wait; # only needed for out of order queues normally
1614
1615=item $ev = $queue->unmap ($mapped, $wait_events...)
1616
1617Unmaps the data from host memory. You must not call any methods that
1618modify the data, or modify the data scalar directly, after calling this
1619method.
1620
1621The mapped event object will always be passed as part of the
1622$wait_events. The mapped event object will be replaced by the new event
1623object that this request creates.
1335 1624
1336=back 1625=back
1337 1626
1338=head2 THE OpenCL::Memory CLASS 1627=head2 THE OpenCL::Memory CLASS
1339 1628
1350 1639
1351=for gengetinfo begin mem 1640=for gengetinfo begin mem
1352 1641
1353=item $mem_object_type = $mem->type 1642=item $mem_object_type = $mem->type
1354 1643
1355Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1644Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1356 1645
1357=item $mem_flags = $mem->flags 1646=item $mem_flags = $mem->flags
1358 1647
1359Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1648Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1360 1649
1361=item $int = $mem->size 1650=item $int = $mem->size
1362 1651
1363Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1652Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1364 1653
1365=item $ptr_value = $mem->host_ptr 1654=item $ptr_value = $mem->host_ptr
1366 1655
1367Calls 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.
1368 1657
1369=item $uint = $mem->map_count 1658=item $uint = $mem->map_count
1370 1659
1371Calls 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.
1372 1661
1373=item $uint = $mem->reference_count 1662=item $uint = $mem->reference_count
1374 1663
1375Calls 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.
1376 1665
1377=item $ctx = $mem->context 1666=item $ctx = $mem->context
1378 1667
1379Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1668Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1380 1669
1381=item $mem = $mem->associated_memobject 1670=item $mem = $mem->associated_memobject
1382 1671
1383Calls 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.
1384 1673
1385=item $int = $mem->offset 1674=item $int = $mem->offset
1386 1675
1387Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1676Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1388 1677
1389=for gengetinfo end mem 1678=for gengetinfo end mem
1390 1679
1391=item ($type, $name) = $mem->gl_object_info 1680=item ($type, $name) = $mem->gl_object_info
1392 1681
1444 1733
1445=for gengetinfo begin image 1734=for gengetinfo begin image
1446 1735
1447=item $int = $image->element_size 1736=item $int = $image->element_size
1448 1737
1449Calls 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.
1450 1739
1451=item $int = $image->row_pitch 1740=item $int = $image->row_pitch
1452 1741
1453Calls 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.
1454 1743
1455=item $int = $image->slice_pitch 1744=item $int = $image->slice_pitch
1456 1745
1457Calls 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.
1458 1747
1459=item $int = $image->width 1748=item $int = $image->width
1460 1749
1461Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1750Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1462 1751
1463=item $int = $image->height 1752=item $int = $image->height
1464 1753
1465Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1754Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1466 1755
1467=item $int = $image->depth 1756=item $int = $image->depth
1468 1757
1469Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1758Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1470 1759
1471=for gengetinfo end image 1760=for gengetinfo end image
1472 1761
1473=for gengetinfo begin gl_texture 1762=for gengetinfo begin gl_texture
1474 1763
1475=item $GLenum = $gl_texture->target 1764=item $GLenum = $gl_texture->target
1476 1765
1477Calls 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.
1478 1767
1479=item $GLint = $gl_texture->gl_mipmap_level 1768=item $GLint = $gl_texture->gl_mipmap_level
1480 1769
1481Calls 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.
1482 1771
1483=for gengetinfo end gl_texture 1772=for gengetinfo end gl_texture
1484 1773
1485=back 1774=back
1486 1775
1496 1785
1497=for gengetinfo begin sampler 1786=for gengetinfo begin sampler
1498 1787
1499=item $uint = $sampler->reference_count 1788=item $uint = $sampler->reference_count
1500 1789
1501Calls 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.
1502 1791
1503=item $ctx = $sampler->context 1792=item $ctx = $sampler->context
1504 1793
1505Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1794Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1506 1795
1507=item $addressing_mode = $sampler->normalized_coords 1796=item $addressing_mode = $sampler->normalized_coords
1508 1797
1509Calls 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.
1510 1799
1511=item $filter_mode = $sampler->addressing_mode 1800=item $filter_mode = $sampler->addressing_mode
1512 1801
1513Calls 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.
1514 1803
1515=item $boolean = $sampler->filter_mode 1804=item $boolean = $sampler->filter_mode
1516 1805
1517Calls 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.
1518 1807
1519=for gengetinfo end sampler 1808=for gengetinfo end sampler
1520 1809
1521=back 1810=back
1522 1811
1540not 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.
1541 1830
1542Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1831Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1543compilation state is successful but some later stage fails. 1832compilation state is successful but some later stage fails.
1544 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
1545L<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>
1546 1846
1547=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1847=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1548 1848
1549Similar 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
1550need to check the compilation status form the callback, or by polling). 1850need to check the compilation status form the callback, or by polling).
1551 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
1552=item $packed_value = $program->build_info ($device, $name) 1860=item $packed_value = $program->build_info ($device, $name)
1553 1861
1554Similar to C<< $platform->info >>, but returns build info for a previous 1862Similar to C<< $platform->info >>, but returns build info for a previous
1555build attempt for the given device. 1863build attempt for the given device.
1556 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
1557L<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>
1558 1871
1559=item $kernel = $program->kernel ($function_name) 1872=item $kernel = $program->kernel ($function_name)
1560 1873
1561Creates 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
1571 1884
1572=for gengetinfo begin program_build 1885=for gengetinfo begin program_build
1573 1886
1574=item $build_status = $program->build_status ($device) 1887=item $build_status = $program->build_status ($device)
1575 1888
1576Calls 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.
1577 1890
1578=item $string = $program->build_options ($device) 1891=item $string = $program->build_options ($device)
1579 1892
1580Calls 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.
1581 1894
1582=item $string = $program->build_log ($device) 1895=item $string = $program->build_log ($device)
1583 1896
1584Calls 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.
1585 1898
1586=for gengetinfo end program_build 1899=for gengetinfo end program_build
1587 1900
1588=item $packed_value = $program->info ($name) 1901=item $packed_value = $program->info ($name)
1589 1902
1593 1906
1594=for gengetinfo begin program 1907=for gengetinfo begin program
1595 1908
1596=item $uint = $program->reference_count 1909=item $uint = $program->reference_count
1597 1910
1598Calls 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.
1599 1912
1600=item $ctx = $program->context 1913=item $ctx = $program->context
1601 1914
1602Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1915Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1603 1916
1604=item $uint = $program->num_devices 1917=item $uint = $program->num_devices
1605 1918
1606Calls 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.
1607 1920
1608=item @devices = $program->devices 1921=item @devices = $program->devices
1609 1922
1610Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1923Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1611 1924
1612=item $string = $program->source 1925=item $string = $program->source
1613 1926
1614Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1927Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1615 1928
1616=item @ints = $program->binary_sizes 1929=item @ints = $program->binary_sizes
1617 1930
1618Calls 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.
1619 1932
1620=for gengetinfo end program 1933=for gengetinfo end program
1621 1934
1622=item @blobs = $program->binaries 1935=item @blobs = $program->binaries
1623 1936
1644 1957
1645=for gengetinfo begin kernel 1958=for gengetinfo begin kernel
1646 1959
1647=item $string = $kernel->function_name 1960=item $string = $kernel->function_name
1648 1961
1649Calls 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.
1650 1963
1651=item $uint = $kernel->num_args 1964=item $uint = $kernel->num_args
1652 1965
1653Calls 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.
1654 1967
1655=item $uint = $kernel->reference_count 1968=item $uint = $kernel->reference_count
1656 1969
1657Calls 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.
1658 1971
1659=item $ctx = $kernel->context 1972=item $ctx = $kernel->context
1660 1973
1661Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1974Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1662 1975
1663=item $program = $kernel->program 1976=item $program = $kernel->program
1664 1977
1665Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1978Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1666 1979
1667=for gengetinfo end kernel 1980=for gengetinfo end kernel
1668 1981
1669=item $packed_value = $kernel->work_group_info ($device, $name) 1982=item $packed_value = $kernel->work_group_info ($device, $name)
1670 1983
1671See C<< $platform->info >> for details. 1984See C<< $platform->info >> for details.
1672 1985
1673The reason this method is not called C<info> is that there already is an
1674C<< ->info >> method.
1675
1676L<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>
1677 1987
1678=for gengetinfo begin kernel_work_group 1988=for gengetinfo begin kernel_work_group
1679 1989
1680=item $int = $kernel->work_group_size ($device) 1990=item $int = $kernel->work_group_size ($device)
1681 1991
1682Calls 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.
1683 1993
1684=item @ints = $kernel->compile_work_group_size ($device) 1994=item @ints = $kernel->compile_work_group_size ($device)
1685 1995
1686Calls 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.
1687 1997
1688=item $ulong = $kernel->local_mem_size ($device) 1998=item $ulong = $kernel->local_mem_size ($device)
1689 1999
1690Calls 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.
1691 2001
1692=item $int = $kernel->preferred_work_group_size_multiple ($device) 2002=item $int = $kernel->preferred_work_group_size_multiple ($device)
1693 2003
1694Calls 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.
1695 2005
1696=item $ulong = $kernel->private_mem_size ($device) 2006=item $ulong = $kernel->private_mem_size ($device)
1697 2007
1698Calls 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.
1699 2009
1700=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
1701 2041
1702=item $kernel->setf ($format, ...) 2042=item $kernel->setf ($format, ...)
1703 2043
1704Sets 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
1705way 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
1817 2157
1818=for gengetinfo begin event 2158=for gengetinfo begin event
1819 2159
1820=item $queue = $event->command_queue 2160=item $queue = $event->command_queue
1821 2161
1822Calls 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.
1823 2163
1824=item $command_type = $event->command_type 2164=item $command_type = $event->command_type
1825 2165
1826Calls 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.
1827 2167
1828=item $uint = $event->reference_count 2168=item $uint = $event->reference_count
1829 2169
1830Calls 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.
1831 2171
1832=item $uint = $event->command_execution_status 2172=item $uint = $event->command_execution_status
1833 2173
1834Calls 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.
1835 2175
1836=item $ctx = $event->context 2176=item $ctx = $event->context
1837 2177
1838Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2178Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1839 2179
1840=for gengetinfo end event 2180=for gengetinfo end event
1841 2181
1842=item $packed_value = $ev->profiling_info ($name) 2182=item $packed_value = $ev->profiling_info ($name)
1843 2183
1850 2190
1851=for gengetinfo begin profiling 2191=for gengetinfo begin profiling
1852 2192
1853=item $ulong = $event->profiling_command_queued 2193=item $ulong = $event->profiling_command_queued
1854 2194
1855Calls 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.
1856 2196
1857=item $ulong = $event->profiling_command_submit 2197=item $ulong = $event->profiling_command_submit
1858 2198
1859Calls 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.
1860 2200
1861=item $ulong = $event->profiling_command_start 2201=item $ulong = $event->profiling_command_start
1862 2202
1863Calls 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.
1864 2204
1865=item $ulong = $event->profiling_command_end 2205=item $ulong = $event->profiling_command_end
1866 2206
1867Calls 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.
1868 2208
1869=for gengetinfo end profiling 2209=for gengetinfo end profiling
1870 2210
1871=back 2211=back
1872 2212
1879=item $ev->set_status ($execution_status) 2219=item $ev->set_status ($execution_status)
1880 2220
1881Sets 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,
1882either with OpenCL::COMPLETE or a negative number as status. 2222either with OpenCL::COMPLETE or a negative number as status.
1883 2223
2224execution_status: OpenCL::COMPLETE or a negative integer.
2225
1884L<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>
1885 2227
1886=back 2228=back
2229
2230=head2 THE OpenCL::Mapped CLASS
2231
2232This class represents objects mapped into host memory. They are
2233represented by a blessed string scalar. The string data is the mapped
2234memory area, that is, if you read or write it, then the mapped object is
2235accessed directly.
2236
2237You must only ever use operations that modify the string in-place - for
2238example, a C<substr> that doesn't change the length, or maybe a regex that
2239doesn't change the length. Any other operation might cause the data to be
2240copied.
2241
2242When the object is destroyed it will enqueue an implicit unmap operation
2243on the queue that was used to create it.
2244
2245Keep in mind that you I<need> to unmap (or destroy) mapped objects before
2246OpenCL sees the changes, even if some implementations don't need this
2247sometimes.
2248
2249Example, replace the first two floats in the mapped buffer by 1 and 2.
2250
2251 my $mapped = $queue->map_buffer ($buf, ...
2252 $mapped->event->wait; # make sure it's there
2253
2254 # now replace first 8 bytes by new data, which is exactly 8 bytes long
2255 # we blindly assume device endianness to equal host endianness
2256 # (and of course, we assume iee 754 single precision floats :)
2257 substr $$mapped, 0, 8, pack "f*", 1, 2;
2258
2259=over 4
2260
2261=item $ev = $mapped->unmap ($wait_events...)
2262
2263Unmaps the mapped memory object, using the queue originally used to create
2264it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
2265
2266=item $bool = $mapped->mapped
2267
2268Returns whether the object is still mapped - true before an C<unmap> is
2269enqueued, false afterwards.
2270
2271=item $ev = $mapped->event
2272
2273Return the event object associated with the mapped object. Initially, this
2274will be the event object created when mapping the object, and after an
2275unmap, this will be the event object that the unmap operation created.
2276
2277=item $mapped->wait
2278
2279Same as C<< $mapped->event->wait >> - makes sure no operations on this
2280mapped object are outstanding.
2281
2282=item $bytes = $mapped->size
2283
2284Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
2285
2286=item $ptr = $mapped->ptr
2287
2288Returns the raw memory address of the mapped area.
2289
2290=item $mapped->set ($offset, $data)
2291
2292Replaces the data at the given C<$offset> in the memory area by the new
2293C<$data>. This method is safer than direct manipulation of C<$mapped>
2294because it does bounds-checking, but also slower.
2295
2296=item $data = $mapped->get ($offset, $length)
2297
2298Returns (without copying) a scalar representing the data at the given
2299C<$offset> and C<$length> in the mapped memory area. This is the same as
2300the following substr, except much slower;
2301
2302 $data = substr $$mapped, $offset, $length
2303
2304=cut
2305
2306sub OpenCL::Mapped::get {
2307 substr ${$_[0]}, $_[1], $_[2]
2308}
2309
2310=back
2311
2312=head2 THE OpenCL::MappedBuffer CLASS
2313
2314This is a subclass of OpenCL::Mapped, representing mapped buffers.
2315
2316=head2 THE OpenCL::MappedImage CLASS
2317
2318This is a subclass of OpenCL::Mapped, representing mapped images.
2319
2320=over 4
2321
2322=item $bytes = $mapped->row_pitch
2323
2324=item $bytes = $mapped->slice_pitch
2325
2326Return the row or slice pitch of the image that has been mapped.
2327
2328=back
2329
1887 2330
1888=cut 2331=cut
1889 2332
18901; 23331;
1891 2334

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines