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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.66 by root, Tue May 1 16:37:23 2012 UTC vs.
Revision 1.79 by root, Sat May 5 13:30:07 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
370 419
371=item * When enqueuing commands, if the enqueue method is called in void 420=item * When enqueuing commands, if the enqueue method is called in void
372context, no event is created. In all other contexts an event is returned 421context, no event is created. In all other contexts an event is returned
373by the method. 422by the method.
374 423
375=item * This module expects all functions to return C<CL_SUCCESS>. If any 424=item * This module expects all functions to return C<OpenCL::SUCCESS>. If any
376other status is returned the function will throw an exception, so you 425other status is returned the function will throw an exception, so you
377don't normally have to to any error checking. 426don't normally have to to any error checking.
378 427
379=back 428=back
380 429
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
529use Async::Interrupt (); 585use Async::Interrupt ();
530 586
531our $POLL_FUNC; # set by XS 587our $POLL_FUNC; # set by XS
532 588
533BEGIN { 589BEGIN {
534 our $VERSION = '0.98'; 590 our $VERSION = '0.99';
535 591
536 require XSLoader; 592 require XSLoader;
537 XSLoader::load (__PACKAGE__, $VERSION); 593 XSLoader::load (__PACKAGE__, $VERSION);
538 594
539 @OpenCL::Platform::ISA = 595 @OpenCL::Platform::ISA =
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
558 @OpenCL::Image1DArray::ISA = 616 @OpenCL::Image1DArray::ISA =
559 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; 617 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
560 618
561 @OpenCL::UserEvent::ISA = OpenCL::Event::; 619 @OpenCL::UserEvent::ISA = OpenCL::Event::;
562 620
563 @OpenCL::MappedBuffer = 621 @OpenCL::MappedBuffer::ISA =
564 @OpenCL::MappedImage = OpenCL::Mapped::; 622 @OpenCL::MappedImage::ISA = OpenCL::Mapped::;
565} 623}
566 624
567=head2 THE OpenCL PACKAGE 625=head2 THE OpenCL PACKAGE
568 626
569=over 4 627=over 4
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
690L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 752L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
691 753
692=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr) 754=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
693 755
694Create a new OpenCL::Context object using the given device object(s)- a 756Create a new OpenCL::Context object using the given device object(s)- a
695CL_CONTEXT_PLATFORM property is supplied automatically. 757OpenCL::CONTEXT_PLATFORM property is supplied automatically.
696 758
697L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 759L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
698 760
699=item $packed_value = $platform->info ($name) 761=item $packed_value = $platform->info ($name)
700 762
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.
1160 1313
1161L<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>
1162 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
1163=item $packed_value = $ctx->info ($name) 1340=item $packed_value = $ctx->info ($name)
1164 1341
1165See C<< $platform->info >> for details. 1342See C<< $platform->info >> for details.
1166 1343
1167L<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>
1168 1345
1169=for gengetinfo begin context 1346=for gengetinfo begin context
1170 1347
1171=item $uint = $context->reference_count 1348=item $uint = $context->reference_count
1172 1349
1173Calls 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.
1174 1351
1175=item @devices = $context->devices 1352=item @devices = $context->devices
1176 1353
1177Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1354Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1178 1355
1179=item @property_ints = $context->properties 1356=item @property_ints = $context->properties
1180 1357
1181Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1358Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1182 1359
1183=item $uint = $context->num_devices 1360=item $uint = $context->num_devices
1184 1361
1185Calls 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.
1186 1363
1187=for gengetinfo end context 1364=for gengetinfo end context
1188 1365
1189=back 1366=back
1190 1367
1306reference 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
1307elements as \@global_work_size. 1484elements as \@global_work_size.
1308 1485
1309L<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>
1310 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
1311=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1496=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1312 1497
1313Enqueues 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
1314for subsequent OpenCL usage. 1499for subsequent OpenCL usage.
1315 1500
1350 1535
1351=for gengetinfo begin command_queue 1536=for gengetinfo begin command_queue
1352 1537
1353=item $ctx = $command_queue->context 1538=item $ctx = $command_queue->context
1354 1539
1355Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1540Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1356 1541
1357=item $device = $command_queue->device 1542=item $device = $command_queue->device
1358 1543
1359Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1544Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1360 1545
1361=item $uint = $command_queue->reference_count 1546=item $uint = $command_queue->reference_count
1362 1547
1363Calls 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.
1364 1549
1365=item $command_queue_properties = $command_queue->properties 1550=item $command_queue_properties = $command_queue->properties
1366 1551
1367Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1552Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1368 1553
1369=for gengetinfo end command_queue 1554=for gengetinfo end command_queue
1370 1555
1371=back 1556=back
1372 1557
1374 1559
1375OpenCL allows you to map buffers and images to host memory (read: perl 1560OpenCL allows you to map buffers and images to host memory (read: perl
1376scalars). This is done much like reading or copying a buffer, by enqueuing 1561scalars). This is done much like reading or copying a buffer, by enqueuing
1377a map or unmap operation on the command queue. 1562a map or unmap operation on the command queue.
1378 1563
1379The map operations return a C<OpenCL::Mapped> object - see L<THE 1564The map operations return an C<OpenCL::Mapped> object - see L<THE
1380OpenCL::Mapped CLASS> section for details on what to do with these 1565OpenCL::Mapped CLASS> section for details on what to do with these
1381objects. 1566objects.
1382 1567
1383The object will be unmapped automatically when the mapped object is 1568The object will be unmapped automatically when the mapped object is
1384destroyed (you can use a barrier to make sure the unmap has finished, 1569destroyed (you can use a barrier to make sure the unmap has finished,
1385before using the buffer in a kernel), but you can also enqueue an unmap 1570before using the buffer in a kernel), but you can also enqueue an unmap
1386operation manually. 1571operation manually.
1387 1572
1388=over 4 1573=over 4
1389 1574
1390=item $mapped_buffer = $queue->map_buffer ($buf, $data, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=0, $wait_events...) 1575=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
1391 1576
1392Maps the given buffer into host memory and returns a C<OpenCL::MappedBuffer> object. 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.
1393 1582
1394L<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>
1395 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
1396=item $mapped_image = $queue->map_image ($img, $data, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=0, $height=0, $depth=0, $wait_events...) 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...)
1397 1593
1398Maps the given image area into host memory and return a 1594Maps the given image area into host memory and return an
1399C<OpenCL::MappedImage> object. Although there are default values for most 1595C<OpenCL::MappedImage> object.
1400arguments, you currently have to specify all arguments, otherwise the call 1596
1401will fail. 1597If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
1598will be replaced by the maximum possible value.
1402 1599
1403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html> 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
1404 1614
1405=item $ev = $queue->unmap ($mapped, $wait_events...) 1615=item $ev = $queue->unmap ($mapped, $wait_events...)
1406 1616
1407Unmaps the data from host memory. You must not call any methods that 1617Unmaps the data from host memory. You must not call any methods that
1408modify the data, or modify the data scalar directly, after calling this 1618modify the data, or modify the data scalar directly, after calling this
1429 1639
1430=for gengetinfo begin mem 1640=for gengetinfo begin mem
1431 1641
1432=item $mem_object_type = $mem->type 1642=item $mem_object_type = $mem->type
1433 1643
1434Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1644Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1435 1645
1436=item $mem_flags = $mem->flags 1646=item $mem_flags = $mem->flags
1437 1647
1438Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1648Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1439 1649
1440=item $int = $mem->size 1650=item $int = $mem->size
1441 1651
1442Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1652Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1443 1653
1444=item $ptr_value = $mem->host_ptr 1654=item $ptr_value = $mem->host_ptr
1445 1655
1446Calls 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.
1447 1657
1448=item $uint = $mem->map_count 1658=item $uint = $mem->map_count
1449 1659
1450Calls 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.
1451 1661
1452=item $uint = $mem->reference_count 1662=item $uint = $mem->reference_count
1453 1663
1454Calls 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.
1455 1665
1456=item $ctx = $mem->context 1666=item $ctx = $mem->context
1457 1667
1458Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1668Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1459 1669
1460=item $mem = $mem->associated_memobject 1670=item $mem = $mem->associated_memobject
1461 1671
1462Calls 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.
1463 1673
1464=item $int = $mem->offset 1674=item $int = $mem->offset
1465 1675
1466Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1676Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1467 1677
1468=for gengetinfo end mem 1678=for gengetinfo end mem
1469 1679
1470=item ($type, $name) = $mem->gl_object_info 1680=item ($type, $name) = $mem->gl_object_info
1471 1681
1491=over 4 1701=over 4
1492 1702
1493=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size) 1703=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1494 1704
1495Creates an OpenCL::Buffer objects from this buffer and returns it. The 1705Creates an OpenCL::Buffer objects from this buffer and returns it. The
1496C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>. 1706C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1497 1707
1498L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html> 1708L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1499 1709
1500=back 1710=back
1501 1711
1517L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1727L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1518 1728
1519=item ($channel_order, $channel_data_type) = $image->format 1729=item ($channel_order, $channel_data_type) = $image->format
1520 1730
1521Returns the channel order and type used to create the image by calling 1731Returns the channel order and type used to create the image by calling
1522C<clGetImageInfo> with C<CL_IMAGE_FORMAT>. 1732C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1523 1733
1524=for gengetinfo begin image 1734=for gengetinfo begin image
1525 1735
1526=item $int = $image->element_size 1736=item $int = $image->element_size
1527 1737
1528Calls 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.
1529 1739
1530=item $int = $image->row_pitch 1740=item $int = $image->row_pitch
1531 1741
1532Calls 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.
1533 1743
1534=item $int = $image->slice_pitch 1744=item $int = $image->slice_pitch
1535 1745
1536Calls 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.
1537 1747
1538=item $int = $image->width 1748=item $int = $image->width
1539 1749
1540Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1750Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1541 1751
1542=item $int = $image->height 1752=item $int = $image->height
1543 1753
1544Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1754Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1545 1755
1546=item $int = $image->depth 1756=item $int = $image->depth
1547 1757
1548Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1758Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1549 1759
1550=for gengetinfo end image 1760=for gengetinfo end image
1551 1761
1552=for gengetinfo begin gl_texture 1762=for gengetinfo begin gl_texture
1553 1763
1554=item $GLenum = $gl_texture->target 1764=item $GLenum = $gl_texture->target
1555 1765
1556Calls 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.
1557 1767
1558=item $GLint = $gl_texture->gl_mipmap_level 1768=item $GLint = $gl_texture->gl_mipmap_level
1559 1769
1560Calls 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.
1561 1771
1562=for gengetinfo end gl_texture 1772=for gengetinfo end gl_texture
1563 1773
1564=back 1774=back
1565 1775
1575 1785
1576=for gengetinfo begin sampler 1786=for gengetinfo begin sampler
1577 1787
1578=item $uint = $sampler->reference_count 1788=item $uint = $sampler->reference_count
1579 1789
1580Calls 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.
1581 1791
1582=item $ctx = $sampler->context 1792=item $ctx = $sampler->context
1583 1793
1584Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1794Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1585 1795
1586=item $addressing_mode = $sampler->normalized_coords 1796=item $addressing_mode = $sampler->normalized_coords
1587 1797
1588Calls 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.
1589 1799
1590=item $filter_mode = $sampler->addressing_mode 1800=item $filter_mode = $sampler->addressing_mode
1591 1801
1592Calls 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.
1593 1803
1594=item $boolean = $sampler->filter_mode 1804=item $boolean = $sampler->filter_mode
1595 1805
1596Calls 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.
1597 1807
1598=for gengetinfo end sampler 1808=for gengetinfo end sampler
1599 1809
1600=back 1810=back
1601 1811
1619not 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.
1620 1830
1621Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1831Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1622compilation state is successful but some later stage fails. 1832compilation state is successful but some later stage fails.
1623 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
1624L<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>
1625 1846
1626=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1847=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1627 1848
1628Similar 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
1629need to check the compilation status form the callback, or by polling). 1850need to check the compilation status form the callback, or by polling).
1630 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
1631=item $packed_value = $program->build_info ($device, $name) 1860=item $packed_value = $program->build_info ($device, $name)
1632 1861
1633Similar to C<< $platform->info >>, but returns build info for a previous 1862Similar to C<< $platform->info >>, but returns build info for a previous
1634build attempt for the given device. 1863build attempt for the given device.
1635 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
1636L<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>
1637 1871
1638=item $kernel = $program->kernel ($function_name) 1872=item $kernel = $program->kernel ($function_name)
1639 1873
1640Creates 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
1650 1884
1651=for gengetinfo begin program_build 1885=for gengetinfo begin program_build
1652 1886
1653=item $build_status = $program->build_status ($device) 1887=item $build_status = $program->build_status ($device)
1654 1888
1655Calls 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.
1656 1890
1657=item $string = $program->build_options ($device) 1891=item $string = $program->build_options ($device)
1658 1892
1659Calls 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.
1660 1894
1661=item $string = $program->build_log ($device) 1895=item $string = $program->build_log ($device)
1662 1896
1663Calls 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.
1898
1899=item $binary_type = $program->binary_type ($device)
1900
1901Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1664 1902
1665=for gengetinfo end program_build 1903=for gengetinfo end program_build
1666 1904
1667=item $packed_value = $program->info ($name) 1905=item $packed_value = $program->info ($name)
1668 1906
1672 1910
1673=for gengetinfo begin program 1911=for gengetinfo begin program
1674 1912
1675=item $uint = $program->reference_count 1913=item $uint = $program->reference_count
1676 1914
1677Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. 1915Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1678 1916
1679=item $ctx = $program->context 1917=item $ctx = $program->context
1680 1918
1681Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1919Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1682 1920
1683=item $uint = $program->num_devices 1921=item $uint = $program->num_devices
1684 1922
1685Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. 1923Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1686 1924
1687=item @devices = $program->devices 1925=item @devices = $program->devices
1688 1926
1689Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1927Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1690 1928
1691=item $string = $program->source 1929=item $string = $program->source
1692 1930
1693Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1931Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1694 1932
1695=item @ints = $program->binary_sizes 1933=item @ints = $program->binary_sizes
1696 1934
1697Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. 1935Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1698 1936
1699=for gengetinfo end program 1937=for gengetinfo end program
1700 1938
1701=item @blobs = $program->binaries 1939=item @blobs = $program->binaries
1702 1940
1723 1961
1724=for gengetinfo begin kernel 1962=for gengetinfo begin kernel
1725 1963
1726=item $string = $kernel->function_name 1964=item $string = $kernel->function_name
1727 1965
1728Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. 1966Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1729 1967
1730=item $uint = $kernel->num_args 1968=item $uint = $kernel->num_args
1731 1969
1732Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. 1970Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1733 1971
1734=item $uint = $kernel->reference_count 1972=item $uint = $kernel->reference_count
1735 1973
1736Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. 1974Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1737 1975
1738=item $ctx = $kernel->context 1976=item $ctx = $kernel->context
1739 1977
1740Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1978Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1741 1979
1742=item $program = $kernel->program 1980=item $program = $kernel->program
1743 1981
1744Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1982Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1745 1983
1746=for gengetinfo end kernel 1984=for gengetinfo end kernel
1747 1985
1748=item $packed_value = $kernel->work_group_info ($device, $name) 1986=item $packed_value = $kernel->work_group_info ($device, $name)
1749 1987
1750See C<< $platform->info >> for details. 1988See C<< $platform->info >> for details.
1751 1989
1752The reason this method is not called C<info> is that there already is an
1753C<< ->info >> method.
1754
1755L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> 1990L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1756 1991
1757=for gengetinfo begin kernel_work_group 1992=for gengetinfo begin kernel_work_group
1758 1993
1759=item $int = $kernel->work_group_size ($device) 1994=item $int = $kernel->work_group_size ($device)
1760 1995
1761Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. 1996Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1762 1997
1763=item @ints = $kernel->compile_work_group_size ($device) 1998=item @ints = $kernel->compile_work_group_size ($device)
1764 1999
1765Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. 2000Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1766 2001
1767=item $ulong = $kernel->local_mem_size ($device) 2002=item $ulong = $kernel->local_mem_size ($device)
1768 2003
1769Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. 2004Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1770 2005
1771=item $int = $kernel->preferred_work_group_size_multiple ($device) 2006=item $int = $kernel->preferred_work_group_size_multiple ($device)
1772 2007
1773Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. 2008Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1774 2009
1775=item $ulong = $kernel->private_mem_size ($device) 2010=item $ulong = $kernel->private_mem_size ($device)
1776 2011
1777Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. 2012Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1778 2013
1779=for gengetinfo end kernel_work_group 2014=for gengetinfo end kernel_work_group
2015
2016=item $packed_value = $kernel->arg_info ($idx, $name)
2017
2018See C<< $platform->info >> for details.
2019
2020L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
2021
2022=for gengetinfo begin kernel_arg
2023
2024=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
2025
2026Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
2027
2028=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
2029
2030Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
2031
2032=item $string = $kernel->arg_type_name ($idx)
2033
2034Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
2035
2036=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
2037
2038Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
2039
2040=item $string = $kernel->arg_name ($idx)
2041
2042Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
2043
2044=for gengetinfo end kernel_arg
1780 2045
1781=item $kernel->setf ($format, ...) 2046=item $kernel->setf ($format, ...)
1782 2047
1783Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic 2048Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1784way to set arguments (and with OpenCL 1.2 it might be rather slow), you 2049way to set arguments (and with OpenCL 1.2 it might be rather slow), you
1896 2161
1897=for gengetinfo begin event 2162=for gengetinfo begin event
1898 2163
1899=item $queue = $event->command_queue 2164=item $queue = $event->command_queue
1900 2165
1901Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. 2166Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1902 2167
1903=item $command_type = $event->command_type 2168=item $command_type = $event->command_type
1904 2169
1905Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. 2170Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1906 2171
1907=item $uint = $event->reference_count 2172=item $uint = $event->reference_count
1908 2173
1909Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. 2174Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1910 2175
1911=item $uint = $event->command_execution_status 2176=item $uint = $event->command_execution_status
1912 2177
1913Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. 2178Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1914 2179
1915=item $ctx = $event->context 2180=item $ctx = $event->context
1916 2181
1917Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2182Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1918 2183
1919=for gengetinfo end event 2184=for gengetinfo end event
1920 2185
1921=item $packed_value = $ev->profiling_info ($name) 2186=item $packed_value = $ev->profiling_info ($name)
1922 2187
1929 2194
1930=for gengetinfo begin profiling 2195=for gengetinfo begin profiling
1931 2196
1932=item $ulong = $event->profiling_command_queued 2197=item $ulong = $event->profiling_command_queued
1933 2198
1934Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. 2199Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1935 2200
1936=item $ulong = $event->profiling_command_submit 2201=item $ulong = $event->profiling_command_submit
1937 2202
1938Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. 2203Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1939 2204
1940=item $ulong = $event->profiling_command_start 2205=item $ulong = $event->profiling_command_start
1941 2206
1942Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. 2207Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1943 2208
1944=item $ulong = $event->profiling_command_end 2209=item $ulong = $event->profiling_command_end
1945 2210
1946Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. 2211Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1947 2212
1948=for gengetinfo end profiling 2213=for gengetinfo end profiling
1949 2214
1950=back 2215=back
1951 2216
1957 2222
1958=item $ev->set_status ($execution_status) 2223=item $ev->set_status ($execution_status)
1959 2224
1960Sets the execution status of the user event. Can only be called once, 2225Sets the execution status of the user event. Can only be called once,
1961either with OpenCL::COMPLETE or a negative number as status. 2226either with OpenCL::COMPLETE or a negative number as status.
2227
2228execution_status: OpenCL::COMPLETE or a negative integer.
1962 2229
1963L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2230L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1964 2231
1965=back 2232=back
1966 2233
1977copied. 2244copied.
1978 2245
1979When the object is destroyed it will enqueue an implicit unmap operation 2246When the object is destroyed it will enqueue an implicit unmap operation
1980on the queue that was used to create it. 2247on the queue that was used to create it.
1981 2248
2249Keep in mind that you I<need> to unmap (or destroy) mapped objects before
2250OpenCL sees the changes, even if some implementations don't need this
2251sometimes.
2252
1982Example, replace the first two floats in the mapped buffer by 1 and 2. 2253Example, replace the first two floats in the mapped buffer by 1 and 2.
1983 2254
1984 my $mapped = $queue->map_buffer ($buf, ... 2255 my $mapped = $queue->map_buffer ($buf, ...
1985 $mapped->event->wait; # make sure it's there 2256 $mapped->event->wait; # make sure it's there
1986 2257
1989 # (and of course, we assume iee 754 single precision floats :) 2260 # (and of course, we assume iee 754 single precision floats :)
1990 substr $$mapped, 0, 8, pack "f*", 1, 2; 2261 substr $$mapped, 0, 8, pack "f*", 1, 2;
1991 2262
1992=over 4 2263=over 4
1993 2264
2265=item $ev = $mapped->unmap ($wait_events...)
2266
2267Unmaps the mapped memory object, using the queue originally used to create
2268it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
2269
1994=item $bool = $mapped->mapped 2270=item $bool = $mapped->mapped
1995 2271
1996Returns whether the object is still mapped - true before an C<unmap> is 2272Returns whether the object is still mapped - true before an C<unmap> is
1997enqueued, false afterwards. 2273enqueued, false afterwards.
1998 2274
2011 2287
2012Returns the size of the mapped area, in bytes. Same as C<length $$mapped>. 2288Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
2013 2289
2014=item $ptr = $mapped->ptr 2290=item $ptr = $mapped->ptr
2015 2291
2016Returns the raw memory address of the mapped area - same as C<$mapped+0>. 2292Returns the raw memory address of the mapped area.
2293
2294=item $mapped->set ($offset, $data)
2295
2296Replaces the data at the given C<$offset> in the memory area by the new
2297C<$data>. This method is safer than direct manipulation of C<$mapped>
2298because it does bounds-checking, but also slower.
2299
2300=item $data = $mapped->get ($offset, $length)
2301
2302Returns (without copying) a scalar representing the data at the given
2303C<$offset> and C<$length> in the mapped memory area. This is the same as
2304the following substr, except much slower;
2305
2306 $data = substr $$mapped, $offset, $length
2307
2308=cut
2309
2310sub OpenCL::Mapped::get {
2311 substr ${$_[0]}, $_[1], $_[2]
2312}
2017 2313
2018=back 2314=back
2019 2315
2020=head2 THE OpenCL::MappedBuffer CLASS 2316=head2 THE OpenCL::MappedBuffer CLASS
2021 2317
2022This is a subclass of OpenCL::Mapped, representing mapped buffers. 2318This is a subclass of OpenCL::Mapped, representing mapped buffers.
2023 2319
2320=head2 THE OpenCL::MappedImage CLASS
2321
2322This is a subclass of OpenCL::Mapped, representing mapped images.
2323
2024=over 4 2324=over 4
2025 2325
2026=back 2326=item $bytes = $mapped->row_pitch
2027 2327
2028=head2 THE OpenCL::MappedImage CLASS 2328=item $bytes = $mapped->slice_pitch
2029 2329
2030This is a subclass of OpenCL::Mapped, representing mapped images. 2330Return the row or slice pitch of the image that has been mapped.
2031
2032=over 4
2033 2331
2034=back 2332=back
2035 2333
2036 2334
2037=cut 2335=cut

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines