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.25 by root, Tue Nov 22 10:39:47 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>
459 771
460=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 772=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
461 773
462L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 774L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
463 775
776=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...)
777
778http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
779
780=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...)
781
782http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
783
464=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 784=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
465 785
466L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 786L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
467 787
468=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 788=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
469 789
470L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 790L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
471 791
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...) 792=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 793
474Yeah. 794Yeah.
475 795
476L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> 796L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
477 797
527 847
528=item $queue->finish 848=item $queue->finish
529 849
530L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 850L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
531 851
852=item $packed_value = $queue->info ($name)
853
854See C<< $platform->info >> for details.
855
856L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
857
858=for gengetinfo begin command_queue
859
860=item $ctx = $command_queue->context
861
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
863
864=item $device = $command_queue->device
865
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
867
868=item $uint = $command_queue->reference_count
869
870Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
871
872=item $command_queue_properties = $command_queue->properties
873
874Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
875
876=for gengetinfo end command_queue
877
532=back 878=back
533 879
534=head2 THE OpenCL::Memory CLASS 880=head2 THE OpenCL::Memory CLASS
535 881
536This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 882This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
537OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 883OpenCL::Image2D and OpenCL::Image3D.
538currently only exist to allow type-checking.
539 884
540=over 4 885=over 4
541 886
542=item $packed_value = $memory->info ($name) 887=item $packed_value = $memory->info ($name)
543 888
544See C<< $platform->info >> for details. 889See C<< $platform->info >> for details.
545 890
546L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 891L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
547 892
893=for gengetinfo begin mem
894
895=item $mem_object_type = $mem->type
896
897Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
898
899=item $mem_flags = $mem->flags
900
901Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
902
903=item $int = $mem->size
904
905Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
906
907=item $ptr_value = $mem->host_ptr
908
909Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
910
911=item $uint = $mem->map_count
912
913Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
914
915=item $uint = $mem->reference_count
916
917Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
918
919=item $ctx = $mem->context
920
921Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
922
923=item $mem = $mem->associated_memobject
924
925Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
926
927=item $int = $mem->offset
928
929Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
930
931=for gengetinfo end mem
932
548=back 933=back
549 934
935=head2 THE OpenCL::Image CLASS
936
937This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
938
939=over 4
940
941=item $packed_value = $ev->image_info ($name)
942
943See C<< $platform->info >> for details.
944
945The reason this method is not called C<info> is that there already is an
946C<< ->info >> method inherited from C<OpenCL::Memory>.
947
948L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
949
950=for gengetinfo begin image
951
952=item $int = $image->element_size
953
954Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
955
956=item $int = $image->row_pitch
957
958Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
959
960=item $int = $image->slice_pitch
961
962Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
963
964=item $int = $image->width
965
966Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
967
968=item $int = $image->height
969
970Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
971
972=item $int = $image->depth
973
974Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
975
976=for gengetinfo end image
977
978=back
979
550=head2 THE OpenCL::Sampler CLASS 980=head2 THE OpenCL::Sampler CLASS
551 981
552=over 4 982=over 4
553 983
554=item $packed_value = $sampler->info ($name) 984=item $packed_value = $sampler->info ($name)
555 985
556See C<< $platform->info >> for details. 986See C<< $platform->info >> for details.
557 987
558L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 988L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
559 989
990=for gengetinfo begin sampler
991
992=item $uint = $sampler->reference_count
993
994Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
995
996=item $ctx = $sampler->context
997
998Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
999
1000=item $addressing_mode = $sampler->normalized_coords
1001
1002Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1003
1004=item $filter_mode = $sampler->addressing_mode
1005
1006Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1007
1008=item $boolean = $sampler->filter_mode
1009
1010Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1011
1012=for gengetinfo end sampler
1013
560=back 1014=back
561 1015
562=head2 THE OpenCL::Program CLASS 1016=head2 THE OpenCL::Program CLASS
563 1017
564=over 4 1018=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 1019
572=item $program->build ($device, $options = "") 1020=item $program->build ($device, $options = "")
573 1021
574Tries to build the program with the givne options. 1022Tries to build the program with the givne options.
575 1023
587Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1035Creates an OpenCL::Kernel object out of the named C<__kernel> function in
588the program. 1036the program.
589 1037
590L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1038L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
591 1039
1040=for gengetinfo begin program_build
1041
1042=item $build_status = $program->build_status ($device)
1043
1044Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1045
1046=item $string = $program->build_options ($device)
1047
1048Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1049
1050=item $string = $program->build_log ($device)
1051
1052Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1053
1054=for gengetinfo end program_build
1055
1056=item $packed_value = $program->info ($name)
1057
1058See C<< $platform->info >> for details.
1059
1060L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1061
1062=for gengetinfo begin program
1063
1064=item $uint = $program->reference_count
1065
1066Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1067
1068=item $ctx = $program->context
1069
1070Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1071
1072=item $uint = $program->num_devices
1073
1074Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1075
1076=item @devices = $program->devices
1077
1078Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1079
1080=item $string = $program->source
1081
1082Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1083
1084=item @ints = $program->binary_sizes
1085
1086Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1087
1088=for gengetinfo end program
1089
1090=item @blobs = $program->binaries
1091
1092Returns a string for the compiled binary for every device associated with
1093the program, empty strings indicate missing programs, and an empty result
1094means no program binaries are available.
1095
1096These "binaries" are often, in fact, informative low-level assembly
1097sources.
1098
1099L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1100
592=back 1101=back
593 1102
594=head2 THE OpenCL::Kernel CLASS 1103=head2 THE OpenCL::Kernel CLASS
595 1104
596=over 4 1105=over 4
598=item $packed_value = $kernel->info ($name) 1107=item $packed_value = $kernel->info ($name)
599 1108
600See C<< $platform->info >> for details. 1109See C<< $platform->info >> for details.
601 1110
602L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1111L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1112
1113=for gengetinfo begin kernel
1114
1115=item $string = $kernel->function_name
1116
1117Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1118
1119=item $uint = $kernel->num_args
1120
1121Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1122
1123=item $uint = $kernel->reference_count
1124
1125Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1126
1127=item $ctx = $kernel->context
1128
1129Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1130
1131=item $program = $kernel->program
1132
1133Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1134
1135=for gengetinfo end kernel
1136
1137=item $packed_value = $kernel->work_group_info ($device, $name)
1138
1139See C<< $platform->info >> for details.
1140
1141The reason this method is not called C<info> is that there already is an
1142C<< ->info >> method.
1143
1144L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1145
1146=for gengetinfo begin kernel_work_group
1147
1148=item $int = $kernel->work_group_size ($device)
1149
1150Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1151
1152=item @ints = $kernel->compile_work_group_size ($device)
1153
1154Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1155
1156=item $ulong = $kernel->local_mem_size ($device)
1157
1158Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1159
1160=item $int = $kernel->preferred_work_group_size_multiple ($device)
1161
1162Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1163
1164=item $ulong = $kernel->private_mem_size ($device)
1165
1166Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1167
1168=for gengetinfo end kernel_work_group
603 1169
604=item $kernel->set_TYPE ($index, $value) 1170=item $kernel->set_TYPE ($index, $value)
605 1171
606This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1172This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
607 1173
623This is the superclass for all event objects (including OpenCL::UserEvent 1189This is the superclass for all event objects (including OpenCL::UserEvent
624objects). 1190objects).
625 1191
626=over 4 1192=over 4
627 1193
1194=item $ev->wait
1195
1196Waits for the event to complete.
1197
1198L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1199
628=item $packed_value = $ev->info ($name) 1200=item $packed_value = $ev->info ($name)
629 1201
630See C<< $platform->info >> for details. 1202See C<< $platform->info >> for details.
631 1203
632L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1204L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
633 1205
634=item $ev->wait 1206=for gengetinfo begin event
635 1207
636Waits for the event to complete. 1208=item $queue = $event->command_queue
637 1209
1210Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1211
1212=item $command_type = $event->command_type
1213
1214Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1215
1216=item $uint = $event->reference_count
1217
1218Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1219
1220=item $uint = $event->command_execution_status
1221
1222Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1223
1224=item $ctx = $event->context
1225
1226Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1227
1228=for gengetinfo end event
1229
1230=item $packed_value = $ev->profiling_info ($name)
1231
1232See C<< $platform->info >> for details.
1233
1234The reason this method is not called C<info> is that there already is an
1235C<< ->info >> method.
1236
638L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1237L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1238
1239=for gengetinfo begin profiling
1240
1241=item $ulong = $event->profiling_command_queued
1242
1243Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1244
1245=item $ulong = $event->profiling_command_submit
1246
1247Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1248
1249=item $ulong = $event->profiling_command_start
1250
1251Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1252
1253=item $ulong = $event->profiling_command_end
1254
1255Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1256
1257=for gengetinfo end profiling
639 1258
640=back 1259=back
641 1260
642=head2 THE OpenCL::UserEvent CLASS 1261=head2 THE OpenCL::UserEvent CLASS
643 1262
656package OpenCL; 1275package OpenCL;
657 1276
658use common::sense; 1277use common::sense;
659 1278
660BEGIN { 1279BEGIN {
661 our $VERSION = '0.14'; 1280 our $VERSION = '0.55';
662 1281
663 require XSLoader; 1282 require XSLoader;
664 XSLoader::load (__PACKAGE__, $VERSION); 1283 XSLoader::load (__PACKAGE__, $VERSION);
665 1284
666 @OpenCL::Buffer::ISA = 1285 @OpenCL::Buffer::ISA =

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines