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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.20 by root, Sun Nov 20 01:09:48 2011 UTC vs.
Revision 1.54 by root, Tue Apr 24 14:57:06 2012 UTC

101 101
102Best 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
103system. 103system.
104 104
105 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
106 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 106 printf "platform: %s\n", $platform->name;
107 printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); 107 printf "extensions: %s\n", $platform->extensions;
108 for my $device ($platform->devices) { 108 for my $device ($platform->devices) {
109 printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); 109 printf "+ device: %s\n", $device->name;
110 my $ctx = $device->context; 110 my $ctx = $platform->context (undef, [$device]);
111 # do stuff 111 # do stuff
112 } 112 }
113 } 113 }
114 114
115=head2 Get a useful context and a command queue. 115=head2 Get a useful context and a command queue.
149 149
150=head2 Create and build a program, then create a kernel out of one of its 150=head2 Create and build a program, then create a kernel out of one of its
151functions. 151functions.
152 152
153 my $src = ' 153 my $src = '
154 __kernel void 154 kernel void
155 squareit (__global float *input, __global float *output) 155 squareit (global float *input, global float *output)
156 { 156 {
157 $id = get_global_id (0); 157 $id = get_global_id (0);
158 output [id] = input [id] * input [id]; 158 output [id] = input [id] * input [id];
159 } 159 }
160 '; 160 ';
161 161
162 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->build_program ($src);
163
164 # build croaks on compile errors, so catch it and print the compile errors
165 eval { $prog->build ($dev); 1 }
166 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
167
168 my $kernel = $prog->kernel ("squareit"); 163 my $kernel = $prog->kernel ("squareit");
169 164
170=head2 Create some input and output float buffers, then call the 165=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them. 166'squareit' kernel on them.
172 167
210 # enqueue an async read 205 # enqueue an async read
211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 206 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212 207
213 # wait for the last event to complete 208 # wait for the last event to complete
214 $ev->wait; 209 $ev->wait;
210
211=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
212set tunnel effect.
213
214This is quite a long example to get you going.
215
216 use OpenGL ":all";
217 use OpenCL;
218
219 # open a window and create a gl texture
220 OpenGL::glpOpenWindow width => 256, height => 256;
221 my $texid = glGenTextures_p 1;
222 glBindTexture GL_TEXTURE_2D, $texid;
223 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
224
225 # find and use the first opencl device that let's us get a shared opengl context
226 my $platform;
227 my $dev;
228 my $ctx;
229
230 for (OpenCL::platforms) {
231 $platform = $_;
232 for ($platform->devices) {
233 $dev = $_;
234 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
235 and last;
236 }
237 }
238
239 $ctx
240 or die "cannot find suitable OpenCL device\n";
241
242 my $queue = $ctx->queue ($dev);
243
244 # now attach an opencl image2d object to the opengl texture
245 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
246
247 # now the boring opencl code
248 my $src = <<EOF;
249 kernel void
250 juliatunnel (write_only image2d_t img, float time)
251 {
252 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
253
254 float2 m = (float2)(1.f, p.y) / fabs (p.x);
255 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
256
257 float2 z = m;
258 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
259
260 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
261 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
262
263 float3 colour = (float3)(z.x, z.y, z.x * z.y);
264 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
265 }
266 EOF
267
268 my $prog = $ctx->build_program ($src);
269 my $kernel = $prog->kernel ("juliatunnel");
270
271 # program compiled, kernel ready, now draw and loop
272
273 for (my $time; ; ++$time) {
274 # acquire objects from opengl
275 $queue->enqueue_acquire_gl_objects ([$tex]);
276
277 # configure and run our kernel
278 $kernel->set_image2d (0, $tex);
279 $kernel->set_float (1, $time);
280 $queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
281
282 # release objects to opengl again
283 $queue->enqueue_release_gl_objects ([$tex]);
284
285 # wait
286 $queue->finish;
287
288 # now draw the texture, the defaults should be all right
289 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
290
291 glEnable GL_TEXTURE_2D;
292 glBegin GL_QUADS;
293 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
294 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
295 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
296 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
297 glEnd;
298
299 glXSwapBuffers;
300
301 select undef, undef, undef, 1/60;
302 }
215 303
216=head1 DOCUMENTATION 304=head1 DOCUMENTATION
217 305
218=head2 BASIC CONVENTIONS 306=head2 BASIC CONVENTIONS
219 307
241=item * Structures are often specified by flattening out their components 329=item * Structures are often specified by flattening out their components
242as with short vectors, and returned as arrayrefs. 330as with short vectors, and returned as arrayrefs.
243 331
244=item * When enqueuing commands, the wait list is specified by adding 332=item * When enqueuing commands, the wait list is specified by adding
245extra arguments to the function - anywhere a C<$wait_events...> argument 333extra arguments to the function - anywhere a C<$wait_events...> argument
246is documented this can be any number of event objects. 334is documented this can be any number of event objects. As an extsnion
335implemented by this module, C<undef> values will be ignored in the event
336list.
247 337
248=item * When enqueuing commands, if the enqueue method is called in void 338=item * When enqueuing commands, if the enqueue method is called in void
249context, no event is created. In all other contexts an event is returned 339context, no event is created. In all other contexts an event is returned
250by the method. 340by the method.
251 341
271 ulong IV - Q 361 ulong IV - Q
272 float NV float f 362 float NV float f
273 half IV ushort S 363 half IV ushort S
274 double NV double d 364 double NV double d
275 365
366=head2 GLX SUPPORT
367
368Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
369module, which has little to no documentation and has little to no support
370for glX), this module, as a special extension, treats context creation
371properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
372specially: If either or both of these are C<undef>, then the OpenCL
373module tries to dynamically resolve C<glXGetCurrentDisplay> and
374C<glXGetCurrentContext>, call these functions and use their return values
375instead.
376
377For this to work, the OpenGL library must be loaded, a GLX context must
378have been created and be made current, and C<dlsym> must be available and
379capable of finding the function via C<RTLD_DEFAULT>.
380
381=cut
382
383package OpenCL;
384
385use common::sense;
386
387BEGIN {
388 our $VERSION = '0.97';
389
390 require XSLoader;
391 XSLoader::load (__PACKAGE__, $VERSION);
392
393 @OpenCL::Platform::ISA =
394 @OpenCL::Device::ISA =
395 @OpenCL::Context::ISA =
396 @OpenCL::Queue::ISA =
397 @OpenCL::Memory::ISA =
398 @OpenCL::Sampler::ISA =
399 @OpenCL::Program::ISA =
400 @OpenCL::Kernel::ISA =
401 @OpenCL::Event::ISA = OpenCL::Object::;
402
403 @OpenCL::Buffer::ISA =
404 @OpenCL::Image::ISA = OpenCL::Memory::;
405
406 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
407
408 @OpenCL::Image2D::ISA =
409 @OpenCL::Image3D::ISA =
410 @OpenCL::Image2DArray::ISA =
411 @OpenCL::Image1D::ISA =
412 @OpenCL::Image1DArray::ISA =
413 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
414
415 @OpenCL::UserEvent::ISA = OpenCL::Event::;
416}
417
276=head2 THE OpenCL PACKAGE 418=head2 THE OpenCL PACKAGE
277 419
278=over 4 420=over 4
279 421
280=item $int = OpenCL::errno 422=item $int = OpenCL::errno
286 428
287Comverts an error value into a human readable string. 429Comverts an error value into a human readable string.
288 430
289=item $str = OpenCL::enum2str $enum 431=item $str = OpenCL::enum2str $enum
290 432
291Converts most enum values (inof parameter names, image format constants, 433Converts most enum values (of parameter names, image format constants,
292object types, addressing and filter modes, command types etc.) into a 434object types, addressing and filter modes, command types etc.) into a
293human readbale string. When confronted with some random integer it can be 435human readable string. When confronted with some random integer it can be
294very helpful to pass it through this function to maybe get some readable 436very helpful to pass it through this function to maybe get some readable
295string out of it. 437string out of it.
296 438
297=item @platforms = OpenCL::platforms 439=item @platforms = OpenCL::platforms
298 440
312 454
313L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 455L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314 456
315=back 457=back
316 458
459=head2 THE OpenCL::Object CLASS
460
461This is the base class for all objects in the OpenCL module. The only
462method it implements is the C<id> method, which is only useful if you want
463to interface to OpenCL on the C level.
464
465=over 4
466
467=item $iv = $obj->id
468
469OpenCL objects are represented by pointers or integers on the C level. If
470you want to interface to an OpenCL object directly on the C level, then
471you need this value, which is returned by this method. You should use an
472C<IV> type in your code and cast that to the correct type.
473
474=cut
475
476sub OpenCL::Object::id {
477 ${$_[0]}
478}
479
480=back
481
317=head2 THE OpenCL::Platform CLASS 482=head2 THE OpenCL::Platform CLASS
318 483
319=over 4 484=over 4
320 485
321=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 486=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322 487
323Returns a list of matching OpenCL::Device objects. 488Returns a list of matching OpenCL::Device objects.
324 489
325=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 490=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
326 491
327Tries to create a context. Never worked for me, and you need devices explitly anyway. 492Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 493
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 494L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 495
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 496=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
332 497
333Create a new OpenCL::Context object using the given device object(s)- a 498Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 499CL_CONTEXT_PLATFORM property is supplied automatically.
335 500
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 501L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
337 502
338=item $packed_value = $platform->info ($name) 503=item $packed_value = $platform->info ($name)
339 504
340Calls C<clGetPlatformInfo> and returns the packed, raw value - for 505Calls C<clGetPlatformInfo> and returns the packed, raw value - for
341strings, this will be the string, for other values you probably need to 506strings, this will be the string (possibly including terminating \0), for
342use the correct C<unpack>. 507other values you probably need to use the correct C<unpack>.
343 508
344It's best to avoid this method and use one of the predefined C<get_*> 509It's best to avoid this method and use one of the following convenience
345methods. 510wrappers.
346 511
347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 512L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348 513
514=item $platform->unload_compiler
515
516Attempts to unload the compiler for this platform, for endless
517profit. Does nothing on OpenCL 1.1.
518
519L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
520
349=for gengetinfo begin platform 521=for gengetinfo begin platform
350 522
351
352=item $string = $platform->profile 523=item $string = $platform->profile
353 524
354Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s). 525Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
355 526
356=item $string = $platform->version 527=item $string = $platform->version
357 528
358Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s). 529Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
359 530
360=item $string = $platform->name 531=item $string = $platform->name
361 532
362Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s). 533Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
363 534
364=item $string = $platform->vendor 535=item $string = $platform->vendor
365 536
366Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s). 537Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
367 538
368=item $string = $platform->extensions 539=item $string = $platform->extensions
369 540
370Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s). 541Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
542
371=for gengetinfo end platform 543=for gengetinfo end platform
372 544
373=back 545=back
374 546
375=head2 THE OpenCL::Device CLASS 547=head2 THE OpenCL::Device CLASS
380 552
381See C<< $platform->info >> for details. 553See C<< $platform->info >> for details.
382 554
383L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 555L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
384 556
557=for gengetinfo begin device
558
559=item $device_type = $device->type
560
561Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
562
563=item $uint = $device->vendor_id
564
565Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
566
567=item $uint = $device->max_compute_units
568
569Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
570
571=item $uint = $device->max_work_item_dimensions
572
573Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
574
575=item $int = $device->max_work_group_size
576
577Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
578
579=item @ints = $device->max_work_item_sizes
580
581Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
582
583=item $uint = $device->preferred_vector_width_char
584
585Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
586
587=item $uint = $device->preferred_vector_width_short
588
589Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
590
591=item $uint = $device->preferred_vector_width_int
592
593Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
594
595=item $uint = $device->preferred_vector_width_long
596
597Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
598
599=item $uint = $device->preferred_vector_width_float
600
601Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
602
603=item $uint = $device->preferred_vector_width_double
604
605Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
606
607=item $uint = $device->max_clock_frequency
608
609Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
610
611=item $bitfield = $device->address_bits
612
613Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
614
615=item $uint = $device->max_read_image_args
616
617Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
618
619=item $uint = $device->max_write_image_args
620
621Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
622
623=item $ulong = $device->max_mem_alloc_size
624
625Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
626
627=item $int = $device->image2d_max_width
628
629Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
630
631=item $int = $device->image2d_max_height
632
633Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
634
635=item $int = $device->image3d_max_width
636
637Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
638
639=item $int = $device->image3d_max_height
640
641Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
642
643=item $int = $device->image3d_max_depth
644
645Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
646
647=item $uint = $device->image_support
648
649Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
650
651=item $int = $device->max_parameter_size
652
653Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
654
655=item $uint = $device->max_samplers
656
657Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
658
659=item $uint = $device->mem_base_addr_align
660
661Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
662
663=item $uint = $device->min_data_type_align_size
664
665Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
666
667=item $device_fp_config = $device->single_fp_config
668
669Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
670
671=item $device_mem_cache_type = $device->global_mem_cache_type
672
673Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
674
675=item $uint = $device->global_mem_cacheline_size
676
677Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
678
679=item $ulong = $device->global_mem_cache_size
680
681Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
682
683=item $ulong = $device->global_mem_size
684
685Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
686
687=item $ulong = $device->max_constant_buffer_size
688
689Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
690
691=item $uint = $device->max_constant_args
692
693Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
694
695=item $device_local_mem_type = $device->local_mem_type
696
697Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
698
699=item $ulong = $device->local_mem_size
700
701Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
702
703=item $boolean = $device->error_correction_support
704
705Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
706
707=item $int = $device->profiling_timer_resolution
708
709Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
710
711=item $boolean = $device->endian_little
712
713Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
714
715=item $boolean = $device->available
716
717Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
718
719=item $boolean = $device->compiler_available
720
721Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
722
723=item $device_exec_capabilities = $device->execution_capabilities
724
725Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
726
727=item $command_queue_properties = $device->properties
728
729Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
730
731=item $ = $device->platform
732
733Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
734
735=item $string = $device->name
736
737Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
738
739=item $string = $device->vendor
740
741Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
742
743=item $string = $device->driver_version
744
745Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
746
747=item $string = $device->profile
748
749Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
750
751=item $string = $device->version
752
753Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
754
755=item $string = $device->extensions
756
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
758
759=item $uint = $device->preferred_vector_width_half
760
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
762
763=item $uint = $device->native_vector_width_char
764
765Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
766
767=item $uint = $device->native_vector_width_short
768
769Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
770
771=item $uint = $device->native_vector_width_int
772
773Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
774
775=item $uint = $device->native_vector_width_long
776
777Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
778
779=item $uint = $device->native_vector_width_float
780
781Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
782
783=item $uint = $device->native_vector_width_double
784
785Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
786
787=item $uint = $device->native_vector_width_half
788
789Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
790
791=item $device_fp_config = $device->double_fp_config
792
793Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
794
795=item $device_fp_config = $device->half_fp_config
796
797Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
798
799=item $boolean = $device->host_unified_memory
800
801Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
802
803=item $device = $device->parent_device_ext
804
805Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
806
807=item @device_partition_property_exts = $device->partition_types_ext
808
809Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
810
811=item @device_partition_property_exts = $device->affinity_domains_ext
812
813Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
814
815=item $uint = $device->reference_count_ext
816
817Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
818
819=item @device_partition_property_exts = $device->partition_style_ext
820
821Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
822
823=for gengetinfo end device
824
385=back 825=back
386 826
387=head2 THE OpenCL::Context CLASS 827=head2 THE OpenCL::Context CLASS
388 828
389=over 4 829=over 4
390 830
831=item $prog = $ctx->build_program ($program, $options = "")
832
833This convenience function tries to build the program on all devices in
834the context. If the build fails, then the function will C<croak> with the
835build log. Otherwise ti returns the program object.
836
837The C<$program> can either be a C<OpenCL::Program> object or a string
838containing the program. In the latter case, a program objetc will be
839created automatically.
840
841=cut
842
843sub OpenCL::Context::build_program {
844 my ($self, $prog, $options) = @_;
845
846 require Carp;
847
848 $prog = $self->program_with_source ($prog)
849 unless ref $prog;
850
851 for my $dev ($self->devices) {
852 eval { $prog->build ($dev, $options); 1 }
853 or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
854 . $prog->build_log ($dev));
855 }
856
857 $prog
858}
859
391=item $queue = $ctx->queue ($device, $properties) 860=item $queue = $ctx->queue ($device, $properties)
392 861
393Create a new OpenCL::Queue object from the context and the given device. 862Create a new OpenCL::Queue object from the context and the given device.
394 863
395L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 864L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
396 865
866Example: create an out-of-order queue.
867
868 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
869
397=item $ev = $ctx->user_event 870=item $ev = $ctx->user_event
398 871
399Creates a new OpenCL::UserEvent object. 872Creates a new OpenCL::UserEvent object.
400 873
401L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 874L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
402 875
403=item $buf = $ctx->buffer ($flags, $len) 876=item $buf = $ctx->buffer ($flags, $len)
404 877
405Creates a new OpenCL::Buffer object with the given flags and octet-size. 878Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
879given flags and octet-size.
406 880
407L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 881L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
408 882
409=item $buf = $ctx->buffer_sv ($flags, $data) 883=item $buf = $ctx->buffer_sv ($flags, $data)
410 884
411Creates a new OpenCL::Buffer object and initialise it with the given data values. 885Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
886initialise it with the given data values.
887
888=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
889
890Creates a new OpenCL::Image object and optionally initialises it with
891the given data values.
892
893L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
412 894
413=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 895=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
414 896
415Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 897Creates a new OpenCL::Image2D object and optionally initialises it with
898the given data values.
416 899
417L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 900L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
418 901
419=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 902=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
420 903
421Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 904Creates a new OpenCL::Image3D object and optionally initialises it with
905the given data values.
422 906
423L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 907L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
908
909=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
910
911Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
912OpenGL buffer object.
913
914http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
915
916=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
917
918Creates a new OpenCL::Image object that refers to the given OpenGL
919texture object or buffer.
920
921http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
922
923=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
924
925Creates a new OpenCL::Image2D object that refers to the given OpenGL
9262D texture object.
927
928http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
929
930=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
931
932Creates a new OpenCL::Image3D object that refers to the given OpenGL
9333D texture object.
934
935http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
936
937=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
938
939Creates a new OpenCL::Image2D object that refers to the given OpenGL
940render buffer.
941
942http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
424 943
425=item @formats = $ctx->supported_image_formats ($flags, $image_type) 944=item @formats = $ctx->supported_image_formats ($flags, $image_type)
426 945
427Returns a list of matching image formats - each format is an arrayref with 946Returns a list of matching image formats - each format is an arrayref with
428two values, $channel_order and $channel_type, in it. 947two values, $channel_order and $channel_type, in it.
446See C<< $platform->info >> for details. 965See C<< $platform->info >> for details.
447 966
448L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 967L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
449 968
450=for gengetinfo begin context 969=for gengetinfo begin context
970
971=item $uint = $context->reference_count
972
973Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
974
975=item @devices = $context->devices
976
977Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
978
979=item @property_ints = $context->properties
980
981Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
982
983=item $uint = $context->num_devices
984
985Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
451 986
452=for gengetinfo end context 987=for gengetinfo end context
453 988
454=back 989=back
455 990
463for completion, unless the method is called in void context, in which case 998for completion, unless the method is called in void context, in which case
464no event object is created. 999no event object is created.
465 1000
466They also allow you to specify any number of other event objects that this 1001They also allow you to specify any number of other event objects that this
467request has to wait for before it starts executing, by simply passing the 1002request has to wait for before it starts executing, by simply passing the
468event objects as extra parameters to the enqueue methods. 1003event objects as extra parameters to the enqueue methods. To simplify
1004program design, this module ignores any C<undef> values in the list of
1005events. This makes it possible to code operations such as this, without
1006having to put a valid event object into C<$event> first:
1007
1008 $event = $queue->enqueue_xxx (..., $event);
469 1009
470Queues execute in-order by default, without any parallelism, so in most 1010Queues execute in-order by default, without any parallelism, so in most
471cases (i.e. you use only one queue) it's not necessary to wait for or 1011cases (i.e. you use only one queue) it's not necessary to wait for or
472create event objects. 1012create event objects, althoguh an our of order queue is often a bit
1013faster.
473 1014
474=over 4 1015=over 4
475 1016
476=item $packed_value = $ctx->info ($name)
477
478See C<< $platform->info >> for details.
479
480L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
481
482=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1017=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
483 1018
484Reads data from buffer into the given string. 1019Reads data from buffer into the given string.
485 1020
486L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 1021L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
493 1028
494=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1029=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
495 1030
496L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1031L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
497 1032
1033=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...)
1034
1035http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1036
1037=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...)
1038
1039http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1040
498=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1041=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
499 1042
1043L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1044
1045=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...)
1046
500L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1047L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
501 1048
502=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1049=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
503 1050
504L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1051L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
505 1052
1053=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...)
1054
1055L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1056
1057=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...)
1058
1059L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1060
506=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...) 1061=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...)
507 1062
508Yeah. 1063Yeah.
509 1064
510L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
511
512=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...)
513
514L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1065L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
515 1066
516=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...) 1067=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
517 1068
1069Fills the given buffer object with repeated applications of C<$pattern>,
1070starting at C<$offset> for C<$size> octets.
1071
1072L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1073
1074=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1075
1076Fills the given image area with the given rgba colour components. The
1077components are normally floating point values between C<0> and C<1>,
1078except when the image channel data type is a signe dor unsigned
1079unnormalised format, in which case the range is determined by the format.
1080
518L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1081L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
519
520=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...)
521
522L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
523 1082
524=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1083=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
525 1084
526L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1085L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
527 1086
541reference to an array of local work sizes, with the same number of 1100reference to an array of local work sizes, with the same number of
542elements as @$global_work_size. 1101elements as @$global_work_size.
543 1102
544L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1103L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
545 1104
546=item $ev = $queue->enqueue_marker 1105=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
547 1106
1107Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1108for subsequent OpenCL usage.
1109
548L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1110L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1111
1112=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1113
1114Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1115for subsequent OpenGL usage.
1116
1117L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
549 1118
550=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1119=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
551 1120
552L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1121L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
553 1122
554=item $queue->enqueue_barrier 1123=item $ev = $queue->enqueue_marker ($wait_events...)
555 1124
1125L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1126
1127=item $ev = $queue->enqueue_barrier ($wait_events...)
1128
556L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1129L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
557 1130
558=item $queue->flush 1131=item $queue->flush
559 1132
560L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1133L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
561 1134
562=item $queue->finish 1135=item $queue->finish
563 1136
564L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1137L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
565 1138
1139=item $packed_value = $queue->info ($name)
1140
1141See C<< $platform->info >> for details.
1142
1143L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1144
1145=for gengetinfo begin command_queue
1146
1147=item $ctx = $command_queue->context
1148
1149Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1150
1151=item $device = $command_queue->device
1152
1153Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1154
1155=item $uint = $command_queue->reference_count
1156
1157Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1158
1159=item $command_queue_properties = $command_queue->properties
1160
1161Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1162
1163=for gengetinfo end command_queue
1164
566=back 1165=back
567 1166
568=head2 THE OpenCL::Memory CLASS 1167=head2 THE OpenCL::Memory CLASS
569 1168
570This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1169This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
571OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1170OpenCL::Image2D and OpenCL::Image3D.
572currently only exist to allow type-checking.
573 1171
574=over 4 1172=over 4
575 1173
576=item $packed_value = $memory->info ($name) 1174=item $packed_value = $memory->info ($name)
577 1175
578See C<< $platform->info >> for details. 1176See C<< $platform->info >> for details.
579 1177
580L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1178L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
581 1179
1180=for gengetinfo begin mem
1181
1182=item $mem_object_type = $mem->type
1183
1184Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1185
1186=item $mem_flags = $mem->flags
1187
1188Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1189
1190=item $int = $mem->size
1191
1192Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1193
1194=item $ptr_value = $mem->host_ptr
1195
1196Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1197
1198=item $uint = $mem->map_count
1199
1200Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1201
1202=item $uint = $mem->reference_count
1203
1204Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1205
1206=item $ctx = $mem->context
1207
1208Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1209
1210=item $mem = $mem->associated_memobject
1211
1212Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1213
1214=item $int = $mem->offset
1215
1216Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1217
1218=for gengetinfo end mem
1219
1220=item ($type, $name) = $mem->gl_object_info
1221
1222Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1223object "name" (e.g. the texture name) used to create this memory object.
1224
1225L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1226
582=back 1227=back
583 1228
1229=head2 THE OpenCL::Buffer CLASS
1230
1231This is a subclass of OpenCL::Memory, and the superclass of
1232OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1233and sub-buffers.
1234
1235=head2 THE OpenCL::BufferObj CLASS
1236
1237This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1238because one cna create sub buffers of OpenLC::BufferObj objects, but not
1239sub buffers from these sub buffers.
1240
1241=over 4
1242
1243=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1244
1245Creates an OpenCL::Buffer objects from this buffer and returns it. The
1246C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1247
1248L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1249
1250=back
1251
584=head2 THE OpenCL::Image CLASS 1252=head2 THE OpenCL::Image CLASS
585 1253
586This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1254This is the superclass of all image objects - OpenCL::Image1D,
1255OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1256OpenCL::Image2DArray and OpenCL::Image3D.
587 1257
588=over 4 1258=over 4
589 1259
590=item $packed_value = $ev->image_info ($name) 1260=item $packed_value = $image->image_info ($name)
591 1261
592See C<< $platform->info >> for details. 1262See C<< $platform->info >> for details.
593 1263
594The reason this method is not called C<info> is that there already is an 1264The reason this method is not called C<info> is that there already is an
595C<< ->info >> method inherited from C<OpenCL::Memory>. 1265C<< ->info >> method inherited from C<OpenCL::Memory>.
596 1266
597L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1267L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
598 1268
1269=item ($channel_order, $channel_data_type) = $image->format
1270
1271Returns the channel order and type used to create the image by calling
1272C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
1273
1274=for gengetinfo begin image
1275
1276=item $int = $image->element_size
1277
1278Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1279
1280=item $int = $image->row_pitch
1281
1282Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1283
1284=item $int = $image->slice_pitch
1285
1286Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1287
1288=item $int = $image->width
1289
1290Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1291
1292=item $int = $image->height
1293
1294Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1295
1296=item $int = $image->depth
1297
1298Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1299
1300=for gengetinfo end image
1301
1302=for gengetinfo begin gl_texture
1303
1304=item $GLenum = $gl_texture->target
1305
1306Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1307
1308=item $GLint = $gl_texture->gl_mipmap_level
1309
1310Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1311
1312=for gengetinfo end gl_texture
1313
599=back 1314=back
600 1315
601=head2 THE OpenCL::Sampler CLASS 1316=head2 THE OpenCL::Sampler CLASS
602 1317
603=over 4 1318=over 4
606 1321
607See C<< $platform->info >> for details. 1322See C<< $platform->info >> for details.
608 1323
609L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1324L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
610 1325
1326=for gengetinfo begin sampler
1327
1328=item $uint = $sampler->reference_count
1329
1330Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1331
1332=item $ctx = $sampler->context
1333
1334Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1335
1336=item $addressing_mode = $sampler->normalized_coords
1337
1338Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1339
1340=item $filter_mode = $sampler->addressing_mode
1341
1342Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1343
1344=item $boolean = $sampler->filter_mode
1345
1346Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1347
1348=for gengetinfo end sampler
1349
611=back 1350=back
612 1351
613=head2 THE OpenCL::Program CLASS 1352=head2 THE OpenCL::Program CLASS
614 1353
615=over 4 1354=over 4
616 1355
617=item $packed_value = $program->info ($name)
618
619See C<< $platform->info >> for details.
620
621L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
622
623=item $program->build ($device, $options = "") 1356=item $program->build ($device, $options = "")
624 1357
625Tries to build the program with the givne options. 1358Tries to build the program with the given options. See also the
1359C<$ctx->build> convenience function.
626 1360
627L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1361L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
628 1362
629=item $packed_value = $program->build_info ($device, $name) 1363=item $packed_value = $program->build_info ($device, $name)
630 1364
638Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1372Creates an OpenCL::Kernel object out of the named C<__kernel> function in
639the program. 1373the program.
640 1374
641L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1375L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
642 1376
1377=item @kernels = $program->kernels_in_program
1378
1379Returns all kernels successfully compiled for all devices in program.
1380
1381http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1382
1383=for gengetinfo begin program_build
1384
1385=item $build_status = $program->build_status ($device)
1386
1387Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1388
1389=item $string = $program->build_options ($device)
1390
1391Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1392
1393=item $string = $program->build_log ($device)
1394
1395Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1396
1397=for gengetinfo end program_build
1398
1399=item $packed_value = $program->info ($name)
1400
1401See C<< $platform->info >> for details.
1402
1403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1404
1405=for gengetinfo begin program
1406
1407=item $uint = $program->reference_count
1408
1409Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1410
1411=item $ctx = $program->context
1412
1413Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1414
1415=item $uint = $program->num_devices
1416
1417Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1418
1419=item @devices = $program->devices
1420
1421Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1422
1423=item $string = $program->source
1424
1425Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1426
1427=item @ints = $program->binary_sizes
1428
1429Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1430
1431=for gengetinfo end program
1432
1433=item @blobs = $program->binaries
1434
1435Returns a string for the compiled binary for every device associated with
1436the program, empty strings indicate missing programs, and an empty result
1437means no program binaries are available.
1438
1439These "binaries" are often, in fact, informative low-level assembly
1440sources.
1441
1442L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1443
643=back 1444=back
644 1445
645=head2 THE OpenCL::Kernel CLASS 1446=head2 THE OpenCL::Kernel CLASS
646 1447
647=over 4 1448=over 4
649=item $packed_value = $kernel->info ($name) 1450=item $packed_value = $kernel->info ($name)
650 1451
651See C<< $platform->info >> for details. 1452See C<< $platform->info >> for details.
652 1453
653L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1454L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1455
1456=for gengetinfo begin kernel
1457
1458=item $string = $kernel->function_name
1459
1460Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1461
1462=item $uint = $kernel->num_args
1463
1464Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1465
1466=item $uint = $kernel->reference_count
1467
1468Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1469
1470=item $ctx = $kernel->context
1471
1472Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1473
1474=item $program = $kernel->program
1475
1476Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1477
1478=for gengetinfo end kernel
654 1479
655=item $packed_value = $kernel->work_group_info ($device, $name) 1480=item $packed_value = $kernel->work_group_info ($device, $name)
656 1481
657See C<< $platform->info >> for details. 1482See C<< $platform->info >> for details.
658 1483
659The reason this method is not called C<info> is that there already is an 1484The reason this method is not called C<info> is that there already is an
660C<< ->info >> method. 1485C<< ->info >> method.
661 1486
662L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> 1487L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
663 1488
1489=for gengetinfo begin kernel_work_group
1490
1491=item $int = $kernel->work_group_size ($device)
1492
1493Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1494
1495=item @ints = $kernel->compile_work_group_size ($device)
1496
1497Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1498
1499=item $ulong = $kernel->local_mem_size ($device)
1500
1501Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1502
1503=item $int = $kernel->preferred_work_group_size_multiple ($device)
1504
1505Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1506
1507=item $ulong = $kernel->private_mem_size ($device)
1508
1509Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1510
1511=for gengetinfo end kernel_work_group
1512
664=item $kernel->set_TYPE ($index, $value) 1513=item $kernel->set_TYPE ($index, $value)
665 1514
666This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1515This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
667 1516
668TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1517TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
669C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1518C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
670C<image2d>, C<image3d>, C<sampler> or C<event>. 1519C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
671 1520
672Chars and integers (including the half type) are specified as integers, 1521Chars and integers (including the half type) are specified as integers,
673float and double as floating point values, memory/buffer/image2d/image3d 1522float and double as floating point values, memory/buffer/image2d/image3d
674must be an object of that type or C<undef>, and sampler and event must be 1523must be an object of that type or C<undef>, local-memory arguments are
675objects of that type. 1524set by specifying the size, and sampler and event must be objects of that
1525type.
1526
1527Setting an argument for a kernel does NOT keep a reference to the object -
1528for example, if you set an argument to some image object, free the image,
1529and call the kernel, you will run into undefined behaviour.
676 1530
677L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1531L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
678 1532
679=back 1533=back
680 1534
683This is the superclass for all event objects (including OpenCL::UserEvent 1537This is the superclass for all event objects (including OpenCL::UserEvent
684objects). 1538objects).
685 1539
686=over 4 1540=over 4
687 1541
1542=item $ev->wait
1543
1544Waits for the event to complete.
1545
1546L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1547
688=item $packed_value = $ev->info ($name) 1548=item $packed_value = $ev->info ($name)
689 1549
690See C<< $platform->info >> for details. 1550See C<< $platform->info >> for details.
691 1551
692L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1552L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1553
1554=for gengetinfo begin event
1555
1556=item $queue = $event->command_queue
1557
1558Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1559
1560=item $command_type = $event->command_type
1561
1562Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1563
1564=item $uint = $event->reference_count
1565
1566Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1567
1568=item $uint = $event->command_execution_status
1569
1570Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1571
1572=item $ctx = $event->context
1573
1574Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1575
1576=for gengetinfo end event
693 1577
694=item $packed_value = $ev->profiling_info ($name) 1578=item $packed_value = $ev->profiling_info ($name)
695 1579
696See C<< $platform->info >> for details. 1580See C<< $platform->info >> for details.
697 1581
698The reason this method is not called C<info> is that there already is an 1582The reason this method is not called C<info> is that there already is an
699C<< ->info >> method. 1583C<< ->info >> method.
700 1584
701L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html> 1585L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
702 1586
703=item $ev->wait 1587=for gengetinfo begin profiling
704 1588
705Waits for the event to complete. 1589=item $ulong = $event->profiling_command_queued
706 1590
707L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1591Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1592
1593=item $ulong = $event->profiling_command_submit
1594
1595Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1596
1597=item $ulong = $event->profiling_command_start
1598
1599Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1600
1601=item $ulong = $event->profiling_command_end
1602
1603Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1604
1605=for gengetinfo end profiling
708 1606
709=back 1607=back
710 1608
711=head2 THE OpenCL::UserEvent CLASS 1609=head2 THE OpenCL::UserEvent CLASS
712 1610
719L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 1617L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
720 1618
721=back 1619=back
722 1620
723=cut 1621=cut
724
725package OpenCL;
726
727use common::sense;
728
729BEGIN {
730 our $VERSION = '0.15';
731
732 require XSLoader;
733 XSLoader::load (__PACKAGE__, $VERSION);
734
735 @OpenCL::Buffer::ISA =
736 @OpenCL::Image::ISA = OpenCL::Memory::;
737
738 @OpenCL::Image2D::ISA =
739 @OpenCL::Image3D::ISA = OpenCL::Image::;
740
741 @OpenCL::UserEvent::ISA = OpenCL::Event::;
742}
743 1622
7441; 16231;
745 1624
746=head1 AUTHOR 1625=head1 AUTHOR
747 1626

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines