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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.22 by root, Sun Nov 20 10:25:17 2011 UTC vs.
Revision 1.53 by root, Tue Apr 24 14:30:57 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.96';
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)
… …
326 491
327Tries to create a context. Never worked for me, and you need devices explicitly 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>
… …
344It's best to avoid this method and use one of the following convenience 509It's best to avoid this method and use one of the following convenience
345wrappers. 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=item $string = $platform->profile 523=item $string = $platform->profile
352 524
353Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s). 525Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
354 526
355=item $string = $platform->version 527=item $string = $platform->version
356 528
357Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s). 529Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
358 530
359=item $string = $platform->name 531=item $string = $platform->name
360 532
361Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s). 533Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
362 534
363=item $string = $platform->vendor 535=item $string = $platform->vendor
364 536
365Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s). 537Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
366 538
367=item $string = $platform->extensions 539=item $string = $platform->extensions
368 540
369Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s). 541Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
370 542
371=for gengetinfo end platform 543=for gengetinfo end platform
372 544
373=back 545=back
374 546
… …
384 556
385=for gengetinfo begin device 557=for gengetinfo begin device
386 558
387=item $device_type = $device->type 559=item $device_type = $device->type
388 560
389Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s). 561Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
390 562
391=item $uint = $device->vendor_id 563=item $uint = $device->vendor_id
392 564
393Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s). 565Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
394 566
395=item $uint = $device->max_compute_units 567=item $uint = $device->max_compute_units
396 568
397Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s). 569Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
398 570
399=item $uint = $device->max_work_item_dimensions 571=item $uint = $device->max_work_item_dimensions
400 572
401Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s). 573Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
402 574
403=item $int = $device->max_work_group_size 575=item $int = $device->max_work_group_size
404 576
405Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s). 577Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
406 578
407=item @ints = $device->max_work_item_sizes 579=item @ints = $device->max_work_item_sizes
408 580
409Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s). 581Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
410 582
411=item $uint = $device->preferred_vector_width_char 583=item $uint = $device->preferred_vector_width_char
412 584
413Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s). 585Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
414 586
415=item $uint = $device->preferred_vector_width_short 587=item $uint = $device->preferred_vector_width_short
416 588
417Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s). 589Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
418 590
419=item $uint = $device->preferred_vector_width_int 591=item $uint = $device->preferred_vector_width_int
420 592
421Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s). 593Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
422 594
423=item $uint = $device->preferred_vector_width_long 595=item $uint = $device->preferred_vector_width_long
424 596
425Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s). 597Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
426 598
427=item $uint = $device->preferred_vector_width_float 599=item $uint = $device->preferred_vector_width_float
428 600
429Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s). 601Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
430 602
431=item $uint = $device->preferred_vector_width_double 603=item $uint = $device->preferred_vector_width_double
432 604
433Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s). 605Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
434 606
435=item $uint = $device->max_clock_frequency 607=item $uint = $device->max_clock_frequency
436 608
437Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s). 609Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
438 610
439=item $bitfield = $device->address_bits 611=item $bitfield = $device->address_bits
440 612
441Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s). 613Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
442 614
443=item $uint = $device->max_read_image_args 615=item $uint = $device->max_read_image_args
444 616
445Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s). 617Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
446 618
447=item $uint = $device->max_write_image_args 619=item $uint = $device->max_write_image_args
448 620
449Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s). 621Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
450 622
451=item $ulong = $device->max_mem_alloc_size 623=item $ulong = $device->max_mem_alloc_size
452 624
453Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s). 625Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
454 626
455=item $int = $device->image2d_max_width 627=item $int = $device->image2d_max_width
456 628
457Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s). 629Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
458 630
459=item $int = $device->image2d_max_height 631=item $int = $device->image2d_max_height
460 632
461Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s). 633Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
462 634
463=item $int = $device->image3d_max_width 635=item $int = $device->image3d_max_width
464 636
465Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s). 637Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
466 638
467=item $int = $device->image3d_max_height 639=item $int = $device->image3d_max_height
468 640
469Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s). 641Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
470 642
471=item $int = $device->image3d_max_depth 643=item $int = $device->image3d_max_depth
472 644
473Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s). 645Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
474 646
475=item $uint = $device->image_support 647=item $uint = $device->image_support
476 648
477Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s). 649Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
478 650
479=item $int = $device->max_parameter_size 651=item $int = $device->max_parameter_size
480 652
481Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s). 653Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
482 654
483=item $uint = $device->max_samplers 655=item $uint = $device->max_samplers
484 656
485Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s). 657Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
486 658
487=item $uint = $device->mem_base_addr_align 659=item $uint = $device->mem_base_addr_align
488 660
489Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s). 661Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
490 662
491=item $uint = $device->min_data_type_align_size 663=item $uint = $device->min_data_type_align_size
492 664
493Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s). 665Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
494 666
495=item $device_fp_config = $device->single_fp_config 667=item $device_fp_config = $device->single_fp_config
496 668
497Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s). 669Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
498 670
499=item $device_mem_cache_type = $device->global_mem_cache_type 671=item $device_mem_cache_type = $device->global_mem_cache_type
500 672
501Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s). 673Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
502 674
503=item $uint = $device->global_mem_cacheline_size 675=item $uint = $device->global_mem_cacheline_size
504 676
505Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s). 677Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
506 678
507=item $ulong = $device->global_mem_cache_size 679=item $ulong = $device->global_mem_cache_size
508 680
509Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s). 681Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
510 682
511=item $ulong = $device->global_mem_size 683=item $ulong = $device->global_mem_size
512 684
513Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s). 685Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
514 686
515=item $ulong = $device->max_constant_buffer_size 687=item $ulong = $device->max_constant_buffer_size
516 688
517Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s). 689Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
518 690
519=item $uint = $device->max_constant_args 691=item $uint = $device->max_constant_args
520 692
521Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s). 693Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
522 694
523=item $device_local_mem_type = $device->local_mem_type 695=item $device_local_mem_type = $device->local_mem_type
524 696
525Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s). 697Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
526 698
527=item $ulong = $device->local_mem_size 699=item $ulong = $device->local_mem_size
528 700
529Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s). 701Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
530 702
531=item $boolean = $device->error_correction_support 703=item $boolean = $device->error_correction_support
532 704
533Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s). 705Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
534 706
535=item $int = $device->profiling_timer_resolution 707=item $int = $device->profiling_timer_resolution
536 708
537Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s). 709Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
538 710
539=item $boolean = $device->endian_little 711=item $boolean = $device->endian_little
540 712
541Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s). 713Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
542 714
543=item $boolean = $device->available 715=item $boolean = $device->available
544 716
545Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s). 717Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
546 718
547=item $boolean = $device->compiler_available 719=item $boolean = $device->compiler_available
548 720
549Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s). 721Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
550 722
551=item $device_exec_capabilities = $device->execution_capabilities 723=item $device_exec_capabilities = $device->execution_capabilities
552 724
553Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s). 725Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
554 726
555=item $command_queue_properties = $device->properties 727=item $command_queue_properties = $device->properties
556 728
557Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s). 729Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
558 730
559=item $ = $device->platform 731=item $ = $device->platform
560 732
561Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s). 733Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
562 734
563=item $string = $device->name 735=item $string = $device->name
564 736
565Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s). 737Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
566 738
567=item $string = $device->vendor 739=item $string = $device->vendor
568 740
569Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s). 741Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
570 742
571=item $string = $device->driver_version 743=item $string = $device->driver_version
572 744
573Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s). 745Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
574 746
575=item $string = $device->profile 747=item $string = $device->profile
576 748
577Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s). 749Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
578 750
579=item $string = $device->version 751=item $string = $device->version
580 752
581Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s). 753Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
582 754
583=item $string = $device->extensions 755=item $string = $device->extensions
584 756
585Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s). 757Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
586 758
587=item $uint = $device->preferred_vector_width_half 759=item $uint = $device->preferred_vector_width_half
588 760
589Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s). 761Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
590 762
591=item $uint = $device->native_vector_width_char 763=item $uint = $device->native_vector_width_char
592 764
593Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s). 765Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
594 766
595=item $uint = $device->native_vector_width_short 767=item $uint = $device->native_vector_width_short
596 768
597Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s). 769Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
598 770
599=item $uint = $device->native_vector_width_int 771=item $uint = $device->native_vector_width_int
600 772
601Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s). 773Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
602 774
603=item $uint = $device->native_vector_width_long 775=item $uint = $device->native_vector_width_long
604 776
605Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s). 777Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
606 778
607=item $uint = $device->native_vector_width_float 779=item $uint = $device->native_vector_width_float
608 780
609Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s). 781Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
610 782
611=item $uint = $device->native_vector_width_double 783=item $uint = $device->native_vector_width_double
612 784
613Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s). 785Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
614 786
615=item $uint = $device->native_vector_width_half 787=item $uint = $device->native_vector_width_half
616 788
617Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s). 789Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
618 790
619=item $device_fp_config = $device->double_fp_config 791=item $device_fp_config = $device->double_fp_config
620 792
621Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s). 793Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
622 794
623=item $device_fp_config = $device->half_fp_config 795=item $device_fp_config = $device->half_fp_config
624 796
625Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s). 797Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
626 798
627=item $boolean = $device->host_unified_memory 799=item $boolean = $device->host_unified_memory
628 800
629Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s). 801Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
630 802
631=item $device = $device->parent_device_ext 803=item $device = $device->parent_device_ext
632 804
633Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s). 805Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
634 806
635=item @device_partition_property_exts = $device->partition_types_ext 807=item @device_partition_property_exts = $device->partition_types_ext
636 808
637Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s). 809Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
638 810
639=item @device_partition_property_exts = $device->affinity_domains_ext 811=item @device_partition_property_exts = $device->affinity_domains_ext
640 812
641Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s). 813Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
642 814
643=item $uint = $device->reference_count_ext 815=item $uint = $device->reference_count_ext
644 816
645Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s). 817Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
646 818
647=item @device_partition_property_exts = $device->partition_style_ext 819=item @device_partition_property_exts = $device->partition_style_ext
648 820
649Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s). 821Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
650 822
651=for gengetinfo end device 823=for gengetinfo end device
652 824
653=back 825=back
654 826
655=head2 THE OpenCL::Context CLASS 827=head2 THE OpenCL::Context CLASS
656 828
657=over 4 829=over 4
658 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 $prog = $self->program_with_source ($prog)
847 unless ref $prog;
848
849 for my $dev ($self->devices) {
850 eval { $prog->build ($dev, $options); 1 }
851 or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
852 . $prog->build_log ($dev);
853 }
854
855 $prog
856}
857
659=item $queue = $ctx->queue ($device, $properties) 858=item $queue = $ctx->queue ($device, $properties)
660 859
661Create a new OpenCL::Queue object from the context and the given device. 860Create a new OpenCL::Queue object from the context and the given device.
662 861
663L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 862L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
664 863
864Example: create an out-of-order queue.
865
866 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
867
665=item $ev = $ctx->user_event 868=item $ev = $ctx->user_event
666 869
667Creates a new OpenCL::UserEvent object. 870Creates a new OpenCL::UserEvent object.
668 871
669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 872L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
670 873
671=item $buf = $ctx->buffer ($flags, $len) 874=item $buf = $ctx->buffer ($flags, $len)
672 875
673Creates a new OpenCL::Buffer object with the given flags and octet-size. 876Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
877given flags and octet-size.
674 878
675L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 879L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
676 880
677=item $buf = $ctx->buffer_sv ($flags, $data) 881=item $buf = $ctx->buffer_sv ($flags, $data)
678 882
679Creates a new OpenCL::Buffer object and initialise it with the given data values. 883Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
884initialise it with the given data values.
885
886=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)
887
888Creates a new OpenCL::Image object and optionally initialises it with
889the given data values.
890
891L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
680 892
681=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 893=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
682 894
683Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 895Creates a new OpenCL::Image2D object and optionally initialises it with
896the given data values.
684 897
685L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 898L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
686 899
687=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 900=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
688 901
689Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 902Creates a new OpenCL::Image3D object and optionally initialises it with
903the given data values.
690 904
691L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 905L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
906
907=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
908
909Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
910OpenGL buffer object.
911
912http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
913
914=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
915
916Creates a new OpenCL::Image object that refers to the given OpenGL
917texture object or buffer.
918
919http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
920
921=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
922
923Creates a new OpenCL::Image2D object that refers to the given OpenGL
9242D texture object.
925
926http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
927
928=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
929
930Creates a new OpenCL::Image3D object that refers to the given OpenGL
9313D texture object.
932
933http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
934
935=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
936
937Creates a new OpenCL::Image2D object that refers to the given OpenGL
938render buffer.
939
940http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
692 941
693=item @formats = $ctx->supported_image_formats ($flags, $image_type) 942=item @formats = $ctx->supported_image_formats ($flags, $image_type)
694 943
695Returns a list of matching image formats - each format is an arrayref with 944Returns a list of matching image formats - each format is an arrayref with
696two values, $channel_order and $channel_type, in it. 945two values, $channel_order and $channel_type, in it.
… …
717 966
718=for gengetinfo begin context 967=for gengetinfo begin context
719 968
720=item $uint = $context->reference_count 969=item $uint = $context->reference_count
721 970
722Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s). 971Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
723 972
724=item @devices = $context->devices 973=item @devices = $context->devices
725 974
726Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s). 975Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
727 976
728=item @property_ints = $context->properties 977=item @property_ints = $context->properties
729 978
730Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s). 979Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
731 980
732=item $uint = $context->num_devices 981=item $uint = $context->num_devices
733 982
734Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s). 983Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
735 984
736=for gengetinfo end context 985=for gengetinfo end context
737 986
738=back 987=back
739 988
… …
747for completion, unless the method is called in void context, in which case 996for completion, unless the method is called in void context, in which case
748no event object is created. 997no event object is created.
749 998
750They also allow you to specify any number of other event objects that this 999They also allow you to specify any number of other event objects that this
751request has to wait for before it starts executing, by simply passing the 1000request has to wait for before it starts executing, by simply passing the
752event objects as extra parameters to the enqueue methods. 1001event objects as extra parameters to the enqueue methods. To simplify
1002program design, this module ignores any C<undef> values in the list of
1003events. This makes it possible to code operations such as this, without
1004having to put a valid event object into C<$event> first:
1005
1006 $event = $queue->enqueue_xxx (..., $event);
753 1007
754Queues execute in-order by default, without any parallelism, so in most 1008Queues execute in-order by default, without any parallelism, so in most
755cases (i.e. you use only one queue) it's not necessary to wait for or 1009cases (i.e. you use only one queue) it's not necessary to wait for or
756create event objects. 1010create event objects, althoguh an our of order queue is often a bit
1011faster.
757 1012
758=over 4 1013=over 4
759 1014
760=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1015=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
761 1016
… …
771 1026
772=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1027=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
773 1028
774L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1029L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
775 1030
1031=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...)
1032
1033http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1034
1035=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...)
1036
1037http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1038
776=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1039=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
777 1040
1041L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1042
1043=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...)
1044
778L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 1045L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
779 1046
780=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 1047=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
781 1048
782L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 1049L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
783 1050
1051=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...)
1052
1053L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1054
1055=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...)
1056
1057L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1058
784=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...) 1059=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...)
785 1060
786Yeah. 1061Yeah.
787 1062
788L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
789
790=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...)
791
792L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1063L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
793 1064
794=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...) 1065=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
795 1066
1067Fills the given buffer object with repeated applications of C<$pattern>,
1068starting at C<$offset> for C<$size> octets.
1069
1070L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1071
1072=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1073
1074Fills the given image area with the given rgba colour components. The
1075components are normally floating point values between C<0> and C<1>,
1076except when the image channel data type is a signe dor unsigned
1077unnormalised format, in which case the range is determined by the format.
1078
796L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> 1079L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
797
798=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...)
799
800L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
801 1080
802=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1081=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
803 1082
804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1083L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
805 1084
… …
819reference to an array of local work sizes, with the same number of 1098reference to an array of local work sizes, with the same number of
820elements as @$global_work_size. 1099elements as @$global_work_size.
821 1100
822L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1101L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
823 1102
824=item $ev = $queue->enqueue_marker 1103=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
825 1104
1105Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1106for subsequent OpenCL usage.
1107
826L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1108L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1109
1110=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1111
1112Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1113for subsequent OpenGL usage.
1114
1115L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
827 1116
828=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1117=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
829 1118
830L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1119L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
831 1120
832=item $queue->enqueue_barrier 1121=item $ev = $queue->enqueue_marker ($wait_events...)
833 1122
1123L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1124
1125=item $ev = $queue->enqueue_barrier ($wait_events...)
1126
834L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1127L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
835 1128
836=item $queue->flush 1129=item $queue->flush
837 1130
838L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1131L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
839 1132
… …
849 1142
850=for gengetinfo begin command_queue 1143=for gengetinfo begin command_queue
851 1144
852=item $ctx = $command_queue->context 1145=item $ctx = $command_queue->context
853 1146
854Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s). 1147Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
855 1148
856=item $device = $command_queue->device 1149=item $device = $command_queue->device
857 1150
858Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s). 1151Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
859 1152
860=item $uint = $command_queue->reference_count 1153=item $uint = $command_queue->reference_count
861 1154
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s). 1155Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
863 1156
864=item $command_queue_properties = $command_queue->properties 1157=item $command_queue_properties = $command_queue->properties
865 1158
866Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s). 1159Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
867 1160
868=for gengetinfo end command_queue 1161=for gengetinfo end command_queue
869 1162
870=back 1163=back
871 1164
… …
884 1177
885=for gengetinfo begin mem 1178=for gengetinfo begin mem
886 1179
887=item $mem_object_type = $mem->type 1180=item $mem_object_type = $mem->type
888 1181
889Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s). 1182Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
890 1183
891=item $mem_flags = $mem->flags 1184=item $mem_flags = $mem->flags
892 1185
893Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s). 1186Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
894 1187
895=item $int = $mem->size 1188=item $int = $mem->size
896 1189
897Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s). 1190Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
898 1191
899=item $ptr_value = $mem->host_ptr 1192=item $ptr_value = $mem->host_ptr
900 1193
901Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s). 1194Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
902 1195
903=item $uint = $mem->map_count 1196=item $uint = $mem->map_count
904 1197
905Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s). 1198Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
906 1199
907=item $uint = $mem->reference_count 1200=item $uint = $mem->reference_count
908 1201
909Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s). 1202Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
910 1203
911=item $ctx = $mem->context 1204=item $ctx = $mem->context
912 1205
913Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s). 1206Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
914 1207
915=item $mem = $mem->associated_memobject 1208=item $mem = $mem->associated_memobject
916 1209
917Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s). 1210Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
918 1211
919=item $int = $mem->offset 1212=item $int = $mem->offset
920 1213
921Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s). 1214Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
922 1215
923=for gengetinfo end mem 1216=for gengetinfo end mem
924 1217
1218=item ($type, $name) = $mem->gl_object_info
1219
1220Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1221object "name" (e.g. the texture name) used to create this memory object.
1222
1223L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1224
925=back 1225=back
926 1226
1227=head2 THE OpenCL::Buffer CLASS
1228
1229This is a subclass of OpenCL::Memory, and the superclass of
1230OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1231and sub-buffers.
1232
1233=head2 THE OpenCL::BufferObj CLASS
1234
1235This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1236because one cna create sub buffers of OpenLC::BufferObj objects, but not
1237sub buffers from these sub buffers.
1238
1239=over 4
1240
1241=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1242
1243Creates an OpenCL::Buffer objects from this buffer and returns it. The
1244C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1245
1246L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1247
1248=back
1249
927=head2 THE OpenCL::Image CLASS 1250=head2 THE OpenCL::Image CLASS
928 1251
929This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1252This is the superclass of all image objects - OpenCL::Image1D,
1253OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1254OpenCL::Image2DArray and OpenCL::Image3D.
930 1255
931=over 4 1256=over 4
932 1257
933=item $packed_value = $ev->image_info ($name) 1258=item $packed_value = $image->image_info ($name)
934 1259
935See C<< $platform->info >> for details. 1260See C<< $platform->info >> for details.
936 1261
937The reason this method is not called C<info> is that there already is an 1262The reason this method is not called C<info> is that there already is an
938C<< ->info >> method inherited from C<OpenCL::Memory>. 1263C<< ->info >> method inherited from C<OpenCL::Memory>.
939 1264
940L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1265L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
941 1266
1267=item ($channel_order, $channel_data_type) = $image->format
1268
1269Returns the channel order and type used to create the image by calling
1270C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
1271
942=for gengetinfo begin image 1272=for gengetinfo begin image
943 1273
944=item $int = $image->element_size 1274=item $int = $image->element_size
945 1275
946Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s). 1276Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
947 1277
948=item $int = $image->row_pitch 1278=item $int = $image->row_pitch
949 1279
950Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s). 1280Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
951 1281
952=item $int = $image->slice_pitch 1282=item $int = $image->slice_pitch
953 1283
954Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s). 1284Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
955 1285
956=item $int = $image->width 1286=item $int = $image->width
957 1287
958Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s). 1288Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
959 1289
960=item $int = $image->height 1290=item $int = $image->height
961 1291
962Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s). 1292Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
963 1293
964=item $int = $image->depth 1294=item $int = $image->depth
965 1295
966Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s). 1296Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
967 1297
968=for gengetinfo end image 1298=for gengetinfo end image
969 1299
1300=for gengetinfo begin gl_texture
1301
1302=item $GLenum = $gl_texture->target
1303
1304Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1305
1306=item $GLint = $gl_texture->gl_mipmap_level
1307
1308Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1309
1310=for gengetinfo end gl_texture
1311
970=back 1312=back
971 1313
972=head2 THE OpenCL::Sampler CLASS 1314=head2 THE OpenCL::Sampler CLASS
973 1315
974=over 4 1316=over 4
… …
981 1323
982=for gengetinfo begin sampler 1324=for gengetinfo begin sampler
983 1325
984=item $uint = $sampler->reference_count 1326=item $uint = $sampler->reference_count
985 1327
986Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s). 1328Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
987 1329
988=item $ctx = $sampler->context 1330=item $ctx = $sampler->context
989 1331
990Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s). 1332Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
991 1333
992=item $addressing_mode = $sampler->normalized_coords 1334=item $addressing_mode = $sampler->normalized_coords
993 1335
994Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s). 1336Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
995 1337
996=item $filter_mode = $sampler->addressing_mode 1338=item $filter_mode = $sampler->addressing_mode
997 1339
998Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s). 1340Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
999 1341
1000=item $boolean = $sampler->filter_mode 1342=item $boolean = $sampler->filter_mode
1001 1343
1002Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s). 1344Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1003 1345
1004=for gengetinfo end sampler 1346=for gengetinfo end sampler
1005 1347
1006=back 1348=back
1007 1349
… …
1009 1351
1010=over 4 1352=over 4
1011 1353
1012=item $program->build ($device, $options = "") 1354=item $program->build ($device, $options = "")
1013 1355
1014Tries to build the program with the givne options. 1356Tries to build the program with the given options. See also the
1357C<$ctx->build> convenience function.
1015 1358
1016L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1359L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1017 1360
1018=item $packed_value = $program->build_info ($device, $name) 1361=item $packed_value = $program->build_info ($device, $name)
1019 1362
… …
1027Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1370Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1028the program. 1371the program.
1029 1372
1030L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1373L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1031 1374
1375=item @kernels = $program->kernels_in_program
1376
1377Returns all kernels successfully compiled for all devices in program.
1378
1379http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1380
1032=for gengetinfo begin program_build 1381=for gengetinfo begin program_build
1033 1382
1034=item $build_status = $program->build_status ($device) 1383=item $build_status = $program->build_status ($device)
1035 1384
1036Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s). 1385Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1037 1386
1038=item $string = $program->build_options ($device) 1387=item $string = $program->build_options ($device)
1039 1388
1040Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s). 1389Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1041 1390
1042=item $string = $program->build_log ($device) 1391=item $string = $program->build_log ($device)
1043 1392
1044Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s). 1393Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1045 1394
1046=for gengetinfo end program_build 1395=for gengetinfo end program_build
1047 1396
1048=item $packed_value = $program->info ($name) 1397=item $packed_value = $program->info ($name)
1049 1398
… …
1053 1402
1054=for gengetinfo begin program 1403=for gengetinfo begin program
1055 1404
1056=item $uint = $program->reference_count 1405=item $uint = $program->reference_count
1057 1406
1058Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s). 1407Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1059 1408
1060=item $ctx = $program->context 1409=item $ctx = $program->context
1061 1410
1062Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s). 1411Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1063 1412
1064=item $uint = $program->num_devices 1413=item $uint = $program->num_devices
1065 1414
1066Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s). 1415Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1067 1416
1068=item @devices = $program->devices 1417=item @devices = $program->devices
1069 1418
1070Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s). 1419Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1071 1420
1072=item $string = $program->source 1421=item $string = $program->source
1073 1422
1074Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s). 1423Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1075 1424
1076=item @ints = $program->binary_sizes 1425=item @ints = $program->binary_sizes
1077 1426
1078Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s). 1427Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1079 1428
1080=for gengetinfo end program 1429=for gengetinfo end program
1081 1430
1431=item @blobs = $program->binaries
1432
1433Returns a string for the compiled binary for every device associated with
1434the program, empty strings indicate missing programs, and an empty result
1435means no program binaries are available.
1436
1437These "binaries" are often, in fact, informative low-level assembly
1438sources.
1439
1440L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1441
1082=back 1442=back
1083 1443
1084=head2 THE OpenCL::Kernel CLASS 1444=head2 THE OpenCL::Kernel CLASS
1085 1445
1086=over 4 1446=over 4
… …
1093 1453
1094=for gengetinfo begin kernel 1454=for gengetinfo begin kernel
1095 1455
1096=item $string = $kernel->function_name 1456=item $string = $kernel->function_name
1097 1457
1098Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s). 1458Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1099 1459
1100=item $uint = $kernel->num_args 1460=item $uint = $kernel->num_args
1101 1461
1102Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s). 1462Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1103 1463
1104=item $uint = $kernel->reference_count 1464=item $uint = $kernel->reference_count
1105 1465
1106Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s). 1466Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1107 1467
1108=item $ctx = $kernel->context 1468=item $ctx = $kernel->context
1109 1469
1110Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s). 1470Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1111 1471
1112=item $program = $kernel->program 1472=item $program = $kernel->program
1113 1473
1114Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s). 1474Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1115 1475
1116=for gengetinfo end kernel 1476=for gengetinfo end kernel
1117 1477
1118=item $packed_value = $kernel->work_group_info ($device, $name) 1478=item $packed_value = $kernel->work_group_info ($device, $name)
1119 1479
… …
1126 1486
1127=for gengetinfo begin kernel_work_group 1487=for gengetinfo begin kernel_work_group
1128 1488
1129=item $int = $kernel->work_group_size ($device) 1489=item $int = $kernel->work_group_size ($device)
1130 1490
1131Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s). 1491Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1132 1492
1133=item @ints = $kernel->compile_work_group_size ($device) 1493=item @ints = $kernel->compile_work_group_size ($device)
1134 1494
1135Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s). 1495Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1136 1496
1137=item $ulong = $kernel->local_mem_size ($device) 1497=item $ulong = $kernel->local_mem_size ($device)
1138 1498
1139Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s). 1499Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1140 1500
1141=item $int = $kernel->preferred_work_group_size_multiple ($device) 1501=item $int = $kernel->preferred_work_group_size_multiple ($device)
1142 1502
1143Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s). 1503Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1144 1504
1145=item $ulong = $kernel->private_mem_size ($device) 1505=item $ulong = $kernel->private_mem_size ($device)
1146 1506
1147Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s). 1507Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1148 1508
1149=for gengetinfo end kernel_work_group 1509=for gengetinfo end kernel_work_group
1150 1510
1151=item $kernel->set_TYPE ($index, $value) 1511=item $kernel->set_TYPE ($index, $value)
1152 1512
1153This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1513This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1154 1514
1155TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1515TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1156C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1516C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1157C<image2d>, C<image3d>, C<sampler> or C<event>. 1517C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1158 1518
1159Chars and integers (including the half type) are specified as integers, 1519Chars and integers (including the half type) are specified as integers,
1160float and double as floating point values, memory/buffer/image2d/image3d 1520float and double as floating point values, memory/buffer/image2d/image3d
1161must be an object of that type or C<undef>, and sampler and event must be 1521must be an object of that type or C<undef>, local-memory arguments are
1162objects of that type. 1522set by specifying the size, and sampler and event must be objects of that
1523type.
1524
1525Setting an argument for a kernel does NOT keep a reference to the object -
1526for example, if you set an argument to some image object, free the image,
1527and call the kernel, you will run into undefined behaviour.
1163 1528
1164L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1529L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1165 1530
1166=back 1531=back
1167 1532
… …
1186 1551
1187=for gengetinfo begin event 1552=for gengetinfo begin event
1188 1553
1189=item $queue = $event->command_queue 1554=item $queue = $event->command_queue
1190 1555
1191Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s). 1556Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1192 1557
1193=item $command_type = $event->command_type 1558=item $command_type = $event->command_type
1194 1559
1195Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s). 1560Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1196 1561
1197=item $uint = $event->reference_count 1562=item $uint = $event->reference_count
1198 1563
1199Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s). 1564Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1200 1565
1201=item $uint = $event->command_execution_status 1566=item $uint = $event->command_execution_status
1202 1567
1203Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s). 1568Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1204 1569
1205=item $ctx = $event->context 1570=item $ctx = $event->context
1206 1571
1207Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s). 1572Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1208 1573
1209=for gengetinfo end event 1574=for gengetinfo end event
1210 1575
1211=item $packed_value = $ev->profiling_info ($name) 1576=item $packed_value = $ev->profiling_info ($name)
1212 1577
… …
1219 1584
1220=for gengetinfo begin profiling 1585=for gengetinfo begin profiling
1221 1586
1222=item $ulong = $event->profiling_command_queued 1587=item $ulong = $event->profiling_command_queued
1223 1588
1224Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s). 1589Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1225 1590
1226=item $ulong = $event->profiling_command_submit 1591=item $ulong = $event->profiling_command_submit
1227 1592
1228Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s). 1593Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1229 1594
1230=item $ulong = $event->profiling_command_start 1595=item $ulong = $event->profiling_command_start
1231 1596
1232Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s). 1597Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1233 1598
1234=item $ulong = $event->profiling_command_end 1599=item $ulong = $event->profiling_command_end
1235 1600
1236Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s). 1601Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1237 1602
1238=for gengetinfo end profiling 1603=for gengetinfo end profiling
1239 1604
1240=back 1605=back
1241 1606
… …
1250L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> 1615L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1251 1616
1252=back 1617=back
1253 1618
1254=cut 1619=cut
1255
1256package OpenCL;
1257
1258use common::sense;
1259
1260BEGIN {
1261 our $VERSION = '0.55';
1262
1263 require XSLoader;
1264 XSLoader::load (__PACKAGE__, $VERSION);
1265
1266 @OpenCL::Buffer::ISA =
1267 @OpenCL::Image::ISA = OpenCL::Memory::;
1268
1269 @OpenCL::Image2D::ISA =
1270 @OpenCL::Image3D::ISA = OpenCL::Image::;
1271
1272 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1273}
1274 1620
12751; 16211;
1276 1622
1277=head1 AUTHOR 1623=head1 AUTHOR
1278 1624

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines