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.40 by root, Thu Apr 19 22:33:27 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 spec used to develop this module (1.2 spec was available, but
16no implementation was available to me :). 49no implementation was available to me :).
17 50
18 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
19 52
20OpenCL manpages: 53OpenCL manpages:
21 54
22 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ 55 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
23 56
57If you are into UML class diagrams, the following diagram might help - if
58not, it will be mildly cobfusing:
59
60 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html
61
62Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
63is, but at least it's free of charge:
64
65 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
66
67And here's NVIDIA's OpenCL Best Practises Guide:
68
69 http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
70
71=head1 BASIC WORKFLOW
72
73To get something done, you basically have to do this once (refer to the
74examples below for actual code, this is just a high-level description):
75
76Find some platform (e.g. the first one) and some device(s) (e.g. the first
77device of the platform), and create a context from those.
78
79Create program objects from your OpenCL source code, then build (compile)
80the programs for each device you want to run them on.
81
82Create kernel objects for all kernels you want to use (surprisingly, these
83are not device-specific).
84
85Then, to execute stuff, you repeat these steps, possibly resuing or
86sharing some buffers:
87
88Create some input and output buffers from your context. Set these as
89arguments to your kernel.
90
91Enqueue buffer writes to initialise your input buffers (when not
92initialised at creation time).
93
94Enqueue the kernel execution.
95
96Enqueue buffer reads for your output buffer to read results.
97
24=head1 EXAMPLES 98=head1 EXAMPLES
25 99
26=head2 Enumerate all devices and get contexts for them. 100=head2 Enumerate all devices and get contexts for them.
27 101
102Best run this once to get a feel for the platforms and devices in your
103system.
104
28 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
29 warn $platform->info (OpenCL::PLATFORM_NAME); 106 printf "platform: %s\n", $platform->name;
30 warn $platform->info (OpenCL::PLATFORM_EXTENSIONS); 107 printf "extensions: %s\n", $platform->extensions;
31 for my $device ($platform->devices) { 108 for my $device ($platform->devices) {
32 warn $device->info (OpenCL::DEVICE_NAME); 109 printf "+ device: %s\n", $device->name;
33 my $ctx = $device->context_simple; 110 my $ctx = $platform->context (undef, [$device]);
34 # do stuff 111 # do stuff
35 } 112 }
36 } 113 }
37 114
38=head2 Get a useful context and a command queue. 115=head2 Get a useful context and a command queue.
39 116
40 my $dev = ((OpenCL::platforms)[0]->devices)[0]; 117This is a useful boilerplate for any OpenCL program that only wants to use
41 my $ctx = $dev->context_simple; 118one device,
42 my $queue = $ctx->command_queue_simple ($dev); 119
120 my ($platform) = OpenCL::platforms; # find first platform
121 my ($dev) = $platform->devices; # find first device of platform
122 my $ctx = $platform->context (undef, [$dev]); # create context out of those
123 my $queue = $ctx->queue ($dev); # create a command queue for the device
43 124
44=head2 Print all supported image formats of a context. 125=head2 Print all supported image formats of a context.
45 126
127Best run this once for your context, to see whats available and how to
128gather information.
129
46 for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) { 130 for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
47 say "supported image formats for ", OpenCL::enum2str $type; 131 print "supported image formats for ", OpenCL::enum2str $type, "\n";
48 132
49 for my $f ($ctx->supported_image_formats (0, $type)) { 133 for my $f ($ctx->supported_image_formats (0, $type)) {
50 printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1]; 134 printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];
51 } 135 }
52 } 136 }
55then asynchronously. 139then asynchronously.
56 140
57 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut"); 141 my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
58 142
59 $queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data); 143 $queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);
60 warn $data; 144 print "$data\n";
61 145
62 my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data); 146 my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);
63 $ev->wait; 147 $ev->wait;
64 warn $data; 148 print "$data\n"; # prints "elm"
65 149
66=head2 Create and build a program, then create a kernel out of one of its 150=head2 Create and build a program, then create a kernel out of one of its
67functions. 151functions.
68 152
69 my $src = ' 153 my $src = '
70 __kernel void 154 kernel void
71 squareit (__global float *input, __global float *output) 155 squareit (global float *input, global float *output)
72 { 156 {
73 size_t id = get_global_id (0); 157 $id = get_global_id (0);
74 output [id] = input [id] * input [id]; 158 output [id] = input [id] * input [id];
75 } 159 }
76 '; 160 ';
77 161
78 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->program_with_source ($src);
79 163
164 # build croaks on compile errors, so catch it and print the compile errors
80 eval { $prog->build ($dev); 1 } 165 eval { $prog->build ($dev); 1 }
81 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG); 166 or die $prog->build_log;
82 167
83 my $kernel = $prog->kernel ("squareit"); 168 my $kernel = $prog->kernel ("squareit");
84 169
85=head2 Create some input and output float buffers, then call squareit on them. 170=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them.
86 172
87 my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5); 173 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); 174 my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
89 175
90 # set buffer 176 # set buffer
96 182
97 # enqueue a synchronous read 183 # enqueue a synchronous read
98 $queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); 184 $queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
99 185
100 # print the results: 186 # print the results:
101 say join ", ", unpack "f*", $data; 187 printf "%s\n", join ", ", unpack "f*", $data;
102 188
103=head2 The same enqueue operations as before, but assuming an out-of-order queue, 189=head2 The same enqueue operations as before, but assuming an out-of-order queue,
104showing off barriers. 190showing off barriers.
105 191
106 # execute it for all 4 numbers 192 # execute it for all 4 numbers
125 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
126 212
127 # wait for the last event to complete 213 # wait for the last event to complete
128 $ev->wait; 214 $ev->wait;
129 215
216=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
217set tunnel effect.
218
219This is quite a long example to get you going.
220
221 use OpenGL ":all";
222 use OpenCL;
223
224 # open a window and create a gl texture
225 OpenGL::glpOpenWindow width => 256, height => 256;
226 my $texid = glGenTextures_p 1;
227 glBindTexture GL_TEXTURE_2D, $texid;
228 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
229
230 # find and use the first opencl device that let's us get a shared opengl context
231 my $platform;
232 my $dev;
233 my $ctx;
234
235 for (OpenCL::platforms) {
236 $platform = $_;
237 for ($platform->devices) {
238 $dev = $_;
239 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
240 and last;
241 }
242 }
243
244 $ctx
245 or die "cannot find suitable OpenCL device\n";
246
247 my $queue = $ctx->queue ($dev);
248
249 # now attach an opencl image2d object to the opengl texture
250 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
251
252 # now the boring opencl code
253 my $src = <<EOF;
254 kernel void
255 juliatunnel (write_only image2d_t img, float time)
256 {
257 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
258
259 float2 m = (float2)(1.f, p.y) / fabs (p.x);
260 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
261
262 float2 z = m;
263 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
264
265 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
266 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
267
268 float3 colour = (float3)(z.x, z.y, z.x * z.y);
269 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
270 }
271 EOF
272 my $prog = $ctx->program_with_source ($src);
273 eval { $prog->build ($dev); 1 }
274 or die $prog->build_log ($dev);
275
276 my $kernel = $prog->kernel ("juliatunnel");
277
278 # program compiled, kernel ready, now draw and loop
279
280 for (my $time; ; ++$time) {
281 # acquire objects from opengl
282 $queue->enqueue_acquire_gl_objects ([$tex]);
283
284 # configure and run our kernel
285 $kernel->set_image2d (0, $tex);
286 $kernel->set_float (1, $time);
287 $queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
288
289 # release objects to opengl again
290 $queue->enqueue_release_gl_objects ([$tex]);
291
292 # wait
293 $queue->finish;
294
295 # now draw the texture, the defaults should be all right
296 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
297
298 glEnable GL_TEXTURE_2D;
299 glBegin GL_QUADS;
300 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
301 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
302 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
303 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
304 glEnd;
305
306 glXSwapBuffers;
307
308 select undef, undef, undef, 1/60;
309 }
310
130=head1 DOCUMENTATION 311=head1 DOCUMENTATION
131 312
132=head2 BASIC CONVENTIONS 313=head2 BASIC CONVENTIONS
133 314
134This is not a 1:1 C-style translation of OpenCL to Perl - instead I 315This 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 316I attempted to make the interface as type-safe as possible by introducing
136object syntax where it makes sense. There are a number of important 317object syntax where it makes sense. There are a number of important
137differences between the OpenCL C API and this module: 318differences between the OpenCL C API and this module:
138 319
139=over 4 320=over 4
140 321
141=item * Object lifetime managament is automatic - there is no need 322=item * Object lifetime managament is automatic - there is no need
142to free objects explicitly (C<clReleaseXXX>), the release function 323to free objects explicitly (C<clReleaseXXX>), the release function
143is called automatically once all Perl references to it go away. 324is called automatically once all Perl references to it go away.
144 325
145=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), 326=item * OpenCL uses CamelCase for function names
327(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
146while this module uses underscores as word separator and often leaves out 328uses underscores as word separator and often leaves out prefixes
147prefixes (C<< $platform->info >>). 329(C<OpenCL::platforms>, C<< $platform->info >>).
148 330
149=item * OpenCL often specifies fixed vector function arguments as short 331=item * OpenCL often specifies fixed vector function arguments as short
150arrays (C<size_t origin[3]>), while this module explicitly expects the 332arrays (C<size_t origin[3]>), while this module explicitly expects the
151components as separate arguments- 333components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
334function calls.
152 335
153=item * Where possible, the row_pitch value is calculated from the perl 336=item * Structures are often specified by flattening out their components
154scalar length and need not be specified. 337as with short vectors, and returned as arrayrefs.
155 338
156=item * When enqueuing commands, the wait list is specified by adding 339=item * When enqueuing commands, the wait list is specified by adding
157extra arguments to the function - everywhere a C<$wait_events...> argument 340extra arguments to the function - anywhere a C<$wait_events...> argument
158is documented this can be any number of event objects. 341is documented this can be any number of event objects.
159 342
160=item * When enqueuing commands, if the enqueue method is called in void 343=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 344context, no event is created. In all other contexts an event is returned
162by the method. 345by the method.
167 350
168=back 351=back
169 352
170=head2 PERL AND OPENCL TYPES 353=head2 PERL AND OPENCL TYPES
171 354
172This handy(?) table lists OpenCL types and their perl and pack/unpack 355This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
173format equivalents: 356format equivalents:
174 357
175 OpenCL perl pack/unpack 358 OpenCL perl PDL pack/unpack
176 char IV c 359 char IV - c
177 uchar IV C 360 uchar IV byte C
178 short IV s 361 short IV short s
179 ushort IV S 362 ushort IV ushort S
180 int IV l 363 int IV long? l
181 uint IV L 364 uint IV - L
182 long IV q 365 long IV longlong q
183 ulong IV Q 366 ulong IV - Q
184 float NV f 367 float NV float f
185 half IV S 368 half IV ushort S
186 double NV d 369 double NV double d
370
371=head2 GLX SUPPORT
372
373Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
374module, which has little to no documentation and has little to no support
375for glX), this module, as a special extension, treats context creation
376properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
377specially: If either or both of these are C<undef>, then the OpenCL
378module tries to dynamically resolve C<glXGetCurrentDisplay> and
379C<glXGetCurrentContext>, call these functions and use their return values
380instead.
381
382For this to work, the OpenGL library must be loaded, a GLX context must
383have been created and be made current, and C<dlsym> must be available and
384capable of finding the function via C<RTLD_DEFAULT>.
187 385
188=head2 THE OpenCL PACKAGE 386=head2 THE OpenCL PACKAGE
189 387
190=over 4 388=over 4
191 389
192=item $int = OpenCL::errno 390=item $int = OpenCL::errno
193 391
194The last error returned by a function - it's only changed on errors. 392The last error returned by a function - it's only valid after an error occured
393and before calling another OpenCL function.
195 394
196=item $str = OpenCL::err2str $errval 395=item $str = OpenCL::err2str $errval
197 396
198Comverts an error value into a human readable string. 397Comverts an error value into a human readable string.
199 398
200=item $str = OpenCL::err2str $enum 399=item $str = OpenCL::enum2str $enum
201 400
202Converts most enum values (inof parameter names, image format constants, 401Converts most enum values (of parameter names, image format constants,
203object types, addressing and filter modes, command types etc.) into a 402object types, addressing and filter modes, command types etc.) into a
204human readbale string. When confronted with some random integer it can be 403human readable string. When confronted with some random integer it can be
205very helpful to pass it through this function to maybe get some readable 404very helpful to pass it through this function to maybe get some readable
206string out of it. 405string out of it.
207 406
208=item @platforms = OpenCL::platforms 407=item @platforms = OpenCL::platforms
209 408
210Returns all available OpenCL::Platform objects. 409Returns all available OpenCL::Platform objects.
211 410
212L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 411L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
213 412
214=item $ctx = OpenCL::context_from_type_simple $type = OpenCL::DEVICE_TYPE_DEFAULT 413=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef
215 414
216Tries to create a context from a default device and platform - never worked for me. 415Tries to create a context from a default device and platform - never worked for me.
217 416
218L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 417L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
219 418
227 426
228=head2 THE OpenCL::Platform CLASS 427=head2 THE OpenCL::Platform CLASS
229 428
230=over 4 429=over 4
231 430
431=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
432
433Returns a list of matching OpenCL::Device objects.
434
435=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
436
437Tries to create a context. Never worked for me, and you need devices explicitly anyway.
438
439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
440
441=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
442
443Create a new OpenCL::Context object using the given device object(s)- a
444CL_CONTEXT_PLATFORM property is supplied automatically.
445
446L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
447
232=item $packed_value = $platform->info ($name) 448=item $packed_value = $platform->info ($name)
233 449
234Calls C<clGetPlatformInfo> and returns the packed, raw value - for 450Calls C<clGetPlatformInfo> and returns the packed, raw value - for
235strings, this will be the string, for other values you probably need to 451strings, this will be the string (possibly including terminating \0), for
236use the correct C<unpack>. This might get improved in the future. Hopefully. 452other values you probably need to use the correct C<unpack>.
453
454It's best to avoid this method and use one of the following convenience
455wrappers.
237 456
238L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 457L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
239 458
240=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 459=for gengetinfo begin platform
241 460
242Returns a list of matching OpenCL::Device objects. 461=item $string = $platform->profile
243 462
244=item $ctx = $platform->context_from_type_simple ($type = OpenCL::DEVICE_TYPE_DEFAULT) 463Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
245 464
246Tries to create a context. Never worked for me. 465=item $string = $platform->version
247 466
248L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 467Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
468
469=item $string = $platform->name
470
471Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
472
473=item $string = $platform->vendor
474
475Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
476
477=item $string = $platform->extensions
478
479Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
480
481=for gengetinfo end platform
249 482
250=back 483=back
251 484
252=head2 THE OpenCL::Device CLASS 485=head2 THE OpenCL::Device CLASS
253 486
257 490
258See C<< $platform->info >> for details. 491See C<< $platform->info >> for details.
259 492
260L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 493L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
261 494
495=for gengetinfo begin device
496
497=item $device_type = $device->type
498
499Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
500
501=item $uint = $device->vendor_id
502
503Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
504
505=item $uint = $device->max_compute_units
506
507Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
508
509=item $uint = $device->max_work_item_dimensions
510
511Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
512
513=item $int = $device->max_work_group_size
514
515Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
516
517=item @ints = $device->max_work_item_sizes
518
519Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
520
521=item $uint = $device->preferred_vector_width_char
522
523Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
524
525=item $uint = $device->preferred_vector_width_short
526
527Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
528
529=item $uint = $device->preferred_vector_width_int
530
531Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
532
533=item $uint = $device->preferred_vector_width_long
534
535Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
536
537=item $uint = $device->preferred_vector_width_float
538
539Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
540
541=item $uint = $device->preferred_vector_width_double
542
543Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
544
545=item $uint = $device->max_clock_frequency
546
547Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
548
549=item $bitfield = $device->address_bits
550
551Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
552
553=item $uint = $device->max_read_image_args
554
555Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
556
557=item $uint = $device->max_write_image_args
558
559Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
560
561=item $ulong = $device->max_mem_alloc_size
562
563Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
564
565=item $int = $device->image2d_max_width
566
567Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
568
569=item $int = $device->image2d_max_height
570
571Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
572
573=item $int = $device->image3d_max_width
574
575Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
576
577=item $int = $device->image3d_max_height
578
579Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
580
581=item $int = $device->image3d_max_depth
582
583Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
584
585=item $uint = $device->image_support
586
587Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
588
589=item $int = $device->max_parameter_size
590
591Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
592
262=item $ctx = $device->context_simple 593=item $uint = $device->max_samplers
263 594
264Convenience function to create a new OpenCL::Context object. 595Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
265 596
266L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 597=item $uint = $device->mem_base_addr_align
598
599Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
600
601=item $uint = $device->min_data_type_align_size
602
603Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
604
605=item $device_fp_config = $device->single_fp_config
606
607Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
608
609=item $device_mem_cache_type = $device->global_mem_cache_type
610
611Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
612
613=item $uint = $device->global_mem_cacheline_size
614
615Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
616
617=item $ulong = $device->global_mem_cache_size
618
619Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
620
621=item $ulong = $device->global_mem_size
622
623Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
624
625=item $ulong = $device->max_constant_buffer_size
626
627Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
628
629=item $uint = $device->max_constant_args
630
631Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
632
633=item $device_local_mem_type = $device->local_mem_type
634
635Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
636
637=item $ulong = $device->local_mem_size
638
639Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
640
641=item $boolean = $device->error_correction_support
642
643Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
644
645=item $int = $device->profiling_timer_resolution
646
647Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
648
649=item $boolean = $device->endian_little
650
651Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
652
653=item $boolean = $device->available
654
655Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
656
657=item $boolean = $device->compiler_available
658
659Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
660
661=item $device_exec_capabilities = $device->execution_capabilities
662
663Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
664
665=item $command_queue_properties = $device->properties
666
667Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
668
669=item $ = $device->platform
670
671Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
672
673=item $string = $device->name
674
675Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
676
677=item $string = $device->vendor
678
679Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
680
681=item $string = $device->driver_version
682
683Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
684
685=item $string = $device->profile
686
687Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
688
689=item $string = $device->version
690
691Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
692
693=item $string = $device->extensions
694
695Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
696
697=item $uint = $device->preferred_vector_width_half
698
699Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
700
701=item $uint = $device->native_vector_width_char
702
703Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
704
705=item $uint = $device->native_vector_width_short
706
707Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
708
709=item $uint = $device->native_vector_width_int
710
711Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
712
713=item $uint = $device->native_vector_width_long
714
715Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
716
717=item $uint = $device->native_vector_width_float
718
719Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
720
721=item $uint = $device->native_vector_width_double
722
723Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
724
725=item $uint = $device->native_vector_width_half
726
727Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
728
729=item $device_fp_config = $device->double_fp_config
730
731Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
732
733=item $device_fp_config = $device->half_fp_config
734
735Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
736
737=item $boolean = $device->host_unified_memory
738
739Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
740
741=item $device = $device->parent_device_ext
742
743Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
744
745=item @device_partition_property_exts = $device->partition_types_ext
746
747Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
748
749=item @device_partition_property_exts = $device->affinity_domains_ext
750
751Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
752
753=item $uint = $device->reference_count_ext
754
755Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
756
757=item @device_partition_property_exts = $device->partition_style_ext
758
759Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
760
761=for gengetinfo end device
267 762
268=back 763=back
269 764
270=head2 THE OpenCL::Context CLASS 765=head2 THE OpenCL::Context CLASS
271 766
272=over 4 767=over 4
273 768
274=item $packed_value = $ctx->info ($name) 769=item $queue = $ctx->queue ($device, $properties)
275 770
276See C<< $platform->info >> for details.
277
278L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
279
280=item $queue = $ctx->command_queue_simple ($device)
281
282Convenience function to create a new OpenCL::Queue object from the context and the given device. 771Create a new OpenCL::Queue object from the context and the given device.
283 772
284L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 773L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
285 774
286=item $ev = $ctx->user_event 775=item $ev = $ctx->user_event
287 776
289 778
290L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 779L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
291 780
292=item $buf = $ctx->buffer ($flags, $len) 781=item $buf = $ctx->buffer ($flags, $len)
293 782
294Creates a new OpenCL::Buffer object with the given flags and octet-size. 783Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
784given flags and octet-size.
295 785
296L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 786L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
297 787
298=item $buf = $ctx->buffer_sv ($flags, $data) 788=item $buf = $ctx->buffer_sv ($flags, $data)
299 789
300Creates a new OpenCL::Buffer object and initialise it with the given data values. 790Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
791initialise it with the given data values.
301 792
302=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 793=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
303 794
304Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 795Creates a new OpenCL::Image2D object and optionally initialises it with
796the given data values.
305 797
306L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 798L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
307 799
308=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 800=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
309 801
310Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 802Creates a new OpenCL::Image3D object and optionally initialises it with
803the given data values.
311 804
312L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 805L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
806
807=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
808
809Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
810OpenGL buffer object.
811
812http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
813
814=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
815
816Creates a new OpenCL::Image2D object that refers to the given OpenGL
8172D texture object.
818
819http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
820
821=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
822
823Creates a new OpenCL::Image3D object that refers to the given OpenGL
8243D texture object.
825
826http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
827
828=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
829
830Creates a new OpenCL::Image2D object that refers to the given OpenGL
831render buffer.
832
833http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
313 834
314=item @formats = $ctx->supported_image_formats ($flags, $image_type) 835=item @formats = $ctx->supported_image_formats ($flags, $image_type)
315 836
316Returns a list of matching image formats - each format is an arrayref with 837Returns a list of matching image formats - each format is an arrayref with
317two values, $channel_order and $channel_type, in it. 838two values, $channel_order and $channel_type, in it.
327=item $program = $ctx->program_with_source ($string) 848=item $program = $ctx->program_with_source ($string)
328 849
329Creates a new OpenCL::Program object from the given source code. 850Creates a new OpenCL::Program object from the given source code.
330 851
331L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 852L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
853
854=item $packed_value = $ctx->info ($name)
855
856See C<< $platform->info >> for details.
857
858L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
859
860=for gengetinfo begin context
861
862=item $uint = $context->reference_count
863
864Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
865
866=item @devices = $context->devices
867
868Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
869
870=item @property_ints = $context->properties
871
872Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
873
874=item $uint = $context->num_devices
875
876Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
877
878=for gengetinfo end context
332 879
333=back 880=back
334 881
335=head2 THE OpenCL::Queue CLASS 882=head2 THE OpenCL::Queue CLASS
336 883
350cases (i.e. you use only one queue) it's not necessary to wait for or 897cases (i.e. you use only one queue) it's not necessary to wait for or
351create event objects. 898create event objects.
352 899
353=over 4 900=over 4
354 901
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...) 902=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
362 903
363Reads data from buffer into the given string. 904Reads data from buffer into the given string.
364 905
365L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 906L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
372 913
373=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 914=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
374 915
375L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 916L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
376 917
918=item $ev = $queue->enqueue_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...)
919
920http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
921
922=item $ev = $queue->enqueue_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...)
923
924http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
925
377=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 926=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
378 927
928L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
929
930=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...)
931
379L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 932L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
380 933
381=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 934=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
382 935
383L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 936L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
384 937
938=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...)
939
940L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
941
942=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...)
943
944L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
945
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...) 946=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...)
386 947
387Yeah. 948Yeah.
388 949
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>. 950L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
394
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, ...)
396
397L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
398
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 951
403=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 952=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
404 953
405L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 954L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
406 955
420reference to an array of local work sizes, with the same number of 969reference to an array of local work sizes, with the same number of
421elements as @$global_work_size. 970elements as @$global_work_size.
422 971
423L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 972L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
424 973
425=item $ev = $queue->enqueue_marker 974=item $ev = $queue->enqueue_marker ($wait_events...)
426 975
427L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 976L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
428 977
978=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
979
980Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
981for subsequent OpenCL usage.
982
983L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
984
985=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
986
987Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
988for subsequent OpenGL usage.
989
990L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
991
429=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 992=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
430 993
431L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 994L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
432 995
433=item $queue->enqueue_barrier 996=item $queue->enqueue_barrier
440 1003
441=item $queue->finish 1004=item $queue->finish
442 1005
443L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1006L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
444 1007
1008=item $packed_value = $queue->info ($name)
1009
1010See C<< $platform->info >> for details.
1011
1012L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1013
1014=for gengetinfo begin command_queue
1015
1016=item $ctx = $command_queue->context
1017
1018Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1019
1020=item $device = $command_queue->device
1021
1022Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1023
1024=item $uint = $command_queue->reference_count
1025
1026Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1027
1028=item $command_queue_properties = $command_queue->properties
1029
1030Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1031
1032=for gengetinfo end command_queue
1033
445=back 1034=back
446 1035
447=head2 THE OpenCL::Memory CLASS 1036=head2 THE OpenCL::Memory CLASS
448 1037
449This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1038This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
450OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1039OpenCL::Image2D and OpenCL::Image3D.
451currently only exist to allow type-checking.
452 1040
453=over 4 1041=over 4
454 1042
455=item $packed_value = $memory->info ($name) 1043=item $packed_value = $memory->info ($name)
456 1044
457See C<< $platform->info >> for details. 1045See C<< $platform->info >> for details.
458 1046
459L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1047L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
460 1048
1049=for gengetinfo begin mem
1050
1051=item $mem_object_type = $mem->type
1052
1053Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1054
1055=item $mem_flags = $mem->flags
1056
1057Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1058
1059=item $int = $mem->size
1060
1061Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1062
1063=item $ptr_value = $mem->host_ptr
1064
1065Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1066
1067=item $uint = $mem->map_count
1068
1069Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1070
1071=item $uint = $mem->reference_count
1072
1073Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1074
1075=item $ctx = $mem->context
1076
1077Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1078
1079=item $mem = $mem->associated_memobject
1080
1081Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1082
1083=item $int = $mem->offset
1084
1085Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1086
1087=for gengetinfo end mem
1088
1089=item ($type, $name) = $mem->gl_object_info
1090
1091Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1092object "name" (e.g. the texture name) used to create this memory object.
1093
1094L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1095
461=back 1096=back
462 1097
1098=head2 THE OpenCL::Buffer CLASS
1099
1100This is a subclass of OpenCL::Memory, and the superclass of
1101OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1102and sub-buffers.
1103
1104=head2 THE OpenCL::BufferObj CLASS
1105
1106This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1107because one cna create sub buffers of OpenLC::BufferObj objects, but not
1108sub buffers from these sub buffers.
1109
1110=over 4
1111
1112=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1113
1114Creates an OpenCL::Buffer objects from this buffer and returns it. The
1115C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1116
1117L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1118
1119=back
1120
1121=head2 THE OpenCL::Image CLASS
1122
1123This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
1124
1125=over 4
1126
1127=item $packed_value = $ev->image_info ($name)
1128
1129See C<< $platform->info >> for details.
1130
1131The reason this method is not called C<info> is that there already is an
1132C<< ->info >> method inherited from C<OpenCL::Memory>.
1133
1134L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1135
1136=for gengetinfo begin image
1137
1138=item $int = $image->element_size
1139
1140Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1141
1142=item $int = $image->row_pitch
1143
1144Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1145
1146=item $int = $image->slice_pitch
1147
1148Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1149
1150=item $int = $image->width
1151
1152Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1153
1154=item $int = $image->height
1155
1156Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1157
1158=item $int = $image->depth
1159
1160Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1161
1162=for gengetinfo end image
1163
1164=for gengetinfo begin gl_texture
1165
1166=item $GLenum = $gl_texture->target
1167
1168Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1169
1170=item $GLint = $gl_texture->gl_mipmap_level
1171
1172Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1173
1174=for gengetinfo end gl_texture
1175
1176=back
1177
463=head2 THE OpenCL::Sampler CLASS 1178=head2 THE OpenCL::Sampler CLASS
464 1179
465=over 4 1180=over 4
466 1181
467=item $packed_value = $sampler->info ($name) 1182=item $packed_value = $sampler->info ($name)
468 1183
469See C<< $platform->info >> for details. 1184See C<< $platform->info >> for details.
470 1185
471L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1186L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
472 1187
1188=for gengetinfo begin sampler
1189
1190=item $uint = $sampler->reference_count
1191
1192Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1193
1194=item $ctx = $sampler->context
1195
1196Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1197
1198=item $addressing_mode = $sampler->normalized_coords
1199
1200Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1201
1202=item $filter_mode = $sampler->addressing_mode
1203
1204Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1205
1206=item $boolean = $sampler->filter_mode
1207
1208Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1209
1210=for gengetinfo end sampler
1211
473=back 1212=back
474 1213
475=head2 THE OpenCL::Program CLASS 1214=head2 THE OpenCL::Program CLASS
476 1215
477=over 4 1216=over 4
478
479=item $packed_value = $program->info ($name)
480
481See C<< $platform->info >> for details.
482
483L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
484 1217
485=item $program->build ($device, $options = "") 1218=item $program->build ($device, $options = "")
486 1219
487Tries to build the program with the givne options. 1220Tries to build the program with the givne options.
488 1221
500Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1233Creates an OpenCL::Kernel object out of the named C<__kernel> function in
501the program. 1234the program.
502 1235
503L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1236L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
504 1237
1238=for gengetinfo begin program_build
1239
1240=item $build_status = $program->build_status ($device)
1241
1242Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1243
1244=item $string = $program->build_options ($device)
1245
1246Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1247
1248=item $string = $program->build_log ($device)
1249
1250Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1251
1252=for gengetinfo end program_build
1253
1254=item $packed_value = $program->info ($name)
1255
1256See C<< $platform->info >> for details.
1257
1258L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1259
1260=for gengetinfo begin program
1261
1262=item $uint = $program->reference_count
1263
1264Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1265
1266=item $ctx = $program->context
1267
1268Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1269
1270=item $uint = $program->num_devices
1271
1272Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1273
1274=item @devices = $program->devices
1275
1276Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1277
1278=item $string = $program->source
1279
1280Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1281
1282=item @ints = $program->binary_sizes
1283
1284Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1285
1286=for gengetinfo end program
1287
1288=item @blobs = $program->binaries
1289
1290Returns a string for the compiled binary for every device associated with
1291the program, empty strings indicate missing programs, and an empty result
1292means no program binaries are available.
1293
1294These "binaries" are often, in fact, informative low-level assembly
1295sources.
1296
1297L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1298
505=back 1299=back
506 1300
507=head2 THE OpenCL::Kernel CLASS 1301=head2 THE OpenCL::Kernel CLASS
508 1302
509=over 4 1303=over 4
511=item $packed_value = $kernel->info ($name) 1305=item $packed_value = $kernel->info ($name)
512 1306
513See C<< $platform->info >> for details. 1307See C<< $platform->info >> for details.
514 1308
515L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1309L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1310
1311=for gengetinfo begin kernel
1312
1313=item $string = $kernel->function_name
1314
1315Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1316
1317=item $uint = $kernel->num_args
1318
1319Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1320
1321=item $uint = $kernel->reference_count
1322
1323Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1324
1325=item $ctx = $kernel->context
1326
1327Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1328
1329=item $program = $kernel->program
1330
1331Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1332
1333=for gengetinfo end kernel
1334
1335=item $packed_value = $kernel->work_group_info ($device, $name)
1336
1337See C<< $platform->info >> for details.
1338
1339The reason this method is not called C<info> is that there already is an
1340C<< ->info >> method.
1341
1342L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1343
1344=for gengetinfo begin kernel_work_group
1345
1346=item $int = $kernel->work_group_size ($device)
1347
1348Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1349
1350=item @ints = $kernel->compile_work_group_size ($device)
1351
1352Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1353
1354=item $ulong = $kernel->local_mem_size ($device)
1355
1356Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1357
1358=item $int = $kernel->preferred_work_group_size_multiple ($device)
1359
1360Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1361
1362=item $ulong = $kernel->private_mem_size ($device)
1363
1364Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1365
1366=for gengetinfo end kernel_work_group
516 1367
517=item $kernel->set_TYPE ($index, $value) 1368=item $kernel->set_TYPE ($index, $value)
518 1369
519This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1370This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
520 1371
536This is the superclass for all event objects (including OpenCL::UserEvent 1387This is the superclass for all event objects (including OpenCL::UserEvent
537objects). 1388objects).
538 1389
539=over 4 1390=over 4
540 1391
1392=item $ev->wait
1393
1394Waits for the event to complete.
1395
1396L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1397
541=item $packed_value = $ev->info ($name) 1398=item $packed_value = $ev->info ($name)
542 1399
543See C<< $platform->info >> for details. 1400See C<< $platform->info >> for details.
544 1401
545L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1402L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
546 1403
547=item $ev->wait 1404=for gengetinfo begin event
548 1405
549Waits for the event to complete. 1406=item $queue = $event->command_queue
550 1407
1408Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1409
1410=item $command_type = $event->command_type
1411
1412Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1413
1414=item $uint = $event->reference_count
1415
1416Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1417
1418=item $uint = $event->command_execution_status
1419
1420Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1421
1422=item $ctx = $event->context
1423
1424Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1425
1426=for gengetinfo end event
1427
1428=item $packed_value = $ev->profiling_info ($name)
1429
1430See C<< $platform->info >> for details.
1431
1432The reason this method is not called C<info> is that there already is an
1433C<< ->info >> method.
1434
551L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1435L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1436
1437=for gengetinfo begin profiling
1438
1439=item $ulong = $event->profiling_command_queued
1440
1441Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1442
1443=item $ulong = $event->profiling_command_submit
1444
1445Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1446
1447=item $ulong = $event->profiling_command_start
1448
1449Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1450
1451=item $ulong = $event->profiling_command_end
1452
1453Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1454
1455=for gengetinfo end profiling
552 1456
553=back 1457=back
554 1458
555=head2 THE OpenCL::UserEvent CLASS 1459=head2 THE OpenCL::UserEvent CLASS
556 1460
569package OpenCL; 1473package OpenCL;
570 1474
571use common::sense; 1475use common::sense;
572 1476
573BEGIN { 1477BEGIN {
574 our $VERSION = '0.03'; 1478 our $VERSION = '0.95';
575 1479
576 require XSLoader; 1480 require XSLoader;
577 XSLoader::load (__PACKAGE__, $VERSION); 1481 XSLoader::load (__PACKAGE__, $VERSION);
578 1482
579 @OpenCL::Buffer::ISA = 1483 @OpenCL::Buffer::ISA =
580 @OpenCL::Image::ISA = OpenCL::Memory::; 1484 @OpenCL::Image::ISA = OpenCL::Memory::;
581 1485
1486 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1487
582 @OpenCL::Image2D::ISA = 1488 @OpenCL::Image2D::ISA =
583 @OpenCL::Image3D::ISA = OpenCL::Image::; 1489 @OpenCL::Image3D::ISA = OpenCL::Image::;
584 1490
585 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1491 @OpenCL::UserEvent::ISA = OpenCL::Event::;
586} 1492}
587 1493
5881; 14941;
589 1495
590=head1 AUTHOR 1496=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines