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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.21 by root, Sun Nov 20 10:21:27 2011 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 spec used to develop this module (1.2 spec was available, but 48The OpenCL specs used to develop this module - download these and keept
49no implementation was available to me :). 49hema round, they are required reference material:
50 50
51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
52 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
53 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
52 54
53OpenCL manpages: 55OpenCL manpages:
54 56
55 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ 57 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
58 http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
56 59
57If you are into UML class diagrams, the following diagram might help - if 60If you are into UML class diagrams, the following diagram might help - if
58not, it will be mildly cobfusing: 61not, it will be mildly confusing (also, the class hierarchy of this module
62is much more fine-grained):
59 63
60 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html 64 http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/classDiagram.html
61 65
62Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it 66Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
63is, but at least it's free of charge: 67is, but at least it's free of charge:
64 68
65 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf 69 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
… …
93 97
94Enqueue the kernel execution. 98Enqueue the kernel execution.
95 99
96Enqueue buffer reads for your output buffer to read results. 100Enqueue buffer reads for your output buffer to read results.
97 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.
132
98=head1 EXAMPLES 133=head1 EXAMPLES
99 134
100=head2 Enumerate all devices and get contexts for them. 135=head2 Enumerate all devices and get contexts for them.
101 136
102Best run this once to get a feel for the platforms and devices in your 137Best run this once to get a feel for the platforms and devices in your
103system. 138system.
104 139
105 for my $platform (OpenCL::platforms) { 140 for my $platform (OpenCL::platforms) {
106 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 141 printf "platform: %s\n", $platform->name;
107 printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); 142 printf "extensions: %s\n", $platform->extensions;
108 for my $device ($platform->devices) { 143 for my $device ($platform->devices) {
109 printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); 144 printf "+ device: %s\n", $device->name;
110 my $ctx = $device->context; 145 my $ctx = $platform->context (undef, [$device]);
111 # do stuff 146 # do stuff
112 } 147 }
113 } 148 }
114 149
115=head2 Get a useful context and a command queue. 150=head2 Get a useful context and a command queue.
… …
138=head2 Create a buffer with some predefined data, read it back synchronously, 173=head2 Create a buffer with some predefined data, read it back synchronously,
139then asynchronously. 174then asynchronously.
140 175
141 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut"); 176 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
142 177
143 $queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data); 178 $queue->read_buffer ($buf, 1, 1, 3, my $data);
144 print "$data\n"; 179 print "$data\n";
145 180
146 my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data); 181 my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
147 $ev->wait; 182 $ev->wait;
148 print "$data\n"; # prints "elm" 183 print "$data\n"; # prints "elm"
149 184
150=head2 Create and build a program, then create a kernel out of one of its 185=head2 Create and build a program, then create a kernel out of one of its
151functions. 186functions.
152 187
153 my $src = ' 188 my $src = '
154 __kernel void 189 kernel void
155 squareit (__global float *input, __global float *output) 190 squareit (global float *input, global float *output)
156 { 191 {
157 $id = get_global_id (0); 192 $id = get_global_id (0);
158 output [id] = input [id] * input [id]; 193 output [id] = input [id] * input [id];
159 } 194 }
160 '; 195 ';
161 196
162 my $prog = $ctx->program_with_source ($src); 197 my $prog = $ctx->build_program ($src);
163
164 # build croaks on compile errors, so catch it and print the compile errors
165 eval { $prog->build ($dev); 1 }
166 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
167
168 my $kernel = $prog->kernel ("squareit"); 198 my $kernel = $prog->kernel ("squareit");
169 199
170=head2 Create some input and output float buffers, then call the 200=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them. 201'squareit' kernel on them.
172 202
… …
176 # set buffer 206 # set buffer
177 $kernel->set_buffer (0, $input); 207 $kernel->set_buffer (0, $input);
178 $kernel->set_buffer (1, $output); 208 $kernel->set_buffer (1, $output);
179 209
180 # execute it for all 4 numbers 210 # execute it for all 4 numbers
181 $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 211 $queue->nd_range_kernel ($kernel, undef, [4], undef);
182 212
183 # enqueue a synchronous read 213 # enqueue a synchronous read
184 $queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 214 $queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
185 215
186 # print the results: 216 # print the results:
187 printf "%s\n", join ", ", unpack "f*", $data; 217 printf "%s\n", join ", ", unpack "f*", $data;
188 218
189=head2 The same enqueue operations as before, but assuming an out-of-order queue, 219=head2 The same enqueue operations as before, but assuming an out-of-order queue,
190showing off barriers. 220showing off barriers.
191 221
192 # execute it for all 4 numbers 222 # execute it for all 4 numbers
193 $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 223 $queue->nd_range_kernel ($kernel, undef, [4], undef);
194 224
195 # enqueue a barrier to ensure in-order execution 225 # enqueue a barrier to ensure in-order execution
196 $queue->enqueue_barrier; 226 $queue->barrier;
197 227
198 # enqueue an async read 228 # enqueue an async read
199 $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 229 $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
200 230
201 # wait for all requests to finish 231 # wait for all requests to finish
202 $queue->finish; 232 $queue->finish;
203 233
204=head2 The same enqueue operations as before, but assuming an out-of-order queue, 234=head2 The same enqueue operations as before, but assuming an out-of-order queue,
205showing off event objects and wait lists. 235showing off event objects and wait lists.
206 236
207 # execute it for all 4 numbers 237 # execute it for all 4 numbers
208 my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 238 my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
209 239
210 # enqueue an async read 240 # enqueue an async read
211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 241 $ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212 242
213 # wait for the last event to complete 243 # wait for the last event to complete
214 $ev->wait; 244 $ev->wait;
245
246=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
247set flight effect.
248
249This is quite a long example to get you going - you can download it from
250L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
251
252 use OpenGL ":all";
253 use OpenCL;
254
255 my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
256
257 # open a window and create a gl texture
258 OpenGL::glpOpenWindow width => $S, height => $S;
259 my $texid = glGenTextures_p 1;
260 glBindTexture GL_TEXTURE_2D, $texid;
261 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
262
263 # find and use the first opencl device that let's us get a shared opengl context
264 my $platform;
265 my $dev;
266 my $ctx;
267
268 for (OpenCL::platforms) {
269 $platform = $_;
270 for ($platform->devices) {
271 $dev = $_;
272 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
273 and last;
274 }
275 }
276
277 $ctx
278 or die "cannot find suitable OpenCL device\n";
279
280 my $queue = $ctx->queue ($dev);
281
282 # now attach an opencl image2d object to the opengl texture
283 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
284
285 # now the boring opencl code
286 my $src = <<EOF;
287 kernel void
288 juliatunnel (write_only image2d_t img, float time)
289 {
290 int2 xy = (int2)(get_global_id (0), get_global_id (1));
291 float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
292
293 float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
294 m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
295
296 float2 z = m;
297 float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
298
299 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
300 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
301
302 float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
303 write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
304 }
305 EOF
306
307 my $prog = $ctx->build_program ($src);
308 my $kernel = $prog->kernel ("juliatunnel");
309
310 # program compiled, kernel ready, now draw and loop
311
312 for (my $time; ; ++$time) {
313 # acquire objects from opengl
314 $queue->acquire_gl_objects ([$tex]);
315
316 # configure and run our kernel
317 $kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
318 $queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
319
320 # release objects to opengl again
321 $queue->release_gl_objects ([$tex]);
322
323 # wait
324 $queue->finish;
325
326 # now draw the texture, the defaults should be all right
327 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
328
329 glEnable GL_TEXTURE_2D;
330 glBegin GL_QUADS;
331 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
332 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
333 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
334 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
335 glEnd;
336
337 glXSwapBuffers;
338
339 select undef, undef, undef, 1/60;
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>.
215 385
216=head1 DOCUMENTATION 386=head1 DOCUMENTATION
217 387
218=head2 BASIC CONVENTIONS 388=head2 BASIC CONVENTIONS
219 389
… …
241=item * Structures are often specified by flattening out their components 411=item * Structures are often specified by flattening out their components
242as with short vectors, and returned as arrayrefs. 412as with short vectors, and returned as arrayrefs.
243 413
244=item * When enqueuing commands, the wait list is specified by adding 414=item * When enqueuing commands, the wait list is specified by adding
245extra arguments to the function - anywhere a C<$wait_events...> argument 415extra arguments to the function - anywhere a C<$wait_events...> argument
246is documented this can be any number of event objects. 416is documented this can be any number of event objects. As an extsnion
417implemented by this module, C<undef> values will be ignored in the event
418list.
247 419
248=item * When enqueuing commands, if the enqueue method is called in void 420=item * When enqueuing commands, if the enqueue method is called in void
249context, no event is created. In all other contexts an event is returned 421context, no event is created. In all other contexts an event is returned
250by the method. 422by the method.
251 423
… …
271 ulong IV - Q 443 ulong IV - Q
272 float NV float f 444 float NV float f
273 half IV ushort S 445 half IV ushort S
274 double NV double d 446 double NV double d
275 447
448=head2 GLX SUPPORT
449
450Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
451module, which has little to no documentation and has little to no support
452for glX), this module, as a special extension, treats context creation
453properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
454specially: If either or both of these are C<undef>, then the OpenCL
455module tries to dynamically resolve C<glXGetCurrentDisplay> and
456C<glXGetCurrentContext>, call these functions and use their return values
457instead.
458
459For this to work, the OpenGL library must be loaded, a GLX context must
460have been created and be made current, and C<dlsym> must be available and
461capable of finding the function via C<RTLD_DEFAULT>.
462
463=head2 EVENT SYSTEM
464
465OpenCL can generate a number of (potentially) asynchronous events, for
466example, after compiling a program, to signal a context-related error or,
467perhaps most important, to signal completion of queued jobs (by setting
468callbacks on OpenCL::Event objects).
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
477To facilitate this, this module maintains an event queue - each
478time an asynchronous event happens, it is queued, and perl will be
479interrupted. This is implemented via the L<Async::Interrupt> module. In
480addition, this module has L<AnyEvent> support, so it can seamlessly
481integrate itself into many event loops.
482
483Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
484
485=head3 Don't use callbacks.
486
487When your program never uses any callbacks, then there will never be any
488notifications you need to take care of, and therefore no need to worry
489about all this.
490
491You can achieve a great deal by explicitly waiting for events, or using
492barriers and flush calls. In many programs, there is no need at all to
493tinker with asynchronous events.
494
495=head3 Use AnyEvent
496
497This module automatically registers a watcher that invokes all outstanding
498event callbacks when AnyEvent is initialised (and block asynchronous
499interruptions). Using this mode of operations is the safest and most
500recommended one.
501
502To use this, simply use AnyEvent and this module normally, make sure you
503have an event loop running:
504
505 use Gtk2 -init;
506 use AnyEvent;
507
508 # initialise AnyEvent, by creating a watcher, or:
509 AnyEvent::detect;
510
511 my $e = $queue->marker;
512 $e->cb (sub {
513 warn "opencl is finished\n";
514 })
515
516 main Gtk2;
517
518Note that this module will not initialise AnyEvent for you. Before
519AnyEvent is initialised, the module will asynchronously interrupt perl
520instead. To avoid any surprises, it's best to explicitly initialise
521AnyEvent.
522
523You can temporarily enable asynchronous interruptions (see next paragraph)
524by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
525calling C<$OpenCL::INTERRUPT->block>.
526
527=head3 Let yourself be interrupted at any time
528
529This mode is the default unless AnyEvent is loaded and initialised. In
530this mode, OpenCL asynchronously interrupts a running perl program. The
531emphasis is on both I<asynchronously> and I<running> here.
532
533Asynchronously means that perl might execute your callbacks at any
534time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
535the C<until> loop following the marker call will be interrupted by the
536callback:
537
538 my $e = $queue->marker;
539 my $flag;
540 $e->cb (sub { $flag = 1 });
541 1 until $flag;
542 # $flag is now 1
543
544The reason why you shouldn't blindly copy the above code is that
545busy waiting is a really really bad thing, and really really bad for
546performance.
547
548While at first this asynchronous business might look exciting, it can be
549really hard, because you need to be prepared for the callback code to be
550executed at any time, which limits the amount of things the callback code
551can do safely.
552
553This can be mitigated somewhat by using C<<
554$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
555documentation for details).
556
557The other problem is that your program must be actively I<running> to be
558interrupted. When you calculate stuff, your program is running. When you
559hang in some C functions or other block execution (by calling C<sleep>,
560C<select>, running an event loop and so on), your program is waiting, not
561running.
562
563One way around that would be to attach a read watcher to your event loop,
564listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
565dummy callback (C<sub { }>) to temporarily execute some perl code.
566
567That is then awfully close to using the built-in AnyEvent support above,
568though, so consider that one instead.
569
570=head3 Be creative
571
572OpenCL exports the L<Async::Interrupt> object it uses in the global
573variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
574
575So if you want to feel like a real pro, err, wait, if you feel no risk
576menas no fun, you can experiment by implementing your own mode of
577operations.
578
579=cut
580
581package OpenCL;
582
583use common::sense;
584use Carp ();
585use Async::Interrupt ();
586
587our $POLL_FUNC; # set by XS
588
589BEGIN {
590 our $VERSION = '0.99';
591
592 require XSLoader;
593 XSLoader::load (__PACKAGE__, $VERSION);
594
595 @OpenCL::Platform::ISA =
596 @OpenCL::Device::ISA =
597 @OpenCL::Context::ISA =
598 @OpenCL::Queue::ISA =
599 @OpenCL::Memory::ISA =
600 @OpenCL::Sampler::ISA =
601 @OpenCL::Program::ISA =
602 @OpenCL::Kernel::ISA =
603 @OpenCL::Event::ISA = OpenCL::Object::;
604
605 @OpenCL::SubDevice::ISA = OpenCL::Device::;
606
607 @OpenCL::Buffer::ISA =
608 @OpenCL::Image::ISA = OpenCL::Memory::;
609
610 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
611
612 @OpenCL::Image2D::ISA =
613 @OpenCL::Image3D::ISA =
614 @OpenCL::Image2DArray::ISA =
615 @OpenCL::Image1D::ISA =
616 @OpenCL::Image1DArray::ISA =
617 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
618
619 @OpenCL::UserEvent::ISA = OpenCL::Event::;
620
621 @OpenCL::MappedBuffer::ISA =
622 @OpenCL::MappedImage::ISA = OpenCL::Mapped::;
623}
624
276=head2 THE OpenCL PACKAGE 625=head2 THE OpenCL PACKAGE
277 626
278=over 4 627=over 4
279 628
280=item $int = OpenCL::errno 629=item $int = OpenCL::errno
281 630
282The last error returned by a function - it's only valid after an error occured 631The last error returned by a function - it's only valid after an error occured
283and before calling another OpenCL function. 632and before calling another OpenCL function.
284 633
285=item $str = OpenCL::err2str $errval 634=item $str = OpenCL::err2str [$errval]
286 635
287Comverts an error value into a human readable string. 636Converts an error value into a human readable string. IF no error value is
637given, then the last error will be used (as returned by OpenCL::errno).
288 638
289=item $str = OpenCL::enum2str $enum 639=item $str = OpenCL::enum2str $enum
290 640
291Converts most enum values (inof parameter names, image format constants, 641Converts most enum values (of parameter names, image format constants,
292object types, addressing and filter modes, command types etc.) into a 642object types, addressing and filter modes, command types etc.) into a
293human readbale string. When confronted with some random integer it can be 643human readable string. When confronted with some random integer it can be
294very helpful to pass it through this function to maybe get some readable 644very helpful to pass it through this function to maybe get some readable
295string out of it. 645string out of it.
296 646
297=item @platforms = OpenCL::platforms 647=item @platforms = OpenCL::platforms
298 648
299Returns all available OpenCL::Platform objects. 649Returns all available OpenCL::Platform objects.
300 650
301L<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>
302 652
303=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef 653=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
304 654
305Tries to create a context from a default device and platform - 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.
306 660
307L<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>
308 662
663=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
664
665Create a new OpenCL::Context object using the given device object(s).
666Consider using C<< $platform->context >> instead.
667
668L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
669
309=item OpenCL::wait_for_events $wait_events... 670=item OpenCL::wait_for_events $wait_events...
310 671
311Waits for all events to complete. 672Waits for all events to complete.
312 673
313L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 674L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314 675
676=item OpenCL::poll
677
678Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
679invokes their callbacks.
680
681=item $OpenCL::INTERRUPT
682
683The L<Async::Interrupt> object used to signal asynchronous events (see
684L<EVENT SYSTEM>).
685
686=cut
687
688our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
689
690&_eq_initialise ($INTERRUPT->signal_func);
691
692=item $OpenCL::WATCHER
693
694The L<AnyEvent> watcher object used to watch for asynchronous events (see
695L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
696loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
697
698=cut
699
700our $WATCHER;
701
702sub _init_anyevent {
703 $INTERRUPT->block;
704 $WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
705}
706
707if (defined $AnyEvent::MODEL) {
708 _init_anyevent;
709} else {
710 push @AnyEvent::post_detect, \&_init_anyevent;
711}
712
315=back 713=back
316 714
715=head2 THE OpenCL::Object CLASS
716
717This is the base class for all objects in the OpenCL module. The only
718method it implements is the C<id> method, which is only useful if you want
719to interface to OpenCL on the C level.
720
721=over 4
722
723=item $iv = $obj->id
724
725OpenCL objects are represented by pointers or integers on the C level. If
726you want to interface to an OpenCL object directly on the C level, then
727you need this value, which is returned by this method. You should use an
728C<IV> type in your code and cast that to the correct type.
729
730=cut
731
732sub OpenCL::Object::id {
733 ref $_[0] eq "SCALAR"
734 ? ${ $_[0] }
735 : $_[0][0]
736}
737
738=back
739
317=head2 THE OpenCL::Platform CLASS 740=head2 THE OpenCL::Platform CLASS
318 741
319=over 4 742=over 4
320 743
321=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 744=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322 745
323Returns a list of matching OpenCL::Device objects. 746Returns a list of matching OpenCL::Device objects.
324 747
325=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 748=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
326 749
327Tries to create a context. Never worked for me, and you need devices explitly anyway. 750Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 751
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 752L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 753
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 754=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
332 755
333Create a new OpenCL::Context object using the given device object(s)- a 756Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 757CL_CONTEXT_PLATFORM property is supplied automatically.
335 758
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 759L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
337 760
338=item $packed_value = $platform->info ($name) 761=item $packed_value = $platform->info ($name)
339 762
340Calls C<clGetPlatformInfo> and returns the packed, raw value - for 763Calls C<clGetPlatformInfo> and returns the packed, raw value - for
341strings, this will be the string, for other values you probably need to 764strings, this will be the string (possibly including terminating \0), for
342use the correct C<unpack>. 765other values you probably need to use the correct C<unpack>.
343 766
344It's best to avoid this method and use one of the predefined C<get_*> 767It's best to avoid this method and use one of the following convenience
345methods. 768wrappers.
346 769
347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 770L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348 771
772=item $platform->unload_compiler
773
774Attempts to unload the compiler for this platform, for endless
775profit. Does nothing on OpenCL 1.1.
776
777L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
778
349=for gengetinfo begin platform 779=for gengetinfo begin platform
350 780
351
352=item $string = $platform->profile 781=item $string = $platform->profile
353 782
354Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s). 783Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
355 784
356=item $string = $platform->version 785=item $string = $platform->version
357 786
358Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s). 787Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
359 788
360=item $string = $platform->name 789=item $string = $platform->name
361 790
362Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s). 791Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
363 792
364=item $string = $platform->vendor 793=item $string = $platform->vendor
365 794
366Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s). 795Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
367 796
368=item $string = $platform->extensions 797=item $string = $platform->extensions
369 798
370Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s). 799Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
371 800
372=for gengetinfo end platform 801=for gengetinfo end platform
373 802
374=back 803=back
375 804
… …
381 810
382See C<< $platform->info >> for details. 811See C<< $platform->info >> for details.
383 812
384L<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>
385 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
386=for gengetinfo begin device 821=for gengetinfo begin device
387 822
388
389=item $device_type = $device->type 823=item $device_type = $device->type
390 824
391Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s). 825Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
392 826
393=item $uint = $device->vendor_id 827=item $uint = $device->vendor_id
394 828
395Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s). 829Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
396 830
397=item $uint = $device->max_compute_units 831=item $uint = $device->max_compute_units
398 832
399Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s). 833Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
400 834
401=item $uint = $device->max_work_item_dimensions 835=item $uint = $device->max_work_item_dimensions
402 836
403Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s). 837Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
404 838
405=item $int = $device->max_work_group_size 839=item $int = $device->max_work_group_size
406 840
407Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s). 841Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
408 842
409=item @ints = $device->max_work_item_sizes 843=item @ints = $device->max_work_item_sizes
410 844
411Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s). 845Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
412 846
413=item $uint = $device->preferred_vector_width_char 847=item $uint = $device->preferred_vector_width_char
414 848
415Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s). 849Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
416 850
417=item $uint = $device->preferred_vector_width_short 851=item $uint = $device->preferred_vector_width_short
418 852
419Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s). 853Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
420 854
421=item $uint = $device->preferred_vector_width_int 855=item $uint = $device->preferred_vector_width_int
422 856
423Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s). 857Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
424 858
425=item $uint = $device->preferred_vector_width_long 859=item $uint = $device->preferred_vector_width_long
426 860
427Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s). 861Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
428 862
429=item $uint = $device->preferred_vector_width_float 863=item $uint = $device->preferred_vector_width_float
430 864
431Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s). 865Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
432 866
433=item $uint = $device->preferred_vector_width_double 867=item $uint = $device->preferred_vector_width_double
434 868
435Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s). 869Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
436 870
437=item $uint = $device->max_clock_frequency 871=item $uint = $device->max_clock_frequency
438 872
439Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s). 873Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
440 874
441=item $bitfield = $device->address_bits 875=item $bitfield = $device->address_bits
442 876
443Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s). 877Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
444 878
445=item $uint = $device->max_read_image_args 879=item $uint = $device->max_read_image_args
446 880
447Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s). 881Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
448 882
449=item $uint = $device->max_write_image_args 883=item $uint = $device->max_write_image_args
450 884
451Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s). 885Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
452 886
453=item $ulong = $device->max_mem_alloc_size 887=item $ulong = $device->max_mem_alloc_size
454 888
455Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s). 889Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
456 890
457=item $int = $device->image2d_max_width 891=item $int = $device->image2d_max_width
458 892
459Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s). 893Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
460 894
461=item $int = $device->image2d_max_height 895=item $int = $device->image2d_max_height
462 896
463Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s). 897Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
464 898
465=item $int = $device->image3d_max_width 899=item $int = $device->image3d_max_width
466 900
467Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s). 901Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
468 902
469=item $int = $device->image3d_max_height 903=item $int = $device->image3d_max_height
470 904
471Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s). 905Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
472 906
473=item $int = $device->image3d_max_depth 907=item $int = $device->image3d_max_depth
474 908
475Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s). 909Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
476 910
477=item $uint = $device->image_support 911=item $uint = $device->image_support
478 912
479Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s). 913Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
480 914
481=item $int = $device->max_parameter_size 915=item $int = $device->max_parameter_size
482 916
483Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s). 917Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
484 918
485=item $uint = $device->max_samplers 919=item $uint = $device->max_samplers
486 920
487Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s). 921Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
488 922
489=item $uint = $device->mem_base_addr_align 923=item $uint = $device->mem_base_addr_align
490 924
491Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s). 925Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
492 926
493=item $uint = $device->min_data_type_align_size 927=item $uint = $device->min_data_type_align_size
494 928
495Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s). 929Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
496 930
497=item $device_fp_config = $device->single_fp_config 931=item $device_fp_config = $device->single_fp_config
498 932
499Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s). 933Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
500 934
501=item $device_mem_cache_type = $device->global_mem_cache_type 935=item $device_mem_cache_type = $device->global_mem_cache_type
502 936
503Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s). 937Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
504 938
505=item $uint = $device->global_mem_cacheline_size 939=item $uint = $device->global_mem_cacheline_size
506 940
507Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s). 941Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
508 942
509=item $ulong = $device->global_mem_cache_size 943=item $ulong = $device->global_mem_cache_size
510 944
511Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s). 945Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
512 946
513=item $ulong = $device->global_mem_size 947=item $ulong = $device->global_mem_size
514 948
515Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s). 949Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
516 950
517=item $ulong = $device->max_constant_buffer_size 951=item $ulong = $device->max_constant_buffer_size
518 952
519Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s). 953Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
520 954
521=item $uint = $device->max_constant_args 955=item $uint = $device->max_constant_args
522 956
523Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s). 957Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
524 958
525=item $device_local_mem_type = $device->local_mem_type 959=item $device_local_mem_type = $device->local_mem_type
526 960
527Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s). 961Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
528 962
529=item $ulong = $device->local_mem_size 963=item $ulong = $device->local_mem_size
530 964
531Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s). 965Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
532 966
533=item $boolean = $device->error_correction_support 967=item $boolean = $device->error_correction_support
534 968
535Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s). 969Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
536 970
537=item $int = $device->profiling_timer_resolution 971=item $int = $device->profiling_timer_resolution
538 972
539Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s). 973Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
540 974
541=item $boolean = $device->endian_little 975=item $boolean = $device->endian_little
542 976
543Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s). 977Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
544 978
545=item $boolean = $device->available 979=item $boolean = $device->available
546 980
547Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s). 981Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
548 982
549=item $boolean = $device->compiler_available 983=item $boolean = $device->compiler_available
550 984
551Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s). 985Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
552 986
553=item $device_exec_capabilities = $device->execution_capabilities 987=item $device_exec_capabilities = $device->execution_capabilities
554 988
555Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s). 989Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
556 990
557=item $command_queue_properties = $device->properties 991=item $command_queue_properties = $device->properties
558 992
559Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s). 993Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
560 994
561=item $ = $device->platform 995=item $ = $device->platform
562 996
563Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s). 997Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
564 998
565=item $string = $device->name 999=item $string = $device->name
566 1000
567Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s). 1001Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
568 1002
569=item $string = $device->vendor 1003=item $string = $device->vendor
570 1004
571Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s). 1005Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
572 1006
573=item $string = $device->driver_version 1007=item $string = $device->driver_version
574 1008
575Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s). 1009Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
576 1010
577=item $string = $device->profile 1011=item $string = $device->profile
578 1012
579Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s). 1013Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
580 1014
581=item $string = $device->version 1015=item $string = $device->version
582 1016
583Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s). 1017Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
584 1018
585=item $string = $device->extensions 1019=item $string = $device->extensions
586 1020
587Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s). 1021Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
588 1022
589=item $uint = $device->preferred_vector_width_half 1023=item $uint = $device->preferred_vector_width_half
590 1024
591Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s). 1025Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
592 1026
593=item $uint = $device->native_vector_width_char 1027=item $uint = $device->native_vector_width_char
594 1028
595Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s). 1029Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
596 1030
597=item $uint = $device->native_vector_width_short 1031=item $uint = $device->native_vector_width_short
598 1032
599Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s). 1033Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
600 1034
601=item $uint = $device->native_vector_width_int 1035=item $uint = $device->native_vector_width_int
602 1036
603Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s). 1037Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
604 1038
605=item $uint = $device->native_vector_width_long 1039=item $uint = $device->native_vector_width_long
606 1040
607Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s). 1041Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
608 1042
609=item $uint = $device->native_vector_width_float 1043=item $uint = $device->native_vector_width_float
610 1044
611Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s). 1045Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
612 1046
613=item $uint = $device->native_vector_width_double 1047=item $uint = $device->native_vector_width_double
614 1048
615Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s). 1049Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
616 1050
617=item $uint = $device->native_vector_width_half 1051=item $uint = $device->native_vector_width_half
618 1052
619Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s). 1053Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
620 1054
621=item $device_fp_config = $device->double_fp_config 1055=item $device_fp_config = $device->double_fp_config
622 1056
623Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s). 1057Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
624 1058
625=item $device_fp_config = $device->half_fp_config 1059=item $device_fp_config = $device->half_fp_config
626 1060
627Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s). 1061Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
628 1062
629=item $boolean = $device->host_unified_memory 1063=item $boolean = $device->host_unified_memory
630 1064
631Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s). 1065Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
632 1066
633=item $device = $device->parent_device_ext 1067=item $device = $device->parent_device_ext
634 1068
635Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s). 1069Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
636 1070
637=item @device_partition_property_exts = $device->partition_types_ext 1071=item @device_partition_property_exts = $device->partition_types_ext
638 1072
639Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s). 1073Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
640 1074
641=item @device_partition_property_exts = $device->affinity_domains_ext 1075=item @device_partition_property_exts = $device->affinity_domains_ext
642 1076
643Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s). 1077Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
644 1078
645=item $uint = $device->reference_count_ext 1079=item $uint = $device->reference_count_ext
646 1080
647Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s). 1081Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
648 1082
649=item @device_partition_property_exts = $device->partition_style_ext 1083=item @device_partition_property_exts = $device->partition_style_ext
650 1084
651Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s). 1085Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
652 1086
653=for gengetinfo end device 1087=for gengetinfo end device
654 1088
655=back 1089=back
656 1090
657=head2 THE OpenCL::Context CLASS 1091=head2 THE OpenCL::Context CLASS
658 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
659=over 4 1101=over 4
660 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
1118
1119=over 4
1120
1121=item $prog = $ctx->build_program ($program, $options = "")
1122
1123This convenience function tries to build the program on all devices in
1124the context. If the build fails, then the function will C<croak> with the
1125build log. Otherwise ti returns the program object.
1126
1127The C<$program> can either be a C<OpenCL::Program> object or a string
1128containing the program. In the latter case, a program objetc will be
1129created automatically.
1130
1131=cut
1132
1133sub OpenCL::Context::build_program {
1134 my ($self, $prog, $options) = @_;
1135
1136 $prog = $self->program_with_source ($prog)
1137 unless ref $prog;
1138
1139 eval { $prog->build (undef, $options); 1 }
1140 or errno == BUILD_PROGRAM_FAILURE
1141 or errno == INVALID_BINARY # workaround nvidia bug
1142 or Carp::croak "OpenCL::Context->build_program: " . err2str;
1143
1144 # we check status for all devices
1145 for my $dev ($self->devices) {
1146 $prog->build_status ($dev) == BUILD_SUCCESS
1147 or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1148 . $prog->build_log ($dev);
1149 }
1150
1151 $prog
1152}
1153
661=item $queue = $ctx->queue ($device, $properties) 1154=item $queue = $ctx->queue ($device, $properties)
662 1155
663Create a new OpenCL::Queue object from the context and the given device. 1156Create a new OpenCL::Queue object from the context and the given device.
664 1157
665L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 1158L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
666 1159
1160Example: create an out-of-order queue.
1161
1162 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
1163
667=item $ev = $ctx->user_event 1164=item $ev = $ctx->user_event
668 1165
669Creates a new OpenCL::UserEvent object. 1166Creates a new OpenCL::UserEvent object.
670 1167
671L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 1168L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
672 1169
673=item $buf = $ctx->buffer ($flags, $len) 1170=item $buf = $ctx->buffer ($flags, $len)
674 1171
675Creates a new OpenCL::Buffer object with the given flags and octet-size. 1172Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1173given flags and octet-size.
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.
676 1178
677L<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>
678 1180
679=item $buf = $ctx->buffer_sv ($flags, $data) 1181=item $buf = $ctx->buffer_sv ($flags, $data)
680 1182
681Creates a new OpenCL::Buffer object and initialise it with the given data values. 1183Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1184initialise it with the given data values.
1185
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)
1187
1188Creates a new OpenCL::Image object and optionally initialises it with
1189the given data values.
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
1207L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
682 1208
683=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)
684 1210
685Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 1211Creates a new OpenCL::Image2D object and optionally initialises it with
1212the given data values.
686 1213
687L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 1214L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
688 1215
689=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 1216=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
690 1217
691Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 1218Creates a new OpenCL::Image3D object and optionally initialises it with
1219the given data values.
692 1220
693L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 1221L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
1222
1223=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1224
1225Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1226OpenGL buffer object.
1227
1228flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
1229
1230http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1231
1232=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1233
1234Creates a new OpenCL::Image object that refers to the given OpenGL
1235texture object or buffer.
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
1244http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1245
1246=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1247
1248Creates a new OpenCL::Image2D object that refers to the given OpenGL
12492D texture object.
1250
1251http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
1252
1253=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
1254
1255Creates a new OpenCL::Image3D object that refers to the given OpenGL
12563D texture object.
1257
1258http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
1259
1260=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
1261
1262Creates a new OpenCL::Image2D object that refers to the given OpenGL
1263render buffer.
1264
1265http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
694 1266
695=item @formats = $ctx->supported_image_formats ($flags, $image_type) 1267=item @formats = $ctx->supported_image_formats ($flags, $image_type)
696 1268
697Returns a list of matching image formats - each format is an arrayref with 1269Returns a list of matching image formats - each format is an arrayref with
698two values, $channel_order and $channel_type, in it. 1270two values, $channel_order and $channel_type, in it.
… …
701 1273
702=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) 1274=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
703 1275
704Creates a new OpenCL::Sampler object. 1276Creates a new OpenCL::Sampler object.
705 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
706L<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>
707 1284
708=item $program = $ctx->program_with_source ($string) 1285=item $program = $ctx->program_with_source ($string)
709 1286
710Creates a new OpenCL::Program object from the given source code. 1287Creates a new OpenCL::Program object from the given source code.
711 1288
712L<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>
713 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
714=item $packed_value = $ctx->info ($name) 1315=item $packed_value = $ctx->info ($name)
715 1316
716See C<< $platform->info >> for details. 1317See C<< $platform->info >> for details.
717 1318
718L<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>
719 1320
720=for gengetinfo begin context 1321=for gengetinfo begin context
721 1322
722
723=item $uint = $context->reference_count 1323=item $uint = $context->reference_count
724 1324
725Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s). 1325Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
726 1326
727=item @devices = $context->devices 1327=item @devices = $context->devices
728 1328
729Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s). 1329Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
730 1330
731=item @property_ints = $context->properties 1331=item @property_ints = $context->properties
732 1332
733Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s). 1333Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
734 1334
735=item $uint = $context->num_devices 1335=item $uint = $context->num_devices
736 1336
737Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s). 1337Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
738 1338
739=for gengetinfo end context 1339=for gengetinfo end context
740 1340
741=back 1341=back
742 1342
743=head2 THE OpenCL::Queue CLASS 1343=head2 THE OpenCL::Queue CLASS
744 1344
745An OpenCL::Queue represents an execution queue for OpenCL. You execute 1345An OpenCL::Queue represents an execution queue for OpenCL. You execute
746requests by calling their respective C<enqueue_xxx> method and waitinf for 1346requests by calling their respective method and waiting for it to complete
747it to complete in some way. 1347in some way.
748 1348
749All the enqueue methods return an event object that can be used to wait 1349Most methods that enqueue some request return an event object that can
750for completion, unless the method is called in void context, in which case 1350be used to wait for completion (optionally using a callback), unless
751no event object is created. 1351the method is called in void context, in which case no event object is
1352created.
752 1353
753They also allow you to specify any number of other event objects that this 1354They also allow you to specify any number of other event objects that this
754request has to wait for before it starts executing, by simply passing the 1355request has to wait for before it starts executing, by simply passing the
755event objects as extra parameters to the enqueue methods. 1356event objects as extra parameters to the enqueue methods. To simplify
1357program design, this module ignores any C<undef> values in the list of
1358events. This makes it possible to code operations such as this, without
1359having to put a valid event object into C<$event> first:
1360
1361 $event = $queue->xxx (..., $event);
756 1362
757Queues execute in-order by default, without any parallelism, so in most 1363Queues execute in-order by default, without any parallelism, so in most
758cases (i.e. you use only one queue) it's not necessary to wait for or 1364cases (i.e. you use only one queue) it's not necessary to wait for or
759create event objects. 1365create event objects, althoguh an our of order queue is often a bit
1366faster.
760 1367
761=over 4 1368=over 4
762 1369
763=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1370=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
764 1371
765Reads data from buffer into the given string. 1372Reads data from buffer into the given string.
766 1373
767L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 1374L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
768 1375
769=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...) 1376=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
770 1377
771Writes data to buffer from the given string. 1378Writes data to buffer from the given string.
772 1379
773L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html> 1380L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
774 1381
775=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1382=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
776 1383
777L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1384L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
778 1385
1386=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...)
1387
1388http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1389
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...)
1391
1392http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
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
779=item $ev = $queue->enqueue_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...)
1399
1400C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1401module uses the image width (and height) to supply default values.
780 1402
781L<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>
782 1404
783=item $ev = $queue->enqueue_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...)
784 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.
785L<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>
786 1410
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...)
1412
1413L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1414
1415=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1416
1417L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1418
787=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...) 1419=item $ev = $queue->copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
788 1420
789Yeah. 1421Yeah.
790 1422
791L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
792
793=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
794
795L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1423L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
796 1424
797=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) 1425=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
798 1426
1427Fills the given buffer object with repeated applications of C<$pattern>,
1428starting at C<$offset> for C<$size> octets.
1429
1430L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1431
1432=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1433
1434Fills the given image area with the given rgba colour components. The
1435components are normally floating point values between C<0> and C<1>,
1436except when the image channel data type is a signe dor unsigned
1437unnormalised format, in which case the range is determined by the format.
1438
799L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1439L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
800 1440
801=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
802
803L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
804
805=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1441=item $ev = $queue->task ($kernel, $wait_events...)
806 1442
807L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1443L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
808 1444
809=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...) 1445=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
810 1446
811Enqueues a kernel execution. 1447Enqueues a kernel execution.
812 1448
813@$global_work_size must be specified as a reference to an array of 1449\@global_work_size must be specified as a reference to an array of
814integers specifying the work sizes (element counts). 1450integers specifying the work sizes (element counts).
815 1451
816@$global_work_offset must be either C<undef> (in which case all offsets 1452\@global_work_offset must be either C<undef> (in which case all offsets
817are C<0>), or a reference to an array of work offsets, with the same number 1453are C<0>), or a reference to an array of work offsets, with the same number
818of elements as @$global_work_size. 1454of elements as \@global_work_size.
819 1455
820@$local_work_size must be either C<undef> (in which case the 1456\@local_work_size must be either C<undef> (in which case the
821implementation is supposed to choose good local work sizes), or a 1457implementation is supposed to choose good local work sizes), or a
822reference 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
823elements as @$global_work_size. 1459elements as \@global_work_size.
824 1460
825L<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>
826 1462
827=item $ev = $queue->enqueue_marker 1463=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
828 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
1471=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1472
1473Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1474for subsequent OpenCL usage.
1475
829L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1476L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
830 1477
1478=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1479
1480Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1481for subsequent OpenGL usage.
1482
1483L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1484
831=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1485=item $ev = $queue->wait_for_events ($wait_events...)
832 1486
833L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1487L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
834 1488
835=item $queue->enqueue_barrier 1489=item $ev = $queue->marker ($wait_events...)
836 1490
1491L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1492
1493=item $ev = $queue->barrier ($wait_events...)
1494
837L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1495L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
838 1496
839=item $queue->flush 1497=item $queue->flush
840 1498
841L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1499L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
842 1500
… …
850 1508
851L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html> 1509L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
852 1510
853=for gengetinfo begin command_queue 1511=for gengetinfo begin command_queue
854 1512
855
856=item $ctx = $command_queue->context 1513=item $ctx = $command_queue->context
857 1514
858Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s). 1515Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
859 1516
860=item $device = $command_queue->device 1517=item $device = $command_queue->device
861 1518
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s). 1519Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
863 1520
864=item $uint = $command_queue->reference_count 1521=item $uint = $command_queue->reference_count
865 1522
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s). 1523Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
867 1524
868=item $command_queue_properties = $command_queue->properties 1525=item $command_queue_properties = $command_queue->properties
869 1526
870Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s). 1527Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
871 1528
872=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.
873 1599
874=back 1600=back
875 1601
876=head2 THE OpenCL::Memory CLASS 1602=head2 THE OpenCL::Memory CLASS
877 1603
… …
886 1612
887L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1613L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
888 1614
889=for gengetinfo begin mem 1615=for gengetinfo begin mem
890 1616
891
892=item $mem_object_type = $mem->type 1617=item $mem_object_type = $mem->type
893 1618
894Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s). 1619Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
895 1620
896=item $mem_flags = $mem->flags 1621=item $mem_flags = $mem->flags
897 1622
898Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s). 1623Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
899 1624
900=item $int = $mem->size 1625=item $int = $mem->size
901 1626
902Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s). 1627Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
903 1628
904=item $ptr_value = $mem->host_ptr 1629=item $ptr_value = $mem->host_ptr
905 1630
906Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s). 1631Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
907 1632
908=item $uint = $mem->map_count 1633=item $uint = $mem->map_count
909 1634
910Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s). 1635Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
911 1636
912=item $uint = $mem->reference_count 1637=item $uint = $mem->reference_count
913 1638
914Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s). 1639Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
915 1640
916=item $ctx = $mem->context 1641=item $ctx = $mem->context
917 1642
918Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s). 1643Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
919 1644
920=item $mem = $mem->associated_memobject 1645=item $mem = $mem->associated_memobject
921 1646
922Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s). 1647Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
923 1648
924=item $int = $mem->offset 1649=item $int = $mem->offset
925 1650
926Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s). 1651Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
927 1652
928=for gengetinfo end mem 1653=for gengetinfo end mem
929 1654
1655=item ($type, $name) = $mem->gl_object_info
1656
1657Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1658object "name" (e.g. the texture name) used to create this memory object.
1659
1660L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1661
930=back 1662=back
931 1663
1664=head2 THE OpenCL::Buffer CLASS
1665
1666This is a subclass of OpenCL::Memory, and the superclass of
1667OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1668and sub-buffers.
1669
1670=head2 THE OpenCL::BufferObj CLASS
1671
1672This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1673because one cna create sub buffers of OpenLC::BufferObj objects, but not
1674sub buffers from these sub buffers.
1675
1676=over 4
1677
1678=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1679
1680Creates an OpenCL::Buffer objects from this buffer and returns it. The
1681C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1682
1683L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1684
1685=back
1686
932=head2 THE OpenCL::Image CLASS 1687=head2 THE OpenCL::Image CLASS
933 1688
934This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1689This is the superclass of all image objects - OpenCL::Image1D,
1690OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1691OpenCL::Image2DArray and OpenCL::Image3D.
935 1692
936=over 4 1693=over 4
937 1694
938=item $packed_value = $ev->image_info ($name) 1695=item $packed_value = $image->image_info ($name)
939 1696
940See C<< $platform->info >> for details. 1697See C<< $platform->info >> for details.
941 1698
942The reason this method is not called C<info> is that there already is an 1699The reason this method is not called C<info> is that there already is an
943C<< ->info >> method inherited from C<OpenCL::Memory>. 1700C<< ->info >> method inherited from C<OpenCL::Memory>.
944 1701
945L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1702L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
946 1703
1704=item ($channel_order, $channel_data_type) = $image->format
1705
1706Returns the channel order and type used to create the image by calling
1707C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
1708
947=for gengetinfo begin image 1709=for gengetinfo begin image
948 1710
949
950=item $int = $image->element_size 1711=item $int = $image->element_size
951 1712
952Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s). 1713Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
953 1714
954=item $int = $image->row_pitch 1715=item $int = $image->row_pitch
955 1716
956Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s). 1717Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
957 1718
958=item $int = $image->slice_pitch 1719=item $int = $image->slice_pitch
959 1720
960Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s). 1721Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
961 1722
962=item $int = $image->width 1723=item $int = $image->width
963 1724
964Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s). 1725Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
965 1726
966=item $int = $image->height 1727=item $int = $image->height
967 1728
968Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s). 1729Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
969 1730
970=item $int = $image->depth 1731=item $int = $image->depth
971 1732
972Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s). 1733Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
973 1734
974=for gengetinfo end image 1735=for gengetinfo end image
975 1736
1737=for gengetinfo begin gl_texture
1738
1739=item $GLenum = $gl_texture->target
1740
1741Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1742
1743=item $GLint = $gl_texture->gl_mipmap_level
1744
1745Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1746
1747=for gengetinfo end gl_texture
1748
976=back 1749=back
977 1750
978=head2 THE OpenCL::Sampler CLASS 1751=head2 THE OpenCL::Sampler CLASS
979 1752
980=over 4 1753=over 4
… …
985 1758
986L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1759L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
987 1760
988=for gengetinfo begin sampler 1761=for gengetinfo begin sampler
989 1762
990
991=item $uint = $sampler->reference_count 1763=item $uint = $sampler->reference_count
992 1764
993Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s). 1765Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
994 1766
995=item $ctx = $sampler->context 1767=item $ctx = $sampler->context
996 1768
997Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s). 1769Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
998 1770
999=item $addressing_mode = $sampler->normalized_coords 1771=item $addressing_mode = $sampler->normalized_coords
1000 1772
1001Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s). 1773Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1002 1774
1003=item $filter_mode = $sampler->addressing_mode 1775=item $filter_mode = $sampler->addressing_mode
1004 1776
1005Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s). 1777Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1006 1778
1007=item $boolean = $sampler->filter_mode 1779=item $boolean = $sampler->filter_mode
1008 1780
1009Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s). 1781Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1010 1782
1011=for gengetinfo end sampler 1783=for gengetinfo end sampler
1012 1784
1013=back 1785=back
1014 1786
1015=head2 THE OpenCL::Program CLASS 1787=head2 THE OpenCL::Program CLASS
1016 1788
1017=over 4 1789=over 4
1018 1790
1019=item $program->build ($device, $options = "") 1791=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1020 1792
1021Tries to build the program with the givne options. 1793Tries to build the program with the given options. See also the
1794C<$ctx->build> convenience function.
1795
1796If a callback is specified, then it will be called when compilation is
1797finished. Note that many OpenCL implementations block your program while
1798compiling whether you use a callback or not. See C<build_async> if you
1799want to make sure the build is done in the background.
1800
1801Note that some OpenCL implementations act up badly, and don't call the
1802callback in some error cases (but call it in others). This implementation
1803assumes the callback will always be called, and leaks memory if this is
1804not so. So best make sure you don't pass in invalid values.
1805
1806Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1807compilation state is successful but some later stage fails.
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.
1022 1819
1023L<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>
1821
1822=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1823
1824Similar to C<< ->build >>, except it starts a thread, and never fails (you
1825need to check the compilation status form the callback, or by polling).
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>
1024 1834
1025=item $packed_value = $program->build_info ($device, $name) 1835=item $packed_value = $program->build_info ($device, $name)
1026 1836
1027Similar to C<< $platform->info >>, but returns build info for a previous 1837Similar to C<< $platform->info >>, but returns build info for a previous
1028build attempt for the given device. 1838build attempt for the given device.
… …
1034Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1844Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1035the program. 1845the program.
1036 1846
1037L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1847L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1038 1848
1849=item @kernels = $program->kernels_in_program
1850
1851Returns all kernels successfully compiled for all devices in program.
1852
1853http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1854
1039=for gengetinfo begin program_build 1855=for gengetinfo begin program_build
1040 1856
1041
1042=item $build_status = $program->build_status ($device) 1857=item $build_status = $program->build_status ($device)
1043 1858
1044Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s). 1859Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1045 1860
1046=item $string = $program->build_options ($device) 1861=item $string = $program->build_options ($device)
1047 1862
1048Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s). 1863Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1049 1864
1050=item $string = $program->build_log ($device) 1865=item $string = $program->build_log ($device)
1051 1866
1052Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s). 1867Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1053 1868
1054=for gengetinfo end program_build 1869=for gengetinfo end program_build
1055 1870
1056=item $packed_value = $program->info ($name) 1871=item $packed_value = $program->info ($name)
1057 1872
… …
1059 1874
1060L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> 1875L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1061 1876
1062=for gengetinfo begin program 1877=for gengetinfo begin program
1063 1878
1064
1065=item $uint = $program->reference_count 1879=item $uint = $program->reference_count
1066 1880
1067Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s). 1881Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1068 1882
1069=item $ctx = $program->context 1883=item $ctx = $program->context
1070 1884
1071Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s). 1885Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1072 1886
1073=item $uint = $program->num_devices 1887=item $uint = $program->num_devices
1074 1888
1075Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s). 1889Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1076 1890
1077=item @devices = $program->devices 1891=item @devices = $program->devices
1078 1892
1079Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s). 1893Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1080 1894
1081=item $string = $program->source 1895=item $string = $program->source
1082 1896
1083Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s). 1897Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1084 1898
1085=item @ints = $program->binary_sizes 1899=item @ints = $program->binary_sizes
1086 1900
1087Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s). 1901Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1088 1902
1089=for gengetinfo end program 1903=for gengetinfo end program
1090 1904
1905=item @blobs = $program->binaries
1906
1907Returns a string for the compiled binary for every device associated with
1908the program, empty strings indicate missing programs, and an empty result
1909means no program binaries are available.
1910
1911These "binaries" are often, in fact, informative low-level assembly
1912sources.
1913
1914L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1915
1091=back 1916=back
1092 1917
1093=head2 THE OpenCL::Kernel CLASS 1918=head2 THE OpenCL::Kernel CLASS
1094 1919
1095=over 4 1920=over 4
… …
1100 1925
1101L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1926L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1102 1927
1103=for gengetinfo begin kernel 1928=for gengetinfo begin kernel
1104 1929
1105
1106=item $string = $kernel->function_name 1930=item $string = $kernel->function_name
1107 1931
1108Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s). 1932Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1109 1933
1110=item $uint = $kernel->num_args 1934=item $uint = $kernel->num_args
1111 1935
1112Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s). 1936Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1113 1937
1114=item $uint = $kernel->reference_count 1938=item $uint = $kernel->reference_count
1115 1939
1116Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s). 1940Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1117 1941
1118=item $ctx = $kernel->context 1942=item $ctx = $kernel->context
1119 1943
1120Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s). 1944Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1121 1945
1122=item $program = $kernel->program 1946=item $program = $kernel->program
1123 1947
1124Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s). 1948Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1125 1949
1126=for gengetinfo end kernel 1950=for gengetinfo end kernel
1127 1951
1128=item $packed_value = $kernel->work_group_info ($device, $name) 1952=item $packed_value = $kernel->work_group_info ($device, $name)
1953
1954See C<< $platform->info >> for details.
1955
1956L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1957
1958=for gengetinfo begin kernel_work_group
1959
1960=item $int = $kernel->work_group_size ($device)
1961
1962Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1963
1964=item @ints = $kernel->compile_work_group_size ($device)
1965
1966Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1967
1968=item $ulong = $kernel->local_mem_size ($device)
1969
1970Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1971
1972=item $int = $kernel->preferred_work_group_size_multiple ($device)
1973
1974Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1975
1976=item $ulong = $kernel->private_mem_size ($device)
1977
1978Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1979
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
2011
2012=item $kernel->setf ($format, ...)
2013
2014Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
2015way to set arguments (and with OpenCL 1.2 it might be rather slow), you
2016need to specify a format argument, much as with C<printf>, to tell OpenCL
2017what type of argument it is.
2018
2019The format arguments are single letters:
2020
2021 c char
2022 C unsigned char
2023 s short
2024 S unsigned short
2025 i int
2026 I unsigned int
2027 l long
2028 L unsigned long
2029
2030 h half float (0..65535)
2031 f float
2032 d double
2033
2034 z local (octet size)
2035
2036 m memory object (buffer or image)
2037 a sampler
2038 e event
2039
2040Space characters in the format string are ignored.
2041
2042Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
2043
2044 $kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
2045
2046=item $kernel->set_TYPE ($index, $value)
2047
2048=item $kernel->set_char ($index, $value)
2049
2050=item $kernel->set_uchar ($index, $value)
2051
2052=item $kernel->set_short ($index, $value)
2053
2054=item $kernel->set_ushort ($index, $value)
2055
2056=item $kernel->set_int ($index, $value)
2057
2058=item $kernel->set_uint ($index, $value)
2059
2060=item $kernel->set_long ($index, $value)
2061
2062=item $kernel->set_ulong ($index, $value)
2063
2064=item $kernel->set_half ($index, $value)
2065
2066=item $kernel->set_float ($index, $value)
2067
2068=item $kernel->set_double ($index, $value)
2069
2070=item $kernel->set_memory ($index, $value)
2071
2072=item $kernel->set_buffer ($index, $value)
2073
2074=item $kernel->set_image ($index, $value)
2075
2076=item $kernel->set_sampler ($index, $value)
2077
2078=item $kernel->set_local ($index, $value)
2079
2080=item $kernel->set_event ($index, $value)
2081
2082This is a family of methods to set the kernel argument with the number
2083C<$index> to the give C<$value>.
2084
2085Chars and integers (including the half type) are specified as integers,
2086float and double as floating point values, memory/buffer/image must be
2087an object of that type or C<undef>, local-memory arguments are set by
2088specifying the size, and sampler and event must be objects of that type.
2089
2090Note that C<set_memory> works for all memory objects (all types of buffers
2091and images) - the main purpose of the more specific C<set_TYPE> functions
2092is type checking.
2093
2094Setting an argument for a kernel does NOT keep a reference to the object -
2095for example, if you set an argument to some image object, free the image,
2096and call the kernel, you will run into undefined behaviour.
2097
2098L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
2099
2100=back
2101
2102=head2 THE OpenCL::Event CLASS
2103
2104This is the superclass for all event objects (including OpenCL::UserEvent
2105objects).
2106
2107=over 4
2108
2109=item $ev->wait
2110
2111Waits for the event to complete.
2112
2113L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
2114
2115=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
2116
2117Adds a callback to the callback stack for the given event type. There is
2118no way to remove a callback again.
2119
2120L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
2121
2122=item $packed_value = $ev->info ($name)
2123
2124See C<< $platform->info >> for details.
2125
2126L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
2127
2128=for gengetinfo begin event
2129
2130=item $queue = $event->command_queue
2131
2132Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
2133
2134=item $command_type = $event->command_type
2135
2136Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
2137
2138=item $uint = $event->reference_count
2139
2140Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
2141
2142=item $uint = $event->command_execution_status
2143
2144Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
2145
2146=item $ctx = $event->context
2147
2148Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
2149
2150=for gengetinfo end event
2151
2152=item $packed_value = $ev->profiling_info ($name)
1129 2153
1130See C<< $platform->info >> for details. 2154See C<< $platform->info >> for details.
1131 2155
1132The reason this method is not called C<info> is that there already is an 2156The reason this method is not called C<info> is that there already is an
1133C<< ->info >> method. 2157C<< ->info >> method.
1134 2158
1135L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1136
1137=for gengetinfo begin kernel_work_group
1138
1139
1140=item $int = $kernel->work_group_size ($device)
1141
1142Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s).
1143
1144=item @ints = $kernel->compile_work_group_size ($device)
1145
1146Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s).
1147
1148=item $ulong = $kernel->local_mem_size ($device)
1149
1150Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s).
1151
1152=item $int = $kernel->preferred_work_group_size_multiple ($device)
1153
1154Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s).
1155
1156=item $ulong = $kernel->private_mem_size ($device)
1157
1158Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s).
1159
1160=for gengetinfo end kernel_work_group
1161
1162=item $kernel->set_TYPE ($index, $value)
1163
1164This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1165
1166TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1167C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1168C<image2d>, C<image3d>, C<sampler> or C<event>.
1169
1170Chars and integers (including the half type) are specified as integers,
1171float and double as floating point values, memory/buffer/image2d/image3d
1172must be an object of that type or C<undef>, and sampler and event must be
1173objects of that type.
1174
1175L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 2159L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
2160
2161=for gengetinfo begin profiling
2162
2163=item $ulong = $event->profiling_command_queued
2164
2165Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
2166
2167=item $ulong = $event->profiling_command_submit
2168
2169Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
2170
2171=item $ulong = $event->profiling_command_start
2172
2173Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
2174
2175=item $ulong = $event->profiling_command_end
2176
2177Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
2178
2179=for gengetinfo end profiling
1176 2180
1177=back 2181=back
1178 2182
1179=head2 THE OpenCL::Event CLASS 2183=head2 THE OpenCL::UserEvent CLASS
1180 2184
1181This is the superclass for all event objects (including OpenCL::UserEvent 2185This is a subclass of OpenCL::Event.
1182objects).
1183 2186
1184=over 4 2187=over 4
1185 2188
1186=item $ev->wait 2189=item $ev->set_status ($execution_status)
1187 2190
1188Waits for the event to complete. 2191Sets the execution status of the user event. Can only be called once,
2192either with OpenCL::COMPLETE or a negative number as status.
1189 2193
2194execution_status: OpenCL::COMPLETE or a negative integer.
2195
1190L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 2196L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1191
1192=item $packed_value = $ev->info ($name)
1193
1194See C<< $platform->info >> for details.
1195
1196L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1197
1198=for gengetinfo begin event
1199
1200
1201=item $queue = $event->command_queue
1202
1203Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s).
1204
1205=item $command_type = $event->command_type
1206
1207Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s).
1208
1209=item $uint = $event->reference_count
1210
1211Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s).
1212
1213=item $uint = $event->command_execution_status
1214
1215Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s).
1216
1217=item $ctx = $event->context
1218
1219Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s).
1220
1221=for gengetinfo end event
1222
1223=item $packed_value = $ev->profiling_info ($name)
1224
1225See C<< $platform->info >> for details.
1226
1227The reason this method is not called C<info> is that there already is an
1228C<< ->info >> method.
1229
1230L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1231
1232=for gengetinfo begin profiling
1233
1234
1235=item $ulong = $event->profiling_command_queued
1236
1237Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s).
1238
1239=item $ulong = $event->profiling_command_submit
1240
1241Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s).
1242
1243=item $ulong = $event->profiling_command_start
1244
1245Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s).
1246
1247=item $ulong = $event->profiling_command_end
1248
1249Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s).
1250
1251=for gengetinfo end profiling
1252 2197
1253=back 2198=back
1254 2199
1255=head2 THE OpenCL::UserEvent CLASS 2200=head2 THE OpenCL::Mapped CLASS
1256 2201
1257This is a subclass of OpenCL::Event. 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;
1258 2228
1259=over 4 2229=over 4
1260 2230
1261=item $ev->set_status ($execution_status) 2231=item $ev = $mapped->unmap ($wait_events...)
1262 2232
1263L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 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}
1264 2279
1265=back 2280=back
1266 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
2300
1267=cut 2301=cut
1268
1269package OpenCL;
1270
1271use common::sense;
1272
1273BEGIN {
1274 our $VERSION = '0.55';
1275
1276 require XSLoader;
1277 XSLoader::load (__PACKAGE__, $VERSION);
1278
1279 @OpenCL::Buffer::ISA =
1280 @OpenCL::Image::ISA = OpenCL::Memory::;
1281
1282 @OpenCL::Image2D::ISA =
1283 @OpenCL::Image3D::ISA = OpenCL::Image::;
1284
1285 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1286}
1287 2302
12881; 23031;
1289 2304
1290=head1 AUTHOR 2305=head1 AUTHOR
1291 2306

Diff Legend

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