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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.10 by root, Thu Nov 17 02:10:39 2011 UTC vs.
Revision 1.45 by root, Sat Apr 21 17:50:27 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines