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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC vs.
Revision 1.77 by root, Sat May 5 12:54:03 2012 UTC

43 43
44OpenCL::Event objects are used to signal when something is complete. 44OpenCL::Event objects are used to signal when something is complete.
45 45
46=head2 HELPFUL RESOURCES 46=head2 HELPFUL RESOURCES
47 47
48The OpenCL specs used to develop this module: 48The OpenCL specs used to develop this module - download these and keept
49hema round, they are required reference material:
49 50
50 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf 52 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf 53 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53 54
95initialised at creation time). 96initialised at creation time).
96 97
97Enqueue the kernel execution. 98Enqueue the kernel execution.
98 99
99Enqueue buffer reads for your output buffer to read results. 100Enqueue buffer reads for your output buffer to read results.
101
102=head1 OPENCL 1.1 VS. OPENCL 1.2
103
104This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
1051.2 interface hasn't been tested much for lack of availability of an
106actual implementation.
107
108Every function or method in this manual page that interfaces to a
109particular OpenCL function has a link to the its C manual page.
110
111If the link contains a F<1.1>, then this function is an OpenCL 1.1
112function. Most but not all also exist in OpenCL 1.2, and this module
113tries to emulate the missing ones for you, when told to do so at
114compiletime. You cna check whether a function was removed in OpenCL 1.2 by
115replacing the F<1.1> component in the URL by F<1.2>.
116
117If the link contains a F<1.2>, then this is a OpenCL 1.2-only
118function. Even if the module was compiled with OpenCL 1.2 header files
119and has an 1.2 OpenCL library, calling such a function on a platform that
120doesn't implement 1.2 causes undefined behaviour, usually a crash (But
121this is not guaranteed).
122
123You can find out whether this module was compiled to prefer 1.1
124functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
1251.1 functions generally are implemented using 1.1 OpenCL functions. If it
126is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
127fucntions.
128
129This is a somewhat sorry state of affairs, but the Khronos group choose to
130make every release of OpenCL source and binary incompatible with previous
131releases.
100 132
101=head1 EXAMPLES 133=head1 EXAMPLES
102 134
103=head2 Enumerate all devices and get contexts for them. 135=head2 Enumerate all devices and get contexts for them.
104 136
210 242
211 # wait for the last event to complete 243 # wait for the last event to complete
212 $ev->wait; 244 $ev->wait;
213 245
214=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia 246=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215set tunnel effect. 247set flight effect.
216 248
217This is quite a long example to get you going. 249This is quite a long example to get you going - you can download it from
250L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
218 251
219 use OpenGL ":all"; 252 use OpenGL ":all";
220 use OpenCL; 253 use OpenCL;
221 254
255 my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
256
222 # open a window and create a gl texture 257 # open a window and create a gl texture
223 OpenGL::glpOpenWindow width => 256, height => 256; 258 OpenGL::glpOpenWindow width => $S, height => $S;
224 my $texid = glGenTextures_p 1; 259 my $texid = glGenTextures_p 1;
225 glBindTexture GL_TEXTURE_2D, $texid; 260 glBindTexture GL_TEXTURE_2D, $texid;
226 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0; 261 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
227 262
228 # find and use the first opencl device that let's us get a shared opengl context 263 # find and use the first opencl device that let's us get a shared opengl context
229 my $platform; 264 my $platform;
230 my $dev; 265 my $dev;
231 my $ctx; 266 my $ctx;
250 # now the boring opencl code 285 # now the boring opencl code
251 my $src = <<EOF; 286 my $src = <<EOF;
252 kernel void 287 kernel void
253 juliatunnel (write_only image2d_t img, float time) 288 juliatunnel (write_only image2d_t img, float time)
254 { 289 {
255 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f; 290 int2 xy = (int2)(get_global_id (0), get_global_id (1));
291 float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
256 292
257 float2 m = (float2)(1.f, p.y) / fabs (p.x); 293 float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
258 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f; 294 m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
259 295
260 float2 z = m; 296 float2 z = m;
261 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001)); 297 float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
262 298
263 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) 299 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
264 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c; 300 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
265 301
266 float3 colour = (float3)(z.x, z.y, z.x * z.y); 302 float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
267 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.)); 303 write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
268 } 304 }
269 EOF 305 EOF
270 306
271 my $prog = $ctx->build_program ($src); 307 my $prog = $ctx->build_program ($src);
272 my $kernel = $prog->kernel ("juliatunnel"); 308 my $kernel = $prog->kernel ("juliatunnel");
276 for (my $time; ; ++$time) { 312 for (my $time; ; ++$time) {
277 # acquire objects from opengl 313 # acquire objects from opengl
278 $queue->acquire_gl_objects ([$tex]); 314 $queue->acquire_gl_objects ([$tex]);
279 315
280 # configure and run our kernel 316 # configure and run our kernel
281 $kernel->set_image2d (0, $tex); 317 $kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
282 $kernel->set_float (1, $time);
283 $queue->nd_range_kernel ($kernel, undef, [256, 256], undef); 318 $queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
284 319
285 # release objects to opengl again 320 # release objects to opengl again
286 $queue->release_gl_objects ([$tex]); 321 $queue->release_gl_objects ([$tex]);
287 322
288 # wait 323 # wait
301 336
302 glXSwapBuffers; 337 glXSwapBuffers;
303 338
304 select undef, undef, undef, 1/60; 339 select undef, undef, undef, 1/60;
305 } 340 }
341
342=head2 How to modify the previous example to not rely on GL sharing.
343
344For those poor souls with only a sucky CPU OpenCL implementation, you
345currently have to read the image into some perl scalar, and then modify a
346texture or use glDrawPixels or so).
347
348First, when you don't need gl sharing, you can create the context much simpler:
349
350 $ctx = $platform->context (undef, [$dev])
351
352To use a texture, you would modify the above example by creating an
353OpenCL::Image manually instead of deriving it from a texture:
354
355 my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
356
357And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
358would read the image2d after the kernel has written it:
359
360 $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
361
362And then you would upload the pixel data to the texture (or use glDrawPixels):
363
364 glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
365
366The fully modified example can be found at
367L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
368
369=head2 Julia sets look soooo 80ies.
370
371Then colour them differently, e.g. using orbit traps! Replace the loop and
372colour calculation from the previous examples by this:
373
374 float2 dm = (float2)(1.f, 1.f);
375
376 for (int i = 0; i < 25; ++i)
377 {
378 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
379 dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
380 }
381
382 float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
383
384Also try C<-10.f> instead of C<-1.f>.
306 385
307=head1 DOCUMENTATION 386=head1 DOCUMENTATION
308 387
309=head2 BASIC CONVENTIONS 388=head2 BASIC CONVENTIONS
310 389
386OpenCL can generate a number of (potentially) asynchronous events, for 465OpenCL can generate a number of (potentially) asynchronous events, for
387example, after compiling a program, to signal a context-related error or, 466example, after compiling a program, to signal a context-related error or,
388perhaps most important, to signal completion of queued jobs (by setting 467perhaps most important, to signal completion of queued jobs (by setting
389callbacks on OpenCL::Event objects). 468callbacks on OpenCL::Event objects).
390 469
470The OpenCL module converts all these callbacks into events - you can
471still register callbacks, but they are not executed when your OpenCL
472implementation calls the actual callback, but only later. Therefore, none
473of the limitations of OpenCL callbacks apply to the perl implementation:
474it is perfectly safe to make blocking operations from event callbacks, and
475enqueued operations don't need to be flushed.
476
391To facilitate this, this module maintains an event queue - each 477To facilitate this, this module maintains an event queue - each
392time an asynchronous event happens, it is queued, and perl will be 478time an asynchronous event happens, it is queued, and perl will be
393interrupted. This is implemented via the L<Async::Interrupt> module. In 479interrupted. This is implemented via the L<Async::Interrupt> module. In
394addition, this module has L<AnyEvent> support, so it can seamlessly 480addition, this module has L<AnyEvent> support, so it can seamlessly
395integrate itself into many event loops. 481integrate itself into many event loops.
396 482
397Since this module is a bit hard to understand, here are some case examples: 483Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
398 484
399=head3 Don't use callbacks. 485=head3 Don't use callbacks.
400 486
401When your program never uses any callbacks, then there will never be any 487When your program never uses any callbacks, then there will never be any
402notifications you need to take care of, and therefore no need to worry 488notifications you need to take care of, and therefore no need to worry
499use Async::Interrupt (); 585use Async::Interrupt ();
500 586
501our $POLL_FUNC; # set by XS 587our $POLL_FUNC; # set by XS
502 588
503BEGIN { 589BEGIN {
504 our $VERSION = '0.98'; 590 our $VERSION = '0.99';
505 591
506 require XSLoader; 592 require XSLoader;
507 XSLoader::load (__PACKAGE__, $VERSION); 593 XSLoader::load (__PACKAGE__, $VERSION);
508 594
509 @OpenCL::Platform::ISA = 595 @OpenCL::Platform::ISA =
514 @OpenCL::Sampler::ISA = 600 @OpenCL::Sampler::ISA =
515 @OpenCL::Program::ISA = 601 @OpenCL::Program::ISA =
516 @OpenCL::Kernel::ISA = 602 @OpenCL::Kernel::ISA =
517 @OpenCL::Event::ISA = OpenCL::Object::; 603 @OpenCL::Event::ISA = OpenCL::Object::;
518 604
605 @OpenCL::SubDevice::ISA = OpenCL::Device::;
606
519 @OpenCL::Buffer::ISA = 607 @OpenCL::Buffer::ISA =
520 @OpenCL::Image::ISA = OpenCL::Memory::; 608 @OpenCL::Image::ISA = OpenCL::Memory::;
521 609
522 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 610 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
523 611
527 @OpenCL::Image1D::ISA = 615 @OpenCL::Image1D::ISA =
528 @OpenCL::Image1DArray::ISA = 616 @OpenCL::Image1DArray::ISA =
529 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; 617 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
530 618
531 @OpenCL::UserEvent::ISA = OpenCL::Event::; 619 @OpenCL::UserEvent::ISA = OpenCL::Event::;
620
621 @OpenCL::MappedBuffer::ISA =
622 @OpenCL::MappedImage::ISA = OpenCL::Mapped::;
532} 623}
533 624
534=head2 THE OpenCL PACKAGE 625=head2 THE OpenCL PACKAGE
535 626
536=over 4 627=over 4
560L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 651L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
561 652
562=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr 653=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
563 654
564Tries to create a context from a default device and platform type - never worked for me. 655Tries to create a context from a default device and platform type - never worked for me.
656Consider using C<< $platform->context_from_type >> instead.
657
658type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
659OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
565 660
566L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 661L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
567 662
568=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) 663=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
569 664
570Create a new OpenCL::Context object using the given device object(s). This 665Create a new OpenCL::Context object using the given device object(s).
571function isn't implemented yet, use C<< $platform->context >> instead. 666Consider using C<< $platform->context >> instead.
572 667
573L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 668L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
574 669
575=item OpenCL::wait_for_events $wait_events... 670=item OpenCL::wait_for_events $wait_events...
576 671
683 778
684=for gengetinfo begin platform 779=for gengetinfo begin platform
685 780
686=item $string = $platform->profile 781=item $string = $platform->profile
687 782
688Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 783Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
689 784
690=item $string = $platform->version 785=item $string = $platform->version
691 786
692Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. 787Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
693 788
694=item $string = $platform->name 789=item $string = $platform->name
695 790
696Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. 791Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
697 792
698=item $string = $platform->vendor 793=item $string = $platform->vendor
699 794
700Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. 795Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
701 796
702=item $string = $platform->extensions 797=item $string = $platform->extensions
703 798
704Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. 799Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
705 800
706=for gengetinfo end platform 801=for gengetinfo end platform
707 802
708=back 803=back
709 804
715 810
716See C<< $platform->info >> for details. 811See C<< $platform->info >> for details.
717 812
718L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 813L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
719 814
815=item @devices = $device->sub_devices (\@properties)
816
817Creates OpencL::SubDevice objects by partitioning an existing device.
818
819L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
820
720=for gengetinfo begin device 821=for gengetinfo begin device
721 822
722=item $device_type = $device->type 823=item $device_type = $device->type
723 824
724Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. 825Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
725 826
726=item $uint = $device->vendor_id 827=item $uint = $device->vendor_id
727 828
728Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. 829Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
729 830
730=item $uint = $device->max_compute_units 831=item $uint = $device->max_compute_units
731 832
732Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. 833Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
733 834
734=item $uint = $device->max_work_item_dimensions 835=item $uint = $device->max_work_item_dimensions
735 836
736Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. 837Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
737 838
738=item $int = $device->max_work_group_size 839=item $int = $device->max_work_group_size
739 840
740Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. 841Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
741 842
742=item @ints = $device->max_work_item_sizes 843=item @ints = $device->max_work_item_sizes
743 844
744Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. 845Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
745 846
746=item $uint = $device->preferred_vector_width_char 847=item $uint = $device->preferred_vector_width_char
747 848
748Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. 849Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
749 850
750=item $uint = $device->preferred_vector_width_short 851=item $uint = $device->preferred_vector_width_short
751 852
752Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. 853Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
753 854
754=item $uint = $device->preferred_vector_width_int 855=item $uint = $device->preferred_vector_width_int
755 856
756Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. 857Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
757 858
758=item $uint = $device->preferred_vector_width_long 859=item $uint = $device->preferred_vector_width_long
759 860
760Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. 861Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
761 862
762=item $uint = $device->preferred_vector_width_float 863=item $uint = $device->preferred_vector_width_float
763 864
764Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. 865Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
765 866
766=item $uint = $device->preferred_vector_width_double 867=item $uint = $device->preferred_vector_width_double
767 868
768Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. 869Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
769 870
770=item $uint = $device->max_clock_frequency 871=item $uint = $device->max_clock_frequency
771 872
772Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. 873Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
773 874
774=item $bitfield = $device->address_bits 875=item $bitfield = $device->address_bits
775 876
776Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. 877Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
777 878
778=item $uint = $device->max_read_image_args 879=item $uint = $device->max_read_image_args
779 880
780Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. 881Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
781 882
782=item $uint = $device->max_write_image_args 883=item $uint = $device->max_write_image_args
783 884
784Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. 885Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
785 886
786=item $ulong = $device->max_mem_alloc_size 887=item $ulong = $device->max_mem_alloc_size
787 888
788Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. 889Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
789 890
790=item $int = $device->image2d_max_width 891=item $int = $device->image2d_max_width
791 892
792Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. 893Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
793 894
794=item $int = $device->image2d_max_height 895=item $int = $device->image2d_max_height
795 896
796Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. 897Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
797 898
798=item $int = $device->image3d_max_width 899=item $int = $device->image3d_max_width
799 900
800Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. 901Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
801 902
802=item $int = $device->image3d_max_height 903=item $int = $device->image3d_max_height
803 904
804Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. 905Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
805 906
806=item $int = $device->image3d_max_depth 907=item $int = $device->image3d_max_depth
807 908
808Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. 909Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
809 910
810=item $uint = $device->image_support 911=item $uint = $device->image_support
811 912
812Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. 913Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
813 914
814=item $int = $device->max_parameter_size 915=item $int = $device->max_parameter_size
815 916
816Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. 917Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
817 918
818=item $uint = $device->max_samplers 919=item $uint = $device->max_samplers
819 920
820Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. 921Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
821 922
822=item $uint = $device->mem_base_addr_align 923=item $uint = $device->mem_base_addr_align
823 924
824Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. 925Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
825 926
826=item $uint = $device->min_data_type_align_size 927=item $uint = $device->min_data_type_align_size
827 928
828Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. 929Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
829 930
830=item $device_fp_config = $device->single_fp_config 931=item $device_fp_config = $device->single_fp_config
831 932
832Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. 933Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
833 934
834=item $device_mem_cache_type = $device->global_mem_cache_type 935=item $device_mem_cache_type = $device->global_mem_cache_type
835 936
836Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. 937Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
837 938
838=item $uint = $device->global_mem_cacheline_size 939=item $uint = $device->global_mem_cacheline_size
839 940
840Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. 941Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
841 942
842=item $ulong = $device->global_mem_cache_size 943=item $ulong = $device->global_mem_cache_size
843 944
844Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. 945Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
845 946
846=item $ulong = $device->global_mem_size 947=item $ulong = $device->global_mem_size
847 948
848Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. 949Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
849 950
850=item $ulong = $device->max_constant_buffer_size 951=item $ulong = $device->max_constant_buffer_size
851 952
852Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. 953Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
853 954
854=item $uint = $device->max_constant_args 955=item $uint = $device->max_constant_args
855 956
856Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. 957Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
857 958
858=item $device_local_mem_type = $device->local_mem_type 959=item $device_local_mem_type = $device->local_mem_type
859 960
860Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. 961Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
861 962
862=item $ulong = $device->local_mem_size 963=item $ulong = $device->local_mem_size
863 964
864Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. 965Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
865 966
866=item $boolean = $device->error_correction_support 967=item $boolean = $device->error_correction_support
867 968
868Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. 969Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
869 970
870=item $int = $device->profiling_timer_resolution 971=item $int = $device->profiling_timer_resolution
871 972
872Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. 973Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
873 974
874=item $boolean = $device->endian_little 975=item $boolean = $device->endian_little
875 976
876Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. 977Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
877 978
878=item $boolean = $device->available 979=item $boolean = $device->available
879 980
880Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. 981Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
881 982
882=item $boolean = $device->compiler_available 983=item $boolean = $device->compiler_available
883 984
884Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. 985Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
885 986
886=item $device_exec_capabilities = $device->execution_capabilities 987=item $device_exec_capabilities = $device->execution_capabilities
887 988
888Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. 989Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
889 990
890=item $command_queue_properties = $device->properties 991=item $command_queue_properties = $device->properties
891 992
892Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. 993Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
893 994
894=item $ = $device->platform 995=item $ = $device->platform
895 996
896Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. 997Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
897 998
898=item $string = $device->name 999=item $string = $device->name
899 1000
900Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. 1001Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
901 1002
902=item $string = $device->vendor 1003=item $string = $device->vendor
903 1004
904Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. 1005Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
905 1006
906=item $string = $device->driver_version 1007=item $string = $device->driver_version
907 1008
908Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. 1009Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
909 1010
910=item $string = $device->profile 1011=item $string = $device->profile
911 1012
912Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. 1013Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
913 1014
914=item $string = $device->version 1015=item $string = $device->version
915 1016
916Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. 1017Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
917 1018
918=item $string = $device->extensions 1019=item $string = $device->extensions
919 1020
920Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. 1021Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
921 1022
922=item $uint = $device->preferred_vector_width_half 1023=item $uint = $device->preferred_vector_width_half
923 1024
924Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. 1025Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
925 1026
926=item $uint = $device->native_vector_width_char 1027=item $uint = $device->native_vector_width_char
927 1028
928Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. 1029Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
929 1030
930=item $uint = $device->native_vector_width_short 1031=item $uint = $device->native_vector_width_short
931 1032
932Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. 1033Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
933 1034
934=item $uint = $device->native_vector_width_int 1035=item $uint = $device->native_vector_width_int
935 1036
936Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. 1037Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
937 1038
938=item $uint = $device->native_vector_width_long 1039=item $uint = $device->native_vector_width_long
939 1040
940Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. 1041Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
941 1042
942=item $uint = $device->native_vector_width_float 1043=item $uint = $device->native_vector_width_float
943 1044
944Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. 1045Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
945 1046
946=item $uint = $device->native_vector_width_double 1047=item $uint = $device->native_vector_width_double
947 1048
948Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. 1049Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
949 1050
950=item $uint = $device->native_vector_width_half 1051=item $uint = $device->native_vector_width_half
951 1052
952Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. 1053Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
953 1054
954=item $device_fp_config = $device->double_fp_config 1055=item $device_fp_config = $device->double_fp_config
955 1056
956Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. 1057Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
957 1058
958=item $device_fp_config = $device->half_fp_config 1059=item $device_fp_config = $device->half_fp_config
959 1060
960Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. 1061Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
961 1062
962=item $boolean = $device->host_unified_memory 1063=item $boolean = $device->host_unified_memory
963 1064
964Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. 1065Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
965 1066
966=item $device = $device->parent_device_ext 1067=item $device = $device->parent_device_ext
967 1068
968Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. 1069Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
969 1070
970=item @device_partition_property_exts = $device->partition_types_ext 1071=item @device_partition_property_exts = $device->partition_types_ext
971 1072
972Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. 1073Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
973 1074
974=item @device_partition_property_exts = $device->affinity_domains_ext 1075=item @device_partition_property_exts = $device->affinity_domains_ext
975 1076
976Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 1077Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
977 1078
978=item $uint = $device->reference_count_ext 1079=item $uint = $device->reference_count_ext
979 1080
980Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. 1081Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
981 1082
982=item @device_partition_property_exts = $device->partition_style_ext 1083=item @device_partition_property_exts = $device->partition_style_ext
983 1084
984Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 1085Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
985 1086
986=for gengetinfo end device 1087=for gengetinfo end device
987 1088
988=back 1089=back
989 1090
990=head2 THE OpenCL::Context CLASS 1091=head2 THE OpenCL::Context CLASS
1092
1093An OpenCL::Context is basically a container, or manager, for a number of
1094devices of a platform. It is used to create all sorts of secondary objects
1095such as buffers, queues, programs and so on.
1096
1097All context creation functions and methods take a list of properties
1098(type-value pairs). All property values can be specified as integers -
1099some additionally support other types:
1100
1101=over 4
1102
1103=item OpenCL::CONTEXT_PLATFORM
1104
1105Also accepts OpenCL::Platform objects.
1106
1107=item OpenCL::GLX_DISPLAY_KHR
1108
1109Also accepts C<undef>, in which case a deep and troubling hack is engaged
1110to find the current glx display (see L<GLX SUPPORT>).
1111
1112=item OpenCL::GL_CONTEXT_KHR
1113
1114Also accepts C<undef>, in which case a deep and troubling hack is engaged
1115to find the current glx context (see L<GLX SUPPORT>).
1116
1117=back
991 1118
992=over 4 1119=over 4
993 1120
994=item $prog = $ctx->build_program ($program, $options = "") 1121=item $prog = $ctx->build_program ($program, $options = "")
995 1122
1043=item $buf = $ctx->buffer ($flags, $len) 1170=item $buf = $ctx->buffer ($flags, $len)
1044 1171
1045Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the 1172Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1046given flags and octet-size. 1173given flags and octet-size.
1047 1174
1175flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
1176OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
1177OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
1178
1048L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1179L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1049 1180
1050=item $buf = $ctx->buffer_sv ($flags, $data) 1181=item $buf = $ctx->buffer_sv ($flags, $data)
1051 1182
1052Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 1183Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1055=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) 1186=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)
1056 1187
1057Creates a new OpenCL::Image object and optionally initialises it with 1188Creates a new OpenCL::Image object and optionally initialises it with
1058the given data values. 1189the given data values.
1059 1190
1191channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
1192OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
1193OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
1194
1195channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
1196OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1197OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1198OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1199OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1200
1201
1202type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1203OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1204OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1205OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1206
1060L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> 1207L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1061 1208
1062=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 1209=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1063 1210
1064Creates a new OpenCL::Image2D object and optionally initialises it with 1211Creates a new OpenCL::Image2D object and optionally initialises it with
1076=item $buffer = $ctx->gl_buffer ($flags, $bufobj) 1223=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1077 1224
1078Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 1225Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1079OpenGL buffer object. 1226OpenGL buffer object.
1080 1227
1228flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1229
1081http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 1230http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1082 1231
1083=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) 1232=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1084 1233
1085Creates a new OpenCL::Image object that refers to the given OpenGL 1234Creates a new OpenCL::Image object that refers to the given OpenGL
1086texture object or buffer. 1235texture object or buffer.
1087 1236
1237target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
1238GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
1239GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
1240GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
1241GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
1242GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
1243
1088http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html 1244http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1089 1245
1090=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 1246=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1091 1247
1092Creates a new OpenCL::Image2D object that refers to the given OpenGL 1248Creates a new OpenCL::Image2D object that refers to the given OpenGL
1117 1273
1118=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1274=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1119 1275
1120Creates a new OpenCL::Sampler object. 1276Creates a new OpenCL::Sampler object.
1121 1277
1278addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
1279OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
1280
1281filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
1282
1122L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> 1283L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1123 1284
1124=item $program = $ctx->program_with_source ($string) 1285=item $program = $ctx->program_with_source ($string)
1125 1286
1126Creates a new OpenCL::Program object from the given source code. 1287Creates a new OpenCL::Program object from the given source code.
1127 1288
1128L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 1289L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1129 1290
1291=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
1292
1293Creates a new OpenCL::Program object from the given binaries.
1294
1295L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
1296
1297Example: clone an existing program object that contains a successfully
1298compiled program, no matter how useless this is.
1299
1300 my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
1301
1302=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1303
1304Creates a new OpenCL::Program object from the given built-in kernel names.
1305
1306L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1307
1308=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
1309
1310Links all (already compiled) program objects specified in C<@programs>
1311together and returns a new OpenCL::Program object with the result.
1312
1313L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
1314
1130=item $packed_value = $ctx->info ($name) 1315=item $packed_value = $ctx->info ($name)
1131 1316
1132See C<< $platform->info >> for details. 1317See C<< $platform->info >> for details.
1133 1318
1134L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 1319L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1135 1320
1136=for gengetinfo begin context 1321=for gengetinfo begin context
1137 1322
1138=item $uint = $context->reference_count 1323=item $uint = $context->reference_count
1139 1324
1140Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. 1325Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1141 1326
1142=item @devices = $context->devices 1327=item @devices = $context->devices
1143 1328
1144Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. 1329Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1145 1330
1146=item @property_ints = $context->properties 1331=item @property_ints = $context->properties
1147 1332
1148Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. 1333Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1149 1334
1150=item $uint = $context->num_devices 1335=item $uint = $context->num_devices
1151 1336
1152Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. 1337Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1153 1338
1154=for gengetinfo end context 1339=for gengetinfo end context
1155 1340
1156=back 1341=back
1157 1342
1204 1389
1205=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...) 1390=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...)
1206 1391
1207http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html 1392http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1208 1393
1394=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1395
1396L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
1397
1209=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1398=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1210 1399
1211L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> 1400C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1212 1401module uses the image width (and height) to supply default values.
1213=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1214 1402
1215L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1216 1404
1217=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1405=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1218 1406
1407C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1408module uses the image width (and height) to supply default values.
1219L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1409L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1220 1410
1221=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) 1411=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1222 1412
1223L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1413L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1268reference to an array of local work sizes, with the same number of 1458reference to an array of local work sizes, with the same number of
1269elements as \@global_work_size. 1459elements as \@global_work_size.
1270 1460
1271L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1461L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1272 1462
1463=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
1464
1465Migrates a number of OpenCL::Memory objects to or from the device.
1466
1467flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
1468
1469L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
1470
1273=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) 1471=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1274 1472
1275Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1473Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1276for subsequent OpenCL usage. 1474for subsequent OpenCL usage.
1277 1475
1312 1510
1313=for gengetinfo begin command_queue 1511=for gengetinfo begin command_queue
1314 1512
1315=item $ctx = $command_queue->context 1513=item $ctx = $command_queue->context
1316 1514
1317Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. 1515Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1318 1516
1319=item $device = $command_queue->device 1517=item $device = $command_queue->device
1320 1518
1321Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. 1519Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1322 1520
1323=item $uint = $command_queue->reference_count 1521=item $uint = $command_queue->reference_count
1324 1522
1325Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. 1523Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1326 1524
1327=item $command_queue_properties = $command_queue->properties 1525=item $command_queue_properties = $command_queue->properties
1328 1526
1329Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. 1527Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1330 1528
1331=for gengetinfo end command_queue 1529=for gengetinfo end command_queue
1530
1531=back
1532
1533=head3 MEMORY MAPPED BUFFERS
1534
1535OpenCL allows you to map buffers and images to host memory (read: perl
1536scalars). This is done much like reading or copying a buffer, by enqueuing
1537a map or unmap operation on the command queue.
1538
1539The map operations return an C<OpenCL::Mapped> object - see L<THE
1540OpenCL::Mapped CLASS> section for details on what to do with these
1541objects.
1542
1543The object will be unmapped automatically when the mapped object is
1544destroyed (you can use a barrier to make sure the unmap has finished,
1545before using the buffer in a kernel), but you can also enqueue an unmap
1546operation manually.
1547
1548=over 4
1549
1550=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
1551
1552Maps the given buffer into host memory and returns an
1553C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
1554the map will extend to the end of the buffer.
1555
1556map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1557
1558L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1559
1560Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
1561
1562 {
1563 my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
1564 substr $$mapped, 0, 4, "abcd";
1565 } # asynchronously unmap because $mapped is destroyed
1566
1567=item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...)
1568
1569Maps the given image area into host memory and return an
1570C<OpenCL::MappedImage> object.
1571
1572If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
1573will be replaced by the maximum possible value.
1574
1575L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
1576
1577Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
1578the first channel of the leftmost column to 5, then explicitly unmap
1579it. You are not necessarily meant to do it this way, this example just
1580shows you the accessors to use :)
1581
1582 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
1583
1584 $mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
1585 for 0..$image->height;
1586
1587 $mapped->unmap;.
1588 $mapped->wait; # only needed for out of order queues normally
1589
1590=item $ev = $queue->unmap ($mapped, $wait_events...)
1591
1592Unmaps the data from host memory. You must not call any methods that
1593modify the data, or modify the data scalar directly, after calling this
1594method.
1595
1596The mapped event object will always be passed as part of the
1597$wait_events. The mapped event object will be replaced by the new event
1598object that this request creates.
1332 1599
1333=back 1600=back
1334 1601
1335=head2 THE OpenCL::Memory CLASS 1602=head2 THE OpenCL::Memory CLASS
1336 1603
1347 1614
1348=for gengetinfo begin mem 1615=for gengetinfo begin mem
1349 1616
1350=item $mem_object_type = $mem->type 1617=item $mem_object_type = $mem->type
1351 1618
1352Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. 1619Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1353 1620
1354=item $mem_flags = $mem->flags 1621=item $mem_flags = $mem->flags
1355 1622
1356Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. 1623Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1357 1624
1358=item $int = $mem->size 1625=item $int = $mem->size
1359 1626
1360Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. 1627Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1361 1628
1362=item $ptr_value = $mem->host_ptr 1629=item $ptr_value = $mem->host_ptr
1363 1630
1364Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. 1631Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1365 1632
1366=item $uint = $mem->map_count 1633=item $uint = $mem->map_count
1367 1634
1368Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. 1635Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1369 1636
1370=item $uint = $mem->reference_count 1637=item $uint = $mem->reference_count
1371 1638
1372Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. 1639Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1373 1640
1374=item $ctx = $mem->context 1641=item $ctx = $mem->context
1375 1642
1376Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. 1643Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1377 1644
1378=item $mem = $mem->associated_memobject 1645=item $mem = $mem->associated_memobject
1379 1646
1380Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. 1647Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1381 1648
1382=item $int = $mem->offset 1649=item $int = $mem->offset
1383 1650
1384Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1651Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1385 1652
1386=for gengetinfo end mem 1653=for gengetinfo end mem
1387 1654
1388=item ($type, $name) = $mem->gl_object_info 1655=item ($type, $name) = $mem->gl_object_info
1389 1656
1441 1708
1442=for gengetinfo begin image 1709=for gengetinfo begin image
1443 1710
1444=item $int = $image->element_size 1711=item $int = $image->element_size
1445 1712
1446Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1713Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1447 1714
1448=item $int = $image->row_pitch 1715=item $int = $image->row_pitch
1449 1716
1450Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. 1717Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1451 1718
1452=item $int = $image->slice_pitch 1719=item $int = $image->slice_pitch
1453 1720
1454Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. 1721Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1455 1722
1456=item $int = $image->width 1723=item $int = $image->width
1457 1724
1458Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. 1725Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1459 1726
1460=item $int = $image->height 1727=item $int = $image->height
1461 1728
1462Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. 1729Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1463 1730
1464=item $int = $image->depth 1731=item $int = $image->depth
1465 1732
1466Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1733Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1467 1734
1468=for gengetinfo end image 1735=for gengetinfo end image
1469 1736
1470=for gengetinfo begin gl_texture 1737=for gengetinfo begin gl_texture
1471 1738
1472=item $GLenum = $gl_texture->target 1739=item $GLenum = $gl_texture->target
1473 1740
1474Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. 1741Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1475 1742
1476=item $GLint = $gl_texture->gl_mipmap_level 1743=item $GLint = $gl_texture->gl_mipmap_level
1477 1744
1478Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. 1745Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1479 1746
1480=for gengetinfo end gl_texture 1747=for gengetinfo end gl_texture
1481 1748
1482=back 1749=back
1483 1750
1493 1760
1494=for gengetinfo begin sampler 1761=for gengetinfo begin sampler
1495 1762
1496=item $uint = $sampler->reference_count 1763=item $uint = $sampler->reference_count
1497 1764
1498Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. 1765Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1499 1766
1500=item $ctx = $sampler->context 1767=item $ctx = $sampler->context
1501 1768
1502Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. 1769Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1503 1770
1504=item $addressing_mode = $sampler->normalized_coords 1771=item $addressing_mode = $sampler->normalized_coords
1505 1772
1506Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. 1773Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1507 1774
1508=item $filter_mode = $sampler->addressing_mode 1775=item $filter_mode = $sampler->addressing_mode
1509 1776
1510Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. 1777Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1511 1778
1512=item $boolean = $sampler->filter_mode 1779=item $boolean = $sampler->filter_mode
1513 1780
1514Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. 1781Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1515 1782
1516=for gengetinfo end sampler 1783=for gengetinfo end sampler
1517 1784
1518=back 1785=back
1519 1786
1537not so. So best make sure you don't pass in invalid values. 1804not so. So best make sure you don't pass in invalid values.
1538 1805
1539Some implementations fail with C<OpenCL::INVALID_BINARY> when the 1806Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1540compilation state is successful but some later stage fails. 1807compilation state is successful but some later stage fails.
1541 1808
1809options: C<-D name>, C<-D name=definition>, C<-I dir>,
1810C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
1811C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
1812C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1813C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1814C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1815C<-create-library>, C<-enable-link-options>.
1816
1817build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
1818OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1819
1542L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1820L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1543 1821
1544=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) 1822=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1545 1823
1546Similar to C<< ->build >>, except it starts a thread, and never fails (you 1824Similar to C<< ->build >>, except it starts a thread, and never fails (you
1547need to check the compilation status form the callback, or by polling). 1825need to check the compilation status form the callback, or by polling).
1548 1826
1827=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1828
1829Compiles the given program for the given devices (or all devices if
1830undef). If C<$headers> is given, it must be a hashref with include name =>
1831OpenCL::Program pairs.
1832
1833L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1834
1549=item $packed_value = $program->build_info ($device, $name) 1835=item $packed_value = $program->build_info ($device, $name)
1550 1836
1551Similar to C<< $platform->info >>, but returns build info for a previous 1837Similar to C<< $platform->info >>, but returns build info for a previous
1552build attempt for the given device. 1838build attempt for the given device.
1553 1839
1568 1854
1569=for gengetinfo begin program_build 1855=for gengetinfo begin program_build
1570 1856
1571=item $build_status = $program->build_status ($device) 1857=item $build_status = $program->build_status ($device)
1572 1858
1573Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. 1859Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1574 1860
1575=item $string = $program->build_options ($device) 1861=item $string = $program->build_options ($device)
1576 1862
1577Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. 1863Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1578 1864
1579=item $string = $program->build_log ($device) 1865=item $string = $program->build_log ($device)
1580 1866
1581Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. 1867Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1582 1868
1583=for gengetinfo end program_build 1869=for gengetinfo end program_build
1584 1870
1585=item $packed_value = $program->info ($name) 1871=item $packed_value = $program->info ($name)
1586 1872
1590 1876
1591=for gengetinfo begin program 1877=for gengetinfo begin program
1592 1878
1593=item $uint = $program->reference_count 1879=item $uint = $program->reference_count
1594 1880
1595Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. 1881Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1596 1882
1597=item $ctx = $program->context 1883=item $ctx = $program->context
1598 1884
1599Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. 1885Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1600 1886
1601=item $uint = $program->num_devices 1887=item $uint = $program->num_devices
1602 1888
1603Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. 1889Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1604 1890
1605=item @devices = $program->devices 1891=item @devices = $program->devices
1606 1892
1607Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. 1893Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1608 1894
1609=item $string = $program->source 1895=item $string = $program->source
1610 1896
1611Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. 1897Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1612 1898
1613=item @ints = $program->binary_sizes 1899=item @ints = $program->binary_sizes
1614 1900
1615Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. 1901Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1616 1902
1617=for gengetinfo end program 1903=for gengetinfo end program
1618 1904
1619=item @blobs = $program->binaries 1905=item @blobs = $program->binaries
1620 1906
1641 1927
1642=for gengetinfo begin kernel 1928=for gengetinfo begin kernel
1643 1929
1644=item $string = $kernel->function_name 1930=item $string = $kernel->function_name
1645 1931
1646Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. 1932Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1647 1933
1648=item $uint = $kernel->num_args 1934=item $uint = $kernel->num_args
1649 1935
1650Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. 1936Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1651 1937
1652=item $uint = $kernel->reference_count 1938=item $uint = $kernel->reference_count
1653 1939
1654Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. 1940Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1655 1941
1656=item $ctx = $kernel->context 1942=item $ctx = $kernel->context
1657 1943
1658Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. 1944Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1659 1945
1660=item $program = $kernel->program 1946=item $program = $kernel->program
1661 1947
1662Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. 1948Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1663 1949
1664=for gengetinfo end kernel 1950=for gengetinfo end kernel
1665 1951
1666=item $packed_value = $kernel->work_group_info ($device, $name) 1952=item $packed_value = $kernel->work_group_info ($device, $name)
1667 1953
1668See C<< $platform->info >> for details. 1954See C<< $platform->info >> for details.
1669 1955
1670The reason this method is not called C<info> is that there already is an
1671C<< ->info >> method.
1672
1673L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> 1956L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1674 1957
1675=for gengetinfo begin kernel_work_group 1958=for gengetinfo begin kernel_work_group
1676 1959
1677=item $int = $kernel->work_group_size ($device) 1960=item $int = $kernel->work_group_size ($device)
1678 1961
1679Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. 1962Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1680 1963
1681=item @ints = $kernel->compile_work_group_size ($device) 1964=item @ints = $kernel->compile_work_group_size ($device)
1682 1965
1683Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. 1966Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1684 1967
1685=item $ulong = $kernel->local_mem_size ($device) 1968=item $ulong = $kernel->local_mem_size ($device)
1686 1969
1687Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. 1970Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1688 1971
1689=item $int = $kernel->preferred_work_group_size_multiple ($device) 1972=item $int = $kernel->preferred_work_group_size_multiple ($device)
1690 1973
1691Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. 1974Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1692 1975
1693=item $ulong = $kernel->private_mem_size ($device) 1976=item $ulong = $kernel->private_mem_size ($device)
1694 1977
1695Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. 1978Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1696 1979
1697=for gengetinfo end kernel_work_group 1980=for gengetinfo end kernel_work_group
1981
1982=item $packed_value = $kernel->arg_info ($idx, $name)
1983
1984See C<< $platform->info >> for details.
1985
1986L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
1987
1988=for gengetinfo begin kernel_arg
1989
1990=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
1991
1992Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
1993
1994=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
1995
1996Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
1997
1998=item $string = $kernel->arg_type_name ($idx)
1999
2000Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
2001
2002=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
2003
2004Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
2005
2006=item $string = $kernel->arg_name ($idx)
2007
2008Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
2009
2010=for gengetinfo end kernel_arg
1698 2011
1699=item $kernel->setf ($format, ...) 2012=item $kernel->setf ($format, ...)
1700 2013
1701Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic 2014Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1702way to set arguments (and with OpenCL 1.2 it might be rather slow), you 2015way to set arguments (and with OpenCL 1.2 it might be rather slow), you
1814 2127
1815=for gengetinfo begin event 2128=for gengetinfo begin event
1816 2129
1817=item $queue = $event->command_queue 2130=item $queue = $event->command_queue
1818 2131
1819Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. 2132Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1820 2133
1821=item $command_type = $event->command_type 2134=item $command_type = $event->command_type
1822 2135
1823Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. 2136Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1824 2137
1825=item $uint = $event->reference_count 2138=item $uint = $event->reference_count
1826 2139
1827Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. 2140Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1828 2141
1829=item $uint = $event->command_execution_status 2142=item $uint = $event->command_execution_status
1830 2143
1831Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. 2144Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1832 2145
1833=item $ctx = $event->context 2146=item $ctx = $event->context
1834 2147
1835Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. 2148Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1836 2149
1837=for gengetinfo end event 2150=for gengetinfo end event
1838 2151
1839=item $packed_value = $ev->profiling_info ($name) 2152=item $packed_value = $ev->profiling_info ($name)
1840 2153
1847 2160
1848=for gengetinfo begin profiling 2161=for gengetinfo begin profiling
1849 2162
1850=item $ulong = $event->profiling_command_queued 2163=item $ulong = $event->profiling_command_queued
1851 2164
1852Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. 2165Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1853 2166
1854=item $ulong = $event->profiling_command_submit 2167=item $ulong = $event->profiling_command_submit
1855 2168
1856Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. 2169Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1857 2170
1858=item $ulong = $event->profiling_command_start 2171=item $ulong = $event->profiling_command_start
1859 2172
1860Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. 2173Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1861 2174
1862=item $ulong = $event->profiling_command_end 2175=item $ulong = $event->profiling_command_end
1863 2176
1864Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. 2177Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1865 2178
1866=for gengetinfo end profiling 2179=for gengetinfo end profiling
1867 2180
1868=back 2181=back
1869 2182
1876=item $ev->set_status ($execution_status) 2189=item $ev->set_status ($execution_status)
1877 2190
1878Sets the execution status of the user event. Can only be called once, 2191Sets the execution status of the user event. Can only be called once,
1879either with OpenCL::COMPLETE or a negative number as status. 2192either with OpenCL::COMPLETE or a negative number as status.
1880 2193
2194execution_status: OpenCL::COMPLETE or a negative integer.
2195
1881L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 2196L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1882 2197
1883=back 2198=back
2199
2200=head2 THE OpenCL::Mapped CLASS
2201
2202This class represents objects mapped into host memory. They are
2203represented by a blessed string scalar. The string data is the mapped
2204memory area, that is, if you read or write it, then the mapped object is
2205accessed directly.
2206
2207You must only ever use operations that modify the string in-place - for
2208example, a C<substr> that doesn't change the length, or maybe a regex that
2209doesn't change the length. Any other operation might cause the data to be
2210copied.
2211
2212When the object is destroyed it will enqueue an implicit unmap operation
2213on the queue that was used to create it.
2214
2215Keep in mind that you I<need> to unmap (or destroy) mapped objects before
2216OpenCL sees the changes, even if some implementations don't need this
2217sometimes.
2218
2219Example, replace the first two floats in the mapped buffer by 1 and 2.
2220
2221 my $mapped = $queue->map_buffer ($buf, ...
2222 $mapped->event->wait; # make sure it's there
2223
2224 # now replace first 8 bytes by new data, which is exactly 8 bytes long
2225 # we blindly assume device endianness to equal host endianness
2226 # (and of course, we assume iee 754 single precision floats :)
2227 substr $$mapped, 0, 8, pack "f*", 1, 2;
2228
2229=over 4
2230
2231=item $ev = $mapped->unmap ($wait_events...)
2232
2233Unmaps the mapped memory object, using the queue originally used to create
2234it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
2235
2236=item $bool = $mapped->mapped
2237
2238Returns whether the object is still mapped - true before an C<unmap> is
2239enqueued, false afterwards.
2240
2241=item $ev = $mapped->event
2242
2243Return the event object associated with the mapped object. Initially, this
2244will be the event object created when mapping the object, and after an
2245unmap, this will be the event object that the unmap operation created.
2246
2247=item $mapped->wait
2248
2249Same as C<< $mapped->event->wait >> - makes sure no operations on this
2250mapped object are outstanding.
2251
2252=item $bytes = $mapped->size
2253
2254Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
2255
2256=item $ptr = $mapped->ptr
2257
2258Returns the raw memory address of the mapped area.
2259
2260=item $mapped->set ($offset, $data)
2261
2262Replaces the data at the given C<$offset> in the memory area by the new
2263C<$data>. This method is safer than direct manipulation of C<$mapped>
2264because it does bounds-checking, but also slower.
2265
2266=item $data = $mapped->get ($offset, $length)
2267
2268Returns (without copying) a scalar representing the data at the given
2269C<$offset> and C<$length> in the mapped memory area. This is the same as
2270the following substr, except much slower;
2271
2272 $data = substr $$mapped, $offset, $length
2273
2274=cut
2275
2276sub OpenCL::Mapped::get {
2277 substr ${$_[0]}, $_[1], $_[2]
2278}
2279
2280=back
2281
2282=head2 THE OpenCL::MappedBuffer CLASS
2283
2284This is a subclass of OpenCL::Mapped, representing mapped buffers.
2285
2286=head2 THE OpenCL::MappedImage CLASS
2287
2288This is a subclass of OpenCL::Mapped, representing mapped images.
2289
2290=over 4
2291
2292=item $bytes = $mapped->row_pitch
2293
2294=item $bytes = $mapped->slice_pitch
2295
2296Return the row or slice pitch of the image that has been mapped.
2297
2298=back
2299
1884 2300
1885=cut 2301=cut
1886 2302
18871; 23031;
1888 2304

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines