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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.69 by root, Thu May 3 23:30:08 2012 UTC vs.
Revision 1.87 by root, Mon May 7 01:01:33 2012 UTC

… …
28specific device ("compiling and linking"), also binary programs. For each 28specific device ("compiling and linking"), also binary programs. For each
29kernel function in a program you can then create an OpenCL::Kernel object 29kernel function in a program you can then create an OpenCL::Kernel object
30which represents basically a function call with argument values. 30which represents basically a function call with argument values.
31 31
32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat 32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d 33memory areas, think arrays or structs) and OpenCL::Image objects (think 2D
34or 3d array) for bulk data and input and output for kernels. 34or 3D array) for bulk data and input and output for kernels.
35 35
36OpenCL::Sampler objects, which are kind of like texture filter modes in 36OpenCL::Sampler objects, which are kind of like texture filter modes in
37OpenGL. 37OpenGL.
38 38
39OpenCL::Queue objects - command queues, which allow you to submit memory 39OpenCL::Queue objects - command queues, which allow you to submit memory
… …
43 43
44OpenCL::Event objects are used to signal when something is complete. 44OpenCL::Event objects are used to signal when something is complete.
45 45
46=head2 HELPFUL RESOURCES 46=head2 HELPFUL RESOURCES
47 47
48The OpenCL specs used to develop this module: 48The OpenCL specs used to develop this module - download these and keept
49hema round, they are required reference material:
49 50
50 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf 52 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf 53 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53 54
… …
210 211
211 # wait for the last event to complete 212 # wait for the last event to complete
212 $ev->wait; 213 $ev->wait;
213 214
214=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia 215=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215set tunnel effect. 216set flight effect.
216 217
217This is quite a long example to get you going - you can download it from 218This is quite a long example to get you going - you can also download it
218L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>. 219from L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
219 220
220 use OpenGL ":all"; 221 use OpenGL ":all";
221 use OpenCL; 222 use OpenCL;
222 223
223 my $S = $ARGV[0] || 256; # window/texture size, smaller is faster 224 my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
… …
320To use a texture, you would modify the above example by creating an 321To use a texture, you would modify the above example by creating an
321OpenCL::Image manually instead of deriving it from a texture: 322OpenCL::Image manually instead of deriving it from a texture:
322 323
323 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S); 324 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
324 325
325And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you 326And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
326would read the image2d after the kernel has written it: 327would read the image2d after the kernel has written it:
327 328
328 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data); 329 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
329 330
330And then you would upload the pixel data to the texture (or use glDrawPixels): 331And then you would upload the pixel data to the texture (or use glDrawPixels):
331 332
332 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data; 333 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
333 334
334The fully modified example can be found at 335The fully modified example can be found at
335L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>. 336L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
337
338=head2 Julia sets look soooo 80ies.
339
340Then colour them differently, e.g. using orbit traps! Replace the loop and
341colour calculation from the previous examples by this:
342
343 float2 dm = (float2)(1.f, 1.f);
344
345 for (int i = 0; i < 25; ++i)
346 {
347 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
348 dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
349 }
350
351 float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
352
353Also try C<-10.f> instead of C<-1.f>.
336 354
337=head1 DOCUMENTATION 355=head1 DOCUMENTATION
338 356
339=head2 BASIC CONVENTIONS 357=head2 BASIC CONVENTIONS
340 358
… …
370 388
371=item * When enqueuing commands, if the enqueue method is called in void 389=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 390context, no event is created. In all other contexts an event is returned
373by the method. 391by the method.
374 392
375=item * This module expects all functions to return C<CL_SUCCESS>. If any 393=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 394other status is returned the function will throw an exception, so you
377don't normally have to to any error checking. 395don't normally have to to any error checking.
378 396
379=back 397=back
398
399=head2 CONSTANTS
400
401All C<CL_xxx> constants that this module supports are always available
402in the C<OpenCL> namespace as C<OpenCL::xxx> (i.e. without the C<CL_>
403prefix). Constants which are not defined in the header files used during
404compilation, or otherwise are not available, will have the value C<0> (in
405some cases, this will make them indistinguishable from real constants,
406sorry).
407
408The latest version of this module knows and exports the constants
409listed in L<http://cvs.schmorp.de/OpenCL/constiv.h>.
410
411=head2 OPENCL 1.1 VS. OPENCL 1.2
412
413This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
4141.2 interface hasn't been tested much for lack of availability of an
415actual implementation.
416
417Every function or method in this manual page that interfaces to a
418particular OpenCL function has a link to the its C manual page.
419
420If the link contains a F<1.1>, then this function is an OpenCL 1.1
421function. Most but not all also exist in OpenCL 1.2, and this module
422tries to emulate the missing ones for you, when told to do so at
423compiletime. You can check whether a function was removed in OpenCL 1.2 by
424replacing the F<1.1> component in the URL by F<1.2>.
425
426If the link contains a F<1.2>, then this is a OpenCL 1.2-only
427function. Even if the module was compiled with OpenCL 1.2 header files
428and has an 1.2 OpenCL library, calling such a function on a platform that
429doesn't implement 1.2 causes undefined behaviour, usually a crash (But
430this is not guaranteed).
431
432You can find out whether this module was compiled to prefer 1.1
433functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
4341.1 functions generally are implemented using 1.1 OpenCL functions. If it
435is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
436fucntions.
437
438This is a somewhat sorry state of affairs, but the Khronos group choose to
439make every release of OpenCL source and binary incompatible with previous
440releases.
380 441
381=head2 PERL AND OPENCL TYPES 442=head2 PERL AND OPENCL TYPES
382 443
383This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack 444This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
384format equivalents: 445format equivalents:
… …
416OpenCL can generate a number of (potentially) asynchronous events, for 477OpenCL can generate a number of (potentially) asynchronous events, for
417example, after compiling a program, to signal a context-related error or, 478example, after compiling a program, to signal a context-related error or,
418perhaps most important, to signal completion of queued jobs (by setting 479perhaps most important, to signal completion of queued jobs (by setting
419callbacks on OpenCL::Event objects). 480callbacks on OpenCL::Event objects).
420 481
482The OpenCL module converts all these callbacks into events - you can
483still register callbacks, but they are not executed when your OpenCL
484implementation calls the actual callback, but only later. Therefore, none
485of the limitations of OpenCL callbacks apply to the perl implementation:
486it is perfectly safe to make blocking operations from event callbacks, and
487enqueued operations don't need to be flushed.
488
421To facilitate this, this module maintains an event queue - each 489To facilitate this, this module maintains an event queue - each
422time an asynchronous event happens, it is queued, and perl will be 490time an asynchronous event happens, it is queued, and perl will be
423interrupted. This is implemented via the L<Async::Interrupt> module. In 491interrupted. This is implemented via the L<Async::Interrupt> module. In
424addition, this module has L<AnyEvent> support, so it can seamlessly 492addition, this module has L<AnyEvent> support, so it can seamlessly
425integrate itself into many event loops. 493integrate itself into many event loops.
426 494
427Since this module is a bit hard to understand, here are some case examples: 495Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
428 496
429=head3 Don't use callbacks. 497=head3 Don't use callbacks.
430 498
431When your program never uses any callbacks, then there will never be any 499When 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 500notifications you need to take care of, and therefore no need to worry
… …
529use Async::Interrupt (); 597use Async::Interrupt ();
530 598
531our $POLL_FUNC; # set by XS 599our $POLL_FUNC; # set by XS
532 600
533BEGIN { 601BEGIN {
534 our $VERSION = '0.98'; 602 our $VERSION = '1.01';
535 603
536 require XSLoader; 604 require XSLoader;
537 XSLoader::load (__PACKAGE__, $VERSION); 605 XSLoader::load (__PACKAGE__, $VERSION);
538 606
539 @OpenCL::Platform::ISA = 607 @OpenCL::Platform::ISA =
… …
544 @OpenCL::Sampler::ISA = 612 @OpenCL::Sampler::ISA =
545 @OpenCL::Program::ISA = 613 @OpenCL::Program::ISA =
546 @OpenCL::Kernel::ISA = 614 @OpenCL::Kernel::ISA =
547 @OpenCL::Event::ISA = OpenCL::Object::; 615 @OpenCL::Event::ISA = OpenCL::Object::;
548 616
617 @OpenCL::SubDevice::ISA = OpenCL::Device::;
618
549 @OpenCL::Buffer::ISA = 619 @OpenCL::Buffer::ISA =
550 @OpenCL::Image::ISA = OpenCL::Memory::; 620 @OpenCL::Image::ISA = OpenCL::Memory::;
551 621
552 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 622 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
553 623
… …
573The last error returned by a function - it's only valid after an error occured 643The last error returned by a function - it's only valid after an error occured
574and before calling another OpenCL function. 644and before calling another OpenCL function.
575 645
576=item $str = OpenCL::err2str [$errval] 646=item $str = OpenCL::err2str [$errval]
577 647
578Converts an error value into a human readable string. IF no error value is 648Converts an error value into a human readable string. If no error value is
579given, then the last error will be used (as returned by OpenCL::errno). 649given, then the last error will be used (as returned by OpenCL::errno).
650
651The latest version of this module knows the error constants
652listed in L<http://cvs.schmorp.de/OpenCL/errstr.h>.
580 653
581=item $str = OpenCL::enum2str $enum 654=item $str = OpenCL::enum2str $enum
582 655
583Converts most enum values (of parameter names, image format constants, 656Converts most enum values (of parameter names, image format constants,
584object types, addressing and filter modes, command types etc.) into a 657object types, addressing and filter modes, command types etc.) into a
585human readable string. When confronted with some random integer it can be 658human readable string. When confronted with some random integer it can be
586very helpful to pass it through this function to maybe get some readable 659very helpful to pass it through this function to maybe get some readable
587string out of it. 660string out of it.
588 661
662The latest version of this module knows the enumaration constants
663listed in L<http://cvs.schmorp.de/OpenCL/enumstr.h>.
664
589=item @platforms = OpenCL::platforms 665=item @platforms = OpenCL::platforms
590 666
591Returns all available OpenCL::Platform objects. 667Returns all available OpenCL::Platform objects.
592 668
593L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
594 670
595=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr 671=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
596 672
597Tries to create a context from a default device and platform type - never worked for me. 673Tries to create a context from a default device and platform type - never worked for me.
674Consider using C<< $platform->context_from_type >> instead.
675
676type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
677OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
598 678
599L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 679L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
600 680
601=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 681=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
602 682
603Create a new OpenCL::Context object using the given device object(s). This 683Create a new OpenCL::Context object using the given device object(s).
604function isn't implemented yet, use C<< $platform->context >> instead. 684Consider using C<< $platform->context >> instead.
605 685
606L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 686L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
607 687
608=item OpenCL::wait_for_events $wait_events... 688=item OpenCL::wait_for_events $wait_events...
609 689
… …
690L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 770L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
691 771
692=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr) 772=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
693 773
694Create a new OpenCL::Context object using the given device object(s)- a 774Create a new OpenCL::Context object using the given device object(s)- a
695CL_CONTEXT_PLATFORM property is supplied automatically. 775OpenCL::CONTEXT_PLATFORM property is supplied automatically.
696 776
697L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 777L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
698 778
699=item $packed_value = $platform->info ($name) 779=item $packed_value = $platform->info ($name)
700 780
… …
716 796
717=for gengetinfo begin platform 797=for gengetinfo begin platform
718 798
719=item $string = $platform->profile 799=item $string = $platform->profile
720 800
721Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 801Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
722 802
723=item $string = $platform->version 803=item $string = $platform->version
724 804
725Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 805Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
726 806
727=item $string = $platform->name 807=item $string = $platform->name
728 808
729Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 809Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
730 810
731=item $string = $platform->vendor 811=item $string = $platform->vendor
732 812
733Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 813Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
734 814
735=item $string = $platform->extensions 815=item $string = $platform->extensions
736 816
737Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 817Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
738 818
739=for gengetinfo end platform 819=for gengetinfo end platform
740 820
741=back 821=back
742 822
… …
746 826
747=item $packed_value = $device->info ($name) 827=item $packed_value = $device->info ($name)
748 828
749See C<< $platform->info >> for details. 829See C<< $platform->info >> for details.
750 830
831type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
832OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
833OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
834
835fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
836OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
837OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
838
839mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
840
841local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
842
843exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
844
845command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
846OpenCL::QUEUE_PROFILING_ENABLE.
847
848partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
849OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
850OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
851
852affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
853OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
854OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
855OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
856
751L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 857L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
752 858
859=item @devices = $device->sub_devices (\@properties)
860
861Creates OpencL::SubDevice objects by partitioning an existing device.
862
863L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
864
753=for gengetinfo begin device 865=for gengetinfo begin device
754 866
755=item $device_type = $device->type 867=item $device_type = $device->type
756 868
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 869Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
758 870
759=item $uint = $device->vendor_id 871=item $uint = $device->vendor_id
760 872
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. 873Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
762 874
763=item $uint = $device->max_compute_units 875=item $uint = $device->max_compute_units
764 876
765Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. 877Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
766 878
767=item $uint = $device->max_work_item_dimensions 879=item $uint = $device->max_work_item_dimensions
768 880
769Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. 881Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
770 882
771=item $int = $device->max_work_group_size 883=item $int = $device->max_work_group_size
772 884
773Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. 885Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
774 886
775=item @ints = $device->max_work_item_sizes 887=item @ints = $device->max_work_item_sizes
776 888
777Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. 889Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
778 890
779=item $uint = $device->preferred_vector_width_char 891=item $uint = $device->preferred_vector_width_char
780 892
781Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. 893Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
782 894
783=item $uint = $device->preferred_vector_width_short 895=item $uint = $device->preferred_vector_width_short
784 896
785Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. 897Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
786 898
787=item $uint = $device->preferred_vector_width_int 899=item $uint = $device->preferred_vector_width_int
788 900
789Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. 901Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
790 902
791=item $uint = $device->preferred_vector_width_long 903=item $uint = $device->preferred_vector_width_long
792 904
793Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. 905Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
794 906
795=item $uint = $device->preferred_vector_width_float 907=item $uint = $device->preferred_vector_width_float
796 908
797Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. 909Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
798 910
799=item $uint = $device->preferred_vector_width_double 911=item $uint = $device->preferred_vector_width_double
800 912
801Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. 913Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
802 914
803=item $uint = $device->max_clock_frequency 915=item $uint = $device->max_clock_frequency
804 916
805Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. 917Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
806 918
807=item $bitfield = $device->address_bits 919=item $bitfield = $device->address_bits
808 920
809Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. 921Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
810 922
811=item $uint = $device->max_read_image_args 923=item $uint = $device->max_read_image_args
812 924
813Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. 925Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
814 926
815=item $uint = $device->max_write_image_args 927=item $uint = $device->max_write_image_args
816 928
817Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. 929Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
818 930
819=item $ulong = $device->max_mem_alloc_size 931=item $ulong = $device->max_mem_alloc_size
820 932
821Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. 933Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
822 934
823=item $int = $device->image2d_max_width 935=item $int = $device->image2d_max_width
824 936
825Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. 937Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
826 938
827=item $int = $device->image2d_max_height 939=item $int = $device->image2d_max_height
828 940
829Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. 941Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
830 942
831=item $int = $device->image3d_max_width 943=item $int = $device->image3d_max_width
832 944
833Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. 945Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
834 946
835=item $int = $device->image3d_max_height 947=item $int = $device->image3d_max_height
836 948
837Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. 949Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
838 950
839=item $int = $device->image3d_max_depth 951=item $int = $device->image3d_max_depth
840 952
841Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. 953Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
842 954
843=item $uint = $device->image_support 955=item $uint = $device->image_support
844 956
845Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. 957Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
846 958
847=item $int = $device->max_parameter_size 959=item $int = $device->max_parameter_size
848 960
849Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. 961Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
850 962
851=item $uint = $device->max_samplers 963=item $uint = $device->max_samplers
852 964
853Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. 965Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
854 966
855=item $uint = $device->mem_base_addr_align 967=item $uint = $device->mem_base_addr_align
856 968
857Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. 969Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
858 970
859=item $uint = $device->min_data_type_align_size 971=item $uint = $device->min_data_type_align_size
860 972
861Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. 973Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
862 974
863=item $device_fp_config = $device->single_fp_config 975=item $device_fp_config = $device->single_fp_config
864 976
865Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. 977Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
866 978
867=item $device_mem_cache_type = $device->global_mem_cache_type 979=item $device_mem_cache_type = $device->global_mem_cache_type
868 980
869Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. 981Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
870 982
871=item $uint = $device->global_mem_cacheline_size 983=item $uint = $device->global_mem_cacheline_size
872 984
873Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. 985Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
874 986
875=item $ulong = $device->global_mem_cache_size 987=item $ulong = $device->global_mem_cache_size
876 988
877Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. 989Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
878 990
879=item $ulong = $device->global_mem_size 991=item $ulong = $device->global_mem_size
880 992
881Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. 993Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
882 994
883=item $ulong = $device->max_constant_buffer_size 995=item $ulong = $device->max_constant_buffer_size
884 996
885Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. 997Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
886 998
887=item $uint = $device->max_constant_args 999=item $uint = $device->max_constant_args
888 1000
889Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. 1001Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
890 1002
891=item $device_local_mem_type = $device->local_mem_type 1003=item $device_local_mem_type = $device->local_mem_type
892 1004
893Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. 1005Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
894 1006
895=item $ulong = $device->local_mem_size 1007=item $ulong = $device->local_mem_size
896 1008
897Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. 1009Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
898 1010
899=item $boolean = $device->error_correction_support 1011=item $boolean = $device->error_correction_support
900 1012
901Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. 1013Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
902 1014
903=item $int = $device->profiling_timer_resolution 1015=item $int = $device->profiling_timer_resolution
904 1016
905Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. 1017Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
906 1018
907=item $boolean = $device->endian_little 1019=item $boolean = $device->endian_little
908 1020
909Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. 1021Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
910 1022
911=item $boolean = $device->available 1023=item $boolean = $device->available
912 1024
913Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 1025Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
914 1026
915=item $boolean = $device->compiler_available 1027=item $boolean = $device->compiler_available
916 1028
917Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. 1029Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
918 1030
919=item $device_exec_capabilities = $device->execution_capabilities 1031=item $device_exec_capabilities = $device->execution_capabilities
920 1032
921Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. 1033Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
922 1034
923=item $command_queue_properties = $device->properties 1035=item $command_queue_properties = $device->properties
924 1036
925Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. 1037Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
926 1038
927=item $ = $device->platform 1039=item $ = $device->platform
928 1040
929Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 1041Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
930 1042
931=item $string = $device->name 1043=item $string = $device->name
932 1044
933Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 1045Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
934 1046
935=item $string = $device->vendor 1047=item $string = $device->vendor
936 1048
937Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 1049Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
938 1050
939=item $string = $device->driver_version 1051=item $string = $device->driver_version
940 1052
941Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 1053Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
942 1054
943=item $string = $device->profile 1055=item $string = $device->profile
944 1056
945Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 1057Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
946 1058
947=item $string = $device->version 1059=item $string = $device->version
948 1060
949Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 1061Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
950 1062
951=item $string = $device->extensions 1063=item $string = $device->extensions
952 1064
953Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 1065Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
954 1066
955=item $uint = $device->preferred_vector_width_half 1067=item $uint = $device->preferred_vector_width_half
956 1068
957Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. 1069Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
958 1070
959=item $uint = $device->native_vector_width_char 1071=item $uint = $device->native_vector_width_char
960 1072
961Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. 1073Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
962 1074
963=item $uint = $device->native_vector_width_short 1075=item $uint = $device->native_vector_width_short
964 1076
965Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. 1077Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
966 1078
967=item $uint = $device->native_vector_width_int 1079=item $uint = $device->native_vector_width_int
968 1080
969Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. 1081Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
970 1082
971=item $uint = $device->native_vector_width_long 1083=item $uint = $device->native_vector_width_long
972 1084
973Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. 1085Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
974 1086
975=item $uint = $device->native_vector_width_float 1087=item $uint = $device->native_vector_width_float
976 1088
977Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. 1089Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
978 1090
979=item $uint = $device->native_vector_width_double 1091=item $uint = $device->native_vector_width_double
980 1092
981Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. 1093Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
982 1094
983=item $uint = $device->native_vector_width_half 1095=item $uint = $device->native_vector_width_half
984 1096
985Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. 1097Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
986 1098
987=item $device_fp_config = $device->double_fp_config 1099=item $device_fp_config = $device->double_fp_config
988 1100
989Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. 1101Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
990 1102
991=item $device_fp_config = $device->half_fp_config 1103=item $device_fp_config = $device->half_fp_config
992 1104
993Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. 1105Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
994 1106
995=item $boolean = $device->host_unified_memory 1107=item $boolean = $device->host_unified_memory
996 1108
997Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. 1109Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
998 1110
999=item $device = $device->parent_device_ext 1111=item $device = $device->parent_device_ext
1000 1112
1001Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. 1113Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
1002 1114
1003=item @device_partition_property_exts = $device->partition_types_ext 1115=item @device_partition_property_exts = $device->partition_types_ext
1004 1116
1005Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. 1117Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
1006 1118
1007=item @device_partition_property_exts = $device->affinity_domains_ext 1119=item @device_partition_property_exts = $device->affinity_domains_ext
1008 1120
1009Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 1121Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
1010 1122
1011=item $uint = $device->reference_count_ext 1123=item $uint = $device->reference_count_ext
1012 1124
1013Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. 1125Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
1014 1126
1015=item @device_partition_property_exts = $device->partition_style_ext 1127=item @device_partition_property_exts = $device->partition_style_ext
1016 1128
1017Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 1129Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
1018 1130
1019=for gengetinfo end device 1131=for gengetinfo end device
1020 1132
1021=back 1133=back
1022 1134
1023=head2 THE OpenCL::Context CLASS 1135=head2 THE OpenCL::Context CLASS
1136
1137An OpenCL::Context is basically a container, or manager, for a number of
1138devices of a platform. It is used to create all sorts of secondary objects
1139such as buffers, queues, programs and so on.
1140
1141All context creation functions and methods take a list of properties
1142(type-value pairs). All property values can be specified as integers -
1143some additionally support other types:
1144
1145=over 4
1146
1147=item OpenCL::CONTEXT_PLATFORM
1148
1149Also accepts OpenCL::Platform objects.
1150
1151=item OpenCL::GLX_DISPLAY_KHR
1152
1153Also accepts C<undef>, in which case a deep and troubling hack is engaged
1154to find the current glx display (see L<GLX SUPPORT>).
1155
1156=item OpenCL::GL_CONTEXT_KHR
1157
1158Also accepts C<undef>, in which case a deep and troubling hack is engaged
1159to find the current glx context (see L<GLX SUPPORT>).
1160
1161=back
1024 1162
1025=over 4 1163=over 4
1026 1164
1027=item $prog = $ctx->build_program ($program, $options = "") 1165=item $prog = $ctx->build_program ($program, $options = "")
1028 1166
… …
1076=item $buf = $ctx->buffer ($flags, $len) 1214=item $buf = $ctx->buffer ($flags, $len)
1077 1215
1078Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1216Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1079given flags and octet-size. 1217given flags and octet-size.
1080 1218
1219flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
1220OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
1221OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
1222
1081L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1223L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1082 1224
1083=item $buf = $ctx->buffer_sv ($flags, $data) 1225=item $buf = $ctx->buffer_sv ($flags, $data)
1084 1226
1085Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1227Creates 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) 1230=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 1231
1090Creates a new OpenCL::Image object and optionally initialises it with 1232Creates a new OpenCL::Image object and optionally initialises it with
1091the given data values. 1233the given data values.
1092 1234
1235channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
1236OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
1237OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
1238
1239channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
1240OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1241OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1242OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1243OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1244
1245type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1246OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1247OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1248OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1249
1093L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> 1250L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1094 1251
1095=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1252=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1096 1253
1097Creates a new OpenCL::Image2D object and optionally initialises it with 1254Creates a new OpenCL::Image2D object and optionally initialises it with
… …
1109=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1266=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1110 1267
1111Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 1268Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1112OpenGL buffer object. 1269OpenGL buffer object.
1113 1270
1271flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1272
1114http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 1273http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1115 1274
1116=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1275=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1117 1276
1118Creates a new OpenCL::Image object that refers to the given OpenGL 1277Creates a new OpenCL::Image object that refers to the given OpenGL
1119texture object or buffer. 1278texture object or buffer.
1120 1279
1280target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
1281GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
1282GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
1283GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
1284GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
1285GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
1286
1121http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html 1287http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1122 1288
1123=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1289=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1124 1290
1125Creates a new OpenCL::Image2D object that refers to the given OpenGL 1291Creates a new OpenCL::Image2D object that refers to the given OpenGL
… …
1150 1316
1151=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1317=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1152 1318
1153Creates a new OpenCL::Sampler object. 1319Creates a new OpenCL::Sampler object.
1154 1320
1321addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
1322OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
1323
1324filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
1325
1155L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> 1326L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1156 1327
1157=item $program = $ctx->program_with_source ($string) 1328=item $program = $ctx->program_with_source ($string)
1158 1329
1159Creates a new OpenCL::Program object from the given source code. 1330Creates a new OpenCL::Program object from the given source code.
… …
1169Example: clone an existing program object that contains a successfully 1340Example: clone an existing program object that contains a successfully
1170compiled program, no matter how useless this is. 1341compiled program, no matter how useless this is.
1171 1342
1172 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]); 1343 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
1173 1344
1345=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1346
1347Creates a new OpenCL::Program object from the given built-in kernel names.
1348
1349L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1350
1351=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
1352
1353Links all (already compiled) program objects specified in C<@programs>
1354together and returns a new OpenCL::Program object with the result.
1355
1356L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
1357
1174=item $packed_value = $ctx->info ($name) 1358=item $packed_value = $ctx->info ($name)
1175 1359
1176See C<< $platform->info >> for details. 1360See C<< $platform->info >> for details.
1177 1361
1178L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 1362L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1179 1363
1180=for gengetinfo begin context 1364=for gengetinfo begin context
1181 1365
1182=item $uint = $context->reference_count 1366=item $uint = $context->reference_count
1183 1367
1184Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. 1368Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1185 1369
1186=item @devices = $context->devices 1370=item @devices = $context->devices
1187 1371
1188Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1372Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1189 1373
1190=item @property_ints = $context->properties 1374=item @property_ints = $context->properties
1191 1375
1192Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1376Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1193 1377
1194=item $uint = $context->num_devices 1378=item $uint = $context->num_devices
1195 1379
1196Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. 1380Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1197 1381
1198=for gengetinfo end context 1382=for gengetinfo end context
1199 1383
1200=back 1384=back
1201 1385
… …
1240 1424
1241=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1425=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1242 1426
1243L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1427L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1244 1428
1245=item $ev = $queue->read_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...) 1429$eue->read_buffer_rect ($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...)
1246 1430
1247http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html 1431http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1248 1432
1249=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...) 1433=item $ev = $queue->write_buffer_rect ($buf, $blocking, $buf_y, $host_x, $host_z, $height, $buf_row_pitch, $host_row_pitch, $data, $wait_events...)
1250 1434
1251http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html 1435http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1252 1436
1253=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) 1437=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1254 1438
… …
1317reference to an array of local work sizes, with the same number of 1501reference to an array of local work sizes, with the same number of
1318elements as \@global_work_size. 1502elements as \@global_work_size.
1319 1503
1320L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1504L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1321 1505
1506=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
1507
1508Migrates a number of OpenCL::Memory objects to or from the device.
1509
1510flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
1511
1512L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
1513
1322=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1514=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1323 1515
1324Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1516Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1325for subsequent OpenCL usage. 1517for subsequent OpenCL usage.
1326 1518
… …
1361 1553
1362=for gengetinfo begin command_queue 1554=for gengetinfo begin command_queue
1363 1555
1364=item $ctx = $command_queue->context 1556=item $ctx = $command_queue->context
1365 1557
1366Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1558Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1367 1559
1368=item $device = $command_queue->device 1560=item $device = $command_queue->device
1369 1561
1370Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1562Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1371 1563
1372=item $uint = $command_queue->reference_count 1564=item $uint = $command_queue->reference_count
1373 1565
1374Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. 1566Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1375 1567
1376=item $command_queue_properties = $command_queue->properties 1568=item $command_queue_properties = $command_queue->properties
1377 1569
1378Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1570Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1379 1571
1380=for gengetinfo end command_queue 1572=for gengetinfo end command_queue
1381 1573
1382=back 1574=back
1383 1575
… …
1402 1594
1403Maps the given buffer into host memory and returns an 1595Maps the given buffer into host memory and returns an
1404C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then 1596C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1405the map will extend to the end of the buffer. 1597the map will extend to the end of the buffer.
1406 1598
1599map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1600
1407L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html> 1601L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1408 1602
1409Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap. 1603Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1410 1604
1411 { 1605 {
… …
1428it. You are not necessarily meant to do it this way, this example just 1622it. You are not necessarily meant to do it this way, this example just
1429shows you the accessors to use :) 1623shows you the accessors to use :)
1430 1624
1431 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE); 1625 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
1432 1626
1433 $mapped->set ($_ * $mapped->row_pitch, pack "C", 5) 1627 $mapped->write ($_ * $mapped->row_pitch, pack "C", 5)
1434 for 0..$image->height; 1628 for 0 .. $mapped->height - 1;
1435 1629
1436 $mapped->unmap;. 1630 $mapped->unmap;.
1437 $mapped->wait; # only needed for out of order queues normally 1631 $mapped->wait; # only needed for out of order queues normally
1438 1632
1439=item $ev = $queue->unmap ($mapped, $wait_events...) 1633=item $ev = $queue->unmap ($mapped, $wait_events...)
… …
1459 1653
1460See C<< $platform->info >> for details. 1654See C<< $platform->info >> for details.
1461 1655
1462L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1656L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
1463 1657
1658=item $memory->destructor_callback ($cb->())
1659
1660Sets a callback that will be invoked after the memory object is destructed.
1661
1662L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetMemObjectDestructorCallback.html>
1663
1464=for gengetinfo begin mem 1664=for gengetinfo begin mem
1465 1665
1466=item $mem_object_type = $mem->type 1666=item $mem_object_type = $mem->type
1467 1667
1468Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1668Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1469 1669
1470=item $mem_flags = $mem->flags 1670=item $mem_flags = $mem->flags
1471 1671
1472Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1672Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1473 1673
1474=item $int = $mem->size 1674=item $int = $mem->size
1475 1675
1476Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1676Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1477 1677
1478=item $ptr_value = $mem->host_ptr 1678=item $ptr_value = $mem->host_ptr
1479 1679
1480Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. 1680Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1481 1681
1482=item $uint = $mem->map_count 1682=item $uint = $mem->map_count
1483 1683
1484Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. 1684Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1485 1685
1486=item $uint = $mem->reference_count 1686=item $uint = $mem->reference_count
1487 1687
1488Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. 1688Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1489 1689
1490=item $ctx = $mem->context 1690=item $ctx = $mem->context
1491 1691
1492Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1692Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1493 1693
1494=item $mem = $mem->associated_memobject 1694=item $mem = $mem->associated_memobject
1495 1695
1496Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. 1696Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1497 1697
1498=item $int = $mem->offset 1698=item $int = $mem->offset
1499 1699
1500Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1700Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1501 1701
1502=for gengetinfo end mem 1702=for gengetinfo end mem
1503 1703
1504=item ($type, $name) = $mem->gl_object_info 1704=item ($type, $name) = $mem->gl_object_info
1505 1705
… …
1525=over 4 1725=over 4
1526 1726
1527=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size) 1727=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1528 1728
1529Creates an OpenCL::Buffer objects from this buffer and returns it. The 1729Creates an OpenCL::Buffer objects from this buffer and returns it. The
1530C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>. 1730C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1531 1731
1532L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html> 1732L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1533 1733
1534=back 1734=back
1535 1735
… …
1551L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1751L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1552 1752
1553=item ($channel_order, $channel_data_type) = $image->format 1753=item ($channel_order, $channel_data_type) = $image->format
1554 1754
1555Returns the channel order and type used to create the image by calling 1755Returns the channel order and type used to create the image by calling
1556C<clGetImageInfo> with C<CL_IMAGE_FORMAT>. 1756C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1557 1757
1558=for gengetinfo begin image 1758=for gengetinfo begin image
1559 1759
1560=item $int = $image->element_size 1760=item $int = $image->element_size
1561 1761
1562Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1762Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1563 1763
1564=item $int = $image->row_pitch 1764=item $int = $image->row_pitch
1565 1765
1566Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. 1766Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1567 1767
1568=item $int = $image->slice_pitch 1768=item $int = $image->slice_pitch
1569 1769
1570Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. 1770Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1571 1771
1572=item $int = $image->width 1772=item $int = $image->width
1573 1773
1574Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1774Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1575 1775
1576=item $int = $image->height 1776=item $int = $image->height
1577 1777
1578Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1778Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1579 1779
1580=item $int = $image->depth 1780=item $int = $image->depth
1581 1781
1582Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1782Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1583 1783
1584=for gengetinfo end image 1784=for gengetinfo end image
1585 1785
1586=for gengetinfo begin gl_texture 1786=for gengetinfo begin gl_texture
1587 1787
1588=item $GLenum = $gl_texture->target 1788=item $GLenum = $gl_texture->target
1589 1789
1590Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. 1790Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1591 1791
1592=item $GLint = $gl_texture->gl_mipmap_level 1792=item $GLint = $gl_texture->gl_mipmap_level
1593 1793
1594Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. 1794Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1595 1795
1596=for gengetinfo end gl_texture 1796=for gengetinfo end gl_texture
1597 1797
1598=back 1798=back
1599 1799
… …
1609 1809
1610=for gengetinfo begin sampler 1810=for gengetinfo begin sampler
1611 1811
1612=item $uint = $sampler->reference_count 1812=item $uint = $sampler->reference_count
1613 1813
1614Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. 1814Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1615 1815
1616=item $ctx = $sampler->context 1816=item $ctx = $sampler->context
1617 1817
1618Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1818Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1619 1819
1620=item $addressing_mode = $sampler->normalized_coords 1820=item $addressing_mode = $sampler->normalized_coords
1621 1821
1622Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. 1822Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1623 1823
1624=item $filter_mode = $sampler->addressing_mode 1824=item $filter_mode = $sampler->addressing_mode
1625 1825
1626Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. 1826Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1627 1827
1628=item $boolean = $sampler->filter_mode 1828=item $boolean = $sampler->filter_mode
1629 1829
1630Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. 1830Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1631 1831
1632=for gengetinfo end sampler 1832=for gengetinfo end sampler
1633 1833
1634=back 1834=back
1635 1835
… …
1653not so. So best make sure you don't pass in invalid values. 1853not so. So best make sure you don't pass in invalid values.
1654 1854
1655Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1855Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1656compilation state is successful but some later stage fails. 1856compilation state is successful but some later stage fails.
1657 1857
1858options: C<-D name>, C<-D name=definition>, C<-I dir>,
1859C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
1860C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
1861C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1862C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1863C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1864C<-create-library>, C<-enable-link-options>.
1865
1866build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
1867OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1868
1658L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1869L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1659 1870
1660=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1871=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1661 1872
1662Similar to C<< ->build >>, except it starts a thread, and never fails (you 1873Similar to C<< ->build >>, except it starts a thread, and never fails (you
1663need to check the compilation status form the callback, or by polling). 1874need to check the compilation status form the callback, or by polling).
1664 1875
1876=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1877
1878Compiles the given program for the given devices (or all devices if
1879undef). If C<$headers> is given, it must be a hashref with include name =>
1880OpenCL::Program pairs.
1881
1882L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1883
1665=item $packed_value = $program->build_info ($device, $name) 1884=item $packed_value = $program->build_info ($device, $name)
1666 1885
1667Similar to C<< $platform->info >>, but returns build info for a previous 1886Similar to C<< $platform->info >>, but returns build info for a previous
1668build attempt for the given device. 1887build attempt for the given device.
1669 1888
1889binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
1890OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
1891OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
1892OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
1893
1670L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html> 1894L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1671 1895
1672=item $kernel = $program->kernel ($function_name) 1896=item $kernel = $program->kernel ($function_name)
1673 1897
1674Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1898Creates an OpenCL::Kernel object out of the named C<__kernel> function in
… …
1684 1908
1685=for gengetinfo begin program_build 1909=for gengetinfo begin program_build
1686 1910
1687=item $build_status = $program->build_status ($device) 1911=item $build_status = $program->build_status ($device)
1688 1912
1689Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. 1913Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1690 1914
1691=item $string = $program->build_options ($device) 1915=item $string = $program->build_options ($device)
1692 1916
1693Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. 1917Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1694 1918
1695=item $string = $program->build_log ($device) 1919=item $string = $program->build_log ($device)
1696 1920
1697Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. 1921Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1922
1923=item $binary_type = $program->binary_type ($device)
1924
1925Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1698 1926
1699=for gengetinfo end program_build 1927=for gengetinfo end program_build
1700 1928
1701=item $packed_value = $program->info ($name) 1929=item $packed_value = $program->info ($name)
1702 1930
… …
1706 1934
1707=for gengetinfo begin program 1935=for gengetinfo begin program
1708 1936
1709=item $uint = $program->reference_count 1937=item $uint = $program->reference_count
1710 1938
1711Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. 1939Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1712 1940
1713=item $ctx = $program->context 1941=item $ctx = $program->context
1714 1942
1715Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1943Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1716 1944
1717=item $uint = $program->num_devices 1945=item $uint = $program->num_devices
1718 1946
1719Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. 1947Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1720 1948
1721=item @devices = $program->devices 1949=item @devices = $program->devices
1722 1950
1723Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1951Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1724 1952
1725=item $string = $program->source 1953=item $string = $program->source
1726 1954
1727Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1955Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1728 1956
1729=item @ints = $program->binary_sizes 1957=item @ints = $program->binary_sizes
1730 1958
1731Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. 1959Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1732 1960
1733=for gengetinfo end program 1961=for gengetinfo end program
1734 1962
1735=item @blobs = $program->binaries 1963=item @blobs = $program->binaries
1736 1964
… …
1757 1985
1758=for gengetinfo begin kernel 1986=for gengetinfo begin kernel
1759 1987
1760=item $string = $kernel->function_name 1988=item $string = $kernel->function_name
1761 1989
1762Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. 1990Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1763 1991
1764=item $uint = $kernel->num_args 1992=item $uint = $kernel->num_args
1765 1993
1766Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. 1994Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1767 1995
1768=item $uint = $kernel->reference_count 1996=item $uint = $kernel->reference_count
1769 1997
1770Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. 1998Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1771 1999
1772=item $ctx = $kernel->context 2000=item $ctx = $kernel->context
1773 2001
1774Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 2002Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1775 2003
1776=item $program = $kernel->program 2004=item $program = $kernel->program
1777 2005
1778Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 2006Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1779 2007
1780=for gengetinfo end kernel 2008=for gengetinfo end kernel
1781 2009
1782=item $packed_value = $kernel->work_group_info ($device, $name) 2010=item $packed_value = $kernel->work_group_info ($device, $name)
1783 2011
1784See C<< $platform->info >> for details. 2012See C<< $platform->info >> for details.
1785 2013
1786The reason this method is not called C<info> is that there already is an
1787C<< ->info >> method.
1788
1789L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> 2014L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1790 2015
1791=for gengetinfo begin kernel_work_group 2016=for gengetinfo begin kernel_work_group
1792 2017
1793=item $int = $kernel->work_group_size ($device) 2018=item $int = $kernel->work_group_size ($device)
1794 2019
1795Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. 2020Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1796 2021
1797=item @ints = $kernel->compile_work_group_size ($device) 2022=item @ints = $kernel->compile_work_group_size ($device)
1798 2023
1799Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. 2024Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1800 2025
1801=item $ulong = $kernel->local_mem_size ($device) 2026=item $ulong = $kernel->local_mem_size ($device)
1802 2027
1803Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. 2028Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1804 2029
1805=item $int = $kernel->preferred_work_group_size_multiple ($device) 2030=item $int = $kernel->preferred_work_group_size_multiple ($device)
1806 2031
1807Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. 2032Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1808 2033
1809=item $ulong = $kernel->private_mem_size ($device) 2034=item $ulong = $kernel->private_mem_size ($device)
1810 2035
1811Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. 2036Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1812 2037
1813=for gengetinfo end kernel_work_group 2038=for gengetinfo end kernel_work_group
2039
2040=item $packed_value = $kernel->arg_info ($idx, $name)
2041
2042See C<< $platform->info >> for details.
2043
2044L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
2045
2046=for gengetinfo begin kernel_arg
2047
2048=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
2049
2050Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
2051
2052=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
2053
2054Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
2055
2056=item $string = $kernel->arg_type_name ($idx)
2057
2058Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
2059
2060=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
2061
2062Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
2063
2064=item $string = $kernel->arg_name ($idx)
2065
2066Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
2067
2068=for gengetinfo end kernel_arg
1814 2069
1815=item $kernel->setf ($format, ...) 2070=item $kernel->setf ($format, ...)
1816 2071
1817Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic 2072Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1818way to set arguments (and with OpenCL 1.2 it might be rather slow), you 2073way to set arguments (and with OpenCL 1.2 it might be rather slow), you
… …
1930 2185
1931=for gengetinfo begin event 2186=for gengetinfo begin event
1932 2187
1933=item $queue = $event->command_queue 2188=item $queue = $event->command_queue
1934 2189
1935Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. 2190Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1936 2191
1937=item $command_type = $event->command_type 2192=item $command_type = $event->command_type
1938 2193
1939Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. 2194Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1940 2195
1941=item $uint = $event->reference_count 2196=item $uint = $event->reference_count
1942 2197
1943Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. 2198Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1944 2199
1945=item $uint = $event->command_execution_status 2200=item $uint = $event->command_execution_status
1946 2201
1947Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. 2202Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1948 2203
1949=item $ctx = $event->context 2204=item $ctx = $event->context
1950 2205
1951Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2206Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1952 2207
1953=for gengetinfo end event 2208=for gengetinfo end event
1954 2209
1955=item $packed_value = $ev->profiling_info ($name) 2210=item $packed_value = $ev->profiling_info ($name)
1956 2211
… …
1963 2218
1964=for gengetinfo begin profiling 2219=for gengetinfo begin profiling
1965 2220
1966=item $ulong = $event->profiling_command_queued 2221=item $ulong = $event->profiling_command_queued
1967 2222
1968Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. 2223Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1969 2224
1970=item $ulong = $event->profiling_command_submit 2225=item $ulong = $event->profiling_command_submit
1971 2226
1972Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. 2227Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1973 2228
1974=item $ulong = $event->profiling_command_start 2229=item $ulong = $event->profiling_command_start
1975 2230
1976Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. 2231Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1977 2232
1978=item $ulong = $event->profiling_command_end 2233=item $ulong = $event->profiling_command_end
1979 2234
1980Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. 2235Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1981 2236
1982=for gengetinfo end profiling 2237=for gengetinfo end profiling
1983 2238
1984=back 2239=back
1985 2240
… …
1991 2246
1992=item $ev->set_status ($execution_status) 2247=item $ev->set_status ($execution_status)
1993 2248
1994Sets the execution status of the user event. Can only be called once, 2249Sets the execution status of the user event. Can only be called once,
1995either with OpenCL::COMPLETE or a negative number as status. 2250either with OpenCL::COMPLETE or a negative number as status.
2251
2252execution_status: OpenCL::COMPLETE or a negative integer.
1996 2253
1997L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2254L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1998 2255
1999=back 2256=back
2000 2257
… …
2088 2345
2089This is a subclass of OpenCL::Mapped, representing mapped images. 2346This is a subclass of OpenCL::Mapped, representing mapped images.
2090 2347
2091=over 4 2348=over 4
2092 2349
2350=item $pixels = $mapped->width
2351
2352=item $pixels = $mapped->height
2353
2354=item $pixels = $mapped->depth
2355
2356Return the width/height/depth of the mapped image region, in pixels.
2357
2093=item $bytes = $mapped->row_pitch 2358=item $bytes = $mapped->row_pitch
2094 2359
2095=item $bytes = $mapped->slice_pitch 2360=item $bytes = $mapped->slice_pitch
2096 2361
2097Return the row or slice pitch of the image that has been mapped. 2362Return the row or slice pitch of the image that has been mapped.
2098 2363
2364=item $bytes = $mapped->element_size
2365
2366Return the size of a single pixel.
2367
2368=item $data = $mapped->get_row ($count, $x=0, $y=0, $z=0)
2369
2370Return C<$count> pixels from the given coordinates. The pixel data must
2371be completely contained within a single row.
2372
2373If C<$count> is C<undef>, then all the remaining pixels in that row are
2374returned.
2375
2376=item $mapped->set_row ($data, $x=0, $y=0, $z=0)
2377
2378Write the given pixel data at the given coordinate. The pixel data must
2379be completely contained within a single row.
2380
2099=back 2381=back
2100
2101 2382
2102=cut 2383=cut
2103 2384
21041; 23851;
2105 2386

Diff Legend

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