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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.13 by root, Thu Nov 17 03:01:35 2011 UTC vs.
Revision 1.49 by root, Sat Apr 21 20:48:03 2012 UTC

27OpenCL::Program objects, which store source code and, after building for a 27OpenCL::Program objects, which store source code and, after building for a
28specific device ("compiling and linking"), also binary programs. For each 28specific device ("compiling and linking"), also binary programs. For each
29kernel function in a program you can then create an OpenCL::Kernel object 29kernel function in a program you can then create an OpenCL::Kernel object
30which represents basically 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 (refer to the 73To get something done, you basically have to do this once (refer to the
60examples below for actual code, this is just a high-level description): 74examples below for actual code, this is just a high-level description):
61 75
87 101
88Best run this once to get a feel for the platforms and devices in your 102Best run this once to get a feel for the platforms and devices in your
89system. 103system.
90 104
91 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
92 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 106 printf "platform: %s\n", $platform->name;
93 printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); 107 printf "extensions: %s\n", $platform->extensions;
94 for my $device ($platform->devices) { 108 for my $device ($platform->devices) {
95 printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); 109 printf "+ device: %s\n", $device->name;
96 my $ctx = $device->context; 110 my $ctx = $platform->context (undef, [$device]);
97 # do stuff 111 # do stuff
98 } 112 }
99 } 113 }
100 114
101=head2 Get a useful context and a command queue. 115=head2 Get a useful context and a command queue.
135 149
136=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
137functions. 151functions.
138 152
139 my $src = ' 153 my $src = '
140 __kernel void 154 kernel void
141 squareit (__global float *input, __global float *output) 155 squareit (global float *input, global float *output)
142 { 156 {
143 size_t id = get_global_id (0); 157 $id = get_global_id (0);
144 output [id] = input [id] * input [id]; 158 output [id] = input [id] * input [id];
145 } 159 }
146 '; 160 ';
147 161
148 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->program_with_source ($src);
149 163
150 # build croaks on compile errors, so catch it and print the compile errors 164 # build croaks on compile errors, so catch it and print the compile errors
151 eval { $prog->build ($dev); 1 } 165 eval { $prog->build ($dev, "-cl-fast-relaxed-math"); 1 }
152 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG); 166 or die $prog->build_log;
153 167
154 my $kernel = $prog->kernel ("squareit"); 168 my $kernel = $prog->kernel ("squareit");
155 169
156=head2 Create some input and output float buffers, then call the 170=head2 Create some input and output float buffers, then call the
157'squareit' kernel on them. 171'squareit' kernel on them.
197 $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);
198 212
199 # wait for the last event to complete 213 # wait for the last event to complete
200 $ev->wait; 214 $ev->wait;
201 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
202=head1 DOCUMENTATION 311=head1 DOCUMENTATION
203 312
204=head2 BASIC CONVENTIONS 313=head2 BASIC CONVENTIONS
205 314
206This 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
207attempted to make the interface as type-safe as possible and introducing 316I attempted to make the interface as type-safe as possible by introducing
208object syntax where it makes sense. There are a number of important 317object syntax where it makes sense. There are a number of important
209differences between the OpenCL C API and this module: 318differences between the OpenCL C API and this module:
210 319
211=over 4 320=over 4
212 321
213=item * Object lifetime managament is automatic - there is no need 322=item * Object lifetime managament is automatic - there is no need
214to free objects explicitly (C<clReleaseXXX>), the release function 323to free objects explicitly (C<clReleaseXXX>), the release function
215is called automatically once all Perl references to it go away. 324is called automatically once all Perl references to it go away.
216 325
217=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
218while this module uses underscores as word separator and often leaves out 328uses underscores as word separator and often leaves out prefixes
219prefixes (C<< $platform->info >>). 329(C<OpenCL::platforms>, C<< $platform->info >>).
220 330
221=item * OpenCL often specifies fixed vector function arguments as short 331=item * OpenCL often specifies fixed vector function arguments as short
222arrays (C<size_t origin[3]>), while this module explicitly expects the 332arrays (C<size_t origin[3]>), while this module explicitly expects the
223components as separate arguments- 333components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
334function calls.
224 335
225=item * Structures are often specified with their components, and returned 336=item * Structures are often specified by flattening out their components
226as arrayrefs. 337as with short vectors, and returned as arrayrefs.
227
228=item * Where possible, one of the pitch values is calculated from the
229perl scalar length and need not be specified.
230 338
231=item * When enqueuing commands, the wait list is specified by adding 339=item * When enqueuing commands, the wait list is specified by adding
232extra arguments to the function - anywhere a C<$wait_events...> argument 340extra arguments to the function - anywhere a C<$wait_events...> argument
233is 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.
234 344
235=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
236context, 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
237by the method. 347by the method.
238 348
258 ulong IV - Q 368 ulong IV - Q
259 float NV float f 369 float NV float f
260 half IV ushort S 370 half IV ushort S
261 double NV double d 371 double NV double d
262 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
263=head2 THE OpenCL PACKAGE 388=head2 THE OpenCL PACKAGE
264 389
265=over 4 390=over 4
266 391
267=item $int = OpenCL::errno 392=item $int = OpenCL::errno
273 398
274Comverts an error value into a human readable string. 399Comverts an error value into a human readable string.
275 400
276=item $str = OpenCL::enum2str $enum 401=item $str = OpenCL::enum2str $enum
277 402
278Converts most enum values (inof parameter names, image format constants, 403Converts most enum values (of parameter names, image format constants,
279object types, addressing and filter modes, command types etc.) into a 404object types, addressing and filter modes, command types etc.) into a
280human readbale string. When confronted with some random integer it can be 405human readable string. When confronted with some random integer it can be
281very 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
282string out of it. 407string out of it.
283 408
284=item @platforms = OpenCL::platforms 409=item @platforms = OpenCL::platforms
285 410
303 428
304=head2 THE OpenCL::Platform CLASS 429=head2 THE OpenCL::Platform CLASS
305 430
306=over 4 431=over 4
307 432
308=item $packed_value = $platform->info ($name)
309
310Calls C<clGetPlatformInfo> and returns the packed, raw value - for
311strings, this will be the string, for other values you probably need to
312use the correct C<unpack>. This might get improved in the future. Hopefully.
313
314L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
315
316=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 433=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
317 434
318Returns a list of matching OpenCL::Device objects. 435Returns a list of matching OpenCL::Device objects.
319 436
320=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 437=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
321 438
322Tries to create a context. Never worked for me, and you need devices explitly anyway. 439Tries to create a context. Never worked for me, and you need devices explicitly anyway.
323 440
324L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 441L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
325 442
326=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 443=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
327 444
328Create a new OpenCL::Context object using the given device object(s)- a 445Create a new OpenCL::Context object using the given device object(s)- a
329CL_CONTEXT_PLATFORM property is supplied automatically. 446CL_CONTEXT_PLATFORM property is supplied automatically.
330 447
331L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 448L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
332 449
450=item $packed_value = $platform->info ($name)
451
452Calls C<clGetPlatformInfo> and returns the packed, raw value - for
453strings, this will be the string (possibly including terminating \0), for
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.
458
459L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
460
461=for gengetinfo begin platform
462
463=item $string = $platform->profile
464
465Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
466
467=item $string = $platform->version
468
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
484
333=back 485=back
334 486
335=head2 THE OpenCL::Device CLASS 487=head2 THE OpenCL::Device CLASS
336 488
337=over 4 489=over 4
340 492
341See C<< $platform->info >> for details. 493See C<< $platform->info >> for details.
342 494
343L<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>
344 496
497=for gengetinfo begin device
498
499=item $device_type = $device->type
500
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
764
345=back 765=back
346 766
347=head2 THE OpenCL::Context CLASS 767=head2 THE OpenCL::Context CLASS
348 768
349=over 4 769=over 4
350 770
351=item $packed_value = $ctx->info ($name)
352
353See C<< $platform->info >> for details.
354
355L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
356
357=item $queue = $ctx->queue ($device, $properties) 771=item $queue = $ctx->queue ($device, $properties)
358 772
359Create 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.
360 774
361L<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>
362 776
777Example: create an out-of-order queue.
778
779 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
780
363=item $ev = $ctx->user_event 781=item $ev = $ctx->user_event
364 782
365Creates a new OpenCL::UserEvent object. 783Creates a new OpenCL::UserEvent object.
366 784
367L<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>
368 786
369=item $buf = $ctx->buffer ($flags, $len) 787=item $buf = $ctx->buffer ($flags, $len)
370 788
371Creates 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.
372 791
373L<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>
374 793
375=item $buf = $ctx->buffer_sv ($flags, $data) 794=item $buf = $ctx->buffer_sv ($flags, $data)
376 795
377Creates 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.
378 798
799=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
800
801Creates a new OpenCL::Image object and optionally initialises it with
802the given data values.
803
804L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
805
379=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 806=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
380 807
381Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 808Creates a new OpenCL::Image2D object and optionally initialises it with
809the given data values.
382 810
383L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 811L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
384 812
385=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 813=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
386 814
387Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 815Creates a new OpenCL::Image3D object and optionally initialises it with
816the given data values.
388 817
389L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 818L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
819
820=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
821
822Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
823OpenGL buffer object.
824
825http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
826
827=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
828
829Creates a new OpenCL::Image object that refers to the given OpenGL
830texture object or buffer.
831
832http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
833
834=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
835
836Creates a new OpenCL::Image2D object that refers to the given OpenGL
8372D texture object.
838
839http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
840
841=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
842
843Creates a new OpenCL::Image3D object that refers to the given OpenGL
8443D texture object.
845
846http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
847
848=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
849
850Creates a new OpenCL::Image2D object that refers to the given OpenGL
851render buffer.
852
853http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
390 854
391=item @formats = $ctx->supported_image_formats ($flags, $image_type) 855=item @formats = $ctx->supported_image_formats ($flags, $image_type)
392 856
393Returns a list of matching image formats - each format is an arrayref with 857Returns a list of matching image formats - each format is an arrayref with
394two values, $channel_order and $channel_type, in it. 858two values, $channel_order and $channel_type, in it.
404=item $program = $ctx->program_with_source ($string) 868=item $program = $ctx->program_with_source ($string)
405 869
406Creates a new OpenCL::Program object from the given source code. 870Creates a new OpenCL::Program object from the given source code.
407 871
408L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 872L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
873
874=item $packed_value = $ctx->info ($name)
875
876See C<< $platform->info >> for details.
877
878L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
879
880=for gengetinfo begin context
881
882=item $uint = $context->reference_count
883
884Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
885
886=item @devices = $context->devices
887
888Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
889
890=item @property_ints = $context->properties
891
892Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
893
894=item $uint = $context->num_devices
895
896Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
897
898=for gengetinfo end context
409 899
410=back 900=back
411 901
412=head2 THE OpenCL::Queue CLASS 902=head2 THE OpenCL::Queue CLASS
413 903
419for completion, unless the method is called in void context, in which case 909for completion, unless the method is called in void context, in which case
420no event object is created. 910no event object is created.
421 911
422They also allow you to specify any number of other event objects that this 912They also allow you to specify any number of other event objects that this
423request has to wait for before it starts executing, by simply passing the 913request has to wait for before it starts executing, by simply passing the
424event objects as extra parameters to the enqueue methods. 914event objects as extra parameters to the enqueue methods. To simplify
915program design, this module ignores any C<undef> values in the list of
916events. This makes it possible to code operations such as this, without
917having to put a valid event object into C<$event> first:
918
919 $event = $queue->enqueue_xxx (..., $event);
425 920
426Queues execute in-order by default, without any parallelism, so in most 921Queues execute in-order by default, without any parallelism, so in most
427cases (i.e. you use only one queue) it's not necessary to wait for or 922cases (i.e. you use only one queue) it's not necessary to wait for or
428create event objects. 923create event objects, althoguh an our of order queue is often a bit
924faster.
429 925
430=over 4 926=over 4
431 927
432=item $packed_value = $ctx->info ($name)
433
434See C<< $platform->info >> for details.
435
436L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
437
438=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 928=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
439 929
440Reads data from buffer into the given string. 930Reads data from buffer into the given string.
441 931
442L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 932L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
449 939
450=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 940=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
451 941
452L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 942L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
453 943
944=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...)
945
946http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
947
948=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...)
949
950http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
951
454=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 952=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
455 953
954L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
955
956=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...)
957
456L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 958L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
457 959
458=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 960=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
459 961
460L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 962L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
461 963
964=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...)
965
966L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
967
968=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...)
969
970L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
971
462=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...) 972=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...)
463 973
464Yeah. 974Yeah.
465 975
466L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
467
468=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, ...)
469
470L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 976L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
471
472=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, ...)
473
474L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
475
476=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, ...)
477
478L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
479 977
480=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 978=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
481 979
482L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 980L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
483 981
497reference to an array of local work sizes, with the same number of 995reference to an array of local work sizes, with the same number of
498elements as @$global_work_size. 996elements as @$global_work_size.
499 997
500L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 998L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
501 999
502=item $ev = $queue->enqueue_marker 1000=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
503 1001
1002Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1003for subsequent OpenCL usage.
1004
504L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1005L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1006
1007=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1008
1009Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1010for subsequent OpenGL usage.
1011
1012L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
505 1013
506=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1014=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
507 1015
508L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1016L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
509 1017
510=item $queue->enqueue_barrier 1018=item $ev = $queue->enqueue_marker ($wait_events...)
511 1019
1020L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1021
1022=item $ev = $queue->enqueue_barrier ($wait_events...)
1023
512L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1024L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
513 1025
514=item $queue->flush 1026=item $queue->flush
515 1027
516L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1028L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
517 1029
518=item $queue->finish 1030=item $queue->finish
519 1031
520L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1032L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
521 1033
1034=item $packed_value = $queue->info ($name)
1035
1036See C<< $platform->info >> for details.
1037
1038L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1039
1040=for gengetinfo begin command_queue
1041
1042=item $ctx = $command_queue->context
1043
1044Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1045
1046=item $device = $command_queue->device
1047
1048Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1049
1050=item $uint = $command_queue->reference_count
1051
1052Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1053
1054=item $command_queue_properties = $command_queue->properties
1055
1056Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1057
1058=for gengetinfo end command_queue
1059
522=back 1060=back
523 1061
524=head2 THE OpenCL::Memory CLASS 1062=head2 THE OpenCL::Memory CLASS
525 1063
526This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1064This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
527OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1065OpenCL::Image2D and OpenCL::Image3D.
528currently only exist to allow type-checking.
529 1066
530=over 4 1067=over 4
531 1068
532=item $packed_value = $memory->info ($name) 1069=item $packed_value = $memory->info ($name)
533 1070
534See C<< $platform->info >> for details. 1071See C<< $platform->info >> for details.
535 1072
536L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1073L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
537 1074
1075=for gengetinfo begin mem
1076
1077=item $mem_object_type = $mem->type
1078
1079Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1080
1081=item $mem_flags = $mem->flags
1082
1083Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1084
1085=item $int = $mem->size
1086
1087Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1088
1089=item $ptr_value = $mem->host_ptr
1090
1091Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1092
1093=item $uint = $mem->map_count
1094
1095Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1096
1097=item $uint = $mem->reference_count
1098
1099Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1100
1101=item $ctx = $mem->context
1102
1103Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1104
1105=item $mem = $mem->associated_memobject
1106
1107Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1108
1109=item $int = $mem->offset
1110
1111Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1112
1113=for gengetinfo end mem
1114
1115=item ($type, $name) = $mem->gl_object_info
1116
1117Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1118object "name" (e.g. the texture name) used to create this memory object.
1119
1120L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1121
538=back 1122=back
539 1123
1124=head2 THE OpenCL::Buffer CLASS
1125
1126This is a subclass of OpenCL::Memory, and the superclass of
1127OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1128and sub-buffers.
1129
1130=head2 THE OpenCL::BufferObj CLASS
1131
1132This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1133because one cna create sub buffers of OpenLC::BufferObj objects, but not
1134sub buffers from these sub buffers.
1135
1136=over 4
1137
1138=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1139
1140Creates an OpenCL::Buffer objects from this buffer and returns it. The
1141C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1142
1143L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1144
1145=back
1146
1147=head2 THE OpenCL::Image CLASS
1148
1149This is the superclass of all image objects - OpenCL::Image1D,
1150OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1151OpenCL::Image2DArray and OpenCL::Image3D.
1152
1153=over 4
1154
1155=item $packed_value = $ev->image_info ($name)
1156
1157See C<< $platform->info >> for details.
1158
1159The reason this method is not called C<info> is that there already is an
1160C<< ->info >> method inherited from C<OpenCL::Memory>.
1161
1162L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1163
1164=for gengetinfo begin image
1165
1166=item $int = $image->element_size
1167
1168Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1169
1170=item $int = $image->row_pitch
1171
1172Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1173
1174=item $int = $image->slice_pitch
1175
1176Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1177
1178=item $int = $image->width
1179
1180Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1181
1182=item $int = $image->height
1183
1184Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1185
1186=item $int = $image->depth
1187
1188Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1189
1190=for gengetinfo end image
1191
1192=for gengetinfo begin gl_texture
1193
1194=item $GLenum = $gl_texture->target
1195
1196Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1197
1198=item $GLint = $gl_texture->gl_mipmap_level
1199
1200Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1201
1202=for gengetinfo end gl_texture
1203
1204=back
1205
540=head2 THE OpenCL::Sampler CLASS 1206=head2 THE OpenCL::Sampler CLASS
541 1207
542=over 4 1208=over 4
543 1209
544=item $packed_value = $sampler->info ($name) 1210=item $packed_value = $sampler->info ($name)
545 1211
546See C<< $platform->info >> for details. 1212See C<< $platform->info >> for details.
547 1213
548L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1214L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
549 1215
1216=for gengetinfo begin sampler
1217
1218=item $uint = $sampler->reference_count
1219
1220Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1221
1222=item $ctx = $sampler->context
1223
1224Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1225
1226=item $addressing_mode = $sampler->normalized_coords
1227
1228Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1229
1230=item $filter_mode = $sampler->addressing_mode
1231
1232Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1233
1234=item $boolean = $sampler->filter_mode
1235
1236Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1237
1238=for gengetinfo end sampler
1239
550=back 1240=back
551 1241
552=head2 THE OpenCL::Program CLASS 1242=head2 THE OpenCL::Program CLASS
553 1243
554=over 4 1244=over 4
555
556=item $packed_value = $program->info ($name)
557
558See C<< $platform->info >> for details.
559
560L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
561 1245
562=item $program->build ($device, $options = "") 1246=item $program->build ($device, $options = "")
563 1247
564Tries to build the program with the givne options. 1248Tries to build the program with the givne options.
565 1249
577Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1261Creates an OpenCL::Kernel object out of the named C<__kernel> function in
578the program. 1262the program.
579 1263
580L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1264L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
581 1265
1266=for gengetinfo begin program_build
1267
1268=item $build_status = $program->build_status ($device)
1269
1270Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1271
1272=item $string = $program->build_options ($device)
1273
1274Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1275
1276=item $string = $program->build_log ($device)
1277
1278Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1279
1280=for gengetinfo end program_build
1281
1282=item $packed_value = $program->info ($name)
1283
1284See C<< $platform->info >> for details.
1285
1286L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1287
1288=for gengetinfo begin program
1289
1290=item $uint = $program->reference_count
1291
1292Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1293
1294=item $ctx = $program->context
1295
1296Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1297
1298=item $uint = $program->num_devices
1299
1300Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1301
1302=item @devices = $program->devices
1303
1304Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1305
1306=item $string = $program->source
1307
1308Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1309
1310=item @ints = $program->binary_sizes
1311
1312Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1313
1314=for gengetinfo end program
1315
1316=item @blobs = $program->binaries
1317
1318Returns a string for the compiled binary for every device associated with
1319the program, empty strings indicate missing programs, and an empty result
1320means no program binaries are available.
1321
1322These "binaries" are often, in fact, informative low-level assembly
1323sources.
1324
1325L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1326
582=back 1327=back
583 1328
584=head2 THE OpenCL::Kernel CLASS 1329=head2 THE OpenCL::Kernel CLASS
585 1330
586=over 4 1331=over 4
588=item $packed_value = $kernel->info ($name) 1333=item $packed_value = $kernel->info ($name)
589 1334
590See C<< $platform->info >> for details. 1335See C<< $platform->info >> for details.
591 1336
592L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1337L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1338
1339=for gengetinfo begin kernel
1340
1341=item $string = $kernel->function_name
1342
1343Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1344
1345=item $uint = $kernel->num_args
1346
1347Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1348
1349=item $uint = $kernel->reference_count
1350
1351Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1352
1353=item $ctx = $kernel->context
1354
1355Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1356
1357=item $program = $kernel->program
1358
1359Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1360
1361=for gengetinfo end kernel
1362
1363=item $packed_value = $kernel->work_group_info ($device, $name)
1364
1365See C<< $platform->info >> for details.
1366
1367The reason this method is not called C<info> is that there already is an
1368C<< ->info >> method.
1369
1370L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1371
1372=for gengetinfo begin kernel_work_group
1373
1374=item $int = $kernel->work_group_size ($device)
1375
1376Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1377
1378=item @ints = $kernel->compile_work_group_size ($device)
1379
1380Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1381
1382=item $ulong = $kernel->local_mem_size ($device)
1383
1384Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1385
1386=item $int = $kernel->preferred_work_group_size_multiple ($device)
1387
1388Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1389
1390=item $ulong = $kernel->private_mem_size ($device)
1391
1392Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1393
1394=for gengetinfo end kernel_work_group
593 1395
594=item $kernel->set_TYPE ($index, $value) 1396=item $kernel->set_TYPE ($index, $value)
595 1397
596This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1398This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
597 1399
598TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1400TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
599C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1401C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
600C<image2d>, C<image3d>, C<sampler> or C<event>. 1402C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
601 1403
602Chars and integers (including the half type) are specified as integers, 1404Chars and integers (including the half type) are specified as integers,
603float and double as floating point values, memory/buffer/image2d/image3d 1405float and double as floating point values, memory/buffer/image2d/image3d
604must be an object of that type or C<undef>, and sampler and event must be 1406must be an object of that type or C<undef>, local-memory arguments are
605objects of that type. 1407set by specifying the size, and sampler and event must be objects of that
1408type.
606 1409
607L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1410L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
608 1411
609=back 1412=back
610 1413
613This is the superclass for all event objects (including OpenCL::UserEvent 1416This is the superclass for all event objects (including OpenCL::UserEvent
614objects). 1417objects).
615 1418
616=over 4 1419=over 4
617 1420
1421=item $ev->wait
1422
1423Waits for the event to complete.
1424
1425L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1426
618=item $packed_value = $ev->info ($name) 1427=item $packed_value = $ev->info ($name)
619 1428
620See C<< $platform->info >> for details. 1429See C<< $platform->info >> for details.
621 1430
622L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1431L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
623 1432
624=item $ev->wait 1433=for gengetinfo begin event
625 1434
626Waits for the event to complete. 1435=item $queue = $event->command_queue
627 1436
1437Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1438
1439=item $command_type = $event->command_type
1440
1441Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1442
1443=item $uint = $event->reference_count
1444
1445Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1446
1447=item $uint = $event->command_execution_status
1448
1449Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1450
1451=item $ctx = $event->context
1452
1453Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1454
1455=for gengetinfo end event
1456
1457=item $packed_value = $ev->profiling_info ($name)
1458
1459See C<< $platform->info >> for details.
1460
1461The reason this method is not called C<info> is that there already is an
1462C<< ->info >> method.
1463
628L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1464L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1465
1466=for gengetinfo begin profiling
1467
1468=item $ulong = $event->profiling_command_queued
1469
1470Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1471
1472=item $ulong = $event->profiling_command_submit
1473
1474Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1475
1476=item $ulong = $event->profiling_command_start
1477
1478Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1479
1480=item $ulong = $event->profiling_command_end
1481
1482Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1483
1484=for gengetinfo end profiling
629 1485
630=back 1486=back
631 1487
632=head2 THE OpenCL::UserEvent CLASS 1488=head2 THE OpenCL::UserEvent CLASS
633 1489
646package OpenCL; 1502package OpenCL;
647 1503
648use common::sense; 1504use common::sense;
649 1505
650BEGIN { 1506BEGIN {
651 our $VERSION = '0.14'; 1507 our $VERSION = '0.96';
652 1508
653 require XSLoader; 1509 require XSLoader;
654 XSLoader::load (__PACKAGE__, $VERSION); 1510 XSLoader::load (__PACKAGE__, $VERSION);
655 1511
656 @OpenCL::Buffer::ISA = 1512 @OpenCL::Buffer::ISA =
657 @OpenCL::Image::ISA = OpenCL::Memory::; 1513 @OpenCL::Image::ISA = OpenCL::Memory::;
658 1514
1515 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1516
659 @OpenCL::Image2D::ISA = 1517 @OpenCL::Image2D::ISA =
1518 @OpenCL::Image3D::ISA =
1519 @OpenCL::Image2DArray::ISA =
1520 @OpenCL::Image1D::ISA =
1521 @OpenCL::Image1DArray::ISA =
660 @OpenCL::Image3D::ISA = OpenCL::Image::; 1522 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
661 1523
662 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1524 @OpenCL::UserEvent::ISA = OpenCL::Event::;
663} 1525}
664 1526
6651; 15271;
666 1528
667=head1 AUTHOR 1529=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines