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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.7 by root, Wed Nov 16 00:44:41 2011 UTC vs.
Revision 1.59 by root, Wed Apr 25 20:49:13 2012 UTC

8 8
9=head1 DESCRIPTION 9=head1 DESCRIPTION
10 10
11This is an early release which might be useful, but hasn't seen much testing. 11This is an early release which might be useful, but hasn't seen much testing.
12 12
13=head2 OpenCL FROM 10000 FEET HEIGHT
14
15Here is a high level overview of OpenCL:
16
17First you need to find one or more OpenCL::Platforms (kind of like
18vendors) - usually there is only one.
19
20Each platform gives you access to a number of OpenCL::Device objects, e.g.
21your graphics card.
22
23From a platform and some device(s), you create an OpenCL::Context, which is
24a very central object in OpenCL: Once you have a context you can create
25most other objects:
26
27OpenCL::Program objects, which store source code and, after building for a
28specific device ("compiling and linking"), also binary programs. For each
29kernel function in a program you can then create an OpenCL::Kernel object
30which represents basically a function call with argument values.
31
32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34or 3d array) for bulk data and input and output for kernels.
35
36OpenCL::Sampler objects, which are kind of like texture filter modes in
37OpenGL.
38
39OpenCL::Queue objects - command queues, which allow you to submit memory
40reads, writes and copies, as well as kernel calls to your devices. They
41also offer a variety of methods to synchronise request execution, for
42example with barriers or OpenCL::Event objects.
43
44OpenCL::Event objects are used to signal when something is complete.
45
13=head1 HELPFUL RESOURCES 46=head2 HELPFUL RESOURCES
14 47
15The OpenCL spec used to develop this module (1.2 spec was available, but 48The OpenCL specs used to develop this module:
16no implementation was available to me :).
17 49
18 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 50 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51 http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52 http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
19 53
20OpenCL manpages: 54OpenCL manpages:
21 55
22 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ 56 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
57 http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
58
59If you are into UML class diagrams, the following diagram might help - if
60not, it will be mildly confusing (also, the class hierarchy of this module
61is much more fine-grained):
62
63 http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/classDiagram.html
64
65Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
66is, but at least it's free of charge:
67
68 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
69
70And here's NVIDIA's OpenCL Best Practises Guide:
71
72 http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
73
74=head1 BASIC WORKFLOW
75
76To get something done, you basically have to do this once (refer to the
77examples below for actual code, this is just a high-level description):
78
79Find some platform (e.g. the first one) and some device(s) (e.g. the first
80device of the platform), and create a context from those.
81
82Create program objects from your OpenCL source code, then build (compile)
83the programs for each device you want to run them on.
84
85Create kernel objects for all kernels you want to use (surprisingly, these
86are not device-specific).
87
88Then, to execute stuff, you repeat these steps, possibly resuing or
89sharing some buffers:
90
91Create some input and output buffers from your context. Set these as
92arguments to your kernel.
93
94Enqueue buffer writes to initialise your input buffers (when not
95initialised at creation time).
96
97Enqueue the kernel execution.
98
99Enqueue buffer reads for your output buffer to read results.
23 100
24=head1 EXAMPLES 101=head1 EXAMPLES
25 102
26=head2 Enumerate all devices and get contexts for them. 103=head2 Enumerate all devices and get contexts for them.
27 104
105Best run this once to get a feel for the platforms and devices in your
106system.
107
28 for my $platform (OpenCL::platforms) { 108 for my $platform (OpenCL::platforms) {
29 warn $platform->info (OpenCL::PLATFORM_NAME); 109 printf "platform: %s\n", $platform->name;
30 warn $platform->info (OpenCL::PLATFORM_EXTENSIONS); 110 printf "extensions: %s\n", $platform->extensions;
31 for my $device ($platform->devices) { 111 for my $device ($platform->devices) {
32 warn $device->info (OpenCL::DEVICE_NAME); 112 printf "+ device: %s\n", $device->name;
33 my $ctx = $device->context_simple; 113 my $ctx = $platform->context (undef, [$device]);
34 # do stuff 114 # do stuff
35 } 115 }
36 } 116 }
37 117
38=head2 Get a useful context and a command queue. 118=head2 Get a useful context and a command queue.
39 119
40 my $dev = ((OpenCL::platforms)[0]->devices)[0]; 120This is a useful boilerplate for any OpenCL program that only wants to use
41 my $ctx = $dev->context_simple; 121one device,
42 my $queue = $ctx->command_queue_simple ($dev); 122
123 my ($platform) = OpenCL::platforms; # find first platform
124 my ($dev) = $platform->devices; # find first device of platform
125 my $ctx = $platform->context (undef, [$dev]); # create context out of those
126 my $queue = $ctx->queue ($dev); # create a command queue for the device
43 127
44=head2 Print all supported image formats of a context. 128=head2 Print all supported image formats of a context.
45 129
130Best run this once for your context, to see whats available and how to
131gather information.
132
46 for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) { 133 for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
47 say "supported image formats for ", OpenCL::enum2str $type; 134 print "supported image formats for ", OpenCL::enum2str $type, "\n";
48 135
49 for my $f ($ctx->supported_image_formats (0, $type)) { 136 for my $f ($ctx->supported_image_formats (0, $type)) {
50 printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1]; 137 printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];
51 } 138 }
52 } 139 }
54=head2 Create a buffer with some predefined data, read it back synchronously, 141=head2 Create a buffer with some predefined data, read it back synchronously,
55then asynchronously. 142then asynchronously.
56 143
57 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut"); 144 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
58 145
59 $queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data); 146 $queue->read_buffer ($buf, 1, 1, 3, my $data);
60 warn $data; 147 print "$data\n";
61 148
62 my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data); 149 my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
63 $ev->wait; 150 $ev->wait;
64 warn $data; 151 print "$data\n"; # prints "elm"
65 152
66=head2 Create and build a program, then create a kernel out of one of its 153=head2 Create and build a program, then create a kernel out of one of its
67functions. 154functions.
68 155
69 my $src = ' 156 my $src = '
70 __kernel void 157 kernel void
71 squareit (__global float *input, __global float *output) 158 squareit (global float *input, global float *output)
72 { 159 {
73 size_t id = get_global_id (0); 160 $id = get_global_id (0);
74 output [id] = input [id] * input [id]; 161 output [id] = input [id] * input [id];
75 } 162 }
76 '; 163 ';
77 164
78 my $prog = $ctx->program_with_source ($src); 165 my $prog = $ctx->build_program ($src);
79
80 eval { $prog->build ($dev); 1 }
81 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
82
83 my $kernel = $prog->kernel ("squareit"); 166 my $kernel = $prog->kernel ("squareit");
84 167
85=head2 Create some input and output float buffers, then call squareit on them. 168=head2 Create some input and output float buffers, then call the
169'squareit' kernel on them.
86 170
87 my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5); 171 my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);
88 my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5); 172 my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
89 173
90 # set buffer 174 # set buffer
91 $kernel->set_buffer (0, $input); 175 $kernel->set_buffer (0, $input);
92 $kernel->set_buffer (1, $output); 176 $kernel->set_buffer (1, $output);
93 177
94 # execute it for all 4 numbers 178 # execute it for all 4 numbers
95 $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 179 $queue->nd_range_kernel ($kernel, undef, [4], undef);
96 180
97 # enqueue a synchronous read 181 # enqueue a synchronous read
98 $queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 182 $queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
99 183
100 # print the results: 184 # print the results:
101 say join ", ", unpack "f*", $data; 185 printf "%s\n", join ", ", unpack "f*", $data;
102 186
103=head2 The same enqueue operations as before, but assuming an out-of-order queue, 187=head2 The same enqueue operations as before, but assuming an out-of-order queue,
104showing off barriers. 188showing off barriers.
105 189
106 # execute it for all 4 numbers 190 # execute it for all 4 numbers
107 $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 191 $queue->nd_range_kernel ($kernel, undef, [4], undef);
108 192
109 # enqueue a barrier to ensure in-order execution 193 # enqueue a barrier to ensure in-order execution
110 $queue->enqueue_barrier; 194 $queue->barrier;
111 195
112 # enqueue an async read 196 # enqueue an async read
113 $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 197 $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
114 198
115 # wait for all requests to finish 199 # wait for all requests to finish
116 $queue->finish; 200 $queue->finish;
117 201
118=head2 The same enqueue operations as before, but assuming an out-of-order queue, 202=head2 The same enqueue operations as before, but assuming an out-of-order queue,
119showing off event objects and wait lists. 203showing off event objects and wait lists.
120 204
121 # execute it for all 4 numbers 205 # execute it for all 4 numbers
122 my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); 206 my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
123 207
124 # enqueue an async read 208 # enqueue an async read
125 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 209 $ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
126 210
127 # wait for the last event to complete 211 # wait for the last event to complete
128 $ev->wait; 212 $ev->wait;
129 213
214=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215set tunnel effect.
216
217This is quite a long example to get you going.
218
219 use OpenGL ":all";
220 use OpenCL;
221
222 # open a window and create a gl texture
223 OpenGL::glpOpenWindow width => 256, height => 256;
224 my $texid = glGenTextures_p 1;
225 glBindTexture GL_TEXTURE_2D, $texid;
226 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
227
228 # find and use the first opencl device that let's us get a shared opengl context
229 my $platform;
230 my $dev;
231 my $ctx;
232
233 for (OpenCL::platforms) {
234 $platform = $_;
235 for ($platform->devices) {
236 $dev = $_;
237 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
238 and last;
239 }
240 }
241
242 $ctx
243 or die "cannot find suitable OpenCL device\n";
244
245 my $queue = $ctx->queue ($dev);
246
247 # now attach an opencl image2d object to the opengl texture
248 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
249
250 # now the boring opencl code
251 my $src = <<EOF;
252 kernel void
253 juliatunnel (write_only image2d_t img, float time)
254 {
255 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
256
257 float2 m = (float2)(1.f, p.y) / fabs (p.x);
258 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
259
260 float2 z = m;
261 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
262
263 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
264 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
265
266 float3 colour = (float3)(z.x, z.y, z.x * z.y);
267 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
268 }
269 EOF
270
271 my $prog = $ctx->build_program ($src);
272 my $kernel = $prog->kernel ("juliatunnel");
273
274 # program compiled, kernel ready, now draw and loop
275
276 for (my $time; ; ++$time) {
277 # acquire objects from opengl
278 $queue->acquire_gl_objects ([$tex]);
279
280 # configure and run our kernel
281 $kernel->set_image2d (0, $tex);
282 $kernel->set_float (1, $time);
283 $queue->nd_range_kernel ($kernel, undef, [256, 256], undef);
284
285 # release objects to opengl again
286 $queue->release_gl_objects ([$tex]);
287
288 # wait
289 $queue->finish;
290
291 # now draw the texture, the defaults should be all right
292 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
293
294 glEnable GL_TEXTURE_2D;
295 glBegin GL_QUADS;
296 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
297 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
298 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
299 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
300 glEnd;
301
302 glXSwapBuffers;
303
304 select undef, undef, undef, 1/60;
305 }
306
130=head1 DOCUMENTATION 307=head1 DOCUMENTATION
131 308
132=head2 BASIC CONVENTIONS 309=head2 BASIC CONVENTIONS
133 310
134This is not a 1:1 C-style translation of OpenCL to Perl - instead I 311This is not a one-to-one C-style translation of OpenCL to Perl - instead
135attempted to make the interface as type-safe as possible and introducing 312I attempted to make the interface as type-safe as possible by introducing
136object syntax where it makes sense. There are a number of important 313object syntax where it makes sense. There are a number of important
137differences between the OpenCL C API and this module: 314differences between the OpenCL C API and this module:
138 315
139=over 4 316=over 4
140 317
141=item * Object lifetime managament is automatic - there is no need 318=item * Object lifetime managament is automatic - there is no need
142to free objects explicitly (C<clReleaseXXX>), the release function 319to free objects explicitly (C<clReleaseXXX>), the release function
143is called automatically once all Perl references to it go away. 320is called automatically once all Perl references to it go away.
144 321
145=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), 322=item * OpenCL uses CamelCase for function names
323(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
146while this module uses underscores as word separator and often leaves out 324uses underscores as word separator and often leaves out prefixes
147prefixes (C<< $platform->info >>). 325(C<OpenCL::platforms>, C<< $platform->info >>).
148 326
149=item * OpenCL often specifies fixed vector function arguments as short 327=item * OpenCL often specifies fixed vector function arguments as short
150arrays (C<size_t origin[3]>), while this module explicitly expects the 328arrays (C<size_t origin[3]>), while this module explicitly expects the
151components as separate arguments- 329components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
330function calls.
152 331
153=item * Where possible, the row_pitch value is calculated from the perl 332=item * Structures are often specified by flattening out their components
154scalar length and need not be specified. 333as with short vectors, and returned as arrayrefs.
155 334
156=item * When enqueuing commands, the wait list is specified by adding 335=item * When enqueuing commands, the wait list is specified by adding
157extra arguments to the function - everywhere a C<$wait_events...> argument 336extra arguments to the function - anywhere a C<$wait_events...> argument
158is documented this can be any number of event objects. 337is documented this can be any number of event objects. As an extsnion
338implemented by this module, C<undef> values will be ignored in the event
339list.
159 340
160=item * When enqueuing commands, if the enqueue method is called in void 341=item * When enqueuing commands, if the enqueue method is called in void
161context, no event is created. In all other contexts an event is returned 342context, no event is created. In all other contexts an event is returned
162by the method. 343by the method.
163 344
167 348
168=back 349=back
169 350
170=head2 PERL AND OPENCL TYPES 351=head2 PERL AND OPENCL TYPES
171 352
172This handy(?) table lists OpenCL types and their perl and pack/unpack 353This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
173format equivalents: 354format equivalents:
174 355
175 OpenCL perl pack/unpack 356 OpenCL perl PDL pack/unpack
176 char IV c 357 char IV - c
177 uchar IV C 358 uchar IV byte C
178 short IV s 359 short IV short s
179 ushort IV S 360 ushort IV ushort S
180 int IV l 361 int IV long? l
181 uint IV L 362 uint IV - L
182 long IV q 363 long IV longlong q
183 ulong IV Q 364 ulong IV - Q
184 float NV f 365 float NV float f
185 half IV S 366 half IV ushort S
186 double NV d 367 double NV double d
368
369=head2 GLX SUPPORT
370
371Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
372module, which has little to no documentation and has little to no support
373for glX), this module, as a special extension, treats context creation
374properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
375specially: If either or both of these are C<undef>, then the OpenCL
376module tries to dynamically resolve C<glXGetCurrentDisplay> and
377C<glXGetCurrentContext>, call these functions and use their return values
378instead.
379
380For this to work, the OpenGL library must be loaded, a GLX context must
381have been created and be made current, and C<dlsym> must be available and
382capable of finding the function via C<RTLD_DEFAULT>.
383
384=head2 EVENT SYSTEM
385
386OpenCL can generate a number of (potentially) asynchronous events, for
387example, after compiling a program, to signal a context-related error or,
388perhaps most important, to signal completion of queued jobs (by setting
389callbacks on OpenCL::Event objects).
390
391To facilitate this, this module maintains an event queue - each
392time an asynchronous event happens, it is queued, and perl will be
393interrupted. This is implemented via the L<Async::Interrupt> module. In
394addition, this module has L<AnyEvent> support, so it can seamlessly
395integrate itself into many event loops.
396
397Since this module is a bit hard to understand, here are some case examples:
398
399=head3 Don't use callbacks.
400
401When your program never uses any callbacks, then there will never be any
402notifications you need to take care of, and therefore no need to worry
403about all this.
404
405You can achieve a great deal by explicitly waiting for events, or using
406barriers and flush calls. In many programs, there is no need at all to
407tinker with asynchronous events.
408
409=head3 Use AnyEvent
410
411This module automatically registers a watcher that invokes all outstanding
412event callbacks when AnyEvent is initialised (and block asynchronous
413interruptions). Using this mode of operations is the safest and most
414recommended one.
415
416To use this, simply use AnyEvent and this module normally, make sure you
417have an event loop running:
418
419 use Gtk2 -init;
420 use AnyEvent;
421
422 # initialise AnyEvent, by creating a watcher, or:
423 AnyEvent::detect;
424
425 my $e = $queue->marker;
426 $e->cb (sub {
427 warn "opencl is finished\n";
428 })
429
430 main Gtk2;
431
432Note that this module will not initialise AnyEvent for you. Before
433AnyEvent is initialised, the module will asynchronously interrupt perl
434instead. To avoid any surprises, it's best to explicitly initialise
435AnyEvent.
436
437You can temporarily enable asynchronous interruptions (see next paragraph)
438by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
439calling C<$OpenCL::INTERRUPT->block>.
440
441=head3 Let yourself be interrupted at any time
442
443This mode is the default unless AnyEvent is loaded and initialised. In
444this mode, OpenCL asynchronously interrupts a running perl program. The
445emphasis is on both I<asynchronously> and I<running> here.
446
447Asynchronously means that perl might execute your callbacks at any
448time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
449the C<until> loop following the marker call will be interrupted by the
450callback:
451
452 my $e = $queue->marker;
453 my $flag;
454 $e->cb (sub { $flag = 1 });
455 1 until $flag;
456 # $flag is now 1
457
458The reason why you shouldn't blindly copy the above code is that
459busy waiting is a really really bad thing, and really really bad for
460performance.
461
462While at first this asynchronous business might look exciting, it can be
463really hard, because you need to be prepared for the callback code to be
464executed at any time, which limits the amount of things the callback code
465can do safely.
466
467This can be mitigated somewhat by using C<<
468$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
469documentation for details).
470
471The other problem is that your program must be actively I<running> to be
472interrupted. When you calculate stuff, your program is running. When you
473hang in some C functions or other block execution (by calling C<sleep>,
474C<select>, running an event loop and so on), your program is waiting, not
475running.
476
477One way around that would be to attach a read watcher to your event loop,
478listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
479dummy callback (C<sub { }>) to temporarily execute some perl code.
480
481That is then awfully close to using the built-in AnyEvent support above,
482though, so consider that one instead.
483
484=head3 Be creative
485
486OpenCL exports the L<Async::Interrupt> object it uses in the global
487variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
488
489So if you want to feel like a real pro, err, wait, if you feel no risk
490menas no fun, you can experiment by implementing your own mode of
491operations.
492
493=cut
494
495package OpenCL;
496
497use common::sense;
498use Async::Interrupt ();
499
500our $POLL_FUNC; # set by XS
501
502BEGIN {
503 our $VERSION = '0.97';
504
505 require XSLoader;
506 XSLoader::load (__PACKAGE__, $VERSION);
507
508 @OpenCL::Platform::ISA =
509 @OpenCL::Device::ISA =
510 @OpenCL::Context::ISA =
511 @OpenCL::Queue::ISA =
512 @OpenCL::Memory::ISA =
513 @OpenCL::Sampler::ISA =
514 @OpenCL::Program::ISA =
515 @OpenCL::Kernel::ISA =
516 @OpenCL::Event::ISA = OpenCL::Object::;
517
518 @OpenCL::Buffer::ISA =
519 @OpenCL::Image::ISA = OpenCL::Memory::;
520
521 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
522
523 @OpenCL::Image2D::ISA =
524 @OpenCL::Image3D::ISA =
525 @OpenCL::Image2DArray::ISA =
526 @OpenCL::Image1D::ISA =
527 @OpenCL::Image1DArray::ISA =
528 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
529
530 @OpenCL::UserEvent::ISA = OpenCL::Event::;
531}
187 532
188=head2 THE OpenCL PACKAGE 533=head2 THE OpenCL PACKAGE
189 534
190=over 4 535=over 4
191 536
192=item $int = OpenCL::errno 537=item $int = OpenCL::errno
193 538
194The last error returned by a function - it's only changed on errors. 539The last error returned by a function - it's only valid after an error occured
540and before calling another OpenCL function.
195 541
196=item $str = OpenCL::err2str $errval 542=item $str = OpenCL::err2str $errval
197 543
198Comverts an error value into a human readable string. 544Comverts an error value into a human readable string.
199 545
200=item $str = OpenCL::err2str $enum 546=item $str = OpenCL::enum2str $enum
201 547
202Converts most enum values (inof parameter names, image format constants, 548Converts most enum values (of parameter names, image format constants,
203object types, addressing and filter modes, command types etc.) into a 549object types, addressing and filter modes, command types etc.) into a
204human readbale string. When confronted with some random integer it can be 550human readable string. When confronted with some random integer it can be
205very helpful to pass it through this function to maybe get some readable 551very helpful to pass it through this function to maybe get some readable
206string out of it. 552string out of it.
207 553
208=item @platforms = OpenCL::platforms 554=item @platforms = OpenCL::platforms
209 555
210Returns all available OpenCL::Platform objects. 556Returns all available OpenCL::Platform objects.
211 557
212L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 558L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
213 559
214=item $ctx = OpenCL::context_from_type_simple $type = OpenCL::DEVICE_TYPE_DEFAULT 560=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
215 561
216Tries to create a context from a default device and platform - never worked for me. 562Tries to create a context from a default device and platform type - never worked for me.
217 563
218L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 564L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
219 565
566=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
567
568Create a new OpenCL::Context object using the given device object(s). This
569function isn't implemented yet, use C<< $platform->context >> instead.
570
571L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
572
220=item OpenCL::wait_for_events $wait_events... 573=item OpenCL::wait_for_events $wait_events...
221 574
222Waits for all events to complete. 575Waits for all events to complete.
223 576
224L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 577L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
225 578
579=item OpenCL::poll
580
581Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
582invokes their callbacks.
583
584=item $OpenCL::INTERRUPT
585
586The L<Async::Interrupt> object used to signal asynchronous events (see
587L<EVENT SYSTEM>).
588
589=cut
590
591our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
592
593&_eq_initialise ($INTERRUPT->signal_func);
594
595=item $OpenCL::WATCHER
596
597The L<AnyEvent> watcher object used to watch for asynchronous events (see
598L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
599loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
600
601=cut
602
603our $WATCHER;
604
605sub _init_anyevent {
606 $INTERRUPT->block;
607 $WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
608}
609
610if (defined $AnyEvent::MODEL) {
611 _init_anyevent;
612} else {
613 push @AnyEvent::post_detect, \&_init_anyevent;
614}
615
226=back 616=back
227 617
618=head2 THE OpenCL::Object CLASS
619
620This is the base class for all objects in the OpenCL module. The only
621method it implements is the C<id> method, which is only useful if you want
622to interface to OpenCL on the C level.
623
624=over 4
625
626=item $iv = $obj->id
627
628OpenCL objects are represented by pointers or integers on the C level. If
629you want to interface to an OpenCL object directly on the C level, then
630you need this value, which is returned by this method. You should use an
631C<IV> type in your code and cast that to the correct type.
632
633=cut
634
635sub OpenCL::Object::id {
636 ref $_[0] eq "SCALAR"
637 ? ${ $_[0] }
638 : $_[0][0]
639}
640
641=back
642
228=head2 THE OpenCL::Platform CLASS 643=head2 THE OpenCL::Platform CLASS
229 644
230=over 4 645=over 4
231 646
647=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
648
649Returns a list of matching OpenCL::Device objects.
650
651=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
652
653Tries to create a context. Never worked for me, and you need devices explicitly anyway.
654
655L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
656
657=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
658
659Create a new OpenCL::Context object using the given device object(s)- a
660CL_CONTEXT_PLATFORM property is supplied automatically.
661
662L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
663
232=item $packed_value = $platform->info ($name) 664=item $packed_value = $platform->info ($name)
233 665
234Calls C<clGetPlatformInfo> and returns the packed, raw value - for 666Calls C<clGetPlatformInfo> and returns the packed, raw value - for
235strings, this will be the string, for other values you probably need to 667strings, this will be the string (possibly including terminating \0), for
236use the correct C<unpack>. This might get improved in the future. Hopefully. 668other values you probably need to use the correct C<unpack>.
669
670It's best to avoid this method and use one of the following convenience
671wrappers.
237 672
238L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 673L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
239 674
240=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 675=item $platform->unload_compiler
241 676
242Returns a list of matching OpenCL::Device objects. 677Attempts to unload the compiler for this platform, for endless
678profit. Does nothing on OpenCL 1.1.
243 679
244=item $ctx = $platform->context_from_type_simple ($type = OpenCL::DEVICE_TYPE_DEFAULT)
245
246Tries to create a context. Never worked for me.
247
248L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 680L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
681
682=for gengetinfo begin platform
683
684=item $string = $platform->profile
685
686Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
687
688=item $string = $platform->version
689
690Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
691
692=item $string = $platform->name
693
694Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
695
696=item $string = $platform->vendor
697
698Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
699
700=item $string = $platform->extensions
701
702Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
703
704=for gengetinfo end platform
249 705
250=back 706=back
251 707
252=head2 THE OpenCL::Device CLASS 708=head2 THE OpenCL::Device CLASS
253 709
257 713
258See C<< $platform->info >> for details. 714See C<< $platform->info >> for details.
259 715
260L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 716L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
261 717
718=for gengetinfo begin device
719
720=item $device_type = $device->type
721
722Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
723
724=item $uint = $device->vendor_id
725
726Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
727
728=item $uint = $device->max_compute_units
729
730Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
731
732=item $uint = $device->max_work_item_dimensions
733
734Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
735
736=item $int = $device->max_work_group_size
737
738Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
739
740=item @ints = $device->max_work_item_sizes
741
742Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
743
744=item $uint = $device->preferred_vector_width_char
745
746Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
747
748=item $uint = $device->preferred_vector_width_short
749
750Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
751
752=item $uint = $device->preferred_vector_width_int
753
754Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
755
756=item $uint = $device->preferred_vector_width_long
757
758Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
759
760=item $uint = $device->preferred_vector_width_float
761
762Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
763
764=item $uint = $device->preferred_vector_width_double
765
766Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
767
768=item $uint = $device->max_clock_frequency
769
770Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
771
772=item $bitfield = $device->address_bits
773
774Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
775
776=item $uint = $device->max_read_image_args
777
778Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
779
780=item $uint = $device->max_write_image_args
781
782Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
783
784=item $ulong = $device->max_mem_alloc_size
785
786Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
787
788=item $int = $device->image2d_max_width
789
790Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
791
792=item $int = $device->image2d_max_height
793
794Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
795
796=item $int = $device->image3d_max_width
797
798Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
799
800=item $int = $device->image3d_max_height
801
802Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
803
804=item $int = $device->image3d_max_depth
805
806Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
807
808=item $uint = $device->image_support
809
810Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
811
812=item $int = $device->max_parameter_size
813
814Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
815
262=item $ctx = $device->context_simple 816=item $uint = $device->max_samplers
263 817
264Convenience function to create a new OpenCL::Context object. 818Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
265 819
266L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 820=item $uint = $device->mem_base_addr_align
821
822Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
823
824=item $uint = $device->min_data_type_align_size
825
826Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
827
828=item $device_fp_config = $device->single_fp_config
829
830Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
831
832=item $device_mem_cache_type = $device->global_mem_cache_type
833
834Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
835
836=item $uint = $device->global_mem_cacheline_size
837
838Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
839
840=item $ulong = $device->global_mem_cache_size
841
842Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
843
844=item $ulong = $device->global_mem_size
845
846Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
847
848=item $ulong = $device->max_constant_buffer_size
849
850Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
851
852=item $uint = $device->max_constant_args
853
854Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
855
856=item $device_local_mem_type = $device->local_mem_type
857
858Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
859
860=item $ulong = $device->local_mem_size
861
862Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
863
864=item $boolean = $device->error_correction_support
865
866Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
867
868=item $int = $device->profiling_timer_resolution
869
870Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
871
872=item $boolean = $device->endian_little
873
874Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
875
876=item $boolean = $device->available
877
878Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
879
880=item $boolean = $device->compiler_available
881
882Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
883
884=item $device_exec_capabilities = $device->execution_capabilities
885
886Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
887
888=item $command_queue_properties = $device->properties
889
890Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
891
892=item $ = $device->platform
893
894Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
895
896=item $string = $device->name
897
898Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
899
900=item $string = $device->vendor
901
902Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
903
904=item $string = $device->driver_version
905
906Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
907
908=item $string = $device->profile
909
910Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
911
912=item $string = $device->version
913
914Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
915
916=item $string = $device->extensions
917
918Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
919
920=item $uint = $device->preferred_vector_width_half
921
922Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
923
924=item $uint = $device->native_vector_width_char
925
926Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
927
928=item $uint = $device->native_vector_width_short
929
930Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
931
932=item $uint = $device->native_vector_width_int
933
934Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
935
936=item $uint = $device->native_vector_width_long
937
938Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
939
940=item $uint = $device->native_vector_width_float
941
942Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
943
944=item $uint = $device->native_vector_width_double
945
946Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
947
948=item $uint = $device->native_vector_width_half
949
950Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
951
952=item $device_fp_config = $device->double_fp_config
953
954Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
955
956=item $device_fp_config = $device->half_fp_config
957
958Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
959
960=item $boolean = $device->host_unified_memory
961
962Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
963
964=item $device = $device->parent_device_ext
965
966Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
967
968=item @device_partition_property_exts = $device->partition_types_ext
969
970Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
971
972=item @device_partition_property_exts = $device->affinity_domains_ext
973
974Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
975
976=item $uint = $device->reference_count_ext
977
978Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
979
980=item @device_partition_property_exts = $device->partition_style_ext
981
982Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
983
984=for gengetinfo end device
267 985
268=back 986=back
269 987
270=head2 THE OpenCL::Context CLASS 988=head2 THE OpenCL::Context CLASS
271 989
272=over 4 990=over 4
273 991
274=item $packed_value = $ctx->info ($name) 992=item $prog = $ctx->build_program ($program, $options = "")
275 993
276See C<< $platform->info >> for details. 994This convenience function tries to build the program on all devices in
995the context. If the build fails, then the function will C<croak> with the
996build log. Otherwise ti returns the program object.
277 997
278L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 998The C<$program> can either be a C<OpenCL::Program> object or a string
999containing the program. In the latter case, a program objetc will be
1000created automatically.
279 1001
280=item $queue = $ctx->command_queue_simple ($device) 1002=cut
281 1003
1004sub OpenCL::Context::build_program {
1005 my ($self, $prog, $options) = @_;
1006
1007 require Carp;
1008
1009 $prog = $self->program_with_source ($prog)
1010 unless ref $prog;
1011
1012 # we build separately per device so we instantly know which one failed
1013 for my $dev ($self->devices) {
1014 eval { $prog->build ([$dev], $options); 1 }
1015 or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
1016 . $prog->build_log ($dev));
1017 }
1018
1019 $prog
1020}
1021
1022=item $queue = $ctx->queue ($device, $properties)
1023
282Convenience function to create a new OpenCL::Queue object from the context and the given device. 1024Create a new OpenCL::Queue object from the context and the given device.
283 1025
284L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 1026L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
285 1027
1028Example: create an out-of-order queue.
1029
1030 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
1031
286=item $ev = $ctx->user_event 1032=item $ev = $ctx->user_event
287 1033
288Creates a new OpenCL::UserEvent object. 1034Creates a new OpenCL::UserEvent object.
289 1035
290L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 1036L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
291 1037
292=item $buf = $ctx->buffer ($flags, $len) 1038=item $buf = $ctx->buffer ($flags, $len)
293 1039
294Creates a new OpenCL::Buffer object with the given flags and octet-size. 1040Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1041given flags and octet-size.
295 1042
296L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 1043L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
297 1044
298=item $buf = $ctx->buffer_sv ($flags, $data) 1045=item $buf = $ctx->buffer_sv ($flags, $data)
299 1046
300Creates a new OpenCL::Buffer object and initialise it with the given data values. 1047Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1048initialise it with the given data values.
301 1049
1050=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)
1051
1052Creates a new OpenCL::Image object and optionally initialises it with
1053the given data values.
1054
1055L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1056
302=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 1057=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
303 1058
304Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 1059Creates a new OpenCL::Image2D object and optionally initialises it with
1060the given data values.
305 1061
306L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 1062L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
307 1063
308=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 1064=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
309 1065
310Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 1066Creates a new OpenCL::Image3D object and optionally initialises it with
1067the given data values.
311 1068
312L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 1069L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
1070
1071=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1072
1073Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1074OpenGL buffer object.
1075
1076http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1077
1078=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1079
1080Creates a new OpenCL::Image object that refers to the given OpenGL
1081texture object or buffer.
1082
1083http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1084
1085=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1086
1087Creates a new OpenCL::Image2D object that refers to the given OpenGL
10882D texture object.
1089
1090http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
1091
1092=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
1093
1094Creates a new OpenCL::Image3D object that refers to the given OpenGL
10953D texture object.
1096
1097http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
1098
1099=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
1100
1101Creates a new OpenCL::Image2D object that refers to the given OpenGL
1102render buffer.
1103
1104http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
313 1105
314=item @formats = $ctx->supported_image_formats ($flags, $image_type) 1106=item @formats = $ctx->supported_image_formats ($flags, $image_type)
315 1107
316Returns a list of matching image formats - each format is an arrayref with 1108Returns a list of matching image formats - each format is an arrayref with
317two values, $channel_order and $channel_type, in it. 1109two values, $channel_order and $channel_type, in it.
328 1120
329Creates a new OpenCL::Program object from the given source code. 1121Creates a new OpenCL::Program object from the given source code.
330 1122
331L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 1123L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
332 1124
1125=item $packed_value = $ctx->info ($name)
1126
1127See C<< $platform->info >> for details.
1128
1129L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1130
1131=for gengetinfo begin context
1132
1133=item $uint = $context->reference_count
1134
1135Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
1136
1137=item @devices = $context->devices
1138
1139Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
1140
1141=item @property_ints = $context->properties
1142
1143Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
1144
1145=item $uint = $context->num_devices
1146
1147Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
1148
1149=for gengetinfo end context
1150
333=back 1151=back
334 1152
335=head2 THE OpenCL::Queue CLASS 1153=head2 THE OpenCL::Queue CLASS
336 1154
337An OpenCL::Queue represents an execution queue for OpenCL. You execute 1155An OpenCL::Queue represents an execution queue for OpenCL. You execute
338requests by calling their respective C<enqueue_xxx> method and waitinf for 1156requests by calling their respective method and waiting for it to complete
339it to complete in some way. 1157in some way.
340 1158
341All the enqueue methods return an event object that can be used to wait 1159Most methods that enqueue some request return an event object that can
342for completion, unless the method is called in void context, in which case 1160be used to wait for completion (optionally using a callback), unless
343no event object is created. 1161the method is called in void context, in which case no event object is
1162created.
344 1163
345They also allow you to specify any number of other event objects that this 1164They also allow you to specify any number of other event objects that this
346request has to wait for before it starts executing, by simply passing the 1165request has to wait for before it starts executing, by simply passing the
347event objects as extra parameters to the enqueue methods. 1166event objects as extra parameters to the enqueue methods. To simplify
1167program design, this module ignores any C<undef> values in the list of
1168events. This makes it possible to code operations such as this, without
1169having to put a valid event object into C<$event> first:
1170
1171 $event = $queue->xxx (..., $event);
348 1172
349Queues execute in-order by default, without any parallelism, so in most 1173Queues execute in-order by default, without any parallelism, so in most
350cases (i.e. you use only one queue) it's not necessary to wait for or 1174cases (i.e. you use only one queue) it's not necessary to wait for or
351create event objects. 1175create event objects, althoguh an our of order queue is often a bit
1176faster.
352 1177
353=over 4 1178=over 4
354 1179
355=item $packed_value = $ctx->info ($name)
356
357See C<< $platform->info >> for details.
358
359L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
360
361=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1180=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
362 1181
363Reads data from buffer into the given string. 1182Reads data from buffer into the given string.
364 1183
365L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 1184L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
366 1185
367=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...) 1186=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
368 1187
369Writes data to buffer from the given string. 1188Writes data to buffer from the given string.
370 1189
371L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html> 1190L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
372 1191
373=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1192=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
374 1193
375L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1194L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
376 1195
1196=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...)
1197
1198http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1199
1200=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...)
1201
1202http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1203
377=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1204=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1205
1206L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1207
1208=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
378 1209
379L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1210L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
380 1211
381=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 1212=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
382 1213
383L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1214L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
384 1215
1216=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...)
1217
1218L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1219
1220=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1221
1222L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1223
385=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, 4dst_row_pitch, $dst_slice_pitch, $ait_event...) 1224=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...)
386 1225
387Yeah. 1226Yeah.
388 1227
389L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
390
391=item $ev = $queue->enqueue_copy_buffer_to_image (OpenCL::Buffer src, OpenCL::Image dst, size_t src_offset, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
392
393L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1228L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
394 1229
395=item $ev = $queue->enqueue_copy_image (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...) 1230=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
396 1231
1232Fills the given buffer object with repeated applications of C<$pattern>,
1233starting at C<$offset> for C<$size> octets.
1234
1235L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1236
1237=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1238
1239Fills the given image area with the given rgba colour components. The
1240components are normally floating point values between C<0> and C<1>,
1241except when the image channel data type is a signe dor unsigned
1242unnormalised format, in which case the range is determined by the format.
1243
397L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1244L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
398 1245
399=item $ev = $queue->enqueue_copy_image_to_buffer (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t width, size_t height, size_t depth, size_t dst_offset, ...)
400
401L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
402
403=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1246=item $ev = $queue->task ($kernel, $wait_events...)
404 1247
405L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1248L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
406 1249
407=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...) 1250=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
408 1251
409Enqueues a kernel execution. 1252Enqueues a kernel execution.
410 1253
411@$global_work_size must be specified as a reference to an array of 1254\@global_work_size must be specified as a reference to an array of
412integers specifying the work sizes (element counts). 1255integers specifying the work sizes (element counts).
413 1256
414@$global_work_offset must be either C<undef> (in which case all offsets 1257\@global_work_offset must be either C<undef> (in which case all offsets
415are C<0>), or a reference to an array of work offsets, with the same number 1258are C<0>), or a reference to an array of work offsets, with the same number
416of elements as @$global_work_size. 1259of elements as \@global_work_size.
417 1260
418@$local_work_size must be either C<undef> (in which case the 1261\@local_work_size must be either C<undef> (in which case the
419implementation is supposed to choose good local work sizes), or a 1262implementation is supposed to choose good local work sizes), or a
420reference to an array of local work sizes, with the same number of 1263reference to an array of local work sizes, with the same number of
421elements as @$global_work_size. 1264elements as \@global_work_size.
422 1265
423L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1266L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
424 1267
425=item $ev = $queue->enqueue_marker 1268=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
426 1269
1270Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1271for subsequent OpenCL usage.
1272
427L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1273L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
428 1274
1275=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1276
1277Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1278for subsequent OpenGL usage.
1279
1280L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1281
429=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1282=item $ev = $queue->wait_for_events ($wait_events...)
430 1283
431L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1284L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
432 1285
433=item $queue->enqueue_barrier 1286=item $ev = $queue->marker ($wait_events...)
434 1287
1288L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1289
1290=item $ev = $queue->barrier ($wait_events...)
1291
435L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1292L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
436 1293
437=item $queue->flush 1294=item $queue->flush
438 1295
439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1296L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
440 1297
441=item $queue->finish 1298=item $queue->finish
442 1299
443L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1300L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
444 1301
1302=item $packed_value = $queue->info ($name)
1303
1304See C<< $platform->info >> for details.
1305
1306L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1307
1308=for gengetinfo begin command_queue
1309
1310=item $ctx = $command_queue->context
1311
1312Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1313
1314=item $device = $command_queue->device
1315
1316Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1317
1318=item $uint = $command_queue->reference_count
1319
1320Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1321
1322=item $command_queue_properties = $command_queue->properties
1323
1324Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1325
1326=for gengetinfo end command_queue
1327
445=back 1328=back
446 1329
447=head2 THE OpenCL::Memory CLASS 1330=head2 THE OpenCL::Memory CLASS
448 1331
449This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1332This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
450OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1333OpenCL::Image2D and OpenCL::Image3D.
451currently only exist to allow type-checking.
452 1334
453=over 4 1335=over 4
454 1336
455=item $packed_value = $memory->info ($name) 1337=item $packed_value = $memory->info ($name)
456 1338
457See C<< $platform->info >> for details. 1339See C<< $platform->info >> for details.
458 1340
459L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1341L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
460 1342
1343=for gengetinfo begin mem
1344
1345=item $mem_object_type = $mem->type
1346
1347Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1348
1349=item $mem_flags = $mem->flags
1350
1351Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1352
1353=item $int = $mem->size
1354
1355Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1356
1357=item $ptr_value = $mem->host_ptr
1358
1359Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1360
1361=item $uint = $mem->map_count
1362
1363Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1364
1365=item $uint = $mem->reference_count
1366
1367Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1368
1369=item $ctx = $mem->context
1370
1371Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1372
1373=item $mem = $mem->associated_memobject
1374
1375Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1376
1377=item $int = $mem->offset
1378
1379Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1380
1381=for gengetinfo end mem
1382
1383=item ($type, $name) = $mem->gl_object_info
1384
1385Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1386object "name" (e.g. the texture name) used to create this memory object.
1387
1388L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1389
461=back 1390=back
462 1391
1392=head2 THE OpenCL::Buffer CLASS
1393
1394This is a subclass of OpenCL::Memory, and the superclass of
1395OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1396and sub-buffers.
1397
1398=head2 THE OpenCL::BufferObj CLASS
1399
1400This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1401because one cna create sub buffers of OpenLC::BufferObj objects, but not
1402sub buffers from these sub buffers.
1403
1404=over 4
1405
1406=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1407
1408Creates an OpenCL::Buffer objects from this buffer and returns it. The
1409C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1410
1411L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1412
1413=back
1414
1415=head2 THE OpenCL::Image CLASS
1416
1417This is the superclass of all image objects - OpenCL::Image1D,
1418OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1419OpenCL::Image2DArray and OpenCL::Image3D.
1420
1421=over 4
1422
1423=item $packed_value = $image->image_info ($name)
1424
1425See C<< $platform->info >> for details.
1426
1427The reason this method is not called C<info> is that there already is an
1428C<< ->info >> method inherited from C<OpenCL::Memory>.
1429
1430L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1431
1432=item ($channel_order, $channel_data_type) = $image->format
1433
1434Returns the channel order and type used to create the image by calling
1435C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
1436
1437=for gengetinfo begin image
1438
1439=item $int = $image->element_size
1440
1441Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1442
1443=item $int = $image->row_pitch
1444
1445Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1446
1447=item $int = $image->slice_pitch
1448
1449Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1450
1451=item $int = $image->width
1452
1453Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1454
1455=item $int = $image->height
1456
1457Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1458
1459=item $int = $image->depth
1460
1461Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1462
1463=for gengetinfo end image
1464
1465=for gengetinfo begin gl_texture
1466
1467=item $GLenum = $gl_texture->target
1468
1469Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1470
1471=item $GLint = $gl_texture->gl_mipmap_level
1472
1473Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1474
1475=for gengetinfo end gl_texture
1476
1477=back
1478
463=head2 THE OpenCL::Sampler CLASS 1479=head2 THE OpenCL::Sampler CLASS
464 1480
465=over 4 1481=over 4
466 1482
467=item $packed_value = $sampler->info ($name) 1483=item $packed_value = $sampler->info ($name)
468 1484
469See C<< $platform->info >> for details. 1485See C<< $platform->info >> for details.
470 1486
471L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1487L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
472 1488
1489=for gengetinfo begin sampler
1490
1491=item $uint = $sampler->reference_count
1492
1493Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1494
1495=item $ctx = $sampler->context
1496
1497Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1498
1499=item $addressing_mode = $sampler->normalized_coords
1500
1501Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1502
1503=item $filter_mode = $sampler->addressing_mode
1504
1505Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1506
1507=item $boolean = $sampler->filter_mode
1508
1509Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1510
1511=for gengetinfo end sampler
1512
473=back 1513=back
474 1514
475=head2 THE OpenCL::Program CLASS 1515=head2 THE OpenCL::Program CLASS
476 1516
477=over 4 1517=over 4
478 1518
479=item $packed_value = $program->info ($name) 1519=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
480 1520
481See C<< $platform->info >> for details.
482
483L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
484
485=item $program->build ($device, $options = "")
486
487Tries to build the program with the givne options. 1521Tries to build the program with the given options. See also the
1522C<$ctx->build> convenience function.
1523
1524If a callback is specified, then it will be called when compilation is
1525finished. Note that many OpenCL implementations block your program while
1526compiling whether you use a callback or not. See C<build_async> if you
1527want to make sure the build is done in the background.
1528
1529Note that some OpenCL implementations atc up badly, and don't call the
1530callback in some error cases (but call it in others). This implementation
1531assumes the callback will always be called, and leaks memory if this is
1532not so. So best make sure you don't pass in invalid values.
488 1533
489L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1534L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1535
1536=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1537
1538Similar to C<< ->build >>, except it starts a thread, and never fails (you
1539need to check the compilation status form the callback, or by polling).
490 1540
491=item $packed_value = $program->build_info ($device, $name) 1541=item $packed_value = $program->build_info ($device, $name)
492 1542
493Similar to C<< $platform->info >>, but returns build info for a previous 1543Similar to C<< $platform->info >>, but returns build info for a previous
494build attempt for the given device. 1544build attempt for the given device.
500Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1550Creates an OpenCL::Kernel object out of the named C<__kernel> function in
501the program. 1551the program.
502 1552
503L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1553L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
504 1554
1555=item @kernels = $program->kernels_in_program
1556
1557Returns all kernels successfully compiled for all devices in program.
1558
1559http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1560
1561=for gengetinfo begin program_build
1562
1563=item $build_status = $program->build_status ($device)
1564
1565Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1566
1567=item $string = $program->build_options ($device)
1568
1569Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1570
1571=item $string = $program->build_log ($device)
1572
1573Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1574
1575=for gengetinfo end program_build
1576
1577=item $packed_value = $program->info ($name)
1578
1579See C<< $platform->info >> for details.
1580
1581L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1582
1583=for gengetinfo begin program
1584
1585=item $uint = $program->reference_count
1586
1587Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1588
1589=item $ctx = $program->context
1590
1591Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1592
1593=item $uint = $program->num_devices
1594
1595Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1596
1597=item @devices = $program->devices
1598
1599Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1600
1601=item $string = $program->source
1602
1603Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1604
1605=item @ints = $program->binary_sizes
1606
1607Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1608
1609=for gengetinfo end program
1610
1611=item @blobs = $program->binaries
1612
1613Returns a string for the compiled binary for every device associated with
1614the program, empty strings indicate missing programs, and an empty result
1615means no program binaries are available.
1616
1617These "binaries" are often, in fact, informative low-level assembly
1618sources.
1619
1620L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1621
505=back 1622=back
506 1623
507=head2 THE OpenCL::Kernel CLASS 1624=head2 THE OpenCL::Kernel CLASS
508 1625
509=over 4 1626=over 4
512 1629
513See C<< $platform->info >> for details. 1630See C<< $platform->info >> for details.
514 1631
515L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1632L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
516 1633
1634=for gengetinfo begin kernel
1635
1636=item $string = $kernel->function_name
1637
1638Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1639
1640=item $uint = $kernel->num_args
1641
1642Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1643
1644=item $uint = $kernel->reference_count
1645
1646Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1647
1648=item $ctx = $kernel->context
1649
1650Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1651
1652=item $program = $kernel->program
1653
1654Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1655
1656=for gengetinfo end kernel
1657
1658=item $packed_value = $kernel->work_group_info ($device, $name)
1659
1660See C<< $platform->info >> for details.
1661
1662The reason this method is not called C<info> is that there already is an
1663C<< ->info >> method.
1664
1665L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1666
1667=for gengetinfo begin kernel_work_group
1668
1669=item $int = $kernel->work_group_size ($device)
1670
1671Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1672
1673=item @ints = $kernel->compile_work_group_size ($device)
1674
1675Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1676
1677=item $ulong = $kernel->local_mem_size ($device)
1678
1679Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1680
1681=item $int = $kernel->preferred_work_group_size_multiple ($device)
1682
1683Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1684
1685=item $ulong = $kernel->private_mem_size ($device)
1686
1687Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1688
1689=for gengetinfo end kernel_work_group
1690
517=item $kernel->set_TYPE ($index, $value) 1691=item $kernel->set_TYPE ($index, $value)
518 1692
1693=item $kernel->set_char ($index, $value)
1694
1695=item $kernel->set_uchar ($index, $value)
1696
1697=item $kernel->set_short ($index, $value)
1698
1699=item $kernel->set_ushort ($index, $value)
1700
1701=item $kernel->set_int ($index, $value)
1702
1703=item $kernel->set_uint ($index, $value)
1704
1705=item $kernel->set_long ($index, $value)
1706
1707=item $kernel->set_ulong ($index, $value)
1708
1709=item $kernel->set_half ($index, $value)
1710
1711=item $kernel->set_float ($index, $value)
1712
1713=item $kernel->set_double ($index, $value)
1714
1715=item $kernel->set_memory ($index, $value)
1716
1717=item $kernel->set_buffer ($index, $value)
1718
1719=item $kernel->set_image ($index, $value)
1720
1721=item $kernel->set_sampler ($index, $value)
1722
1723=item $kernel->set_local ($index, $value)
1724
1725=item $kernel->set_event ($index, $value)
1726
519This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1727This is a family of methods to set the kernel argument with the number
520 1728C<$index> to the give C<$value>.
521TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
522C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
523C<image2d>, C<image3d>, C<sampler> or C<event>.
524 1729
525Chars and integers (including the half type) are specified as integers, 1730Chars and integers (including the half type) are specified as integers,
526float and double as floating point values, memory/buffer/image2d/image3d 1731float and double as floating point values, memory/buffer/image must be
527must be an object of that type or C<undef>, and sampler and event must be 1732an object of that type or C<undef>, local-memory arguments are set by
528objects of that type. 1733specifying the size, and sampler and event must be objects of that type.
1734
1735Note that C<set_memory> works for all memory objects (all types of buffers
1736and images) - the main purpose of the more specific C<set_TYPE> functions
1737is type checking.
1738
1739Setting an argument for a kernel does NOT keep a reference to the object -
1740for example, if you set an argument to some image object, free the image,
1741and call the kernel, you will run into undefined behaviour.
529 1742
530L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1743L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
531 1744
532=back 1745=back
533 1746
536This is the superclass for all event objects (including OpenCL::UserEvent 1749This is the superclass for all event objects (including OpenCL::UserEvent
537objects). 1750objects).
538 1751
539=over 4 1752=over 4
540 1753
1754=item $ev->wait
1755
1756Waits for the event to complete.
1757
1758L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1759
1760=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
1761
1762Adds a callback to the callback stack for the given event type. There is
1763no way to remove a callback again.
1764
1765L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
1766
541=item $packed_value = $ev->info ($name) 1767=item $packed_value = $ev->info ($name)
542 1768
543See C<< $platform->info >> for details. 1769See C<< $platform->info >> for details.
544 1770
545L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1771L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
546 1772
547=item $ev->wait 1773=for gengetinfo begin event
548 1774
549Waits for the event to complete. 1775=item $queue = $event->command_queue
550 1776
1777Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1778
1779=item $command_type = $event->command_type
1780
1781Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1782
1783=item $uint = $event->reference_count
1784
1785Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1786
1787=item $uint = $event->command_execution_status
1788
1789Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1790
1791=item $ctx = $event->context
1792
1793Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1794
1795=for gengetinfo end event
1796
1797=item $packed_value = $ev->profiling_info ($name)
1798
1799See C<< $platform->info >> for details.
1800
1801The reason this method is not called C<info> is that there already is an
1802C<< ->info >> method.
1803
551L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1805
1806=for gengetinfo begin profiling
1807
1808=item $ulong = $event->profiling_command_queued
1809
1810Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1811
1812=item $ulong = $event->profiling_command_submit
1813
1814Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1815
1816=item $ulong = $event->profiling_command_start
1817
1818Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1819
1820=item $ulong = $event->profiling_command_end
1821
1822Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1823
1824=for gengetinfo end profiling
552 1825
553=back 1826=back
554 1827
555=head2 THE OpenCL::UserEvent CLASS 1828=head2 THE OpenCL::UserEvent CLASS
556 1829
558 1831
559=over 4 1832=over 4
560 1833
561=item $ev->set_status ($execution_status) 1834=item $ev->set_status ($execution_status)
562 1835
1836Sets the execution status of the user event. Can only be called once,
1837either with OpenCL::COMPLETE or a negative number as status.
1838
563L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 1839L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
564 1840
565=back 1841=back
566 1842
567=cut 1843=cut
568
569package OpenCL;
570
571use common::sense;
572
573BEGIN {
574 our $VERSION = '0.03';
575
576 require XSLoader;
577 XSLoader::load (__PACKAGE__, $VERSION);
578
579 @OpenCL::Buffer::ISA =
580 @OpenCL::Image::ISA = OpenCL::Memory::;
581
582 @OpenCL::Image2D::ISA =
583 @OpenCL::Image3D::ISA = OpenCL::Image::;
584
585 @OpenCL::UserEvent::ISA = OpenCL::Event::;
586}
587 1844
5881; 18451;
589 1846
590=head1 AUTHOR 1847=head1 AUTHOR
591 1848

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines