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.30 by root, Thu Apr 5 10:08:59 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.
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); 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.
201 215
202=head1 DOCUMENTATION 216=head1 DOCUMENTATION
203 217
204=head2 BASIC CONVENTIONS 218=head2 BASIC CONVENTIONS
205 219
206This is not a 1:1 C-style translation of OpenCL to Perl - instead I 220This 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 221I attempted to make the interface as type-safe as possible by introducing
208object syntax where it makes sense. There are a number of important 222object syntax where it makes sense. There are a number of important
209differences between the OpenCL C API and this module: 223differences between the OpenCL C API and this module:
210 224
211=over 4 225=over 4
212 226
213=item * Object lifetime managament is automatic - there is no need 227=item * Object lifetime managament is automatic - there is no need
214to free objects explicitly (C<clReleaseXXX>), the release function 228to free objects explicitly (C<clReleaseXXX>), the release function
215is called automatically once all Perl references to it go away. 229is called automatically once all Perl references to it go away.
216 230
217=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), 231=item * OpenCL uses CamelCase for function names
232(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
218while this module uses underscores as word separator and often leaves out 233uses underscores as word separator and often leaves out prefixes
219prefixes (C<< $platform->info >>). 234(C<OpenCL::platforms>, C<< $platform->info >>).
220 235
221=item * OpenCL often specifies fixed vector function arguments as short 236=item * OpenCL often specifies fixed vector function arguments as short
222arrays (C<size_t origin[3]>), while this module explicitly expects the 237arrays (C<size_t origin[3]>), while this module explicitly expects the
223components as separate arguments- 238components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
239function calls.
224 240
225=item * Where possible, one of the pitch values is calculated from the 241=item * Structures are often specified by flattening out their components
226perl scalar length and need not be specified. 242as with short vectors, and returned as arrayrefs.
227 243
228=item * When enqueuing commands, the wait list is specified by adding 244=item * When enqueuing commands, the wait list is specified by adding
229extra arguments to the function - anywhere a C<$wait_events...> argument 245extra arguments to the function - anywhere a C<$wait_events...> argument
230is documented this can be any number of event objects. 246is documented this can be any number of event objects.
231 247
270 286
271Comverts an error value into a human readable string. 287Comverts an error value into a human readable string.
272 288
273=item $str = OpenCL::enum2str $enum 289=item $str = OpenCL::enum2str $enum
274 290
275Converts most enum values (inof parameter names, image format constants, 291Converts most enum values (of parameter names, image format constants,
276object types, addressing and filter modes, command types etc.) into a 292object types, addressing and filter modes, command types etc.) into a
277human readbale string. When confronted with some random integer it can be 293human readable string. When confronted with some random integer it can be
278very helpful to pass it through this function to maybe get some readable 294very helpful to pass it through this function to maybe get some readable
279string out of it. 295string out of it.
280 296
281=item @platforms = OpenCL::platforms 297=item @platforms = OpenCL::platforms
282 298
300 316
301=head2 THE OpenCL::Platform CLASS 317=head2 THE OpenCL::Platform CLASS
302 318
303=over 4 319=over 4
304 320
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) 321=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
314 322
315Returns a list of matching OpenCL::Device objects. 323Returns a list of matching OpenCL::Device objects.
316 324
317=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 325=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
318 326
319Tries to create a context. Never worked for me, and you need devices explitly anyway. 327Tries to create a context. Never worked for me, and you need devices explicitly anyway.
320 328
321L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
322 330
323=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 331=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
324 332
325Create a new OpenCL::Context object using the given device object(s)- a 333Create a new OpenCL::Context object using the given device object(s)- a
326CL_CONTEXT_PLATFORM property is supplied automatically. 334CL_CONTEXT_PLATFORM property is supplied automatically.
327 335
328L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
329 337
338=item $packed_value = $platform->info ($name)
339
340Calls C<clGetPlatformInfo> and returns the packed, raw value - for
341strings, this will be the string (possibly including terminating \0), for
342other values you probably need to use the correct C<unpack>.
343
344It's best to avoid this method and use one of the following convenience
345wrappers.
346
347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348
349=for gengetinfo begin platform
350
351=item $string = $platform->profile
352
353Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
354
355=item $string = $platform->version
356
357Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
358
359=item $string = $platform->name
360
361Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
362
363=item $string = $platform->vendor
364
365Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
366
367=item $string = $platform->extensions
368
369Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
370
371=for gengetinfo end platform
372
330=back 373=back
331 374
332=head2 THE OpenCL::Device CLASS 375=head2 THE OpenCL::Device CLASS
333 376
334=over 4 377=over 4
337 380
338See C<< $platform->info >> for details. 381See C<< $platform->info >> for details.
339 382
340L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 383L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
341 384
385=for gengetinfo begin device
386
387=item $device_type = $device->type
388
389Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
390
391=item $uint = $device->vendor_id
392
393Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
394
395=item $uint = $device->max_compute_units
396
397Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
398
399=item $uint = $device->max_work_item_dimensions
400
401Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
402
403=item $int = $device->max_work_group_size
404
405Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
406
407=item @ints = $device->max_work_item_sizes
408
409Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
410
411=item $uint = $device->preferred_vector_width_char
412
413Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
414
415=item $uint = $device->preferred_vector_width_short
416
417Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
418
419=item $uint = $device->preferred_vector_width_int
420
421Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
422
423=item $uint = $device->preferred_vector_width_long
424
425Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
426
427=item $uint = $device->preferred_vector_width_float
428
429Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
430
431=item $uint = $device->preferred_vector_width_double
432
433Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
434
435=item $uint = $device->max_clock_frequency
436
437Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
438
439=item $bitfield = $device->address_bits
440
441Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
442
443=item $uint = $device->max_read_image_args
444
445Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
446
447=item $uint = $device->max_write_image_args
448
449Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
450
451=item $ulong = $device->max_mem_alloc_size
452
453Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
454
455=item $int = $device->image2d_max_width
456
457Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
458
459=item $int = $device->image2d_max_height
460
461Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
462
463=item $int = $device->image3d_max_width
464
465Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
466
467=item $int = $device->image3d_max_height
468
469Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
470
471=item $int = $device->image3d_max_depth
472
473Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
474
475=item $uint = $device->image_support
476
477Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
478
479=item $int = $device->max_parameter_size
480
481Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
482
483=item $uint = $device->max_samplers
484
485Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
486
487=item $uint = $device->mem_base_addr_align
488
489Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
490
491=item $uint = $device->min_data_type_align_size
492
493Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
494
495=item $device_fp_config = $device->single_fp_config
496
497Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
498
499=item $device_mem_cache_type = $device->global_mem_cache_type
500
501Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
502
503=item $uint = $device->global_mem_cacheline_size
504
505Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
506
507=item $ulong = $device->global_mem_cache_size
508
509Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
510
511=item $ulong = $device->global_mem_size
512
513Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
514
515=item $ulong = $device->max_constant_buffer_size
516
517Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
518
519=item $uint = $device->max_constant_args
520
521Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
522
523=item $device_local_mem_type = $device->local_mem_type
524
525Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
526
527=item $ulong = $device->local_mem_size
528
529Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
530
531=item $boolean = $device->error_correction_support
532
533Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
534
535=item $int = $device->profiling_timer_resolution
536
537Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
538
539=item $boolean = $device->endian_little
540
541Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
542
543=item $boolean = $device->available
544
545Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
546
547=item $boolean = $device->compiler_available
548
549Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
550
551=item $device_exec_capabilities = $device->execution_capabilities
552
553Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
554
555=item $command_queue_properties = $device->properties
556
557Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
558
559=item $ = $device->platform
560
561Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
562
563=item $string = $device->name
564
565Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
566
567=item $string = $device->vendor
568
569Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
570
571=item $string = $device->driver_version
572
573Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
574
575=item $string = $device->profile
576
577Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
578
579=item $string = $device->version
580
581Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
582
583=item $string = $device->extensions
584
585Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
586
587=item $uint = $device->preferred_vector_width_half
588
589Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
590
591=item $uint = $device->native_vector_width_char
592
593Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
594
595=item $uint = $device->native_vector_width_short
596
597Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
598
599=item $uint = $device->native_vector_width_int
600
601Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
602
603=item $uint = $device->native_vector_width_long
604
605Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
606
607=item $uint = $device->native_vector_width_float
608
609Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
610
611=item $uint = $device->native_vector_width_double
612
613Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
614
615=item $uint = $device->native_vector_width_half
616
617Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
618
619=item $device_fp_config = $device->double_fp_config
620
621Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
622
623=item $device_fp_config = $device->half_fp_config
624
625Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
626
627=item $boolean = $device->host_unified_memory
628
629Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
630
631=item $device = $device->parent_device_ext
632
633Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
634
635=item @device_partition_property_exts = $device->partition_types_ext
636
637Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
638
639=item @device_partition_property_exts = $device->affinity_domains_ext
640
641Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
642
643=item $uint = $device->reference_count_ext
644
645Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
646
647=item @device_partition_property_exts = $device->partition_style_ext
648
649Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
650
651=for gengetinfo end device
652
342=back 653=back
343 654
344=head2 THE OpenCL::Context CLASS 655=head2 THE OpenCL::Context CLASS
345 656
346=over 4 657=over 4
347 658
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) 659=item $queue = $ctx->queue ($device, $properties)
355 660
356Create a new OpenCL::Queue object from the context and the given device. 661Create a new OpenCL::Queue object from the context and the given device.
357 662
358L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 663L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
363 668
364L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
365 670
366=item $buf = $ctx->buffer ($flags, $len) 671=item $buf = $ctx->buffer ($flags, $len)
367 672
368Creates a new OpenCL::Buffer object with the given flags and octet-size. 673Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
674given flags and octet-size.
369 675
370L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 676L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
371 677
372=item $buf = $ctx->buffer_sv ($flags, $data) 678=item $buf = $ctx->buffer_sv ($flags, $data)
373 679
374Creates a new OpenCL::Buffer object and initialise it with the given data values. 680Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
681initialise it with the given data values.
375 682
376=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 683=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
377 684
378Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 685Creates a new OpenCL::Image2D object and optionally initialises it with
686the given data values.
379 687
380L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 688L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
381 689
382=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 690=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
383 691
384Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 692Creates a new OpenCL::Image3D object and optionally initialises it with
693the given data values.
385 694
386L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 695L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
387 696
388=item @formats = $ctx->supported_image_formats ($flags, $image_type) 697=item @formats = $ctx->supported_image_formats ($flags, $image_type)
389 698
401=item $program = $ctx->program_with_source ($string) 710=item $program = $ctx->program_with_source ($string)
402 711
403Creates a new OpenCL::Program object from the given source code. 712Creates a new OpenCL::Program object from the given source code.
404 713
405L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 714L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
715
716=item $packed_value = $ctx->info ($name)
717
718See C<< $platform->info >> for details.
719
720L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
721
722=for gengetinfo begin context
723
724=item $uint = $context->reference_count
725
726Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
727
728=item @devices = $context->devices
729
730Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
731
732=item @property_ints = $context->properties
733
734Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
735
736=item $uint = $context->num_devices
737
738Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
739
740=for gengetinfo end context
406 741
407=back 742=back
408 743
409=head2 THE OpenCL::Queue CLASS 744=head2 THE OpenCL::Queue CLASS
410 745
424cases (i.e. you use only one queue) it's not necessary to wait for or 759cases (i.e. you use only one queue) it's not necessary to wait for or
425create event objects. 760create event objects.
426 761
427=over 4 762=over 4
428 763
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...) 764=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
436 765
437Reads data from buffer into the given string. 766Reads data from buffer into the given string.
438 767
439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 768L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
446 775
447=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 776=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
448 777
449L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 778L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
450 779
780=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...)
781
782http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
783
784=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...)
785
786http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
787
451=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 788=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
452 789
790L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
791
792=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...)
793
453L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 794L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
454 795
455=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 796=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
456 797
457L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 798L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
458 799
800=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...)
801
802L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
803
804=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...)
805
806L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
807
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...) 808=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 809
461Yeah. 810Yeah.
462 811
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>. 812L<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 813
477=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 814=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
478 815
479L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 816L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
480 817
514 851
515=item $queue->finish 852=item $queue->finish
516 853
517L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 854L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
518 855
856=item $packed_value = $queue->info ($name)
857
858See C<< $platform->info >> for details.
859
860L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
861
862=for gengetinfo begin command_queue
863
864=item $ctx = $command_queue->context
865
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
867
868=item $device = $command_queue->device
869
870Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
871
872=item $uint = $command_queue->reference_count
873
874Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
875
876=item $command_queue_properties = $command_queue->properties
877
878Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
879
880=for gengetinfo end command_queue
881
519=back 882=back
520 883
521=head2 THE OpenCL::Memory CLASS 884=head2 THE OpenCL::Memory CLASS
522 885
523This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 886This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
524OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 887OpenCL::Image2D and OpenCL::Image3D.
525currently only exist to allow type-checking.
526 888
527=over 4 889=over 4
528 890
529=item $packed_value = $memory->info ($name) 891=item $packed_value = $memory->info ($name)
530 892
531See C<< $platform->info >> for details. 893See C<< $platform->info >> for details.
532 894
533L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 895L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
534 896
897=for gengetinfo begin mem
898
899=item $mem_object_type = $mem->type
900
901Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
902
903=item $mem_flags = $mem->flags
904
905Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
906
907=item $int = $mem->size
908
909Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
910
911=item $ptr_value = $mem->host_ptr
912
913Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
914
915=item $uint = $mem->map_count
916
917Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
918
919=item $uint = $mem->reference_count
920
921Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
922
923=item $ctx = $mem->context
924
925Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
926
927=item $mem = $mem->associated_memobject
928
929Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
930
931=item $int = $mem->offset
932
933Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
934
935=for gengetinfo end mem
936
535=back 937=back
536 938
939=head2 THE OpenCL::Buffer CLASS
940
941This is a subclass of OpenCL::Memory, and the superclass of
942OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
943and sub-buffers.
944
945=head2 THE OpenCL::BufferObj CLASS
946
947This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
948because one cna create sub buffers of OpenLC::BufferObj objects, but not
949sub buffers from these sub buffers.
950
951=over 4
952
953=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
954
955Creates an OpenCL::Buffer objects from this buffer and returns it. The
956C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
957
958L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
959
960=back
961
962=head2 THE OpenCL::Image CLASS
963
964This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
965
966=over 4
967
968=item $packed_value = $ev->image_info ($name)
969
970See C<< $platform->info >> for details.
971
972The reason this method is not called C<info> is that there already is an
973C<< ->info >> method inherited from C<OpenCL::Memory>.
974
975L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
976
977=for gengetinfo begin image
978
979=item $int = $image->element_size
980
981Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
982
983=item $int = $image->row_pitch
984
985Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
986
987=item $int = $image->slice_pitch
988
989Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
990
991=item $int = $image->width
992
993Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
994
995=item $int = $image->height
996
997Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
998
999=item $int = $image->depth
1000
1001Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1002
1003=for gengetinfo end image
1004
1005=back
1006
537=head2 THE OpenCL::Sampler CLASS 1007=head2 THE OpenCL::Sampler CLASS
538 1008
539=over 4 1009=over 4
540 1010
541=item $packed_value = $sampler->info ($name) 1011=item $packed_value = $sampler->info ($name)
542 1012
543See C<< $platform->info >> for details. 1013See C<< $platform->info >> for details.
544 1014
545L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1015L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
546 1016
1017=for gengetinfo begin sampler
1018
1019=item $uint = $sampler->reference_count
1020
1021Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1022
1023=item $ctx = $sampler->context
1024
1025Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1026
1027=item $addressing_mode = $sampler->normalized_coords
1028
1029Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1030
1031=item $filter_mode = $sampler->addressing_mode
1032
1033Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1034
1035=item $boolean = $sampler->filter_mode
1036
1037Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1038
1039=for gengetinfo end sampler
1040
547=back 1041=back
548 1042
549=head2 THE OpenCL::Program CLASS 1043=head2 THE OpenCL::Program CLASS
550 1044
551=over 4 1045=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 1046
559=item $program->build ($device, $options = "") 1047=item $program->build ($device, $options = "")
560 1048
561Tries to build the program with the givne options. 1049Tries to build the program with the givne options.
562 1050
574Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1062Creates an OpenCL::Kernel object out of the named C<__kernel> function in
575the program. 1063the program.
576 1064
577L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1065L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
578 1066
1067=for gengetinfo begin program_build
1068
1069=item $build_status = $program->build_status ($device)
1070
1071Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1072
1073=item $string = $program->build_options ($device)
1074
1075Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1076
1077=item $string = $program->build_log ($device)
1078
1079Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1080
1081=for gengetinfo end program_build
1082
1083=item $packed_value = $program->info ($name)
1084
1085See C<< $platform->info >> for details.
1086
1087L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1088
1089=for gengetinfo begin program
1090
1091=item $uint = $program->reference_count
1092
1093Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1094
1095=item $ctx = $program->context
1096
1097Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1098
1099=item $uint = $program->num_devices
1100
1101Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1102
1103=item @devices = $program->devices
1104
1105Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1106
1107=item $string = $program->source
1108
1109Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1110
1111=item @ints = $program->binary_sizes
1112
1113Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1114
1115=for gengetinfo end program
1116
1117=item @blobs = $program->binaries
1118
1119Returns a string for the compiled binary for every device associated with
1120the program, empty strings indicate missing programs, and an empty result
1121means no program binaries are available.
1122
1123These "binaries" are often, in fact, informative low-level assembly
1124sources.
1125
1126L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1127
579=back 1128=back
580 1129
581=head2 THE OpenCL::Kernel CLASS 1130=head2 THE OpenCL::Kernel CLASS
582 1131
583=over 4 1132=over 4
585=item $packed_value = $kernel->info ($name) 1134=item $packed_value = $kernel->info ($name)
586 1135
587See C<< $platform->info >> for details. 1136See C<< $platform->info >> for details.
588 1137
589L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1138L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1139
1140=for gengetinfo begin kernel
1141
1142=item $string = $kernel->function_name
1143
1144Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1145
1146=item $uint = $kernel->num_args
1147
1148Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1149
1150=item $uint = $kernel->reference_count
1151
1152Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1153
1154=item $ctx = $kernel->context
1155
1156Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1157
1158=item $program = $kernel->program
1159
1160Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1161
1162=for gengetinfo end kernel
1163
1164=item $packed_value = $kernel->work_group_info ($device, $name)
1165
1166See C<< $platform->info >> for details.
1167
1168The reason this method is not called C<info> is that there already is an
1169C<< ->info >> method.
1170
1171L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1172
1173=for gengetinfo begin kernel_work_group
1174
1175=item $int = $kernel->work_group_size ($device)
1176
1177Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1178
1179=item @ints = $kernel->compile_work_group_size ($device)
1180
1181Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1182
1183=item $ulong = $kernel->local_mem_size ($device)
1184
1185Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1186
1187=item $int = $kernel->preferred_work_group_size_multiple ($device)
1188
1189Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1190
1191=item $ulong = $kernel->private_mem_size ($device)
1192
1193Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1194
1195=for gengetinfo end kernel_work_group
590 1196
591=item $kernel->set_TYPE ($index, $value) 1197=item $kernel->set_TYPE ($index, $value)
592 1198
593This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1199This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
594 1200
610This is the superclass for all event objects (including OpenCL::UserEvent 1216This is the superclass for all event objects (including OpenCL::UserEvent
611objects). 1217objects).
612 1218
613=over 4 1219=over 4
614 1220
1221=item $ev->wait
1222
1223Waits for the event to complete.
1224
1225L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1226
615=item $packed_value = $ev->info ($name) 1227=item $packed_value = $ev->info ($name)
616 1228
617See C<< $platform->info >> for details. 1229See C<< $platform->info >> for details.
618 1230
619L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1231L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
620 1232
621=item $ev->wait 1233=for gengetinfo begin event
622 1234
623Waits for the event to complete. 1235=item $queue = $event->command_queue
624 1236
1237Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1238
1239=item $command_type = $event->command_type
1240
1241Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1242
1243=item $uint = $event->reference_count
1244
1245Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1246
1247=item $uint = $event->command_execution_status
1248
1249Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1250
1251=item $ctx = $event->context
1252
1253Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1254
1255=for gengetinfo end event
1256
1257=item $packed_value = $ev->profiling_info ($name)
1258
1259See C<< $platform->info >> for details.
1260
1261The reason this method is not called C<info> is that there already is an
1262C<< ->info >> method.
1263
625L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1264L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1265
1266=for gengetinfo begin profiling
1267
1268=item $ulong = $event->profiling_command_queued
1269
1270Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1271
1272=item $ulong = $event->profiling_command_submit
1273
1274Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1275
1276=item $ulong = $event->profiling_command_start
1277
1278Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1279
1280=item $ulong = $event->profiling_command_end
1281
1282Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1283
1284=for gengetinfo end profiling
626 1285
627=back 1286=back
628 1287
629=head2 THE OpenCL::UserEvent CLASS 1288=head2 THE OpenCL::UserEvent CLASS
630 1289
643package OpenCL; 1302package OpenCL;
644 1303
645use common::sense; 1304use common::sense;
646 1305
647BEGIN { 1306BEGIN {
648 our $VERSION = '0.03'; 1307 our $VERSION = '0.91';
649 1308
650 require XSLoader; 1309 require XSLoader;
651 XSLoader::load (__PACKAGE__, $VERSION); 1310 XSLoader::load (__PACKAGE__, $VERSION);
652 1311
653 @OpenCL::Buffer::ISA = 1312 @OpenCL::Buffer::ISA =
654 @OpenCL::Image::ISA = OpenCL::Memory::; 1313 @OpenCL::Image::ISA = OpenCL::Memory::;
655 1314
1315 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1316
656 @OpenCL::Image2D::ISA = 1317 @OpenCL::Image2D::ISA =
657 @OpenCL::Image3D::ISA = OpenCL::Image::; 1318 @OpenCL::Image3D::ISA = OpenCL::Image::;
658 1319
659 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1320 @OpenCL::UserEvent::ISA = OpenCL::Event::;
660} 1321}
661 1322
6621; 13231;
663 1324
664=head1 AUTHOR 1325=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines