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

Diff Legend

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