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

Diff Legend

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