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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.11 by root, Thu Nov 17 02:54:14 2011 UTC vs.
Revision 1.47 by root, Sat Apr 21 19:48: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 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 * Where possible, one of the pitch values is calculated from the 336=item * Structures are often specified by flattening out their components
226perl scalar length and need not be specified. 337as with short vectors, and returned as arrayrefs.
227 338
228=item * When enqueuing commands, the wait list is specified by adding 339=item * When enqueuing commands, the wait list is specified by adding
229extra arguments to the function - anywhere a C<$wait_events...> argument 340extra arguments to the function - anywhere a C<$wait_events...> argument
230is 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.
231 344
232=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
233context, 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
234by the method. 347by the method.
235 348
255 ulong IV - Q 368 ulong IV - Q
256 float NV float f 369 float NV float f
257 half IV ushort S 370 half IV ushort S
258 double NV double d 371 double NV double d
259 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
260=head2 THE OpenCL PACKAGE 388=head2 THE OpenCL PACKAGE
261 389
262=over 4 390=over 4
263 391
264=item $int = OpenCL::errno 392=item $int = OpenCL::errno
270 398
271Comverts an error value into a human readable string. 399Comverts an error value into a human readable string.
272 400
273=item $str = OpenCL::enum2str $enum 401=item $str = OpenCL::enum2str $enum
274 402
275Converts most enum values (inof parameter names, image format constants, 403Converts most enum values (of parameter names, image format constants,
276object types, addressing and filter modes, command types etc.) into a 404object types, addressing and filter modes, command types etc.) into a
277human readbale string. When confronted with some random integer it can be 405human readable string. When confronted with some random integer it can be
278very 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
279string out of it. 407string out of it.
280 408
281=item @platforms = OpenCL::platforms 409=item @platforms = OpenCL::platforms
282 410
300 428
301=head2 THE OpenCL::Platform CLASS 429=head2 THE OpenCL::Platform CLASS
302 430
303=over 4 431=over 4
304 432
305=item $packed_value = $platform->info ($name)
306
307Calls C<clGetPlatformInfo> and returns the packed, raw value - for
308strings, this will be the string, for other values you probably need to
309use the correct C<unpack>. This might get improved in the future. Hopefully.
310
311L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
312
313=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 433=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
314 434
315Returns a list of matching OpenCL::Device objects. 435Returns a list of matching OpenCL::Device objects.
316 436
317=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)
318 438
319Tries 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.
320 440
321L<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>
322 442
323=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 443=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
324 444
325Create 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
326CL_CONTEXT_PLATFORM property is supplied automatically. 446CL_CONTEXT_PLATFORM property is supplied automatically.
327 447
328L<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>
329 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
330=back 485=back
331 486
332=head2 THE OpenCL::Device CLASS 487=head2 THE OpenCL::Device CLASS
333 488
334=over 4 489=over 4
337 492
338See C<< $platform->info >> for details. 493See C<< $platform->info >> for details.
339 494
340L<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>
341 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
342=back 765=back
343 766
344=head2 THE OpenCL::Context CLASS 767=head2 THE OpenCL::Context CLASS
345 768
346=over 4 769=over 4
347 770
348=item $packed_value = $ctx->info ($name)
349
350See C<< $platform->info >> for details.
351
352L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
353
354=item $queue = $ctx->queue ($device, $properties) 771=item $queue = $ctx->queue ($device, $properties)
355 772
356Create 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.
357 774
358L<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>
359 776
777Example: create an out-of-order queue.
778
779 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
780
360=item $ev = $ctx->user_event 781=item $ev = $ctx->user_event
361 782
362Creates a new OpenCL::UserEvent object. 783Creates a new OpenCL::UserEvent object.
363 784
364L<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>
365 786
366=item $buf = $ctx->buffer ($flags, $len) 787=item $buf = $ctx->buffer ($flags, $len)
367 788
368Creates 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.
369 791
370L<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>
371 793
372=item $buf = $ctx->buffer_sv ($flags, $data) 794=item $buf = $ctx->buffer_sv ($flags, $data)
373 795
374Creates 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.
375 798
376=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 799=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
377 800
378Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 801Creates a new OpenCL::Image2D object and optionally initialises it with
802the given data values.
379 803
380L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
381 805
382=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 806=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
383 807
384Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 808Creates a new OpenCL::Image3D object and optionally initialises it with
809the given data values.
385 810
386L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 811L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
812
813=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
814
815Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
816OpenGL buffer object.
817
818http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
819
820=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
821
822Creates a new OpenCL::Image object that refers to the given OpenGL
823texture object or buffer.
824
825http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
826
827=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
828
829Creates a new OpenCL::Image2D object that refers to the given OpenGL
8302D texture object.
831
832http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
833
834=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
835
836Creates a new OpenCL::Image3D object that refers to the given OpenGL
8373D texture object.
838
839http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
840
841=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
842
843Creates a new OpenCL::Image2D object that refers to the given OpenGL
844render buffer.
845
846http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
387 847
388=item @formats = $ctx->supported_image_formats ($flags, $image_type) 848=item @formats = $ctx->supported_image_formats ($flags, $image_type)
389 849
390Returns a list of matching image formats - each format is an arrayref with 850Returns a list of matching image formats - each format is an arrayref with
391two values, $channel_order and $channel_type, in it. 851two values, $channel_order and $channel_type, in it.
401=item $program = $ctx->program_with_source ($string) 861=item $program = $ctx->program_with_source ($string)
402 862
403Creates a new OpenCL::Program object from the given source code. 863Creates a new OpenCL::Program object from the given source code.
404 864
405L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 865L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
866
867=item $packed_value = $ctx->info ($name)
868
869See C<< $platform->info >> for details.
870
871L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
872
873=for gengetinfo begin context
874
875=item $uint = $context->reference_count
876
877Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
878
879=item @devices = $context->devices
880
881Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
882
883=item @property_ints = $context->properties
884
885Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
886
887=item $uint = $context->num_devices
888
889Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
890
891=for gengetinfo end context
406 892
407=back 893=back
408 894
409=head2 THE OpenCL::Queue CLASS 895=head2 THE OpenCL::Queue CLASS
410 896
416for completion, unless the method is called in void context, in which case 902for completion, unless the method is called in void context, in which case
417no event object is created. 903no event object is created.
418 904
419They also allow you to specify any number of other event objects that this 905They also allow you to specify any number of other event objects that this
420request has to wait for before it starts executing, by simply passing the 906request has to wait for before it starts executing, by simply passing the
421event objects as extra parameters to the enqueue methods. 907event objects as extra parameters to the enqueue methods. To simplify
908program design, this module ignores any C<undef> values in the list of
909events. This makes it possible to code operations such as this, without
910having to put a valid event object into C<$event> first:
911
912 $event = $queue->enqueue_xxx (..., $event);
422 913
423Queues execute in-order by default, without any parallelism, so in most 914Queues execute in-order by default, without any parallelism, so in most
424cases (i.e. you use only one queue) it's not necessary to wait for or 915cases (i.e. you use only one queue) it's not necessary to wait for or
425create event objects. 916create event objects, althoguh an our of order queue is often a bit
917faster.
426 918
427=over 4 919=over 4
428 920
429=item $packed_value = $ctx->info ($name)
430
431See C<< $platform->info >> for details.
432
433L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
434
435=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 921=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
436 922
437Reads data from buffer into the given string. 923Reads data from buffer into the given string.
438 924
439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 925L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
446 932
447=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 933=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
448 934
449L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 935L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
450 936
937=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...)
938
939http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
940
941=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...)
942
943http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
944
451=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 945=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
452 946
947L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
948
949=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...)
950
453L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 951L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
454 952
455=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 953=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
456 954
457L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 955L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
458 956
957=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...)
958
959L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
960
961=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...)
962
963L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
964
459=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...) 965=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...)
460 966
461Yeah. 967Yeah.
462 968
463L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
464
465=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, ...)
466
467L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 969L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
468
469=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, ...)
470
471L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
472
473=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, ...)
474
475L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
476 970
477=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 971=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
478 972
479L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 973L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
480 974
494reference to an array of local work sizes, with the same number of 988reference to an array of local work sizes, with the same number of
495elements as @$global_work_size. 989elements as @$global_work_size.
496 990
497L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 991L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
498 992
499=item $ev = $queue->enqueue_marker 993=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
500 994
995Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
996for subsequent OpenCL usage.
997
501L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 998L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
999
1000=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1001
1002Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1003for subsequent OpenGL usage.
1004
1005L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
502 1006
503=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1007=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
504 1008
505L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1009L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
506 1010
507=item $queue->enqueue_barrier 1011=item $ev = $queue->enqueue_marker ($wait_events...)
508 1012
1013L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1014
1015=item $ev = $queue->enqueue_barrier ($wait_events...)
1016
509L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1017L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
510 1018
511=item $queue->flush 1019=item $queue->flush
512 1020
513L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1021L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
514 1022
515=item $queue->finish 1023=item $queue->finish
516 1024
517L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1025L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
518 1026
1027=item $packed_value = $queue->info ($name)
1028
1029See C<< $platform->info >> for details.
1030
1031L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1032
1033=for gengetinfo begin command_queue
1034
1035=item $ctx = $command_queue->context
1036
1037Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1038
1039=item $device = $command_queue->device
1040
1041Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1042
1043=item $uint = $command_queue->reference_count
1044
1045Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1046
1047=item $command_queue_properties = $command_queue->properties
1048
1049Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1050
1051=for gengetinfo end command_queue
1052
519=back 1053=back
520 1054
521=head2 THE OpenCL::Memory CLASS 1055=head2 THE OpenCL::Memory CLASS
522 1056
523This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1057This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
524OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1058OpenCL::Image2D and OpenCL::Image3D.
525currently only exist to allow type-checking.
526 1059
527=over 4 1060=over 4
528 1061
529=item $packed_value = $memory->info ($name) 1062=item $packed_value = $memory->info ($name)
530 1063
531See C<< $platform->info >> for details. 1064See C<< $platform->info >> for details.
532 1065
533L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1066L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
534 1067
1068=for gengetinfo begin mem
1069
1070=item $mem_object_type = $mem->type
1071
1072Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1073
1074=item $mem_flags = $mem->flags
1075
1076Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1077
1078=item $int = $mem->size
1079
1080Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1081
1082=item $ptr_value = $mem->host_ptr
1083
1084Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1085
1086=item $uint = $mem->map_count
1087
1088Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1089
1090=item $uint = $mem->reference_count
1091
1092Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1093
1094=item $ctx = $mem->context
1095
1096Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1097
1098=item $mem = $mem->associated_memobject
1099
1100Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1101
1102=item $int = $mem->offset
1103
1104Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1105
1106=for gengetinfo end mem
1107
1108=item ($type, $name) = $mem->gl_object_info
1109
1110Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1111object "name" (e.g. the texture name) used to create this memory object.
1112
1113L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1114
535=back 1115=back
536 1116
1117=head2 THE OpenCL::Buffer CLASS
1118
1119This is a subclass of OpenCL::Memory, and the superclass of
1120OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1121and sub-buffers.
1122
1123=head2 THE OpenCL::BufferObj CLASS
1124
1125This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1126because one cna create sub buffers of OpenLC::BufferObj objects, but not
1127sub buffers from these sub buffers.
1128
1129=over 4
1130
1131=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1132
1133Creates an OpenCL::Buffer objects from this buffer and returns it. The
1134C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1135
1136L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1137
1138=back
1139
1140=head2 THE OpenCL::Image CLASS
1141
1142This is the superclass of all image objects - OpenCL::Image1D,
1143OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1144OpenCL::Image2DArray and OpenCL::Image3D.
1145
1146=over 4
1147
1148=item $packed_value = $ev->image_info ($name)
1149
1150See C<< $platform->info >> for details.
1151
1152The reason this method is not called C<info> is that there already is an
1153C<< ->info >> method inherited from C<OpenCL::Memory>.
1154
1155L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1156
1157=for gengetinfo begin image
1158
1159=item $int = $image->element_size
1160
1161Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1162
1163=item $int = $image->row_pitch
1164
1165Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1166
1167=item $int = $image->slice_pitch
1168
1169Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1170
1171=item $int = $image->width
1172
1173Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1174
1175=item $int = $image->height
1176
1177Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1178
1179=item $int = $image->depth
1180
1181Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1182
1183=for gengetinfo end image
1184
1185=for gengetinfo begin gl_texture
1186
1187=item $GLenum = $gl_texture->target
1188
1189Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1190
1191=item $GLint = $gl_texture->gl_mipmap_level
1192
1193Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1194
1195=for gengetinfo end gl_texture
1196
1197=back
1198
537=head2 THE OpenCL::Sampler CLASS 1199=head2 THE OpenCL::Sampler CLASS
538 1200
539=over 4 1201=over 4
540 1202
541=item $packed_value = $sampler->info ($name) 1203=item $packed_value = $sampler->info ($name)
542 1204
543See C<< $platform->info >> for details. 1205See C<< $platform->info >> for details.
544 1206
545L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1207L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
546 1208
1209=for gengetinfo begin sampler
1210
1211=item $uint = $sampler->reference_count
1212
1213Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1214
1215=item $ctx = $sampler->context
1216
1217Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1218
1219=item $addressing_mode = $sampler->normalized_coords
1220
1221Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1222
1223=item $filter_mode = $sampler->addressing_mode
1224
1225Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1226
1227=item $boolean = $sampler->filter_mode
1228
1229Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1230
1231=for gengetinfo end sampler
1232
547=back 1233=back
548 1234
549=head2 THE OpenCL::Program CLASS 1235=head2 THE OpenCL::Program CLASS
550 1236
551=over 4 1237=over 4
552
553=item $packed_value = $program->info ($name)
554
555See C<< $platform->info >> for details.
556
557L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
558 1238
559=item $program->build ($device, $options = "") 1239=item $program->build ($device, $options = "")
560 1240
561Tries to build the program with the givne options. 1241Tries to build the program with the givne options.
562 1242
574Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1254Creates an OpenCL::Kernel object out of the named C<__kernel> function in
575the program. 1255the program.
576 1256
577L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1257L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
578 1258
1259=for gengetinfo begin program_build
1260
1261=item $build_status = $program->build_status ($device)
1262
1263Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1264
1265=item $string = $program->build_options ($device)
1266
1267Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1268
1269=item $string = $program->build_log ($device)
1270
1271Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1272
1273=for gengetinfo end program_build
1274
1275=item $packed_value = $program->info ($name)
1276
1277See C<< $platform->info >> for details.
1278
1279L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1280
1281=for gengetinfo begin program
1282
1283=item $uint = $program->reference_count
1284
1285Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1286
1287=item $ctx = $program->context
1288
1289Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1290
1291=item $uint = $program->num_devices
1292
1293Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1294
1295=item @devices = $program->devices
1296
1297Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1298
1299=item $string = $program->source
1300
1301Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1302
1303=item @ints = $program->binary_sizes
1304
1305Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1306
1307=for gengetinfo end program
1308
1309=item @blobs = $program->binaries
1310
1311Returns a string for the compiled binary for every device associated with
1312the program, empty strings indicate missing programs, and an empty result
1313means no program binaries are available.
1314
1315These "binaries" are often, in fact, informative low-level assembly
1316sources.
1317
1318L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1319
579=back 1320=back
580 1321
581=head2 THE OpenCL::Kernel CLASS 1322=head2 THE OpenCL::Kernel CLASS
582 1323
583=over 4 1324=over 4
585=item $packed_value = $kernel->info ($name) 1326=item $packed_value = $kernel->info ($name)
586 1327
587See C<< $platform->info >> for details. 1328See C<< $platform->info >> for details.
588 1329
589L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1330L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1331
1332=for gengetinfo begin kernel
1333
1334=item $string = $kernel->function_name
1335
1336Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1337
1338=item $uint = $kernel->num_args
1339
1340Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1341
1342=item $uint = $kernel->reference_count
1343
1344Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1345
1346=item $ctx = $kernel->context
1347
1348Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1349
1350=item $program = $kernel->program
1351
1352Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1353
1354=for gengetinfo end kernel
1355
1356=item $packed_value = $kernel->work_group_info ($device, $name)
1357
1358See C<< $platform->info >> for details.
1359
1360The reason this method is not called C<info> is that there already is an
1361C<< ->info >> method.
1362
1363L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1364
1365=for gengetinfo begin kernel_work_group
1366
1367=item $int = $kernel->work_group_size ($device)
1368
1369Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1370
1371=item @ints = $kernel->compile_work_group_size ($device)
1372
1373Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1374
1375=item $ulong = $kernel->local_mem_size ($device)
1376
1377Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1378
1379=item $int = $kernel->preferred_work_group_size_multiple ($device)
1380
1381Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1382
1383=item $ulong = $kernel->private_mem_size ($device)
1384
1385Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1386
1387=for gengetinfo end kernel_work_group
590 1388
591=item $kernel->set_TYPE ($index, $value) 1389=item $kernel->set_TYPE ($index, $value)
592 1390
593This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1391This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
594 1392
595TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1393TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
596C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1394C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
597C<image2d>, C<image3d>, C<sampler> or C<event>. 1395C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
598 1396
599Chars and integers (including the half type) are specified as integers, 1397Chars and integers (including the half type) are specified as integers,
600float and double as floating point values, memory/buffer/image2d/image3d 1398float and double as floating point values, memory/buffer/image2d/image3d
601must be an object of that type or C<undef>, and sampler and event must be 1399must be an object of that type or C<undef>, local-memory arguments are
602objects of that type. 1400set by specifying the size, and sampler and event must be objects of that
1401type.
603 1402
604L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
605 1404
606=back 1405=back
607 1406
610This is the superclass for all event objects (including OpenCL::UserEvent 1409This is the superclass for all event objects (including OpenCL::UserEvent
611objects). 1410objects).
612 1411
613=over 4 1412=over 4
614 1413
1414=item $ev->wait
1415
1416Waits for the event to complete.
1417
1418L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1419
615=item $packed_value = $ev->info ($name) 1420=item $packed_value = $ev->info ($name)
616 1421
617See C<< $platform->info >> for details. 1422See C<< $platform->info >> for details.
618 1423
619L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1424L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
620 1425
621=item $ev->wait 1426=for gengetinfo begin event
622 1427
623Waits for the event to complete. 1428=item $queue = $event->command_queue
624 1429
1430Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1431
1432=item $command_type = $event->command_type
1433
1434Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1435
1436=item $uint = $event->reference_count
1437
1438Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1439
1440=item $uint = $event->command_execution_status
1441
1442Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1443
1444=item $ctx = $event->context
1445
1446Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1447
1448=for gengetinfo end event
1449
1450=item $packed_value = $ev->profiling_info ($name)
1451
1452See C<< $platform->info >> for details.
1453
1454The reason this method is not called C<info> is that there already is an
1455C<< ->info >> method.
1456
625L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1457L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1458
1459=for gengetinfo begin profiling
1460
1461=item $ulong = $event->profiling_command_queued
1462
1463Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1464
1465=item $ulong = $event->profiling_command_submit
1466
1467Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1468
1469=item $ulong = $event->profiling_command_start
1470
1471Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1472
1473=item $ulong = $event->profiling_command_end
1474
1475Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1476
1477=for gengetinfo end profiling
626 1478
627=back 1479=back
628 1480
629=head2 THE OpenCL::UserEvent CLASS 1481=head2 THE OpenCL::UserEvent CLASS
630 1482
643package OpenCL; 1495package OpenCL;
644 1496
645use common::sense; 1497use common::sense;
646 1498
647BEGIN { 1499BEGIN {
648 our $VERSION = '0.03'; 1500 our $VERSION = '0.96';
649 1501
650 require XSLoader; 1502 require XSLoader;
651 XSLoader::load (__PACKAGE__, $VERSION); 1503 XSLoader::load (__PACKAGE__, $VERSION);
652 1504
653 @OpenCL::Buffer::ISA = 1505 @OpenCL::Buffer::ISA =
654 @OpenCL::Image::ISA = OpenCL::Memory::; 1506 @OpenCL::Image::ISA = OpenCL::Memory::;
655 1507
1508 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1509
656 @OpenCL::Image2D::ISA = 1510 @OpenCL::Image2D::ISA =
1511 @OpenCL::Image3D::ISA =
1512 @OpenCL::Image2DArray::ISA =
1513 @OpenCL::Image1D::ISA =
1514 @OpenCL::Image1DArray::ISA =
657 @OpenCL::Image3D::ISA = OpenCL::Image::; 1515 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
658 1516
659 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1517 @OpenCL::UserEvent::ISA = OpenCL::Event::;
660} 1518}
661 1519
6621; 15201;
663 1521
664=head1 AUTHOR 1522=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines