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

Diff Legend

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