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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.16 by root, Thu Nov 17 03:42:03 2011 UTC vs.
Revision 1.24 by root, Sun Nov 20 22:31:48 2011 UTC

27OpenCL::Program objects, which store source code and, after building for a 27OpenCL::Program objects, which store source code and, after building for a
28specific device ("compiling and linking"), also binary programs. For each 28specific device ("compiling and linking"), also binary programs. For each
29kernel function in a program you can then create an OpenCL::Kernel object 29kernel function in a program you can then create an OpenCL::Kernel object
30which represents basically a function call with argument values. 30which represents basically a function call with argument values.
31 31
32OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat 32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d 33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34or 3d array) for bulk data and input and output for kernels. 34or 3d array) for bulk data and input and output for kernels.
35 35
36OpenCL::Sampler objects, which are kind of like texture filter modes in 36OpenCL::Sampler objects, which are kind of like texture filter modes in
37OpenGL. 37OpenGL.
52 52
53OpenCL manpages: 53OpenCL manpages:
54 54
55 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ 55 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
56 56
57If you are into UML class diagrams, the following diagram might help - if
58not, it will be mildly cobfusing:
59
60 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html
61
57Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it 62Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
58is, but at least it's free of charge: 63is, but at least it's free of charge:
59 64
60 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf 65 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
61 66
62If you are into UML class diagrams, the following diagram might help - if 67And here's NVIDIA's OpenCL Best Practises Guide:
63not, it will be mildly cofusing:
64 68
65 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html 69 http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
66 70
67=head1 BASIC WORKFLOW 71=head1 BASIC WORKFLOW
68 72
69To get something done, you basically have to do this once (refer to the 73To get something done, you basically have to do this once (refer to the
70examples below for actual code, this is just a high-level description): 74examples below for actual code, this is just a high-level description):
97 101
98Best run this once to get a feel for the platforms and devices in your 102Best run this once to get a feel for the platforms and devices in your
99system. 103system.
100 104
101 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
102 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 106 printf "platform: %s\n", $platform->name;
103 printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); 107 printf "extensions: %s\n", $platform->extensions;
104 for my $device ($platform->devices) { 108 for my $device ($platform->devices) {
105 printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); 109 printf "+ device: %s\n", $device->name;
106 my $ctx = $device->context; 110 my $ctx = $device->context;
107 # do stuff 111 # do stuff
108 } 112 }
109 } 113 }
110 114
157 161
158 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->program_with_source ($src);
159 163
160 # 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
161 eval { $prog->build ($dev); 1 } 165 eval { $prog->build ($dev); 1 }
162 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG); 166 or die $prog->build_log;
163 167
164 my $kernel = $prog->kernel ("squareit"); 168 my $kernel = $prog->kernel ("squareit");
165 169
166=head2 Create some input and output float buffers, then call the 170=head2 Create some input and output float buffers, then call the
167'squareit' kernel on them. 171'squareit' kernel on them.
222 226
223=item * Object lifetime managament is automatic - there is no need 227=item * Object lifetime managament is automatic - there is no need
224to free objects explicitly (C<clReleaseXXX>), the release function 228to free objects explicitly (C<clReleaseXXX>), the release function
225is called automatically once all Perl references to it go away. 229is called automatically once all Perl references to it go away.
226 230
227=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
228while this module uses underscores as word separator and often leaves out 233uses underscores as word separator and often leaves out prefixes
229prefixes (C<< $platform->info >>). 234(C<OpenCL::platforms>, C<< $platform->info >>).
230 235
231=item * OpenCL often specifies fixed vector function arguments as short 236=item * OpenCL often specifies fixed vector function arguments as short
232arrays (C<$origin[3]>), while this module explicitly expects the 237arrays (C<size_t origin[3]>), while this module explicitly expects the
233components as separate arguments- 238components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
239function calls.
234 240
235=item * Structures are often specified with their components, and returned 241=item * Structures are often specified by flattening out their components
236as arrayrefs. 242as with short vectors, and returned as arrayrefs.
237
238=item * Where possible, one of the pitch values is calculated from the
239perl scalar length and need not be specified.
240 243
241=item * When enqueuing commands, the wait list is specified by adding 244=item * When enqueuing commands, the wait list is specified by adding
242extra arguments to the function - anywhere a C<$wait_events...> argument 245extra arguments to the function - anywhere a C<$wait_events...> argument
243is documented this can be any number of event objects. 246is documented this can be any number of event objects.
244 247
313 316
314=head2 THE OpenCL::Platform CLASS 317=head2 THE OpenCL::Platform CLASS
315 318
316=over 4 319=over 4
317 320
318=item $packed_value = $platform->info ($name)
319
320Calls C<clGetPlatformInfo> and returns the packed, raw value - for
321strings, this will be the string, for other values you probably need to
322use the correct C<unpack>. This might get improved in the future. Hopefully.
323
324L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
325
326=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 321=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
327 322
328Returns a list of matching OpenCL::Device objects. 323Returns a list of matching OpenCL::Device objects.
329 324
330=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)
331 326
332Tries 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.
333 328
334L<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>
335 330
336=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)
337 332
338Create 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
339CL_CONTEXT_PLATFORM property is supplied automatically. 334CL_CONTEXT_PLATFORM property is supplied automatically.
340 335
341L<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>
342 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
343=back 373=back
344 374
345=head2 THE OpenCL::Device CLASS 375=head2 THE OpenCL::Device CLASS
346 376
347=over 4 377=over 4
350 380
351See C<< $platform->info >> for details. 381See C<< $platform->info >> for details.
352 382
353L<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>
354 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
355=back 653=back
356 654
357=head2 THE OpenCL::Context CLASS 655=head2 THE OpenCL::Context CLASS
358 656
359=over 4 657=over 4
360 658
361=item $packed_value = $ctx->info ($name)
362
363See C<< $platform->info >> for details.
364
365L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
366
367=item $queue = $ctx->queue ($device, $properties) 659=item $queue = $ctx->queue ($device, $properties)
368 660
369Create 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.
370 662
371L<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>
384 676
385=item $buf = $ctx->buffer_sv ($flags, $data) 677=item $buf = $ctx->buffer_sv ($flags, $data)
386 678
387Creates a new OpenCL::Buffer object and initialise it with the given data values. 679Creates a new OpenCL::Buffer object and initialise it with the given data values.
388 680
389=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 681=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
390 682
391Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 683Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.
392 684
393L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 685L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
394 686
395=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 687=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
396 688
397Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 689Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.
398 690
399L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 691L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
400 692
414=item $program = $ctx->program_with_source ($string) 706=item $program = $ctx->program_with_source ($string)
415 707
416Creates a new OpenCL::Program object from the given source code. 708Creates a new OpenCL::Program object from the given source code.
417 709
418L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 710L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
711
712=item $packed_value = $ctx->info ($name)
713
714See C<< $platform->info >> for details.
715
716L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
717
718=for gengetinfo begin context
719
720=item $uint = $context->reference_count
721
722Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
723
724=item @devices = $context->devices
725
726Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
727
728=item @property_ints = $context->properties
729
730Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
731
732=item $uint = $context->num_devices
733
734Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
735
736=for gengetinfo end context
419 737
420=back 738=back
421 739
422=head2 THE OpenCL::Queue CLASS 740=head2 THE OpenCL::Queue CLASS
423 741
437cases (i.e. you use only one queue) it's not necessary to wait for or 755cases (i.e. you use only one queue) it's not necessary to wait for or
438create event objects. 756create event objects.
439 757
440=over 4 758=over 4
441 759
442=item $packed_value = $ctx->info ($name)
443
444See C<< $platform->info >> for details.
445
446L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
447
448=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 760=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
449 761
450Reads data from buffer into the given string. 762Reads data from buffer into the given string.
451 763
452L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 764L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
463 775
464=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 776=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
465 777
466L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 778L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
467 779
468=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 780=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
469 781
470L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 782L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
471 783
472=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, 4dst_row_pitch, $dst_slice_pitch, $wait_event...) 784=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
473 785
474Yeah. 786Yeah.
475 787
476L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> 788L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
477 789
527 839
528=item $queue->finish 840=item $queue->finish
529 841
530L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 842L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
531 843
844=item $packed_value = $queue->info ($name)
845
846See C<< $platform->info >> for details.
847
848L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
849
850=for gengetinfo begin command_queue
851
852=item $ctx = $command_queue->context
853
854Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
855
856=item $device = $command_queue->device
857
858Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
859
860=item $uint = $command_queue->reference_count
861
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
863
864=item $command_queue_properties = $command_queue->properties
865
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
867
868=for gengetinfo end command_queue
869
532=back 870=back
533 871
534=head2 THE OpenCL::Memory CLASS 872=head2 THE OpenCL::Memory CLASS
535 873
536This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 874This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
537OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 875OpenCL::Image2D and OpenCL::Image3D.
538currently only exist to allow type-checking.
539 876
540=over 4 877=over 4
541 878
542=item $packed_value = $memory->info ($name) 879=item $packed_value = $memory->info ($name)
543 880
544See C<< $platform->info >> for details. 881See C<< $platform->info >> for details.
545 882
546L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 883L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
547 884
885=for gengetinfo begin mem
886
887=item $mem_object_type = $mem->type
888
889Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
890
891=item $mem_flags = $mem->flags
892
893Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
894
895=item $int = $mem->size
896
897Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
898
899=item $ptr_value = $mem->host_ptr
900
901Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
902
903=item $uint = $mem->map_count
904
905Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
906
907=item $uint = $mem->reference_count
908
909Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
910
911=item $ctx = $mem->context
912
913Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
914
915=item $mem = $mem->associated_memobject
916
917Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
918
919=item $int = $mem->offset
920
921Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
922
923=for gengetinfo end mem
924
548=back 925=back
549 926
927=head2 THE OpenCL::Image CLASS
928
929This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
930
931=over 4
932
933=item $packed_value = $ev->image_info ($name)
934
935See C<< $platform->info >> for details.
936
937The reason this method is not called C<info> is that there already is an
938C<< ->info >> method inherited from C<OpenCL::Memory>.
939
940L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
941
942=for gengetinfo begin image
943
944=item $int = $image->element_size
945
946Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
947
948=item $int = $image->row_pitch
949
950Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
951
952=item $int = $image->slice_pitch
953
954Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
955
956=item $int = $image->width
957
958Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
959
960=item $int = $image->height
961
962Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
963
964=item $int = $image->depth
965
966Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
967
968=for gengetinfo end image
969
970=back
971
550=head2 THE OpenCL::Sampler CLASS 972=head2 THE OpenCL::Sampler CLASS
551 973
552=over 4 974=over 4
553 975
554=item $packed_value = $sampler->info ($name) 976=item $packed_value = $sampler->info ($name)
555 977
556See C<< $platform->info >> for details. 978See C<< $platform->info >> for details.
557 979
558L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 980L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
559 981
982=for gengetinfo begin sampler
983
984=item $uint = $sampler->reference_count
985
986Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
987
988=item $ctx = $sampler->context
989
990Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
991
992=item $addressing_mode = $sampler->normalized_coords
993
994Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
995
996=item $filter_mode = $sampler->addressing_mode
997
998Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
999
1000=item $boolean = $sampler->filter_mode
1001
1002Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1003
1004=for gengetinfo end sampler
1005
560=back 1006=back
561 1007
562=head2 THE OpenCL::Program CLASS 1008=head2 THE OpenCL::Program CLASS
563 1009
564=over 4 1010=over 4
565
566=item $packed_value = $program->info ($name)
567
568See C<< $platform->info >> for details.
569
570L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
571 1011
572=item $program->build ($device, $options = "") 1012=item $program->build ($device, $options = "")
573 1013
574Tries to build the program with the givne options. 1014Tries to build the program with the givne options.
575 1015
587Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1027Creates an OpenCL::Kernel object out of the named C<__kernel> function in
588the program. 1028the program.
589 1029
590L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1030L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
591 1031
1032=for gengetinfo begin program_build
1033
1034=item $build_status = $program->build_status ($device)
1035
1036Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1037
1038=item $string = $program->build_options ($device)
1039
1040Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1041
1042=item $string = $program->build_log ($device)
1043
1044Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1045
1046=for gengetinfo end program_build
1047
1048=item $packed_value = $program->info ($name)
1049
1050See C<< $platform->info >> for details.
1051
1052L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1053
1054=for gengetinfo begin program
1055
1056=item $uint = $program->reference_count
1057
1058Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1059
1060=item $ctx = $program->context
1061
1062Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1063
1064=item $uint = $program->num_devices
1065
1066Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1067
1068=item @devices = $program->devices
1069
1070Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1071
1072=item $string = $program->source
1073
1074Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1075
1076=item @ints = $program->binary_sizes
1077
1078Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1079
1080=for gengetinfo end program
1081
1082=item @blobs = $program->binaries
1083
1084Returns a string for the compiled binary for every device associated with
1085the program, empty strings indicate missing programs, and an empty result
1086means no program binaries are available.
1087
1088These "binaries" are often, in fact, informative low-level assembly
1089sources.
1090
1091L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1092
592=back 1093=back
593 1094
594=head2 THE OpenCL::Kernel CLASS 1095=head2 THE OpenCL::Kernel CLASS
595 1096
596=over 4 1097=over 4
598=item $packed_value = $kernel->info ($name) 1099=item $packed_value = $kernel->info ($name)
599 1100
600See C<< $platform->info >> for details. 1101See C<< $platform->info >> for details.
601 1102
602L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1103L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1104
1105=for gengetinfo begin kernel
1106
1107=item $string = $kernel->function_name
1108
1109Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1110
1111=item $uint = $kernel->num_args
1112
1113Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1114
1115=item $uint = $kernel->reference_count
1116
1117Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1118
1119=item $ctx = $kernel->context
1120
1121Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1122
1123=item $program = $kernel->program
1124
1125Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1126
1127=for gengetinfo end kernel
1128
1129=item $packed_value = $kernel->work_group_info ($device, $name)
1130
1131See C<< $platform->info >> for details.
1132
1133The reason this method is not called C<info> is that there already is an
1134C<< ->info >> method.
1135
1136L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1137
1138=for gengetinfo begin kernel_work_group
1139
1140=item $int = $kernel->work_group_size ($device)
1141
1142Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1143
1144=item @ints = $kernel->compile_work_group_size ($device)
1145
1146Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1147
1148=item $ulong = $kernel->local_mem_size ($device)
1149
1150Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1151
1152=item $int = $kernel->preferred_work_group_size_multiple ($device)
1153
1154Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1155
1156=item $ulong = $kernel->private_mem_size ($device)
1157
1158Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1159
1160=for gengetinfo end kernel_work_group
603 1161
604=item $kernel->set_TYPE ($index, $value) 1162=item $kernel->set_TYPE ($index, $value)
605 1163
606This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1164This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
607 1165
623This is the superclass for all event objects (including OpenCL::UserEvent 1181This is the superclass for all event objects (including OpenCL::UserEvent
624objects). 1182objects).
625 1183
626=over 4 1184=over 4
627 1185
1186=item $ev->wait
1187
1188Waits for the event to complete.
1189
1190L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1191
628=item $packed_value = $ev->info ($name) 1192=item $packed_value = $ev->info ($name)
629 1193
630See C<< $platform->info >> for details. 1194See C<< $platform->info >> for details.
631 1195
632L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1196L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
633 1197
634=item $ev->wait 1198=for gengetinfo begin event
635 1199
636Waits for the event to complete. 1200=item $queue = $event->command_queue
637 1201
1202Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1203
1204=item $command_type = $event->command_type
1205
1206Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1207
1208=item $uint = $event->reference_count
1209
1210Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1211
1212=item $uint = $event->command_execution_status
1213
1214Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1215
1216=item $ctx = $event->context
1217
1218Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1219
1220=for gengetinfo end event
1221
1222=item $packed_value = $ev->profiling_info ($name)
1223
1224See C<< $platform->info >> for details.
1225
1226The reason this method is not called C<info> is that there already is an
1227C<< ->info >> method.
1228
638L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1229L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1230
1231=for gengetinfo begin profiling
1232
1233=item $ulong = $event->profiling_command_queued
1234
1235Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1236
1237=item $ulong = $event->profiling_command_submit
1238
1239Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1240
1241=item $ulong = $event->profiling_command_start
1242
1243Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1244
1245=item $ulong = $event->profiling_command_end
1246
1247Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1248
1249=for gengetinfo end profiling
639 1250
640=back 1251=back
641 1252
642=head2 THE OpenCL::UserEvent CLASS 1253=head2 THE OpenCL::UserEvent CLASS
643 1254
656package OpenCL; 1267package OpenCL;
657 1268
658use common::sense; 1269use common::sense;
659 1270
660BEGIN { 1271BEGIN {
661 our $VERSION = '0.14'; 1272 our $VERSION = '0.55';
662 1273
663 require XSLoader; 1274 require XSLoader;
664 XSLoader::load (__PACKAGE__, $VERSION); 1275 XSLoader::load (__PACKAGE__, $VERSION);
665 1276
666 @OpenCL::Buffer::ISA = 1277 @OpenCL::Buffer::ISA =

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines