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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.21 by root, Sun Nov 20 10:21:27 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)
322 487
323Returns a list of matching OpenCL::Device objects. 488Returns a list of matching OpenCL::Device objects.
324 489
325=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 490=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
326 491
327Tries to create a context. Never worked for me, and you need devices explitly anyway. 492Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 493
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 494L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 495
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 496=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
332 497
333Create a new OpenCL::Context object using the given device object(s)- a 498Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 499CL_CONTEXT_PLATFORM property is supplied automatically.
335 500
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 501L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
337 502
338=item $packed_value = $platform->info ($name) 503=item $packed_value = $platform->info ($name)
339 504
340Calls C<clGetPlatformInfo> and returns the packed, raw value - for 505Calls C<clGetPlatformInfo> and returns the packed, raw value - for
341strings, this will be the string, for other values you probably need to 506strings, this will be the string (possibly including terminating \0), for
342use the correct C<unpack>. 507other values you probably need to use the correct C<unpack>.
343 508
344It's best to avoid this method and use one of the predefined C<get_*> 509It's best to avoid this method and use one of the following convenience
345methods. 510wrappers.
346 511
347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 512L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348 513
514=item $platform->unload_compiler
515
516Attempts to unload the compiler for this platform, for endless
517profit. Does nothing on OpenCL 1.1.
518
519L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
520
349=for gengetinfo begin platform 521=for gengetinfo begin platform
350 522
351
352=item $string = $platform->profile 523=item $string = $platform->profile
353 524
354Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s). 525Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
355 526
356=item $string = $platform->version 527=item $string = $platform->version
357 528
358Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s). 529Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
359 530
360=item $string = $platform->name 531=item $string = $platform->name
361 532
362Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s). 533Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
363 534
364=item $string = $platform->vendor 535=item $string = $platform->vendor
365 536
366Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s). 537Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
367 538
368=item $string = $platform->extensions 539=item $string = $platform->extensions
369 540
370Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s). 541Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
371 542
372=for gengetinfo end platform 543=for gengetinfo end platform
373 544
374=back 545=back
375 546
… …
383 554
384L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 555L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
385 556
386=for gengetinfo begin device 557=for gengetinfo begin device
387 558
388
389=item $device_type = $device->type 559=item $device_type = $device->type
390 560
391Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s). 561Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
392 562
393=item $uint = $device->vendor_id 563=item $uint = $device->vendor_id
394 564
395Calls 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.
396 566
397=item $uint = $device->max_compute_units 567=item $uint = $device->max_compute_units
398 568
399Calls 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.
400 570
401=item $uint = $device->max_work_item_dimensions 571=item $uint = $device->max_work_item_dimensions
402 572
403Calls 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.
404 574
405=item $int = $device->max_work_group_size 575=item $int = $device->max_work_group_size
406 576
407Calls 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.
408 578
409=item @ints = $device->max_work_item_sizes 579=item @ints = $device->max_work_item_sizes
410 580
411Calls 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.
412 582
413=item $uint = $device->preferred_vector_width_char 583=item $uint = $device->preferred_vector_width_char
414 584
415Calls 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.
416 586
417=item $uint = $device->preferred_vector_width_short 587=item $uint = $device->preferred_vector_width_short
418 588
419Calls 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.
420 590
421=item $uint = $device->preferred_vector_width_int 591=item $uint = $device->preferred_vector_width_int
422 592
423Calls 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.
424 594
425=item $uint = $device->preferred_vector_width_long 595=item $uint = $device->preferred_vector_width_long
426 596
427Calls 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.
428 598
429=item $uint = $device->preferred_vector_width_float 599=item $uint = $device->preferred_vector_width_float
430 600
431Calls 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.
432 602
433=item $uint = $device->preferred_vector_width_double 603=item $uint = $device->preferred_vector_width_double
434 604
435Calls 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.
436 606
437=item $uint = $device->max_clock_frequency 607=item $uint = $device->max_clock_frequency
438 608
439Calls 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.
440 610
441=item $bitfield = $device->address_bits 611=item $bitfield = $device->address_bits
442 612
443Calls 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.
444 614
445=item $uint = $device->max_read_image_args 615=item $uint = $device->max_read_image_args
446 616
447Calls 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.
448 618
449=item $uint = $device->max_write_image_args 619=item $uint = $device->max_write_image_args
450 620
451Calls 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.
452 622
453=item $ulong = $device->max_mem_alloc_size 623=item $ulong = $device->max_mem_alloc_size
454 624
455Calls 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.
456 626
457=item $int = $device->image2d_max_width 627=item $int = $device->image2d_max_width
458 628
459Calls 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.
460 630
461=item $int = $device->image2d_max_height 631=item $int = $device->image2d_max_height
462 632
463Calls 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.
464 634
465=item $int = $device->image3d_max_width 635=item $int = $device->image3d_max_width
466 636
467Calls 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.
468 638
469=item $int = $device->image3d_max_height 639=item $int = $device->image3d_max_height
470 640
471Calls 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.
472 642
473=item $int = $device->image3d_max_depth 643=item $int = $device->image3d_max_depth
474 644
475Calls 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.
476 646
477=item $uint = $device->image_support 647=item $uint = $device->image_support
478 648
479Calls 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.
480 650
481=item $int = $device->max_parameter_size 651=item $int = $device->max_parameter_size
482 652
483Calls 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.
484 654
485=item $uint = $device->max_samplers 655=item $uint = $device->max_samplers
486 656
487Calls 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.
488 658
489=item $uint = $device->mem_base_addr_align 659=item $uint = $device->mem_base_addr_align
490 660
491Calls 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.
492 662
493=item $uint = $device->min_data_type_align_size 663=item $uint = $device->min_data_type_align_size
494 664
495Calls 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.
496 666
497=item $device_fp_config = $device->single_fp_config 667=item $device_fp_config = $device->single_fp_config
498 668
499Calls 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.
500 670
501=item $device_mem_cache_type = $device->global_mem_cache_type 671=item $device_mem_cache_type = $device->global_mem_cache_type
502 672
503Calls 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.
504 674
505=item $uint = $device->global_mem_cacheline_size 675=item $uint = $device->global_mem_cacheline_size
506 676
507Calls 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.
508 678
509=item $ulong = $device->global_mem_cache_size 679=item $ulong = $device->global_mem_cache_size
510 680
511Calls 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.
512 682
513=item $ulong = $device->global_mem_size 683=item $ulong = $device->global_mem_size
514 684
515Calls 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.
516 686
517=item $ulong = $device->max_constant_buffer_size 687=item $ulong = $device->max_constant_buffer_size
518 688
519Calls 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.
520 690
521=item $uint = $device->max_constant_args 691=item $uint = $device->max_constant_args
522 692
523Calls 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.
524 694
525=item $device_local_mem_type = $device->local_mem_type 695=item $device_local_mem_type = $device->local_mem_type
526 696
527Calls 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.
528 698
529=item $ulong = $device->local_mem_size 699=item $ulong = $device->local_mem_size
530 700
531Calls 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.
532 702
533=item $boolean = $device->error_correction_support 703=item $boolean = $device->error_correction_support
534 704
535Calls 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.
536 706
537=item $int = $device->profiling_timer_resolution 707=item $int = $device->profiling_timer_resolution
538 708
539Calls 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.
540 710
541=item $boolean = $device->endian_little 711=item $boolean = $device->endian_little
542 712
543Calls 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.
544 714
545=item $boolean = $device->available 715=item $boolean = $device->available
546 716
547Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s). 717Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
548 718
549=item $boolean = $device->compiler_available 719=item $boolean = $device->compiler_available
550 720
551Calls 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.
552 722
553=item $device_exec_capabilities = $device->execution_capabilities 723=item $device_exec_capabilities = $device->execution_capabilities
554 724
555Calls 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.
556 726
557=item $command_queue_properties = $device->properties 727=item $command_queue_properties = $device->properties
558 728
559Calls 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.
560 730
561=item $ = $device->platform 731=item $ = $device->platform
562 732
563Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s). 733Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
564 734
565=item $string = $device->name 735=item $string = $device->name
566 736
567Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s). 737Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
568 738
569=item $string = $device->vendor 739=item $string = $device->vendor
570 740
571Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s). 741Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
572 742
573=item $string = $device->driver_version 743=item $string = $device->driver_version
574 744
575Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s). 745Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
576 746
577=item $string = $device->profile 747=item $string = $device->profile
578 748
579Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s). 749Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
580 750
581=item $string = $device->version 751=item $string = $device->version
582 752
583Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s). 753Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
584 754
585=item $string = $device->extensions 755=item $string = $device->extensions
586 756
587Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s). 757Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
588 758
589=item $uint = $device->preferred_vector_width_half 759=item $uint = $device->preferred_vector_width_half
590 760
591Calls 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.
592 762
593=item $uint = $device->native_vector_width_char 763=item $uint = $device->native_vector_width_char
594 764
595Calls 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.
596 766
597=item $uint = $device->native_vector_width_short 767=item $uint = $device->native_vector_width_short
598 768
599Calls 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.
600 770
601=item $uint = $device->native_vector_width_int 771=item $uint = $device->native_vector_width_int
602 772
603Calls 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.
604 774
605=item $uint = $device->native_vector_width_long 775=item $uint = $device->native_vector_width_long
606 776
607Calls 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.
608 778
609=item $uint = $device->native_vector_width_float 779=item $uint = $device->native_vector_width_float
610 780
611Calls 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.
612 782
613=item $uint = $device->native_vector_width_double 783=item $uint = $device->native_vector_width_double
614 784
615Calls 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.
616 786
617=item $uint = $device->native_vector_width_half 787=item $uint = $device->native_vector_width_half
618 788
619Calls 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.
620 790
621=item $device_fp_config = $device->double_fp_config 791=item $device_fp_config = $device->double_fp_config
622 792
623Calls 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.
624 794
625=item $device_fp_config = $device->half_fp_config 795=item $device_fp_config = $device->half_fp_config
626 796
627Calls 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.
628 798
629=item $boolean = $device->host_unified_memory 799=item $boolean = $device->host_unified_memory
630 800
631Calls 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.
632 802
633=item $device = $device->parent_device_ext 803=item $device = $device->parent_device_ext
634 804
635Calls 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.
636 806
637=item @device_partition_property_exts = $device->partition_types_ext 807=item @device_partition_property_exts = $device->partition_types_ext
638 808
639Calls 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.
640 810
641=item @device_partition_property_exts = $device->affinity_domains_ext 811=item @device_partition_property_exts = $device->affinity_domains_ext
642 812
643Calls 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.
644 814
645=item $uint = $device->reference_count_ext 815=item $uint = $device->reference_count_ext
646 816
647Calls 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.
648 818
649=item @device_partition_property_exts = $device->partition_style_ext 819=item @device_partition_property_exts = $device->partition_style_ext
650 820
651Calls 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.
652 822
653=for gengetinfo end device 823=for gengetinfo end device
654 824
655=back 825=back
656 826
657=head2 THE OpenCL::Context CLASS 827=head2 THE OpenCL::Context CLASS
658 828
659=over 4 829=over 4
660 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
661=item $queue = $ctx->queue ($device, $properties) 858=item $queue = $ctx->queue ($device, $properties)
662 859
663Create 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.
664 861
665L<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>
666 863
864Example: create an out-of-order queue.
865
866 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
867
667=item $ev = $ctx->user_event 868=item $ev = $ctx->user_event
668 869
669Creates a new OpenCL::UserEvent object. 870Creates a new OpenCL::UserEvent object.
670 871
671L<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>
672 873
673=item $buf = $ctx->buffer ($flags, $len) 874=item $buf = $ctx->buffer ($flags, $len)
674 875
675Creates 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.
676 878
677L<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>
678 880
679=item $buf = $ctx->buffer_sv ($flags, $data) 881=item $buf = $ctx->buffer_sv ($flags, $data)
680 882
681Creates 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>
682 892
683=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)
684 894
685Creates 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.
686 897
687L<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>
688 899
689=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)
690 901
691Creates 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.
692 904
693L<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
694 941
695=item @formats = $ctx->supported_image_formats ($flags, $image_type) 942=item @formats = $ctx->supported_image_formats ($flags, $image_type)
696 943
697Returns 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
698two values, $channel_order and $channel_type, in it. 945two values, $channel_order and $channel_type, in it.
… …
717 964
718L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> 965L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
719 966
720=for gengetinfo begin context 967=for gengetinfo begin context
721 968
722
723=item $uint = $context->reference_count 969=item $uint = $context->reference_count
724 970
725Calls 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.
726 972
727=item @devices = $context->devices 973=item @devices = $context->devices
728 974
729Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s). 975Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
730 976
731=item @property_ints = $context->properties 977=item @property_ints = $context->properties
732 978
733Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s). 979Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
734 980
735=item $uint = $context->num_devices 981=item $uint = $context->num_devices
736 982
737Calls 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.
738 984
739=for gengetinfo end context 985=for gengetinfo end context
740 986
741=back 987=back
742 988
… …
750for 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
751no event object is created. 997no event object is created.
752 998
753They 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
754request 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
755event 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);
756 1007
757Queues execute in-order by default, without any parallelism, so in most 1008Queues execute in-order by default, without any parallelism, so in most
758cases (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
759create event objects. 1010create event objects, althoguh an our of order queue is often a bit
1011faster.
760 1012
761=over 4 1013=over 4
762 1014
763=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...)
764 1016
… …
774 1026
775=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...)
776 1028
777L<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>
778 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
779=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...)
780 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
781L<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>
782 1046
783=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...)
784 1048
785L<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>
786 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
787=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...) 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...)
788 1060
789Yeah. 1061Yeah.
790 1062
791L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
792
793=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
794
795L<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>.
796 1064
797=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) 1065=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
798 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
799L<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>
800
801=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
802
803L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
804 1080
805=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1081=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
806 1082
807L<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>
808 1084
… …
822reference 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
823elements as @$global_work_size. 1099elements as @$global_work_size.
824 1100
825L<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>
826 1102
827=item $ev = $queue->enqueue_marker 1103=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
828 1104
1105Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1106for subsequent OpenCL usage.
1107
829L<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>
830 1116
831=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1117=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
832 1118
833L<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>
834 1120
835=item $queue->enqueue_barrier 1121=item $ev = $queue->enqueue_marker ($wait_events...)
836 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
837L<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>
838 1128
839=item $queue->flush 1129=item $queue->flush
840 1130
841L<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>
842 1132
… …
850 1140
851L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html> 1141L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
852 1142
853=for gengetinfo begin command_queue 1143=for gengetinfo begin command_queue
854 1144
855
856=item $ctx = $command_queue->context 1145=item $ctx = $command_queue->context
857 1146
858Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s). 1147Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
859 1148
860=item $device = $command_queue->device 1149=item $device = $command_queue->device
861 1150
862Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s). 1151Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
863 1152
864=item $uint = $command_queue->reference_count 1153=item $uint = $command_queue->reference_count
865 1154
866Calls 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.
867 1156
868=item $command_queue_properties = $command_queue->properties 1157=item $command_queue_properties = $command_queue->properties
869 1158
870Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s). 1159Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
871 1160
872=for gengetinfo end command_queue 1161=for gengetinfo end command_queue
873 1162
874=back 1163=back
875 1164
… …
886 1175
887L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1176L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
888 1177
889=for gengetinfo begin mem 1178=for gengetinfo begin mem
890 1179
891
892=item $mem_object_type = $mem->type 1180=item $mem_object_type = $mem->type
893 1181
894Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s). 1182Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
895 1183
896=item $mem_flags = $mem->flags 1184=item $mem_flags = $mem->flags
897 1185
898Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s). 1186Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
899 1187
900=item $int = $mem->size 1188=item $int = $mem->size
901 1189
902Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s). 1190Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
903 1191
904=item $ptr_value = $mem->host_ptr 1192=item $ptr_value = $mem->host_ptr
905 1193
906Calls 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.
907 1195
908=item $uint = $mem->map_count 1196=item $uint = $mem->map_count
909 1197
910Calls 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.
911 1199
912=item $uint = $mem->reference_count 1200=item $uint = $mem->reference_count
913 1201
914Calls 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.
915 1203
916=item $ctx = $mem->context 1204=item $ctx = $mem->context
917 1205
918Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s). 1206Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
919 1207
920=item $mem = $mem->associated_memobject 1208=item $mem = $mem->associated_memobject
921 1209
922Calls 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.
923 1211
924=item $int = $mem->offset 1212=item $int = $mem->offset
925 1213
926Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s). 1214Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
927 1215
928=for gengetinfo end mem 1216=for gengetinfo end mem
929 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
930=back 1225=back
931 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
932=head2 THE OpenCL::Image CLASS 1250=head2 THE OpenCL::Image CLASS
933 1251
934This 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.
935 1255
936=over 4 1256=over 4
937 1257
938=item $packed_value = $ev->image_info ($name) 1258=item $packed_value = $image->image_info ($name)
939 1259
940See C<< $platform->info >> for details. 1260See C<< $platform->info >> for details.
941 1261
942The 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
943C<< ->info >> method inherited from C<OpenCL::Memory>. 1263C<< ->info >> method inherited from C<OpenCL::Memory>.
944 1264
945L<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>
946 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
947=for gengetinfo begin image 1272=for gengetinfo begin image
948 1273
949
950=item $int = $image->element_size 1274=item $int = $image->element_size
951 1275
952Calls 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.
953 1277
954=item $int = $image->row_pitch 1278=item $int = $image->row_pitch
955 1279
956Calls 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.
957 1281
958=item $int = $image->slice_pitch 1282=item $int = $image->slice_pitch
959 1283
960Calls 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.
961 1285
962=item $int = $image->width 1286=item $int = $image->width
963 1287
964Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s). 1288Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
965 1289
966=item $int = $image->height 1290=item $int = $image->height
967 1291
968Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s). 1292Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
969 1293
970=item $int = $image->depth 1294=item $int = $image->depth
971 1295
972Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s). 1296Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
973 1297
974=for gengetinfo end image 1298=for gengetinfo end image
975 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
976=back 1312=back
977 1313
978=head2 THE OpenCL::Sampler CLASS 1314=head2 THE OpenCL::Sampler CLASS
979 1315
980=over 4 1316=over 4
… …
985 1321
986L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1322L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
987 1323
988=for gengetinfo begin sampler 1324=for gengetinfo begin sampler
989 1325
990
991=item $uint = $sampler->reference_count 1326=item $uint = $sampler->reference_count
992 1327
993Calls 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.
994 1329
995=item $ctx = $sampler->context 1330=item $ctx = $sampler->context
996 1331
997Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s). 1332Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
998 1333
999=item $addressing_mode = $sampler->normalized_coords 1334=item $addressing_mode = $sampler->normalized_coords
1000 1335
1001Calls 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.
1002 1337
1003=item $filter_mode = $sampler->addressing_mode 1338=item $filter_mode = $sampler->addressing_mode
1004 1339
1005Calls 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.
1006 1341
1007=item $boolean = $sampler->filter_mode 1342=item $boolean = $sampler->filter_mode
1008 1343
1009Calls 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.
1010 1345
1011=for gengetinfo end sampler 1346=for gengetinfo end sampler
1012 1347
1013=back 1348=back
1014 1349
… …
1016 1351
1017=over 4 1352=over 4
1018 1353
1019=item $program->build ($device, $options = "") 1354=item $program->build ($device, $options = "")
1020 1355
1021Tries 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.
1022 1358
1023L<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>
1024 1360
1025=item $packed_value = $program->build_info ($device, $name) 1361=item $packed_value = $program->build_info ($device, $name)
1026 1362
… …
1034Creates 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
1035the program. 1371the program.
1036 1372
1037L<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>
1038 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
1039=for gengetinfo begin program_build 1381=for gengetinfo begin program_build
1040 1382
1041
1042=item $build_status = $program->build_status ($device) 1383=item $build_status = $program->build_status ($device)
1043 1384
1044Calls 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.
1045 1386
1046=item $string = $program->build_options ($device) 1387=item $string = $program->build_options ($device)
1047 1388
1048Calls 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.
1049 1390
1050=item $string = $program->build_log ($device) 1391=item $string = $program->build_log ($device)
1051 1392
1052Calls 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.
1053 1394
1054=for gengetinfo end program_build 1395=for gengetinfo end program_build
1055 1396
1056=item $packed_value = $program->info ($name) 1397=item $packed_value = $program->info ($name)
1057 1398
… …
1059 1400
1060L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> 1401L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1061 1402
1062=for gengetinfo begin program 1403=for gengetinfo begin program
1063 1404
1064
1065=item $uint = $program->reference_count 1405=item $uint = $program->reference_count
1066 1406
1067Calls 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.
1068 1408
1069=item $ctx = $program->context 1409=item $ctx = $program->context
1070 1410
1071Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s). 1411Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1072 1412
1073=item $uint = $program->num_devices 1413=item $uint = $program->num_devices
1074 1414
1075Calls 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.
1076 1416
1077=item @devices = $program->devices 1417=item @devices = $program->devices
1078 1418
1079Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s). 1419Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1080 1420
1081=item $string = $program->source 1421=item $string = $program->source
1082 1422
1083Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s). 1423Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1084 1424
1085=item @ints = $program->binary_sizes 1425=item @ints = $program->binary_sizes
1086 1426
1087Calls 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.
1088 1428
1089=for gengetinfo end program 1429=for gengetinfo end program
1090 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
1091=back 1442=back
1092 1443
1093=head2 THE OpenCL::Kernel CLASS 1444=head2 THE OpenCL::Kernel CLASS
1094 1445
1095=over 4 1446=over 4
… …
1100 1451
1101L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1452L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1102 1453
1103=for gengetinfo begin kernel 1454=for gengetinfo begin kernel
1104 1455
1105
1106=item $string = $kernel->function_name 1456=item $string = $kernel->function_name
1107 1457
1108Calls 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.
1109 1459
1110=item $uint = $kernel->num_args 1460=item $uint = $kernel->num_args
1111 1461
1112Calls 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.
1113 1463
1114=item $uint = $kernel->reference_count 1464=item $uint = $kernel->reference_count
1115 1465
1116Calls 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.
1117 1467
1118=item $ctx = $kernel->context 1468=item $ctx = $kernel->context
1119 1469
1120Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s). 1470Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1121 1471
1122=item $program = $kernel->program 1472=item $program = $kernel->program
1123 1473
1124Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s). 1474Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1125 1475
1126=for gengetinfo end kernel 1476=for gengetinfo end kernel
1127 1477
1128=item $packed_value = $kernel->work_group_info ($device, $name) 1478=item $packed_value = $kernel->work_group_info ($device, $name)
1129 1479
… …
1134 1484
1135L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> 1485L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1136 1486
1137=for gengetinfo begin kernel_work_group 1487=for gengetinfo begin kernel_work_group
1138 1488
1139
1140=item $int = $kernel->work_group_size ($device) 1489=item $int = $kernel->work_group_size ($device)
1141 1490
1142Calls 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.
1143 1492
1144=item @ints = $kernel->compile_work_group_size ($device) 1493=item @ints = $kernel->compile_work_group_size ($device)
1145 1494
1146Calls 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.
1147 1496
1148=item $ulong = $kernel->local_mem_size ($device) 1497=item $ulong = $kernel->local_mem_size ($device)
1149 1498
1150Calls 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.
1151 1500
1152=item $int = $kernel->preferred_work_group_size_multiple ($device) 1501=item $int = $kernel->preferred_work_group_size_multiple ($device)
1153 1502
1154Calls 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.
1155 1504
1156=item $ulong = $kernel->private_mem_size ($device) 1505=item $ulong = $kernel->private_mem_size ($device)
1157 1506
1158Calls 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.
1159 1508
1160=for gengetinfo end kernel_work_group 1509=for gengetinfo end kernel_work_group
1161 1510
1162=item $kernel->set_TYPE ($index, $value) 1511=item $kernel->set_TYPE ($index, $value)
1163 1512
1164This 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>.
1165 1514
1166TYPE 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>,
1167C<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>,
1168C<image2d>, C<image3d>, C<sampler> or C<event>. 1517C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1169 1518
1170Chars and integers (including the half type) are specified as integers, 1519Chars and integers (including the half type) are specified as integers,
1171float and double as floating point values, memory/buffer/image2d/image3d 1520float and double as floating point values, memory/buffer/image2d/image3d
1172must 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
1173objects 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.
1174 1528
1175L<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>
1176 1530
1177=back 1531=back
1178 1532
… …
1195 1549
1196L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1550L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1197 1551
1198=for gengetinfo begin event 1552=for gengetinfo begin event
1199 1553
1200
1201=item $queue = $event->command_queue 1554=item $queue = $event->command_queue
1202 1555
1203Calls 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.
1204 1557
1205=item $command_type = $event->command_type 1558=item $command_type = $event->command_type
1206 1559
1207Calls 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.
1208 1561
1209=item $uint = $event->reference_count 1562=item $uint = $event->reference_count
1210 1563
1211Calls 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.
1212 1565
1213=item $uint = $event->command_execution_status 1566=item $uint = $event->command_execution_status
1214 1567
1215Calls 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.
1216 1569
1217=item $ctx = $event->context 1570=item $ctx = $event->context
1218 1571
1219Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s). 1572Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1220 1573
1221=for gengetinfo end event 1574=for gengetinfo end event
1222 1575
1223=item $packed_value = $ev->profiling_info ($name) 1576=item $packed_value = $ev->profiling_info ($name)
1224 1577
… …
1229 1582
1230L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html> 1583L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1231 1584
1232=for gengetinfo begin profiling 1585=for gengetinfo begin profiling
1233 1586
1234
1235=item $ulong = $event->profiling_command_queued 1587=item $ulong = $event->profiling_command_queued
1236 1588
1237Calls 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.
1238 1590
1239=item $ulong = $event->profiling_command_submit 1591=item $ulong = $event->profiling_command_submit
1240 1592
1241Calls 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.
1242 1594
1243=item $ulong = $event->profiling_command_start 1595=item $ulong = $event->profiling_command_start
1244 1596
1245Calls 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.
1246 1598
1247=item $ulong = $event->profiling_command_end 1599=item $ulong = $event->profiling_command_end
1248 1600
1249Calls 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.
1250 1602
1251=for gengetinfo end profiling 1603=for gengetinfo end profiling
1252 1604
1253=back 1605=back
1254 1606
… …
1263L<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>
1264 1616
1265=back 1617=back
1266 1618
1267=cut 1619=cut
1268
1269package OpenCL;
1270
1271use common::sense;
1272
1273BEGIN {
1274 our $VERSION = '0.55';
1275
1276 require XSLoader;
1277 XSLoader::load (__PACKAGE__, $VERSION);
1278
1279 @OpenCL::Buffer::ISA =
1280 @OpenCL::Image::ISA = OpenCL::Memory::;
1281
1282 @OpenCL::Image2D::ISA =
1283 @OpenCL::Image3D::ISA = OpenCL::Image::;
1284
1285 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1286}
1287 1620
12881; 16211;
1289 1622
1290=head1 AUTHOR 1623=head1 AUTHOR
1291 1624

Diff Legend

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