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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.16 by root, Thu Nov 17 03:42:03 2011 UTC vs.
Revision 1.51 by root, Tue Apr 24 13:45:58 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 arrays or structs) and OpenCL::Image objects (think 2d 33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34or 3d array) 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.
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
57Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it 62Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
58is, but at least it's free of charge: 63is, but at least it's free of charge:
59 64
60 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf 65 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
61 66
62If you are into UML class diagrams, the following diagram might help - if 67And here's NVIDIA's OpenCL Best Practises Guide:
63not, it will be mildly cofusing:
64 68
65 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html 69 http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
66 70
67=head1 BASIC WORKFLOW 71=head1 BASIC WORKFLOW
68 72
69To 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
70examples below for actual code, this is just a high-level description): 74examples below for actual code, this is just a high-level description):
97 101
98Best 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
99system. 103system.
100 104
101 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
102 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 106 printf "platform: %s\n", $platform->name;
103 printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); 107 printf "extensions: %s\n", $platform->extensions;
104 for my $device ($platform->devices) { 108 for my $device ($platform->devices) {
105 printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); 109 printf "+ device: %s\n", $device->name;
106 my $ctx = $device->context; 110 my $ctx = $platform->context (undef, [$device]);
107 # do stuff 111 # do stuff
108 } 112 }
109 } 113 }
110 114
111=head2 Get a useful context and a command queue. 115=head2 Get a useful context and a command queue.
145 149
146=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
147functions. 151functions.
148 152
149 my $src = ' 153 my $src = '
150 __kernel void 154 kernel void
151 squareit (__global float *input, __global float *output) 155 squareit (global float *input, global float *output)
152 { 156 {
153 $id = get_global_id (0); 157 $id = get_global_id (0);
154 output [id] = input [id] * input [id]; 158 output [id] = input [id] * input [id];
155 } 159 }
156 '; 160 ';
157 161
158 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->build_program ($src);
159
160 # build croaks on compile errors, so catch it and print the compile errors
161 eval { $prog->build ($dev); 1 }
162 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
163
164 my $kernel = $prog->kernel ("squareit"); 163 my $kernel = $prog->kernel ("squareit");
165 164
166=head2 Create some input and output float buffers, then call the 165=head2 Create some input and output float buffers, then call the
167'squareit' kernel on them. 166'squareit' kernel on them.
168 167
206 # enqueue an async read 205 # enqueue an async read
207 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 206 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
208 207
209 # wait for the last event to complete 208 # wait for the last event to complete
210 $ev->wait; 209 $ev->wait;
210
211=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
212set tunnel effect.
213
214This is quite a long example to get you going.
215
216 use OpenGL ":all";
217 use OpenCL;
218
219 # open a window and create a gl texture
220 OpenGL::glpOpenWindow width => 256, height => 256;
221 my $texid = glGenTextures_p 1;
222 glBindTexture GL_TEXTURE_2D, $texid;
223 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
224
225 # find and use the first opencl device that let's us get a shared opengl context
226 my $platform;
227 my $dev;
228 my $ctx;
229
230 for (OpenCL::platforms) {
231 $platform = $_;
232 for ($platform->devices) {
233 $dev = $_;
234 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
235 and last;
236 }
237 }
238
239 $ctx
240 or die "cannot find suitable OpenCL device\n";
241
242 my $queue = $ctx->queue ($dev);
243
244 # now attach an opencl image2d object to the opengl texture
245 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
246
247 # now the boring opencl code
248 my $src = <<EOF;
249 kernel void
250 juliatunnel (write_only image2d_t img, float time)
251 {
252 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
253
254 float2 m = (float2)(1.f, p.y) / fabs (p.x);
255 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
256
257 float2 z = m;
258 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
259
260 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
261 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
262
263 float3 colour = (float3)(z.x, z.y, z.x * z.y);
264 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
265 }
266 EOF
267
268 my $prog = $ctx->build_program ($src);
269 my $kernel = $prog->kernel ("juliatunnel");
270
271 # program compiled, kernel ready, now draw and loop
272
273 for (my $time; ; ++$time) {
274 # acquire objects from opengl
275 $queue->enqueue_acquire_gl_objects ([$tex]);
276
277 # configure and run our kernel
278 $kernel->set_image2d (0, $tex);
279 $kernel->set_float (1, $time);
280 $queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
281
282 # release objects to opengl again
283 $queue->enqueue_release_gl_objects ([$tex]);
284
285 # wait
286 $queue->finish;
287
288 # now draw the texture, the defaults should be all right
289 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
290
291 glEnable GL_TEXTURE_2D;
292 glBegin GL_QUADS;
293 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
294 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
295 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
296 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
297 glEnd;
298
299 glXSwapBuffers;
300
301 select undef, undef, undef, 1/60;
302 }
211 303
212=head1 DOCUMENTATION 304=head1 DOCUMENTATION
213 305
214=head2 BASIC CONVENTIONS 306=head2 BASIC CONVENTIONS
215 307
222 314
223=item * Object lifetime managament is automatic - there is no need 315=item * Object lifetime managament is automatic - there is no need
224to free objects explicitly (C<clReleaseXXX>), the release function 316to free objects explicitly (C<clReleaseXXX>), the release function
225is called automatically once all Perl references to it go away. 317is called automatically once all Perl references to it go away.
226 318
227=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), 319=item * OpenCL uses CamelCase for function names
320(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
228while this module uses underscores as word separator and often leaves out 321uses underscores as word separator and often leaves out prefixes
229prefixes (C<< $platform->info >>). 322(C<OpenCL::platforms>, C<< $platform->info >>).
230 323
231=item * OpenCL often specifies fixed vector function arguments as short 324=item * OpenCL often specifies fixed vector function arguments as short
232arrays (C<$origin[3]>), while this module explicitly expects the 325arrays (C<size_t origin[3]>), while this module explicitly expects the
233components as separate arguments- 326components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
327function calls.
234 328
235=item * Structures are often specified with their components, and returned 329=item * Structures are often specified by flattening out their components
236as arrayrefs. 330as with short vectors, and returned as arrayrefs.
237
238=item * Where possible, one of the pitch values is calculated from the
239perl scalar length and need not be specified.
240 331
241=item * When enqueuing commands, the wait list is specified by adding 332=item * When enqueuing commands, the wait list is specified by adding
242extra arguments to the function - anywhere a C<$wait_events...> argument 333extra arguments to the function - anywhere a C<$wait_events...> argument
243is documented this can be any number of event objects. 334is documented this can be any number of event objects. As an extsnion
335implemented by this module, C<undef> values will be ignored in the event
336list.
244 337
245=item * When enqueuing commands, if the enqueue method is called in void 338=item * When enqueuing commands, if the enqueue method is called in void
246context, no event is created. In all other contexts an event is returned 339context, no event is created. In all other contexts an event is returned
247by the method. 340by the method.
248 341
268 ulong IV - Q 361 ulong IV - Q
269 float NV float f 362 float NV float f
270 half IV ushort S 363 half IV ushort S
271 double NV double d 364 double NV double d
272 365
366=head2 GLX SUPPORT
367
368Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
369module, which has little to no documentation and has little to no support
370for glX), this module, as a special extension, treats context creation
371properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
372specially: If either or both of these are C<undef>, then the OpenCL
373module tries to dynamically resolve C<glXGetCurrentDisplay> and
374C<glXGetCurrentContext>, call these functions and use their return values
375instead.
376
377For this to work, the OpenGL library must be loaded, a GLX context must
378have been created and be made current, and C<dlsym> must be available and
379capable of finding the function via C<RTLD_DEFAULT>.
380
273=head2 THE OpenCL PACKAGE 381=head2 THE OpenCL PACKAGE
274 382
275=over 4 383=over 4
276 384
277=item $int = OpenCL::errno 385=item $int = OpenCL::errno
283 391
284Comverts an error value into a human readable string. 392Comverts an error value into a human readable string.
285 393
286=item $str = OpenCL::enum2str $enum 394=item $str = OpenCL::enum2str $enum
287 395
288Converts most enum values (inof parameter names, image format constants, 396Converts most enum values (of parameter names, image format constants,
289object types, addressing and filter modes, command types etc.) into a 397object types, addressing and filter modes, command types etc.) into a
290human readbale string. When confronted with some random integer it can be 398human readable string. When confronted with some random integer it can be
291very helpful to pass it through this function to maybe get some readable 399very helpful to pass it through this function to maybe get some readable
292string out of it. 400string out of it.
293 401
294=item @platforms = OpenCL::platforms 402=item @platforms = OpenCL::platforms
295 403
313 421
314=head2 THE OpenCL::Platform CLASS 422=head2 THE OpenCL::Platform CLASS
315 423
316=over 4 424=over 4
317 425
318=item $packed_value = $platform->info ($name)
319
320Calls C<clGetPlatformInfo> and returns the packed, raw value - for
321strings, this will be the string, for other values you probably need to
322use the correct C<unpack>. This might get improved in the future. Hopefully.
323
324L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
325
326=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 426=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
327 427
328Returns a list of matching OpenCL::Device objects. 428Returns a list of matching OpenCL::Device objects.
329 429
330=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 430=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
331 431
332Tries to create a context. Never worked for me, and you need devices explitly anyway. 432Tries to create a context. Never worked for me, and you need devices explicitly anyway.
333 433
334L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 434L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
335 435
336=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 436=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
337 437
338Create a new OpenCL::Context object using the given device object(s)- a 438Create a new OpenCL::Context object using the given device object(s)- a
339CL_CONTEXT_PLATFORM property is supplied automatically. 439CL_CONTEXT_PLATFORM property is supplied automatically.
340 440
341L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 441L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
342 442
443=item $packed_value = $platform->info ($name)
444
445Calls C<clGetPlatformInfo> and returns the packed, raw value - for
446strings, this will be the string (possibly including terminating \0), for
447other values you probably need to use the correct C<unpack>.
448
449It's best to avoid this method and use one of the following convenience
450wrappers.
451
452L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
453
454=item $platform->unload_compiler
455
456Attempts to unload the compiler for this platform, for endless
457profit. Does nothing on OpenCL 1.1.
458
459L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.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
343=back 485=back
344 486
345=head2 THE OpenCL::Device CLASS 487=head2 THE OpenCL::Device CLASS
346 488
347=over 4 489=over 4
350 492
351See C<< $platform->info >> for details. 493See C<< $platform->info >> for details.
352 494
353L<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>
354 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
355=back 765=back
356 766
357=head2 THE OpenCL::Context CLASS 767=head2 THE OpenCL::Context CLASS
358 768
359=over 4 769=over 4
360 770
361=item $packed_value = $ctx->info ($name) 771=item $prog = $ctx->build_program ($program, $options = "")
362 772
363See C<< $platform->info >> for details. 773This convenience function tries to build the program on all devices in
774the context. If the build fails, then the function will C<croak> with the
775build log. Otherwise ti returns the program object.
364 776
365L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 777The C<$program> can either be a C<OpenCL::Program> object or a string
778containing the program. In the latter case, a program objetc will be
779created automatically.
780
781=cut
782
783sub OpenCL::Context::build_program {
784 my ($self, $prog, $options) = @_;
785
786 $prog = $self->program_with_source ($prog)
787 unless ref $prog;
788
789 for my $dev ($self->devices) {
790 eval { $prog->build ($dev, $options); 1 }
791 or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
792 . $prog->build_log ($dev);
793 }
794
795 $prog
796}
366 797
367=item $queue = $ctx->queue ($device, $properties) 798=item $queue = $ctx->queue ($device, $properties)
368 799
369Create a new OpenCL::Queue object from the context and the given device. 800Create a new OpenCL::Queue object from the context and the given device.
370 801
371L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 802L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
372 803
804Example: create an out-of-order queue.
805
806 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
807
373=item $ev = $ctx->user_event 808=item $ev = $ctx->user_event
374 809
375Creates a new OpenCL::UserEvent object. 810Creates a new OpenCL::UserEvent object.
376 811
377L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 812L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
378 813
379=item $buf = $ctx->buffer ($flags, $len) 814=item $buf = $ctx->buffer ($flags, $len)
380 815
381Creates a new OpenCL::Buffer object with the given flags and octet-size. 816Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
817given flags and octet-size.
382 818
383L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 819L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
384 820
385=item $buf = $ctx->buffer_sv ($flags, $data) 821=item $buf = $ctx->buffer_sv ($flags, $data)
386 822
387Creates a new OpenCL::Buffer object and initialise it with the given data values. 823Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
824initialise it with the given data values.
388 825
826=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)
827
828Creates a new OpenCL::Image object and optionally initialises it with
829the given data values.
830
831L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
832
389=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 833=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
390 834
391Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 835Creates a new OpenCL::Image2D object and optionally initialises it with
836the given data values.
392 837
393L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 838L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
394 839
395=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 840=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
396 841
397Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 842Creates a new OpenCL::Image3D object and optionally initialises it with
843the given data values.
398 844
399L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 845L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
846
847=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
848
849Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
850OpenGL buffer object.
851
852http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
853
854=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
855
856Creates a new OpenCL::Image object that refers to the given OpenGL
857texture object or buffer.
858
859http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
860
861=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
862
863Creates a new OpenCL::Image2D object that refers to the given OpenGL
8642D texture object.
865
866http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
867
868=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
869
870Creates a new OpenCL::Image3D object that refers to the given OpenGL
8713D texture object.
872
873http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
874
875=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
876
877Creates a new OpenCL::Image2D object that refers to the given OpenGL
878render buffer.
879
880http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
400 881
401=item @formats = $ctx->supported_image_formats ($flags, $image_type) 882=item @formats = $ctx->supported_image_formats ($flags, $image_type)
402 883
403Returns a list of matching image formats - each format is an arrayref with 884Returns a list of matching image formats - each format is an arrayref with
404two values, $channel_order and $channel_type, in it. 885two values, $channel_order and $channel_type, in it.
414=item $program = $ctx->program_with_source ($string) 895=item $program = $ctx->program_with_source ($string)
415 896
416Creates a new OpenCL::Program object from the given source code. 897Creates a new OpenCL::Program object from the given source code.
417 898
418L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 899L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
900
901=item $packed_value = $ctx->info ($name)
902
903See C<< $platform->info >> for details.
904
905L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
906
907=for gengetinfo begin context
908
909=item $uint = $context->reference_count
910
911Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
912
913=item @devices = $context->devices
914
915Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
916
917=item @property_ints = $context->properties
918
919Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
920
921=item $uint = $context->num_devices
922
923Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
924
925=for gengetinfo end context
419 926
420=back 927=back
421 928
422=head2 THE OpenCL::Queue CLASS 929=head2 THE OpenCL::Queue CLASS
423 930
429for completion, unless the method is called in void context, in which case 936for completion, unless the method is called in void context, in which case
430no event object is created. 937no event object is created.
431 938
432They also allow you to specify any number of other event objects that this 939They also allow you to specify any number of other event objects that this
433request has to wait for before it starts executing, by simply passing the 940request has to wait for before it starts executing, by simply passing the
434event objects as extra parameters to the enqueue methods. 941event objects as extra parameters to the enqueue methods. To simplify
942program design, this module ignores any C<undef> values in the list of
943events. This makes it possible to code operations such as this, without
944having to put a valid event object into C<$event> first:
945
946 $event = $queue->enqueue_xxx (..., $event);
435 947
436Queues execute in-order by default, without any parallelism, so in most 948Queues execute in-order by default, without any parallelism, so in most
437cases (i.e. you use only one queue) it's not necessary to wait for or 949cases (i.e. you use only one queue) it's not necessary to wait for or
438create event objects. 950create event objects, althoguh an our of order queue is often a bit
951faster.
439 952
440=over 4 953=over 4
441 954
442=item $packed_value = $ctx->info ($name)
443
444See C<< $platform->info >> for details.
445
446L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
447
448=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 955=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
449 956
450Reads data from buffer into the given string. 957Reads data from buffer into the given string.
451 958
452L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 959L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
459 966
460=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 967=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
461 968
462L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 969L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
463 970
971=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...)
972
973http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
974
975=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...)
976
977http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
978
464=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 979=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
465 980
981L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
982
983=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...)
984
466L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 985L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
467 986
468=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 987=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
469 988
470L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 989L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
471 990
991=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...)
992
993L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
994
995=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...)
996
997L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
998
472=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, $wait_event...) 999=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...)
473 1000
474Yeah. 1001Yeah.
475 1002
476L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
477
478=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...)
479
480L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1003L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
481
482=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...)
483
484L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
485
486=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...)
487
488L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
489 1004
490=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1005=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
491 1006
492L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1007L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
493 1008
507reference to an array of local work sizes, with the same number of 1022reference to an array of local work sizes, with the same number of
508elements as @$global_work_size. 1023elements as @$global_work_size.
509 1024
510L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1025L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
511 1026
512=item $ev = $queue->enqueue_marker 1027=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
513 1028
1029Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1030for subsequent OpenCL usage.
1031
514L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1032L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1033
1034=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1035
1036Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1037for subsequent OpenGL usage.
1038
1039L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
515 1040
516=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1041=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
517 1042
518L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1043L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
519 1044
520=item $queue->enqueue_barrier 1045=item $ev = $queue->enqueue_marker ($wait_events...)
521 1046
1047L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1048
1049=item $ev = $queue->enqueue_barrier ($wait_events...)
1050
522L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1051L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
523 1052
524=item $queue->flush 1053=item $queue->flush
525 1054
526L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1055L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
527 1056
528=item $queue->finish 1057=item $queue->finish
529 1058
530L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1059L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
531 1060
1061=item $packed_value = $queue->info ($name)
1062
1063See C<< $platform->info >> for details.
1064
1065L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1066
1067=for gengetinfo begin command_queue
1068
1069=item $ctx = $command_queue->context
1070
1071Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1072
1073=item $device = $command_queue->device
1074
1075Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1076
1077=item $uint = $command_queue->reference_count
1078
1079Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1080
1081=item $command_queue_properties = $command_queue->properties
1082
1083Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1084
1085=for gengetinfo end command_queue
1086
532=back 1087=back
533 1088
534=head2 THE OpenCL::Memory CLASS 1089=head2 THE OpenCL::Memory CLASS
535 1090
536This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1091This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
537OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1092OpenCL::Image2D and OpenCL::Image3D.
538currently only exist to allow type-checking.
539 1093
540=over 4 1094=over 4
541 1095
542=item $packed_value = $memory->info ($name) 1096=item $packed_value = $memory->info ($name)
543 1097
544See C<< $platform->info >> for details. 1098See C<< $platform->info >> for details.
545 1099
546L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1100L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
547 1101
1102=for gengetinfo begin mem
1103
1104=item $mem_object_type = $mem->type
1105
1106Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1107
1108=item $mem_flags = $mem->flags
1109
1110Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1111
1112=item $int = $mem->size
1113
1114Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1115
1116=item $ptr_value = $mem->host_ptr
1117
1118Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1119
1120=item $uint = $mem->map_count
1121
1122Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1123
1124=item $uint = $mem->reference_count
1125
1126Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1127
1128=item $ctx = $mem->context
1129
1130Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1131
1132=item $mem = $mem->associated_memobject
1133
1134Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1135
1136=item $int = $mem->offset
1137
1138Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1139
1140=for gengetinfo end mem
1141
1142=item ($type, $name) = $mem->gl_object_info
1143
1144Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1145object "name" (e.g. the texture name) used to create this memory object.
1146
1147L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1148
548=back 1149=back
549 1150
1151=head2 THE OpenCL::Buffer CLASS
1152
1153This is a subclass of OpenCL::Memory, and the superclass of
1154OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1155and sub-buffers.
1156
1157=head2 THE OpenCL::BufferObj CLASS
1158
1159This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1160because one cna create sub buffers of OpenLC::BufferObj objects, but not
1161sub buffers from these sub buffers.
1162
1163=over 4
1164
1165=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1166
1167Creates an OpenCL::Buffer objects from this buffer and returns it. The
1168C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1169
1170L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1171
1172=back
1173
1174=head2 THE OpenCL::Image CLASS
1175
1176This is the superclass of all image objects - OpenCL::Image1D,
1177OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1178OpenCL::Image2DArray and OpenCL::Image3D.
1179
1180=over 4
1181
1182=item $packed_value = $ev->image_info ($name)
1183
1184See C<< $platform->info >> for details.
1185
1186The reason this method is not called C<info> is that there already is an
1187C<< ->info >> method inherited from C<OpenCL::Memory>.
1188
1189L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1190
1191=for gengetinfo begin image
1192
1193=item $int = $image->element_size
1194
1195Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1196
1197=item $int = $image->row_pitch
1198
1199Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1200
1201=item $int = $image->slice_pitch
1202
1203Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1204
1205=item $int = $image->width
1206
1207Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1208
1209=item $int = $image->height
1210
1211Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1212
1213=item $int = $image->depth
1214
1215Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1216
1217=for gengetinfo end image
1218
1219=for gengetinfo begin gl_texture
1220
1221=item $GLenum = $gl_texture->target
1222
1223Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1224
1225=item $GLint = $gl_texture->gl_mipmap_level
1226
1227Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1228
1229=for gengetinfo end gl_texture
1230
1231=back
1232
550=head2 THE OpenCL::Sampler CLASS 1233=head2 THE OpenCL::Sampler CLASS
551 1234
552=over 4 1235=over 4
553 1236
554=item $packed_value = $sampler->info ($name) 1237=item $packed_value = $sampler->info ($name)
555 1238
556See C<< $platform->info >> for details. 1239See C<< $platform->info >> for details.
557 1240
558L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1241L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
559 1242
1243=for gengetinfo begin sampler
1244
1245=item $uint = $sampler->reference_count
1246
1247Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1248
1249=item $ctx = $sampler->context
1250
1251Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1252
1253=item $addressing_mode = $sampler->normalized_coords
1254
1255Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1256
1257=item $filter_mode = $sampler->addressing_mode
1258
1259Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1260
1261=item $boolean = $sampler->filter_mode
1262
1263Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1264
1265=for gengetinfo end sampler
1266
560=back 1267=back
561 1268
562=head2 THE OpenCL::Program CLASS 1269=head2 THE OpenCL::Program CLASS
563 1270
564=over 4 1271=over 4
565 1272
566=item $packed_value = $program->info ($name)
567
568See C<< $platform->info >> for details.
569
570L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
571
572=item $program->build ($device, $options = "") 1273=item $program->build ($device, $options = "")
573 1274
574Tries to build the program with the givne options. 1275Tries to build the program with the given options. See also the
1276C<$ctx->build> convenience function.
575 1277
576L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1278L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
577 1279
578=item $packed_value = $program->build_info ($device, $name) 1280=item $packed_value = $program->build_info ($device, $name)
579 1281
587Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1289Creates an OpenCL::Kernel object out of the named C<__kernel> function in
588the program. 1290the program.
589 1291
590L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1292L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
591 1293
1294=item @kernels = $program->kernels_in_program
1295
1296Returns all kernels successfully compiled for all devices in program.
1297
1298http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1299
1300=for gengetinfo begin program_build
1301
1302=item $build_status = $program->build_status ($device)
1303
1304Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1305
1306=item $string = $program->build_options ($device)
1307
1308Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1309
1310=item $string = $program->build_log ($device)
1311
1312Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1313
1314=for gengetinfo end program_build
1315
1316=item $packed_value = $program->info ($name)
1317
1318See C<< $platform->info >> for details.
1319
1320L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1321
1322=for gengetinfo begin program
1323
1324=item $uint = $program->reference_count
1325
1326Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1327
1328=item $ctx = $program->context
1329
1330Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1331
1332=item $uint = $program->num_devices
1333
1334Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1335
1336=item @devices = $program->devices
1337
1338Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1339
1340=item $string = $program->source
1341
1342Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1343
1344=item @ints = $program->binary_sizes
1345
1346Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1347
1348=for gengetinfo end program
1349
1350=item @blobs = $program->binaries
1351
1352Returns a string for the compiled binary for every device associated with
1353the program, empty strings indicate missing programs, and an empty result
1354means no program binaries are available.
1355
1356These "binaries" are often, in fact, informative low-level assembly
1357sources.
1358
1359L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1360
592=back 1361=back
593 1362
594=head2 THE OpenCL::Kernel CLASS 1363=head2 THE OpenCL::Kernel CLASS
595 1364
596=over 4 1365=over 4
598=item $packed_value = $kernel->info ($name) 1367=item $packed_value = $kernel->info ($name)
599 1368
600See C<< $platform->info >> for details. 1369See C<< $platform->info >> for details.
601 1370
602L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1371L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1372
1373=for gengetinfo begin kernel
1374
1375=item $string = $kernel->function_name
1376
1377Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1378
1379=item $uint = $kernel->num_args
1380
1381Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1382
1383=item $uint = $kernel->reference_count
1384
1385Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1386
1387=item $ctx = $kernel->context
1388
1389Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1390
1391=item $program = $kernel->program
1392
1393Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1394
1395=for gengetinfo end kernel
1396
1397=item $packed_value = $kernel->work_group_info ($device, $name)
1398
1399See C<< $platform->info >> for details.
1400
1401The reason this method is not called C<info> is that there already is an
1402C<< ->info >> method.
1403
1404L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1405
1406=for gengetinfo begin kernel_work_group
1407
1408=item $int = $kernel->work_group_size ($device)
1409
1410Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1411
1412=item @ints = $kernel->compile_work_group_size ($device)
1413
1414Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1415
1416=item $ulong = $kernel->local_mem_size ($device)
1417
1418Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1419
1420=item $int = $kernel->preferred_work_group_size_multiple ($device)
1421
1422Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1423
1424=item $ulong = $kernel->private_mem_size ($device)
1425
1426Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1427
1428=for gengetinfo end kernel_work_group
603 1429
604=item $kernel->set_TYPE ($index, $value) 1430=item $kernel->set_TYPE ($index, $value)
605 1431
606This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1432This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
607 1433
608TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1434TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
609C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1435C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
610C<image2d>, C<image3d>, C<sampler> or C<event>. 1436C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
611 1437
612Chars and integers (including the half type) are specified as integers, 1438Chars and integers (including the half type) are specified as integers,
613float and double as floating point values, memory/buffer/image2d/image3d 1439float and double as floating point values, memory/buffer/image2d/image3d
614must be an object of that type or C<undef>, and sampler and event must be 1440must be an object of that type or C<undef>, local-memory arguments are
615objects of that type. 1441set by specifying the size, and sampler and event must be objects of that
1442type.
1443
1444Setting an argument for a kernel does NOT keep a reference to the object -
1445for example, if you set an argument to some image object, free the image,
1446and call the kernel, you will run into undefined behaviour.
616 1447
617L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1448L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
618 1449
619=back 1450=back
620 1451
623This is the superclass for all event objects (including OpenCL::UserEvent 1454This is the superclass for all event objects (including OpenCL::UserEvent
624objects). 1455objects).
625 1456
626=over 4 1457=over 4
627 1458
1459=item $ev->wait
1460
1461Waits for the event to complete.
1462
1463L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1464
628=item $packed_value = $ev->info ($name) 1465=item $packed_value = $ev->info ($name)
629 1466
630See C<< $platform->info >> for details. 1467See C<< $platform->info >> for details.
631 1468
632L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1469L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
633 1470
634=item $ev->wait 1471=for gengetinfo begin event
635 1472
636Waits for the event to complete. 1473=item $queue = $event->command_queue
637 1474
1475Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1476
1477=item $command_type = $event->command_type
1478
1479Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1480
1481=item $uint = $event->reference_count
1482
1483Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1484
1485=item $uint = $event->command_execution_status
1486
1487Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1488
1489=item $ctx = $event->context
1490
1491Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1492
1493=for gengetinfo end event
1494
1495=item $packed_value = $ev->profiling_info ($name)
1496
1497See C<< $platform->info >> for details.
1498
1499The reason this method is not called C<info> is that there already is an
1500C<< ->info >> method.
1501
638L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1502L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1503
1504=for gengetinfo begin profiling
1505
1506=item $ulong = $event->profiling_command_queued
1507
1508Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1509
1510=item $ulong = $event->profiling_command_submit
1511
1512Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1513
1514=item $ulong = $event->profiling_command_start
1515
1516Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1517
1518=item $ulong = $event->profiling_command_end
1519
1520Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1521
1522=for gengetinfo end profiling
639 1523
640=back 1524=back
641 1525
642=head2 THE OpenCL::UserEvent CLASS 1526=head2 THE OpenCL::UserEvent CLASS
643 1527
656package OpenCL; 1540package OpenCL;
657 1541
658use common::sense; 1542use common::sense;
659 1543
660BEGIN { 1544BEGIN {
661 our $VERSION = '0.14'; 1545 our $VERSION = '0.96';
662 1546
663 require XSLoader; 1547 require XSLoader;
664 XSLoader::load (__PACKAGE__, $VERSION); 1548 XSLoader::load (__PACKAGE__, $VERSION);
665 1549
666 @OpenCL::Buffer::ISA = 1550 @OpenCL::Buffer::ISA =
667 @OpenCL::Image::ISA = OpenCL::Memory::; 1551 @OpenCL::Image::ISA = OpenCL::Memory::;
668 1552
1553 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1554
669 @OpenCL::Image2D::ISA = 1555 @OpenCL::Image2D::ISA =
1556 @OpenCL::Image3D::ISA =
1557 @OpenCL::Image2DArray::ISA =
1558 @OpenCL::Image1D::ISA =
1559 @OpenCL::Image1DArray::ISA =
670 @OpenCL::Image3D::ISA = OpenCL::Image::; 1560 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
671 1561
672 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1562 @OpenCL::UserEvent::ISA = OpenCL::Event::;
673} 1563}
674 1564
6751; 15651;
676 1566
677=head1 AUTHOR 1567=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines