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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.12 by root, Thu Nov 17 02:56:47 2011 UTC vs.
Revision 1.21 by root, Sun Nov 20 10:21:27 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 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
51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf 51 http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
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
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
56 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):
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);
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
300 316
301=head2 THE OpenCL::Platform CLASS 317=head2 THE OpenCL::Platform CLASS
302 318
303=over 4 319=over 4
304 320
321=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322
323Returns a list of matching OpenCL::Device objects.
324
325=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
326
327Tries to create a context. Never worked for me, and you need devices explitly anyway.
328
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)
332
333Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically.
335
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
337
305=item $packed_value = $platform->info ($name) 338=item $packed_value = $platform->info ($name)
306 339
307Calls C<clGetPlatformInfo> and returns the packed, raw value - for 340Calls C<clGetPlatformInfo> and returns the packed, raw value - for
308strings, this will be the string, for other values you probably need to 341strings, 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. 342use the correct C<unpack>.
343
344It's best to avoid this method and use one of the predefined C<get_*>
345methods.
310 346
311L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
312 348
313=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 349=for gengetinfo begin platform
314 350
315Returns a list of matching OpenCL::Device objects.
316 351
317=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 352=item $string = $platform->profile
318 353
319Tries to create a context. Never worked for me, and you need devices explitly anyway. 354Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s).
320 355
321L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 356=item $string = $platform->version
322 357
323=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 358Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s).
324 359
325Create a new OpenCL::Context object using the given device object(s)- a 360=item $string = $platform->name
326CL_CONTEXT_PLATFORM property is supplied automatically.
327 361
328L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 362Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s).
363
364=item $string = $platform->vendor
365
366Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s).
367
368=item $string = $platform->extensions
369
370Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s).
371
372=for gengetinfo end platform
329 373
330=back 374=back
331 375
332=head2 THE OpenCL::Device CLASS 376=head2 THE OpenCL::Device CLASS
333 377
337 381
338See C<< $platform->info >> for details. 382See C<< $platform->info >> for details.
339 383
340L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 384L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
341 385
386=for gengetinfo begin device
387
388
389=item $device_type = $device->type
390
391Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s).
392
393=item $uint = $device->vendor_id
394
395Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s).
396
397=item $uint = $device->max_compute_units
398
399Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s).
400
401=item $uint = $device->max_work_item_dimensions
402
403Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s).
404
405=item $int = $device->max_work_group_size
406
407Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s).
408
409=item @ints = $device->max_work_item_sizes
410
411Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s).
412
413=item $uint = $device->preferred_vector_width_char
414
415Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s).
416
417=item $uint = $device->preferred_vector_width_short
418
419Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s).
420
421=item $uint = $device->preferred_vector_width_int
422
423Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s).
424
425=item $uint = $device->preferred_vector_width_long
426
427Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s).
428
429=item $uint = $device->preferred_vector_width_float
430
431Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s).
432
433=item $uint = $device->preferred_vector_width_double
434
435Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s).
436
437=item $uint = $device->max_clock_frequency
438
439Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s).
440
441=item $bitfield = $device->address_bits
442
443Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s).
444
445=item $uint = $device->max_read_image_args
446
447Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s).
448
449=item $uint = $device->max_write_image_args
450
451Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s).
452
453=item $ulong = $device->max_mem_alloc_size
454
455Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s).
456
457=item $int = $device->image2d_max_width
458
459Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s).
460
461=item $int = $device->image2d_max_height
462
463Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s).
464
465=item $int = $device->image3d_max_width
466
467Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s).
468
469=item $int = $device->image3d_max_height
470
471Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s).
472
473=item $int = $device->image3d_max_depth
474
475Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s).
476
477=item $uint = $device->image_support
478
479Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s).
480
481=item $int = $device->max_parameter_size
482
483Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s).
484
485=item $uint = $device->max_samplers
486
487Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s).
488
489=item $uint = $device->mem_base_addr_align
490
491Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s).
492
493=item $uint = $device->min_data_type_align_size
494
495Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s).
496
497=item $device_fp_config = $device->single_fp_config
498
499Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s).
500
501=item $device_mem_cache_type = $device->global_mem_cache_type
502
503Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s).
504
505=item $uint = $device->global_mem_cacheline_size
506
507Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s).
508
509=item $ulong = $device->global_mem_cache_size
510
511Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s).
512
513=item $ulong = $device->global_mem_size
514
515Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s).
516
517=item $ulong = $device->max_constant_buffer_size
518
519Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s).
520
521=item $uint = $device->max_constant_args
522
523Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s).
524
525=item $device_local_mem_type = $device->local_mem_type
526
527Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s).
528
529=item $ulong = $device->local_mem_size
530
531Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s).
532
533=item $boolean = $device->error_correction_support
534
535Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s).
536
537=item $int = $device->profiling_timer_resolution
538
539Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s).
540
541=item $boolean = $device->endian_little
542
543Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s).
544
545=item $boolean = $device->available
546
547Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s).
548
549=item $boolean = $device->compiler_available
550
551Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s).
552
553=item $device_exec_capabilities = $device->execution_capabilities
554
555Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s).
556
557=item $command_queue_properties = $device->properties
558
559Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s).
560
561=item $ = $device->platform
562
563Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s).
564
565=item $string = $device->name
566
567Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s).
568
569=item $string = $device->vendor
570
571Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s).
572
573=item $string = $device->driver_version
574
575Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s).
576
577=item $string = $device->profile
578
579Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s).
580
581=item $string = $device->version
582
583Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s).
584
585=item $string = $device->extensions
586
587Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s).
588
589=item $uint = $device->preferred_vector_width_half
590
591Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s).
592
593=item $uint = $device->native_vector_width_char
594
595Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s).
596
597=item $uint = $device->native_vector_width_short
598
599Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s).
600
601=item $uint = $device->native_vector_width_int
602
603Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s).
604
605=item $uint = $device->native_vector_width_long
606
607Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s).
608
609=item $uint = $device->native_vector_width_float
610
611Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s).
612
613=item $uint = $device->native_vector_width_double
614
615Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s).
616
617=item $uint = $device->native_vector_width_half
618
619Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s).
620
621=item $device_fp_config = $device->double_fp_config
622
623Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s).
624
625=item $device_fp_config = $device->half_fp_config
626
627Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s).
628
629=item $boolean = $device->host_unified_memory
630
631Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s).
632
633=item $device = $device->parent_device_ext
634
635Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s).
636
637=item @device_partition_property_exts = $device->partition_types_ext
638
639Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s).
640
641=item @device_partition_property_exts = $device->affinity_domains_ext
642
643Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s).
644
645=item $uint = $device->reference_count_ext
646
647Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s).
648
649=item @device_partition_property_exts = $device->partition_style_ext
650
651Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s).
652
653=for gengetinfo end device
654
342=back 655=back
343 656
344=head2 THE OpenCL::Context CLASS 657=head2 THE OpenCL::Context CLASS
345 658
346=over 4 659=over 4
347 660
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) 661=item $queue = $ctx->queue ($device, $properties)
355 662
356Create a new OpenCL::Queue object from the context and the given device. 663Create a new OpenCL::Queue object from the context and the given device.
357 664
358L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 665L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
371 678
372=item $buf = $ctx->buffer_sv ($flags, $data) 679=item $buf = $ctx->buffer_sv ($flags, $data)
373 680
374Creates a new OpenCL::Buffer object and initialise it with the given data values. 681Creates a new OpenCL::Buffer object and initialise 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 the given data values.
379 686
380L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 687L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
381 688
382=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 689=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
383 690
384Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 691Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.
385 692
386L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 693L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
387 694
401=item $program = $ctx->program_with_source ($string) 708=item $program = $ctx->program_with_source ($string)
402 709
403Creates a new OpenCL::Program object from the given source code. 710Creates a new OpenCL::Program object from the given source code.
404 711
405L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 712L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
713
714=item $packed_value = $ctx->info ($name)
715
716See C<< $platform->info >> for details.
717
718L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
719
720=for gengetinfo begin context
721
722
723=item $uint = $context->reference_count
724
725Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s).
726
727=item @devices = $context->devices
728
729Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s).
730
731=item @property_ints = $context->properties
732
733Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s).
734
735=item $uint = $context->num_devices
736
737Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s).
738
739=for gengetinfo end context
406 740
407=back 741=back
408 742
409=head2 THE OpenCL::Queue CLASS 743=head2 THE OpenCL::Queue CLASS
410 744
424cases (i.e. you use only one queue) it's not necessary to wait for or 758cases (i.e. you use only one queue) it's not necessary to wait for or
425create event objects. 759create event objects.
426 760
427=over 4 761=over 4
428 762
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...) 763=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
436 764
437Reads data from buffer into the given string. 765Reads data from buffer into the given string.
438 766
439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 767L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
450 778
451=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 779=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
452 780
453L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 781L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
454 782
455=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 783=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
456 784
457L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 785L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
458 786
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...) 787=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 788
461Yeah. 789Yeah.
462 790
463L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> 791L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
464 792
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, ...) 793=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...)
466 794
467L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 795L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
468 796
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, ...) 797=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...)
470 798
471L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 799L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
472 800
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, ...) 801=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...)
474 802
475L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html> 803L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
476 804
477=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 805=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
478 806
514 842
515=item $queue->finish 843=item $queue->finish
516 844
517L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 845L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
518 846
847=item $packed_value = $queue->info ($name)
848
849See C<< $platform->info >> for details.
850
851L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
852
853=for gengetinfo begin command_queue
854
855
856=item $ctx = $command_queue->context
857
858Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s).
859
860=item $device = $command_queue->device
861
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s).
863
864=item $uint = $command_queue->reference_count
865
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s).
867
868=item $command_queue_properties = $command_queue->properties
869
870Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s).
871
872=for gengetinfo end command_queue
873
519=back 874=back
520 875
521=head2 THE OpenCL::Memory CLASS 876=head2 THE OpenCL::Memory CLASS
522 877
523This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 878This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
524OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 879OpenCL::Image2D and OpenCL::Image3D.
525currently only exist to allow type-checking.
526 880
527=over 4 881=over 4
528 882
529=item $packed_value = $memory->info ($name) 883=item $packed_value = $memory->info ($name)
530 884
531See C<< $platform->info >> for details. 885See C<< $platform->info >> for details.
532 886
533L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 887L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
534 888
889=for gengetinfo begin mem
890
891
892=item $mem_object_type = $mem->type
893
894Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s).
895
896=item $mem_flags = $mem->flags
897
898Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s).
899
900=item $int = $mem->size
901
902Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s).
903
904=item $ptr_value = $mem->host_ptr
905
906Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s).
907
908=item $uint = $mem->map_count
909
910Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s).
911
912=item $uint = $mem->reference_count
913
914Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s).
915
916=item $ctx = $mem->context
917
918Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s).
919
920=item $mem = $mem->associated_memobject
921
922Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s).
923
924=item $int = $mem->offset
925
926Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s).
927
928=for gengetinfo end mem
929
535=back 930=back
536 931
932=head2 THE OpenCL::Image CLASS
933
934This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
935
936=over 4
937
938=item $packed_value = $ev->image_info ($name)
939
940See C<< $platform->info >> for details.
941
942The reason this method is not called C<info> is that there already is an
943C<< ->info >> method inherited from C<OpenCL::Memory>.
944
945L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
946
947=for gengetinfo begin image
948
949
950=item $int = $image->element_size
951
952Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s).
953
954=item $int = $image->row_pitch
955
956Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s).
957
958=item $int = $image->slice_pitch
959
960Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s).
961
962=item $int = $image->width
963
964Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s).
965
966=item $int = $image->height
967
968Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s).
969
970=item $int = $image->depth
971
972Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s).
973
974=for gengetinfo end image
975
976=back
977
537=head2 THE OpenCL::Sampler CLASS 978=head2 THE OpenCL::Sampler CLASS
538 979
539=over 4 980=over 4
540 981
541=item $packed_value = $sampler->info ($name) 982=item $packed_value = $sampler->info ($name)
542 983
543See C<< $platform->info >> for details. 984See C<< $platform->info >> for details.
544 985
545L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 986L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
546 987
988=for gengetinfo begin sampler
989
990
991=item $uint = $sampler->reference_count
992
993Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s).
994
995=item $ctx = $sampler->context
996
997Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s).
998
999=item $addressing_mode = $sampler->normalized_coords
1000
1001Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s).
1002
1003=item $filter_mode = $sampler->addressing_mode
1004
1005Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s).
1006
1007=item $boolean = $sampler->filter_mode
1008
1009Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s).
1010
1011=for gengetinfo end sampler
1012
547=back 1013=back
548 1014
549=head2 THE OpenCL::Program CLASS 1015=head2 THE OpenCL::Program CLASS
550 1016
551=over 4 1017=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 1018
559=item $program->build ($device, $options = "") 1019=item $program->build ($device, $options = "")
560 1020
561Tries to build the program with the givne options. 1021Tries to build the program with the givne options.
562 1022
574Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1034Creates an OpenCL::Kernel object out of the named C<__kernel> function in
575the program. 1035the program.
576 1036
577L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1037L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
578 1038
1039=for gengetinfo begin program_build
1040
1041
1042=item $build_status = $program->build_status ($device)
1043
1044Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s).
1045
1046=item $string = $program->build_options ($device)
1047
1048Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s).
1049
1050=item $string = $program->build_log ($device)
1051
1052Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s).
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
1065=item $uint = $program->reference_count
1066
1067Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s).
1068
1069=item $ctx = $program->context
1070
1071Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s).
1072
1073=item $uint = $program->num_devices
1074
1075Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s).
1076
1077=item @devices = $program->devices
1078
1079Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s).
1080
1081=item $string = $program->source
1082
1083Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s).
1084
1085=item @ints = $program->binary_sizes
1086
1087Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s).
1088
1089=for gengetinfo end program
1090
579=back 1091=back
580 1092
581=head2 THE OpenCL::Kernel CLASS 1093=head2 THE OpenCL::Kernel CLASS
582 1094
583=over 4 1095=over 4
585=item $packed_value = $kernel->info ($name) 1097=item $packed_value = $kernel->info ($name)
586 1098
587See C<< $platform->info >> for details. 1099See C<< $platform->info >> for details.
588 1100
589L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1101L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1102
1103=for gengetinfo begin kernel
1104
1105
1106=item $string = $kernel->function_name
1107
1108Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s).
1109
1110=item $uint = $kernel->num_args
1111
1112Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s).
1113
1114=item $uint = $kernel->reference_count
1115
1116Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s).
1117
1118=item $ctx = $kernel->context
1119
1120Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s).
1121
1122=item $program = $kernel->program
1123
1124Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s).
1125
1126=for gengetinfo end kernel
1127
1128=item $packed_value = $kernel->work_group_info ($device, $name)
1129
1130See C<< $platform->info >> for details.
1131
1132The reason this method is not called C<info> is that there already is an
1133C<< ->info >> method.
1134
1135L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1136
1137=for gengetinfo begin kernel_work_group
1138
1139
1140=item $int = $kernel->work_group_size ($device)
1141
1142Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s).
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(s).
1147
1148=item $ulong = $kernel->local_mem_size ($device)
1149
1150Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s).
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(s).
1155
1156=item $ulong = $kernel->private_mem_size ($device)
1157
1158Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s).
1159
1160=for gengetinfo end kernel_work_group
590 1161
591=item $kernel->set_TYPE ($index, $value) 1162=item $kernel->set_TYPE ($index, $value)
592 1163
593This 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>.
594 1165
610This is the superclass for all event objects (including OpenCL::UserEvent 1181This is the superclass for all event objects (including OpenCL::UserEvent
611objects). 1182objects).
612 1183
613=over 4 1184=over 4
614 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
615=item $packed_value = $ev->info ($name) 1192=item $packed_value = $ev->info ($name)
616 1193
617See C<< $platform->info >> for details. 1194See C<< $platform->info >> for details.
618 1195
619L<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>
620 1197
621=item $ev->wait 1198=for gengetinfo begin event
622 1199
623Waits for the event to complete.
624 1200
1201=item $queue = $event->command_queue
1202
1203Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s).
1204
1205=item $command_type = $event->command_type
1206
1207Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s).
1208
1209=item $uint = $event->reference_count
1210
1211Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s).
1212
1213=item $uint = $event->command_execution_status
1214
1215Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s).
1216
1217=item $ctx = $event->context
1218
1219Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s).
1220
1221=for gengetinfo end event
1222
1223=item $packed_value = $ev->profiling_info ($name)
1224
1225See C<< $platform->info >> for details.
1226
1227The reason this method is not called C<info> is that there already is an
1228C<< ->info >> method.
1229
625L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1230L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1231
1232=for gengetinfo begin profiling
1233
1234
1235=item $ulong = $event->profiling_command_queued
1236
1237Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s).
1238
1239=item $ulong = $event->profiling_command_submit
1240
1241Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s).
1242
1243=item $ulong = $event->profiling_command_start
1244
1245Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s).
1246
1247=item $ulong = $event->profiling_command_end
1248
1249Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s).
1250
1251=for gengetinfo end profiling
626 1252
627=back 1253=back
628 1254
629=head2 THE OpenCL::UserEvent CLASS 1255=head2 THE OpenCL::UserEvent CLASS
630 1256
643package OpenCL; 1269package OpenCL;
644 1270
645use common::sense; 1271use common::sense;
646 1272
647BEGIN { 1273BEGIN {
648 our $VERSION = '0.14'; 1274 our $VERSION = '0.55';
649 1275
650 require XSLoader; 1276 require XSLoader;
651 XSLoader::load (__PACKAGE__, $VERSION); 1277 XSLoader::load (__PACKAGE__, $VERSION);
652 1278
653 @OpenCL::Buffer::ISA = 1279 @OpenCL::Buffer::ISA =

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines