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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.14 by root, Thu Nov 17 03:02:25 2011 UTC vs.
Revision 1.50 by root, Tue Apr 24 13:30:49 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.
196 # enqueue an async read 210 # enqueue an async read
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;
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 }
201 310
202=head1 DOCUMENTATION 311=head1 DOCUMENTATION
203 312
204=head2 BASIC CONVENTIONS 313=head2 BASIC CONVENTIONS
205 314
212 321
213=item * Object lifetime managament is automatic - there is no need 322=item * Object lifetime managament is automatic - there is no need
214to free objects explicitly (C<clReleaseXXX>), the release function 323to free objects explicitly (C<clReleaseXXX>), the release function
215is called automatically once all Perl references to it go away. 324is called automatically once all Perl references to it go away.
216 325
217=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), 326=item * OpenCL uses CamelCase for function names
327(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
218while this module uses underscores as word separator and often leaves out 328uses underscores as word separator and often leaves out prefixes
219prefixes (C<< $platform->info >>). 329(C<OpenCL::platforms>, C<< $platform->info >>).
220 330
221=item * OpenCL often specifies fixed vector function arguments as short 331=item * OpenCL often specifies fixed vector function arguments as short
222arrays (C<size_t origin[3]>), while this module explicitly expects the 332arrays (C<size_t origin[3]>), while this module explicitly expects the
223components as separate arguments- 333components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
334function calls.
224 335
225=item * Structures are often specified with their components, and returned 336=item * Structures are often specified by flattening out their components
226as arrayrefs. 337as with short vectors, and returned as arrayrefs.
227
228=item * Where possible, one of the pitch values is calculated from the
229perl scalar length and need not be specified.
230 338
231=item * When enqueuing commands, the wait list is specified by adding 339=item * When enqueuing commands, the wait list is specified by adding
232extra arguments to the function - anywhere a C<$wait_events...> argument 340extra arguments to the function - anywhere a C<$wait_events...> argument
233is documented this can be any number of event objects. 341is documented this can be any number of event objects. As an extsnion
342implemented by this module, C<undef> values will be ignored in the event
343list.
234 344
235=item * When enqueuing commands, if the enqueue method is called in void 345=item * When enqueuing commands, if the enqueue method is called in void
236context, no event is created. In all other contexts an event is returned 346context, no event is created. In all other contexts an event is returned
237by the method. 347by the method.
238 348
258 ulong IV - Q 368 ulong IV - Q
259 float NV float f 369 float NV float f
260 half IV ushort S 370 half IV ushort S
261 double NV double d 371 double NV double d
262 372
373=head2 GLX SUPPORT
374
375Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
376module, which has little to no documentation and has little to no support
377for glX), this module, as a special extension, treats context creation
378properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
379specially: If either or both of these are C<undef>, then the OpenCL
380module tries to dynamically resolve C<glXGetCurrentDisplay> and
381C<glXGetCurrentContext>, call these functions and use their return values
382instead.
383
384For this to work, the OpenGL library must be loaded, a GLX context must
385have been created and be made current, and C<dlsym> must be available and
386capable of finding the function via C<RTLD_DEFAULT>.
387
263=head2 THE OpenCL PACKAGE 388=head2 THE OpenCL PACKAGE
264 389
265=over 4 390=over 4
266 391
267=item $int = OpenCL::errno 392=item $int = OpenCL::errno
273 398
274Comverts an error value into a human readable string. 399Comverts an error value into a human readable string.
275 400
276=item $str = OpenCL::enum2str $enum 401=item $str = OpenCL::enum2str $enum
277 402
278Converts most enum values (inof parameter names, image format constants, 403Converts most enum values (of parameter names, image format constants,
279object types, addressing and filter modes, command types etc.) into a 404object types, addressing and filter modes, command types etc.) into a
280human readbale string. When confronted with some random integer it can be 405human readable string. When confronted with some random integer it can be
281very helpful to pass it through this function to maybe get some readable 406very helpful to pass it through this function to maybe get some readable
282string out of it. 407string out of it.
283 408
284=item @platforms = OpenCL::platforms 409=item @platforms = OpenCL::platforms
285 410
303 428
304=head2 THE OpenCL::Platform CLASS 429=head2 THE OpenCL::Platform CLASS
305 430
306=over 4 431=over 4
307 432
308=item $packed_value = $platform->info ($name)
309
310Calls C<clGetPlatformInfo> and returns the packed, raw value - for
311strings, this will be the string, for other values you probably need to
312use the correct C<unpack>. This might get improved in the future. Hopefully.
313
314L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
315
316=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 433=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
317 434
318Returns a list of matching OpenCL::Device objects. 435Returns a list of matching OpenCL::Device objects.
319 436
320=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 437=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
321 438
322Tries to create a context. Never worked for me, and you need devices explitly anyway. 439Tries to create a context. Never worked for me, and you need devices explicitly anyway.
323 440
324L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 441L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
325 442
326=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 443=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
327 444
328Create a new OpenCL::Context object using the given device object(s)- a 445Create a new OpenCL::Context object using the given device object(s)- a
329CL_CONTEXT_PLATFORM property is supplied automatically. 446CL_CONTEXT_PLATFORM property is supplied automatically.
330 447
331L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 448L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
332 449
450=item $packed_value = $platform->info ($name)
451
452Calls C<clGetPlatformInfo> and returns the packed, raw value - for
453strings, this will be the string (possibly including terminating \0), for
454other values you probably need to use the correct C<unpack>.
455
456It's best to avoid this method and use one of the following convenience
457wrappers.
458
459L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
460
461=item $platform->unload_compiler
462
463Attempts to unload the compiler for this platform, for endless
464profit. Does nothing on OpenCL 1.1.
465
466L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
467
468=for gengetinfo begin platform
469
470=item $string = $platform->profile
471
472Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
473
474=item $string = $platform->version
475
476Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
477
478=item $string = $platform->name
479
480Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
481
482=item $string = $platform->vendor
483
484Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
485
486=item $string = $platform->extensions
487
488Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
489
490=for gengetinfo end platform
491
333=back 492=back
334 493
335=head2 THE OpenCL::Device CLASS 494=head2 THE OpenCL::Device CLASS
336 495
337=over 4 496=over 4
340 499
341See C<< $platform->info >> for details. 500See C<< $platform->info >> for details.
342 501
343L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 502L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
344 503
504=for gengetinfo begin device
505
506=item $device_type = $device->type
507
508Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
509
510=item $uint = $device->vendor_id
511
512Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
513
514=item $uint = $device->max_compute_units
515
516Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
517
518=item $uint = $device->max_work_item_dimensions
519
520Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
521
522=item $int = $device->max_work_group_size
523
524Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
525
526=item @ints = $device->max_work_item_sizes
527
528Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
529
530=item $uint = $device->preferred_vector_width_char
531
532Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
533
534=item $uint = $device->preferred_vector_width_short
535
536Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
537
538=item $uint = $device->preferred_vector_width_int
539
540Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
541
542=item $uint = $device->preferred_vector_width_long
543
544Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
545
546=item $uint = $device->preferred_vector_width_float
547
548Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
549
550=item $uint = $device->preferred_vector_width_double
551
552Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
553
554=item $uint = $device->max_clock_frequency
555
556Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
557
558=item $bitfield = $device->address_bits
559
560Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
561
562=item $uint = $device->max_read_image_args
563
564Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
565
566=item $uint = $device->max_write_image_args
567
568Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
569
570=item $ulong = $device->max_mem_alloc_size
571
572Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
573
574=item $int = $device->image2d_max_width
575
576Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
577
578=item $int = $device->image2d_max_height
579
580Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
581
582=item $int = $device->image3d_max_width
583
584Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
585
586=item $int = $device->image3d_max_height
587
588Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
589
590=item $int = $device->image3d_max_depth
591
592Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
593
594=item $uint = $device->image_support
595
596Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
597
598=item $int = $device->max_parameter_size
599
600Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
601
602=item $uint = $device->max_samplers
603
604Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
605
606=item $uint = $device->mem_base_addr_align
607
608Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
609
610=item $uint = $device->min_data_type_align_size
611
612Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
613
614=item $device_fp_config = $device->single_fp_config
615
616Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
617
618=item $device_mem_cache_type = $device->global_mem_cache_type
619
620Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
621
622=item $uint = $device->global_mem_cacheline_size
623
624Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
625
626=item $ulong = $device->global_mem_cache_size
627
628Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
629
630=item $ulong = $device->global_mem_size
631
632Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
633
634=item $ulong = $device->max_constant_buffer_size
635
636Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
637
638=item $uint = $device->max_constant_args
639
640Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
641
642=item $device_local_mem_type = $device->local_mem_type
643
644Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
645
646=item $ulong = $device->local_mem_size
647
648Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
649
650=item $boolean = $device->error_correction_support
651
652Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
653
654=item $int = $device->profiling_timer_resolution
655
656Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
657
658=item $boolean = $device->endian_little
659
660Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
661
662=item $boolean = $device->available
663
664Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
665
666=item $boolean = $device->compiler_available
667
668Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
669
670=item $device_exec_capabilities = $device->execution_capabilities
671
672Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
673
674=item $command_queue_properties = $device->properties
675
676Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
677
678=item $ = $device->platform
679
680Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
681
682=item $string = $device->name
683
684Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
685
686=item $string = $device->vendor
687
688Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
689
690=item $string = $device->driver_version
691
692Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
693
694=item $string = $device->profile
695
696Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
697
698=item $string = $device->version
699
700Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
701
702=item $string = $device->extensions
703
704Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
705
706=item $uint = $device->preferred_vector_width_half
707
708Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
709
710=item $uint = $device->native_vector_width_char
711
712Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
713
714=item $uint = $device->native_vector_width_short
715
716Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
717
718=item $uint = $device->native_vector_width_int
719
720Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
721
722=item $uint = $device->native_vector_width_long
723
724Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
725
726=item $uint = $device->native_vector_width_float
727
728Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
729
730=item $uint = $device->native_vector_width_double
731
732Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
733
734=item $uint = $device->native_vector_width_half
735
736Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
737
738=item $device_fp_config = $device->double_fp_config
739
740Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
741
742=item $device_fp_config = $device->half_fp_config
743
744Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
745
746=item $boolean = $device->host_unified_memory
747
748Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
749
750=item $device = $device->parent_device_ext
751
752Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
753
754=item @device_partition_property_exts = $device->partition_types_ext
755
756Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
757
758=item @device_partition_property_exts = $device->affinity_domains_ext
759
760Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
761
762=item $uint = $device->reference_count_ext
763
764Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
765
766=item @device_partition_property_exts = $device->partition_style_ext
767
768Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
769
770=for gengetinfo end device
771
345=back 772=back
346 773
347=head2 THE OpenCL::Context CLASS 774=head2 THE OpenCL::Context CLASS
348 775
349=over 4 776=over 4
350 777
351=item $packed_value = $ctx->info ($name)
352
353See C<< $platform->info >> for details.
354
355L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
356
357=item $queue = $ctx->queue ($device, $properties) 778=item $queue = $ctx->queue ($device, $properties)
358 779
359Create a new OpenCL::Queue object from the context and the given device. 780Create a new OpenCL::Queue object from the context and the given device.
360 781
361L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 782L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
362 783
784Example: create an out-of-order queue.
785
786 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
787
363=item $ev = $ctx->user_event 788=item $ev = $ctx->user_event
364 789
365Creates a new OpenCL::UserEvent object. 790Creates a new OpenCL::UserEvent object.
366 791
367L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 792L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
368 793
369=item $buf = $ctx->buffer ($flags, $len) 794=item $buf = $ctx->buffer ($flags, $len)
370 795
371Creates a new OpenCL::Buffer object with the given flags and octet-size. 796Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
797given flags and octet-size.
372 798
373L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 799L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
374 800
375=item $buf = $ctx->buffer_sv ($flags, $data) 801=item $buf = $ctx->buffer_sv ($flags, $data)
376 802
377Creates a new OpenCL::Buffer object and initialise it with the given data values. 803Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
804initialise it with the given data values.
378 805
806=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)
807
808Creates a new OpenCL::Image object and optionally initialises it with
809the given data values.
810
811L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
812
379=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 813=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
380 814
381Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 815Creates a new OpenCL::Image2D object and optionally initialises it with
816the given data values.
382 817
383L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 818L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
384 819
385=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 820=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
386 821
387Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 822Creates a new OpenCL::Image3D object and optionally initialises it with
823the given data values.
388 824
389L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 825L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
826
827=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
828
829Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
830OpenGL buffer object.
831
832http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
833
834=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
835
836Creates a new OpenCL::Image object that refers to the given OpenGL
837texture object or buffer.
838
839http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
840
841=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
842
843Creates a new OpenCL::Image2D object that refers to the given OpenGL
8442D texture object.
845
846http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
847
848=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
849
850Creates a new OpenCL::Image3D object that refers to the given OpenGL
8513D texture object.
852
853http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
854
855=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
856
857Creates a new OpenCL::Image2D object that refers to the given OpenGL
858render buffer.
859
860http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
390 861
391=item @formats = $ctx->supported_image_formats ($flags, $image_type) 862=item @formats = $ctx->supported_image_formats ($flags, $image_type)
392 863
393Returns a list of matching image formats - each format is an arrayref with 864Returns a list of matching image formats - each format is an arrayref with
394two values, $channel_order and $channel_type, in it. 865two values, $channel_order and $channel_type, in it.
404=item $program = $ctx->program_with_source ($string) 875=item $program = $ctx->program_with_source ($string)
405 876
406Creates a new OpenCL::Program object from the given source code. 877Creates a new OpenCL::Program object from the given source code.
407 878
408L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 879L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
880
881=item $packed_value = $ctx->info ($name)
882
883See C<< $platform->info >> for details.
884
885L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
886
887=for gengetinfo begin context
888
889=item $uint = $context->reference_count
890
891Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
892
893=item @devices = $context->devices
894
895Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
896
897=item @property_ints = $context->properties
898
899Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
900
901=item $uint = $context->num_devices
902
903Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
904
905=for gengetinfo end context
409 906
410=back 907=back
411 908
412=head2 THE OpenCL::Queue CLASS 909=head2 THE OpenCL::Queue CLASS
413 910
419for completion, unless the method is called in void context, in which case 916for completion, unless the method is called in void context, in which case
420no event object is created. 917no event object is created.
421 918
422They also allow you to specify any number of other event objects that this 919They also allow you to specify any number of other event objects that this
423request has to wait for before it starts executing, by simply passing the 920request has to wait for before it starts executing, by simply passing the
424event objects as extra parameters to the enqueue methods. 921event objects as extra parameters to the enqueue methods. To simplify
922program design, this module ignores any C<undef> values in the list of
923events. This makes it possible to code operations such as this, without
924having to put a valid event object into C<$event> first:
925
926 $event = $queue->enqueue_xxx (..., $event);
425 927
426Queues execute in-order by default, without any parallelism, so in most 928Queues execute in-order by default, without any parallelism, so in most
427cases (i.e. you use only one queue) it's not necessary to wait for or 929cases (i.e. you use only one queue) it's not necessary to wait for or
428create event objects. 930create event objects, althoguh an our of order queue is often a bit
931faster.
429 932
430=over 4 933=over 4
431 934
432=item $packed_value = $ctx->info ($name)
433
434See C<< $platform->info >> for details.
435
436L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
437
438=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 935=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
439 936
440Reads data from buffer into the given string. 937Reads data from buffer into the given string.
441 938
442L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 939L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
449 946
450=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 947=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
451 948
452L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 949L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
453 950
951=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...)
952
953http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
954
955=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...)
956
957http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
958
454=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 959=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
455 960
961L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
962
963=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...)
964
456L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 965L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
457 966
458=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 967=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
459 968
460L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 969L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
461 970
971=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...)
972
973L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
974
975=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...)
976
977L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
978
462=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, 4dst_row_pitch, $dst_slice_pitch, $ait_event...) 979=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
463 980
464Yeah. 981Yeah.
465 982
466L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
467
468=item $ev = $queue->enqueue_copy_buffer_to_image (OpenCL::Buffer src, OpenCL::Image dst, size_t src_offset, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
469
470L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 983L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
471
472=item $ev = $queue->enqueue_copy_image (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
473
474L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
475
476=item $ev = $queue->enqueue_copy_image_to_buffer (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t width, size_t height, size_t depth, size_t dst_offset, ...)
477
478L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
479 984
480=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 985=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
481 986
482L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 987L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
483 988
497reference to an array of local work sizes, with the same number of 1002reference to an array of local work sizes, with the same number of
498elements as @$global_work_size. 1003elements as @$global_work_size.
499 1004
500L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1005L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
501 1006
502=item $ev = $queue->enqueue_marker 1007=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
503 1008
1009Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1010for subsequent OpenCL usage.
1011
504L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1012L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1013
1014=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1015
1016Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1017for subsequent OpenGL usage.
1018
1019L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
505 1020
506=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1021=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
507 1022
508L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1023L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
509 1024
510=item $queue->enqueue_barrier 1025=item $ev = $queue->enqueue_marker ($wait_events...)
511 1026
1027L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1028
1029=item $ev = $queue->enqueue_barrier ($wait_events...)
1030
512L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1031L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
513 1032
514=item $queue->flush 1033=item $queue->flush
515 1034
516L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1035L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
517 1036
518=item $queue->finish 1037=item $queue->finish
519 1038
520L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1039L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
521 1040
1041=item $packed_value = $queue->info ($name)
1042
1043See C<< $platform->info >> for details.
1044
1045L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1046
1047=for gengetinfo begin command_queue
1048
1049=item $ctx = $command_queue->context
1050
1051Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1052
1053=item $device = $command_queue->device
1054
1055Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1056
1057=item $uint = $command_queue->reference_count
1058
1059Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1060
1061=item $command_queue_properties = $command_queue->properties
1062
1063Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1064
1065=for gengetinfo end command_queue
1066
522=back 1067=back
523 1068
524=head2 THE OpenCL::Memory CLASS 1069=head2 THE OpenCL::Memory CLASS
525 1070
526This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1071This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
527OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1072OpenCL::Image2D and OpenCL::Image3D.
528currently only exist to allow type-checking.
529 1073
530=over 4 1074=over 4
531 1075
532=item $packed_value = $memory->info ($name) 1076=item $packed_value = $memory->info ($name)
533 1077
534See C<< $platform->info >> for details. 1078See C<< $platform->info >> for details.
535 1079
536L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1080L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
537 1081
1082=for gengetinfo begin mem
1083
1084=item $mem_object_type = $mem->type
1085
1086Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1087
1088=item $mem_flags = $mem->flags
1089
1090Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1091
1092=item $int = $mem->size
1093
1094Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1095
1096=item $ptr_value = $mem->host_ptr
1097
1098Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1099
1100=item $uint = $mem->map_count
1101
1102Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1103
1104=item $uint = $mem->reference_count
1105
1106Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1107
1108=item $ctx = $mem->context
1109
1110Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1111
1112=item $mem = $mem->associated_memobject
1113
1114Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1115
1116=item $int = $mem->offset
1117
1118Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1119
1120=for gengetinfo end mem
1121
1122=item ($type, $name) = $mem->gl_object_info
1123
1124Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1125object "name" (e.g. the texture name) used to create this memory object.
1126
1127L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1128
538=back 1129=back
539 1130
1131=head2 THE OpenCL::Buffer CLASS
1132
1133This is a subclass of OpenCL::Memory, and the superclass of
1134OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1135and sub-buffers.
1136
1137=head2 THE OpenCL::BufferObj CLASS
1138
1139This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1140because one cna create sub buffers of OpenLC::BufferObj objects, but not
1141sub buffers from these sub buffers.
1142
1143=over 4
1144
1145=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1146
1147Creates an OpenCL::Buffer objects from this buffer and returns it. The
1148C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1149
1150L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1151
1152=back
1153
1154=head2 THE OpenCL::Image CLASS
1155
1156This is the superclass of all image objects - OpenCL::Image1D,
1157OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1158OpenCL::Image2DArray and OpenCL::Image3D.
1159
1160=over 4
1161
1162=item $packed_value = $ev->image_info ($name)
1163
1164See C<< $platform->info >> for details.
1165
1166The reason this method is not called C<info> is that there already is an
1167C<< ->info >> method inherited from C<OpenCL::Memory>.
1168
1169L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1170
1171=for gengetinfo begin image
1172
1173=item $int = $image->element_size
1174
1175Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1176
1177=item $int = $image->row_pitch
1178
1179Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1180
1181=item $int = $image->slice_pitch
1182
1183Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1184
1185=item $int = $image->width
1186
1187Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1188
1189=item $int = $image->height
1190
1191Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1192
1193=item $int = $image->depth
1194
1195Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1196
1197=for gengetinfo end image
1198
1199=for gengetinfo begin gl_texture
1200
1201=item $GLenum = $gl_texture->target
1202
1203Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1204
1205=item $GLint = $gl_texture->gl_mipmap_level
1206
1207Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1208
1209=for gengetinfo end gl_texture
1210
1211=back
1212
540=head2 THE OpenCL::Sampler CLASS 1213=head2 THE OpenCL::Sampler CLASS
541 1214
542=over 4 1215=over 4
543 1216
544=item $packed_value = $sampler->info ($name) 1217=item $packed_value = $sampler->info ($name)
545 1218
546See C<< $platform->info >> for details. 1219See C<< $platform->info >> for details.
547 1220
548L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1221L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
549 1222
1223=for gengetinfo begin sampler
1224
1225=item $uint = $sampler->reference_count
1226
1227Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1228
1229=item $ctx = $sampler->context
1230
1231Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1232
1233=item $addressing_mode = $sampler->normalized_coords
1234
1235Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1236
1237=item $filter_mode = $sampler->addressing_mode
1238
1239Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1240
1241=item $boolean = $sampler->filter_mode
1242
1243Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1244
1245=for gengetinfo end sampler
1246
550=back 1247=back
551 1248
552=head2 THE OpenCL::Program CLASS 1249=head2 THE OpenCL::Program CLASS
553 1250
554=over 4 1251=over 4
555
556=item $packed_value = $program->info ($name)
557
558See C<< $platform->info >> for details.
559
560L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
561 1252
562=item $program->build ($device, $options = "") 1253=item $program->build ($device, $options = "")
563 1254
564Tries to build the program with the givne options. 1255Tries to build the program with the givne options.
565 1256
577Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1268Creates an OpenCL::Kernel object out of the named C<__kernel> function in
578the program. 1269the program.
579 1270
580L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1271L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
581 1272
1273=item @kernels = $program->kernels_in_program
1274
1275Returns all kernels successfully compiled for all devices in program.
1276
1277http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1278
1279=for gengetinfo begin program_build
1280
1281=item $build_status = $program->build_status ($device)
1282
1283Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1284
1285=item $string = $program->build_options ($device)
1286
1287Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1288
1289=item $string = $program->build_log ($device)
1290
1291Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1292
1293=for gengetinfo end program_build
1294
1295=item $packed_value = $program->info ($name)
1296
1297See C<< $platform->info >> for details.
1298
1299L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1300
1301=for gengetinfo begin program
1302
1303=item $uint = $program->reference_count
1304
1305Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1306
1307=item $ctx = $program->context
1308
1309Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1310
1311=item $uint = $program->num_devices
1312
1313Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1314
1315=item @devices = $program->devices
1316
1317Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1318
1319=item $string = $program->source
1320
1321Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1322
1323=item @ints = $program->binary_sizes
1324
1325Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1326
1327=for gengetinfo end program
1328
1329=item @blobs = $program->binaries
1330
1331Returns a string for the compiled binary for every device associated with
1332the program, empty strings indicate missing programs, and an empty result
1333means no program binaries are available.
1334
1335These "binaries" are often, in fact, informative low-level assembly
1336sources.
1337
1338L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1339
582=back 1340=back
583 1341
584=head2 THE OpenCL::Kernel CLASS 1342=head2 THE OpenCL::Kernel CLASS
585 1343
586=over 4 1344=over 4
588=item $packed_value = $kernel->info ($name) 1346=item $packed_value = $kernel->info ($name)
589 1347
590See C<< $platform->info >> for details. 1348See C<< $platform->info >> for details.
591 1349
592L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1350L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1351
1352=for gengetinfo begin kernel
1353
1354=item $string = $kernel->function_name
1355
1356Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1357
1358=item $uint = $kernel->num_args
1359
1360Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1361
1362=item $uint = $kernel->reference_count
1363
1364Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1365
1366=item $ctx = $kernel->context
1367
1368Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1369
1370=item $program = $kernel->program
1371
1372Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1373
1374=for gengetinfo end kernel
1375
1376=item $packed_value = $kernel->work_group_info ($device, $name)
1377
1378See C<< $platform->info >> for details.
1379
1380The reason this method is not called C<info> is that there already is an
1381C<< ->info >> method.
1382
1383L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1384
1385=for gengetinfo begin kernel_work_group
1386
1387=item $int = $kernel->work_group_size ($device)
1388
1389Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1390
1391=item @ints = $kernel->compile_work_group_size ($device)
1392
1393Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1394
1395=item $ulong = $kernel->local_mem_size ($device)
1396
1397Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1398
1399=item $int = $kernel->preferred_work_group_size_multiple ($device)
1400
1401Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1402
1403=item $ulong = $kernel->private_mem_size ($device)
1404
1405Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1406
1407=for gengetinfo end kernel_work_group
593 1408
594=item $kernel->set_TYPE ($index, $value) 1409=item $kernel->set_TYPE ($index, $value)
595 1410
596This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1411This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
597 1412
598TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1413TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
599C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1414C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
600C<image2d>, C<image3d>, C<sampler> or C<event>. 1415C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
601 1416
602Chars and integers (including the half type) are specified as integers, 1417Chars and integers (including the half type) are specified as integers,
603float and double as floating point values, memory/buffer/image2d/image3d 1418float and double as floating point values, memory/buffer/image2d/image3d
604must be an object of that type or C<undef>, and sampler and event must be 1419must be an object of that type or C<undef>, local-memory arguments are
605objects of that type. 1420set by specifying the size, and sampler and event must be objects of that
1421type.
1422
1423Setting an argument for a kernel does NOT keep a reference to the object -
1424for example, if you set an argument to some image object, free the image,
1425and call the kernel, you will run into undefined behaviour.
606 1426
607L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1427L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
608 1428
609=back 1429=back
610 1430
613This is the superclass for all event objects (including OpenCL::UserEvent 1433This is the superclass for all event objects (including OpenCL::UserEvent
614objects). 1434objects).
615 1435
616=over 4 1436=over 4
617 1437
1438=item $ev->wait
1439
1440Waits for the event to complete.
1441
1442L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1443
618=item $packed_value = $ev->info ($name) 1444=item $packed_value = $ev->info ($name)
619 1445
620See C<< $platform->info >> for details. 1446See C<< $platform->info >> for details.
621 1447
622L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1448L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
623 1449
624=item $ev->wait 1450=for gengetinfo begin event
625 1451
626Waits for the event to complete. 1452=item $queue = $event->command_queue
627 1453
1454Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1455
1456=item $command_type = $event->command_type
1457
1458Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1459
1460=item $uint = $event->reference_count
1461
1462Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1463
1464=item $uint = $event->command_execution_status
1465
1466Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1467
1468=item $ctx = $event->context
1469
1470Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1471
1472=for gengetinfo end event
1473
1474=item $packed_value = $ev->profiling_info ($name)
1475
1476See C<< $platform->info >> for details.
1477
1478The reason this method is not called C<info> is that there already is an
1479C<< ->info >> method.
1480
628L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1481L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1482
1483=for gengetinfo begin profiling
1484
1485=item $ulong = $event->profiling_command_queued
1486
1487Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1488
1489=item $ulong = $event->profiling_command_submit
1490
1491Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1492
1493=item $ulong = $event->profiling_command_start
1494
1495Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1496
1497=item $ulong = $event->profiling_command_end
1498
1499Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1500
1501=for gengetinfo end profiling
629 1502
630=back 1503=back
631 1504
632=head2 THE OpenCL::UserEvent CLASS 1505=head2 THE OpenCL::UserEvent CLASS
633 1506
646package OpenCL; 1519package OpenCL;
647 1520
648use common::sense; 1521use common::sense;
649 1522
650BEGIN { 1523BEGIN {
651 our $VERSION = '0.14'; 1524 our $VERSION = '0.96';
652 1525
653 require XSLoader; 1526 require XSLoader;
654 XSLoader::load (__PACKAGE__, $VERSION); 1527 XSLoader::load (__PACKAGE__, $VERSION);
655 1528
656 @OpenCL::Buffer::ISA = 1529 @OpenCL::Buffer::ISA =
657 @OpenCL::Image::ISA = OpenCL::Memory::; 1530 @OpenCL::Image::ISA = OpenCL::Memory::;
658 1531
1532 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1533
659 @OpenCL::Image2D::ISA = 1534 @OpenCL::Image2D::ISA =
1535 @OpenCL::Image3D::ISA =
1536 @OpenCL::Image2DArray::ISA =
1537 @OpenCL::Image1D::ISA =
1538 @OpenCL::Image1DArray::ISA =
660 @OpenCL::Image3D::ISA = OpenCL::Image::; 1539 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
661 1540
662 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1541 @OpenCL::UserEvent::ISA = OpenCL::Event::;
663} 1542}
664 1543
6651; 15441;
666 1545
667=head1 AUTHOR 1546=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines