… | |
… | |
28 | specific device ("compiling and linking"), also binary programs. For each |
28 | specific device ("compiling and linking"), also binary programs. For each |
29 | kernel function in a program you can then create an OpenCL::Kernel object |
29 | kernel function in a program you can then create an OpenCL::Kernel object |
30 | which represents basically a function call with argument values. |
30 | which represents basically a function call with argument values. |
31 | |
31 | |
32 | OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat |
32 | OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat |
33 | memory areas, think arrays or structs) and OpenCL::Image objects (think 2d |
33 | memory areas, think arrays or structs) and OpenCL::Image objects (think 2D |
34 | or 3d array) for bulk data and input and output for kernels. |
34 | or 3D array) for bulk data and input and output for kernels. |
35 | |
35 | |
36 | OpenCL::Sampler objects, which are kind of like texture filter modes in |
36 | OpenCL::Sampler objects, which are kind of like texture filter modes in |
37 | OpenGL. |
37 | OpenGL. |
38 | |
38 | |
39 | OpenCL::Queue objects - command queues, which allow you to submit memory |
39 | OpenCL::Queue objects - command queues, which allow you to submit memory |
… | |
… | |
43 | |
43 | |
44 | OpenCL::Event objects are used to signal when something is complete. |
44 | OpenCL::Event objects are used to signal when something is complete. |
45 | |
45 | |
46 | =head2 HELPFUL RESOURCES |
46 | =head2 HELPFUL RESOURCES |
47 | |
47 | |
48 | The OpenCL specs used to develop this module: |
48 | The OpenCL specs used to develop this module - download these and keept |
|
|
49 | hema round, they are required reference material: |
49 | |
50 | |
50 | http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf |
51 | http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf |
51 | http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf |
52 | http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf |
52 | http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf |
53 | http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf |
53 | |
54 | |
… | |
… | |
210 | |
211 | |
211 | # wait for the last event to complete |
212 | # wait for the last event to complete |
212 | $ev->wait; |
213 | $ev->wait; |
213 | |
214 | |
214 | =head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia |
215 | =head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia |
215 | set tunnel effect. |
216 | set flight effect. |
216 | |
217 | |
217 | This is quite a long example to get you going - you can download it from |
218 | This is quite a long example to get you going - you can also download it |
218 | L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>. |
219 | from L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>. |
219 | |
220 | |
220 | use OpenGL ":all"; |
221 | use OpenGL ":all"; |
221 | use OpenCL; |
222 | use OpenCL; |
222 | |
223 | |
223 | my $S = $ARGV[0] || 256; # window/texture size, smaller is faster |
224 | my $S = $ARGV[0] || 256; # window/texture size, smaller is faster |
… | |
… | |
320 | To use a texture, you would modify the above example by creating an |
321 | To use a texture, you would modify the above example by creating an |
321 | OpenCL::Image manually instead of deriving it from a texture: |
322 | OpenCL::Image manually instead of deriving it from a texture: |
322 | |
323 | |
323 | my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S); |
324 | my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S); |
324 | |
325 | |
325 | And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you |
326 | And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you |
326 | would read the image2d after the kernel has written it: |
327 | would read the image2d after the kernel has written it: |
327 | |
328 | |
328 | $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data); |
329 | $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data); |
329 | |
330 | |
330 | And then you would upload the pixel data to the texture (or use glDrawPixels): |
331 | And then you would upload the pixel data to the texture (or use glDrawPixels): |
331 | |
332 | |
332 | glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data; |
333 | glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data; |
333 | |
334 | |
334 | The fully modified example can be found at |
335 | The fully modified example can be found at |
335 | L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>. |
336 | L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>. |
|
|
337 | |
|
|
338 | =head2 Julia sets look soooo 80ies. |
|
|
339 | |
|
|
340 | Then colour them differently, e.g. using orbit traps! Replace the loop and |
|
|
341 | colour calculation from the previous examples by this: |
|
|
342 | |
|
|
343 | float2 dm = (float2)(1.f, 1.f); |
|
|
344 | |
|
|
345 | for (int i = 0; i < 25; ++i) |
|
|
346 | { |
|
|
347 | z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c; |
|
|
348 | dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f))); |
|
|
349 | } |
|
|
350 | |
|
|
351 | float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x); |
|
|
352 | |
|
|
353 | Also try C<-10.f> instead of C<-1.f>. |
336 | |
354 | |
337 | =head1 DOCUMENTATION |
355 | =head1 DOCUMENTATION |
338 | |
356 | |
339 | =head2 BASIC CONVENTIONS |
357 | =head2 BASIC CONVENTIONS |
340 | |
358 | |
… | |
… | |
370 | |
388 | |
371 | =item * When enqueuing commands, if the enqueue method is called in void |
389 | =item * When enqueuing commands, if the enqueue method is called in void |
372 | context, no event is created. In all other contexts an event is returned |
390 | context, no event is created. In all other contexts an event is returned |
373 | by the method. |
391 | by the method. |
374 | |
392 | |
375 | =item * This module expects all functions to return C<CL_SUCCESS>. If any |
393 | =item * This module expects all functions to return C<OpenCL::SUCCESS>. If any |
376 | other status is returned the function will throw an exception, so you |
394 | other status is returned the function will throw an exception, so you |
377 | don't normally have to to any error checking. |
395 | don't normally have to to any error checking. |
378 | |
396 | |
379 | =back |
397 | =back |
|
|
398 | |
|
|
399 | =head2 CONSTANTS |
|
|
400 | |
|
|
401 | All C<CL_xxx> constants that this module supports are always available |
|
|
402 | in the C<OpenCL> namespace as C<OpenCL::xxx> (i.e. without the C<CL_> |
|
|
403 | prefix). Constants which are not defined in the header files used during |
|
|
404 | compilation, or otherwise are not available, will have the value C<-1>. |
|
|
405 | |
|
|
406 | The latest version of this module knows and exports the constants |
|
|
407 | listed in L<http://cvs.schmorp.de/OpenCL/constiv.h>. |
|
|
408 | |
|
|
409 | =head2 OPENCL 1.1 VS. OPENCL 1.2 |
|
|
410 | |
|
|
411 | This module supports both OpenCL version 1.1 and 1.2, although the OpenCL |
|
|
412 | 1.2 interface hasn't been tested much for lack of availability of an |
|
|
413 | actual implementation. |
|
|
414 | |
|
|
415 | Every function or method in this manual page that interfaces to a |
|
|
416 | particular OpenCL function has a link to the its C manual page. |
|
|
417 | |
|
|
418 | If the link contains a F<1.1>, then this function is an OpenCL 1.1 |
|
|
419 | function. Most but not all also exist in OpenCL 1.2, and this module |
|
|
420 | tries to emulate the missing ones for you, when told to do so at |
|
|
421 | compiletime. You can check whether a function was removed in OpenCL 1.2 by |
|
|
422 | replacing the F<1.1> component in the URL by F<1.2>. |
|
|
423 | |
|
|
424 | If the link contains a F<1.2>, then this is a OpenCL 1.2-only |
|
|
425 | function. Even if the module was compiled with OpenCL 1.2 header files |
|
|
426 | and has an 1.2 OpenCL library, calling such a function on a platform that |
|
|
427 | doesn't implement 1.2 causes undefined behaviour, usually a crash (But |
|
|
428 | this is not guaranteed). |
|
|
429 | |
|
|
430 | You can find out whether this module was compiled to prefer 1.1 |
|
|
431 | functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then |
|
|
432 | 1.1 functions generally are implemented using 1.1 OpenCL functions. If it |
|
|
433 | is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2 |
|
|
434 | fucntions. |
|
|
435 | |
|
|
436 | This is a somewhat sorry state of affairs, but the Khronos group choose to |
|
|
437 | make every release of OpenCL source and binary incompatible with previous |
|
|
438 | releases. |
380 | |
439 | |
381 | =head2 PERL AND OPENCL TYPES |
440 | =head2 PERL AND OPENCL TYPES |
382 | |
441 | |
383 | This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack |
442 | This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack |
384 | format equivalents: |
443 | format equivalents: |
… | |
… | |
416 | OpenCL can generate a number of (potentially) asynchronous events, for |
475 | OpenCL can generate a number of (potentially) asynchronous events, for |
417 | example, after compiling a program, to signal a context-related error or, |
476 | example, after compiling a program, to signal a context-related error or, |
418 | perhaps most important, to signal completion of queued jobs (by setting |
477 | perhaps most important, to signal completion of queued jobs (by setting |
419 | callbacks on OpenCL::Event objects). |
478 | callbacks on OpenCL::Event objects). |
420 | |
479 | |
|
|
480 | The OpenCL module converts all these callbacks into events - you can |
|
|
481 | still register callbacks, but they are not executed when your OpenCL |
|
|
482 | implementation calls the actual callback, but only later. Therefore, none |
|
|
483 | of the limitations of OpenCL callbacks apply to the perl implementation: |
|
|
484 | it is perfectly safe to make blocking operations from event callbacks, and |
|
|
485 | enqueued operations don't need to be flushed. |
|
|
486 | |
421 | To facilitate this, this module maintains an event queue - each |
487 | To facilitate this, this module maintains an event queue - each |
422 | time an asynchronous event happens, it is queued, and perl will be |
488 | time an asynchronous event happens, it is queued, and perl will be |
423 | interrupted. This is implemented via the L<Async::Interrupt> module. In |
489 | interrupted. This is implemented via the L<Async::Interrupt> module. In |
424 | addition, this module has L<AnyEvent> support, so it can seamlessly |
490 | addition, this module has L<AnyEvent> support, so it can seamlessly |
425 | integrate itself into many event loops. |
491 | integrate itself into many event loops. |
426 | |
492 | |
427 | Since this module is a bit hard to understand, here are some case examples: |
493 | Since L<Async::Interrupt> is a bit hard to understand, here are some case examples: |
428 | |
494 | |
429 | =head3 Don't use callbacks. |
495 | =head3 Don't use callbacks. |
430 | |
496 | |
431 | When your program never uses any callbacks, then there will never be any |
497 | When your program never uses any callbacks, then there will never be any |
432 | notifications you need to take care of, and therefore no need to worry |
498 | notifications you need to take care of, and therefore no need to worry |
… | |
… | |
529 | use Async::Interrupt (); |
595 | use Async::Interrupt (); |
530 | |
596 | |
531 | our $POLL_FUNC; # set by XS |
597 | our $POLL_FUNC; # set by XS |
532 | |
598 | |
533 | BEGIN { |
599 | BEGIN { |
534 | our $VERSION = '0.98'; |
600 | our $VERSION = '0.99'; |
535 | |
601 | |
536 | require XSLoader; |
602 | require XSLoader; |
537 | XSLoader::load (__PACKAGE__, $VERSION); |
603 | XSLoader::load (__PACKAGE__, $VERSION); |
538 | |
604 | |
539 | @OpenCL::Platform::ISA = |
605 | @OpenCL::Platform::ISA = |
… | |
… | |
544 | @OpenCL::Sampler::ISA = |
610 | @OpenCL::Sampler::ISA = |
545 | @OpenCL::Program::ISA = |
611 | @OpenCL::Program::ISA = |
546 | @OpenCL::Kernel::ISA = |
612 | @OpenCL::Kernel::ISA = |
547 | @OpenCL::Event::ISA = OpenCL::Object::; |
613 | @OpenCL::Event::ISA = OpenCL::Object::; |
548 | |
614 | |
|
|
615 | @OpenCL::SubDevice::ISA = OpenCL::Device::; |
|
|
616 | |
549 | @OpenCL::Buffer::ISA = |
617 | @OpenCL::Buffer::ISA = |
550 | @OpenCL::Image::ISA = OpenCL::Memory::; |
618 | @OpenCL::Image::ISA = OpenCL::Memory::; |
551 | |
619 | |
552 | @OpenCL::BufferObj::ISA = OpenCL::Buffer::; |
620 | @OpenCL::BufferObj::ISA = OpenCL::Buffer::; |
553 | |
621 | |
… | |
… | |
573 | The last error returned by a function - it's only valid after an error occured |
641 | The last error returned by a function - it's only valid after an error occured |
574 | and before calling another OpenCL function. |
642 | and before calling another OpenCL function. |
575 | |
643 | |
576 | =item $str = OpenCL::err2str [$errval] |
644 | =item $str = OpenCL::err2str [$errval] |
577 | |
645 | |
578 | Converts an error value into a human readable string. IF no error value is |
646 | Converts an error value into a human readable string. If no error value is |
579 | given, then the last error will be used (as returned by OpenCL::errno). |
647 | given, then the last error will be used (as returned by OpenCL::errno). |
|
|
648 | |
|
|
649 | The latest version of this module knows the error constants |
|
|
650 | listed in L<http://cvs.schmorp.de/OpenCL/errstr.h>. |
580 | |
651 | |
581 | =item $str = OpenCL::enum2str $enum |
652 | =item $str = OpenCL::enum2str $enum |
582 | |
653 | |
583 | Converts most enum values (of parameter names, image format constants, |
654 | Converts most enum values (of parameter names, image format constants, |
584 | object types, addressing and filter modes, command types etc.) into a |
655 | object types, addressing and filter modes, command types etc.) into a |
585 | human readable string. When confronted with some random integer it can be |
656 | human readable string. When confronted with some random integer it can be |
586 | very helpful to pass it through this function to maybe get some readable |
657 | very helpful to pass it through this function to maybe get some readable |
587 | string out of it. |
658 | string out of it. |
588 | |
659 | |
|
|
660 | The latest version of this module knows the enumaration constants |
|
|
661 | listed in L<http://cvs.schmorp.de/OpenCL/enumstr.h>. |
|
|
662 | |
589 | =item @platforms = OpenCL::platforms |
663 | =item @platforms = OpenCL::platforms |
590 | |
664 | |
591 | Returns all available OpenCL::Platform objects. |
665 | Returns all available OpenCL::Platform objects. |
592 | |
666 | |
593 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> |
667 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> |
594 | |
668 | |
595 | =item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr |
669 | =item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr |
596 | |
670 | |
597 | Tries to create a context from a default device and platform type - never worked for me. |
671 | Tries to create a context from a default device and platform type - never worked for me. |
|
|
672 | Consider using C<< $platform->context_from_type >> instead. |
|
|
673 | |
|
|
674 | type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU, |
|
|
675 | OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL. |
598 | |
676 | |
599 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
677 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
600 | |
678 | |
601 | =item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) |
679 | =item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) |
602 | |
680 | |
603 | Create a new OpenCL::Context object using the given device object(s). This |
681 | Create a new OpenCL::Context object using the given device object(s). |
604 | function isn't implemented yet, use C<< $platform->context >> instead. |
682 | Consider using C<< $platform->context >> instead. |
605 | |
683 | |
606 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
684 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
607 | |
685 | |
608 | =item OpenCL::wait_for_events $wait_events... |
686 | =item OpenCL::wait_for_events $wait_events... |
609 | |
687 | |
… | |
… | |
690 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
768 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
691 | |
769 | |
692 | =item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr) |
770 | =item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr) |
693 | |
771 | |
694 | Create a new OpenCL::Context object using the given device object(s)- a |
772 | Create a new OpenCL::Context object using the given device object(s)- a |
695 | CL_CONTEXT_PLATFORM property is supplied automatically. |
773 | OpenCL::CONTEXT_PLATFORM property is supplied automatically. |
696 | |
774 | |
697 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
775 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
698 | |
776 | |
699 | =item $packed_value = $platform->info ($name) |
777 | =item $packed_value = $platform->info ($name) |
700 | |
778 | |
… | |
… | |
716 | |
794 | |
717 | =for gengetinfo begin platform |
795 | =for gengetinfo begin platform |
718 | |
796 | |
719 | =item $string = $platform->profile |
797 | =item $string = $platform->profile |
720 | |
798 | |
721 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. |
799 | Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result. |
722 | |
800 | |
723 | =item $string = $platform->version |
801 | =item $string = $platform->version |
724 | |
802 | |
725 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. |
803 | Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result. |
726 | |
804 | |
727 | =item $string = $platform->name |
805 | =item $string = $platform->name |
728 | |
806 | |
729 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. |
807 | Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result. |
730 | |
808 | |
731 | =item $string = $platform->vendor |
809 | =item $string = $platform->vendor |
732 | |
810 | |
733 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. |
811 | Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result. |
734 | |
812 | |
735 | =item $string = $platform->extensions |
813 | =item $string = $platform->extensions |
736 | |
814 | |
737 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. |
815 | Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result. |
738 | |
816 | |
739 | =for gengetinfo end platform |
817 | =for gengetinfo end platform |
740 | |
818 | |
741 | =back |
819 | =back |
742 | |
820 | |
… | |
… | |
746 | |
824 | |
747 | =item $packed_value = $device->info ($name) |
825 | =item $packed_value = $device->info ($name) |
748 | |
826 | |
749 | See C<< $platform->info >> for details. |
827 | See C<< $platform->info >> for details. |
750 | |
828 | |
|
|
829 | type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, |
|
|
830 | OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR, |
|
|
831 | OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL. |
|
|
832 | |
|
|
833 | fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST, |
|
|
834 | OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA, |
|
|
835 | OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT. |
|
|
836 | |
|
|
837 | mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE. |
|
|
838 | |
|
|
839 | local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL. |
|
|
840 | |
|
|
841 | exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL. |
|
|
842 | |
|
|
843 | command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE, |
|
|
844 | OpenCL::QUEUE_PROFILING_ENABLE. |
|
|
845 | |
|
|
846 | partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY, |
|
|
847 | OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END, |
|
|
848 | OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN. |
|
|
849 | |
|
|
850 | affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA, |
|
|
851 | OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE, |
|
|
852 | OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE, |
|
|
853 | OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE. |
|
|
854 | |
751 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> |
855 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> |
752 | |
856 | |
|
|
857 | =item @devices = $device->sub_devices (\@properties) |
|
|
858 | |
|
|
859 | Creates OpencL::SubDevice objects by partitioning an existing device. |
|
|
860 | |
|
|
861 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html> |
|
|
862 | |
753 | =for gengetinfo begin device |
863 | =for gengetinfo begin device |
754 | |
864 | |
755 | =item $device_type = $device->type |
865 | =item $device_type = $device->type |
756 | |
866 | |
757 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. |
867 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result. |
758 | |
868 | |
759 | =item $uint = $device->vendor_id |
869 | =item $uint = $device->vendor_id |
760 | |
870 | |
761 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. |
871 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result. |
762 | |
872 | |
763 | =item $uint = $device->max_compute_units |
873 | =item $uint = $device->max_compute_units |
764 | |
874 | |
765 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. |
875 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result. |
766 | |
876 | |
767 | =item $uint = $device->max_work_item_dimensions |
877 | =item $uint = $device->max_work_item_dimensions |
768 | |
878 | |
769 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. |
879 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. |
770 | |
880 | |
771 | =item $int = $device->max_work_group_size |
881 | =item $int = $device->max_work_group_size |
772 | |
882 | |
773 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. |
883 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. |
774 | |
884 | |
775 | =item @ints = $device->max_work_item_sizes |
885 | =item @ints = $device->max_work_item_sizes |
776 | |
886 | |
777 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. |
887 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. |
778 | |
888 | |
779 | =item $uint = $device->preferred_vector_width_char |
889 | =item $uint = $device->preferred_vector_width_char |
780 | |
890 | |
781 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. |
891 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. |
782 | |
892 | |
783 | =item $uint = $device->preferred_vector_width_short |
893 | =item $uint = $device->preferred_vector_width_short |
784 | |
894 | |
785 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. |
895 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. |
786 | |
896 | |
787 | =item $uint = $device->preferred_vector_width_int |
897 | =item $uint = $device->preferred_vector_width_int |
788 | |
898 | |
789 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. |
899 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. |
790 | |
900 | |
791 | =item $uint = $device->preferred_vector_width_long |
901 | =item $uint = $device->preferred_vector_width_long |
792 | |
902 | |
793 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. |
903 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. |
794 | |
904 | |
795 | =item $uint = $device->preferred_vector_width_float |
905 | =item $uint = $device->preferred_vector_width_float |
796 | |
906 | |
797 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. |
907 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. |
798 | |
908 | |
799 | =item $uint = $device->preferred_vector_width_double |
909 | =item $uint = $device->preferred_vector_width_double |
800 | |
910 | |
801 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. |
911 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. |
802 | |
912 | |
803 | =item $uint = $device->max_clock_frequency |
913 | =item $uint = $device->max_clock_frequency |
804 | |
914 | |
805 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. |
915 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. |
806 | |
916 | |
807 | =item $bitfield = $device->address_bits |
917 | =item $bitfield = $device->address_bits |
808 | |
918 | |
809 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. |
919 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result. |
810 | |
920 | |
811 | =item $uint = $device->max_read_image_args |
921 | =item $uint = $device->max_read_image_args |
812 | |
922 | |
813 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. |
923 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. |
814 | |
924 | |
815 | =item $uint = $device->max_write_image_args |
925 | =item $uint = $device->max_write_image_args |
816 | |
926 | |
817 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. |
927 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. |
818 | |
928 | |
819 | =item $ulong = $device->max_mem_alloc_size |
929 | =item $ulong = $device->max_mem_alloc_size |
820 | |
930 | |
821 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. |
931 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. |
822 | |
932 | |
823 | =item $int = $device->image2d_max_width |
933 | =item $int = $device->image2d_max_width |
824 | |
934 | |
825 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. |
935 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. |
826 | |
936 | |
827 | =item $int = $device->image2d_max_height |
937 | =item $int = $device->image2d_max_height |
828 | |
938 | |
829 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. |
939 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. |
830 | |
940 | |
831 | =item $int = $device->image3d_max_width |
941 | =item $int = $device->image3d_max_width |
832 | |
942 | |
833 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. |
943 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. |
834 | |
944 | |
835 | =item $int = $device->image3d_max_height |
945 | =item $int = $device->image3d_max_height |
836 | |
946 | |
837 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. |
947 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. |
838 | |
948 | |
839 | =item $int = $device->image3d_max_depth |
949 | =item $int = $device->image3d_max_depth |
840 | |
950 | |
841 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. |
951 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. |
842 | |
952 | |
843 | =item $uint = $device->image_support |
953 | =item $uint = $device->image_support |
844 | |
954 | |
845 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. |
955 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result. |
846 | |
956 | |
847 | =item $int = $device->max_parameter_size |
957 | =item $int = $device->max_parameter_size |
848 | |
958 | |
849 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. |
959 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result. |
850 | |
960 | |
851 | =item $uint = $device->max_samplers |
961 | =item $uint = $device->max_samplers |
852 | |
962 | |
853 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. |
963 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result. |
854 | |
964 | |
855 | =item $uint = $device->mem_base_addr_align |
965 | =item $uint = $device->mem_base_addr_align |
856 | |
966 | |
857 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. |
967 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. |
858 | |
968 | |
859 | =item $uint = $device->min_data_type_align_size |
969 | =item $uint = $device->min_data_type_align_size |
860 | |
970 | |
861 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. |
971 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. |
862 | |
972 | |
863 | =item $device_fp_config = $device->single_fp_config |
973 | =item $device_fp_config = $device->single_fp_config |
864 | |
974 | |
865 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. |
975 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result. |
866 | |
976 | |
867 | =item $device_mem_cache_type = $device->global_mem_cache_type |
977 | =item $device_mem_cache_type = $device->global_mem_cache_type |
868 | |
978 | |
869 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. |
979 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. |
870 | |
980 | |
871 | =item $uint = $device->global_mem_cacheline_size |
981 | =item $uint = $device->global_mem_cacheline_size |
872 | |
982 | |
873 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. |
983 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. |
874 | |
984 | |
875 | =item $ulong = $device->global_mem_cache_size |
985 | =item $ulong = $device->global_mem_cache_size |
876 | |
986 | |
877 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. |
987 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. |
878 | |
988 | |
879 | =item $ulong = $device->global_mem_size |
989 | =item $ulong = $device->global_mem_size |
880 | |
990 | |
881 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. |
991 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result. |
882 | |
992 | |
883 | =item $ulong = $device->max_constant_buffer_size |
993 | =item $ulong = $device->max_constant_buffer_size |
884 | |
994 | |
885 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. |
995 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. |
886 | |
996 | |
887 | =item $uint = $device->max_constant_args |
997 | =item $uint = $device->max_constant_args |
888 | |
998 | |
889 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. |
999 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result. |
890 | |
1000 | |
891 | =item $device_local_mem_type = $device->local_mem_type |
1001 | =item $device_local_mem_type = $device->local_mem_type |
892 | |
1002 | |
893 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. |
1003 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result. |
894 | |
1004 | |
895 | =item $ulong = $device->local_mem_size |
1005 | =item $ulong = $device->local_mem_size |
896 | |
1006 | |
897 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. |
1007 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result. |
898 | |
1008 | |
899 | =item $boolean = $device->error_correction_support |
1009 | =item $boolean = $device->error_correction_support |
900 | |
1010 | |
901 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. |
1011 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. |
902 | |
1012 | |
903 | =item $int = $device->profiling_timer_resolution |
1013 | =item $int = $device->profiling_timer_resolution |
904 | |
1014 | |
905 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. |
1015 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. |
906 | |
1016 | |
907 | =item $boolean = $device->endian_little |
1017 | =item $boolean = $device->endian_little |
908 | |
1018 | |
909 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. |
1019 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result. |
910 | |
1020 | |
911 | =item $boolean = $device->available |
1021 | =item $boolean = $device->available |
912 | |
1022 | |
913 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. |
1023 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result. |
914 | |
1024 | |
915 | =item $boolean = $device->compiler_available |
1025 | =item $boolean = $device->compiler_available |
916 | |
1026 | |
917 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. |
1027 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result. |
918 | |
1028 | |
919 | =item $device_exec_capabilities = $device->execution_capabilities |
1029 | =item $device_exec_capabilities = $device->execution_capabilities |
920 | |
1030 | |
921 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. |
1031 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result. |
922 | |
1032 | |
923 | =item $command_queue_properties = $device->properties |
1033 | =item $command_queue_properties = $device->properties |
924 | |
1034 | |
925 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. |
1035 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result. |
926 | |
1036 | |
927 | =item $ = $device->platform |
1037 | =item $ = $device->platform |
928 | |
1038 | |
929 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. |
1039 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result. |
930 | |
1040 | |
931 | =item $string = $device->name |
1041 | =item $string = $device->name |
932 | |
1042 | |
933 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. |
1043 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result. |
934 | |
1044 | |
935 | =item $string = $device->vendor |
1045 | =item $string = $device->vendor |
936 | |
1046 | |
937 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. |
1047 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result. |
938 | |
1048 | |
939 | =item $string = $device->driver_version |
1049 | =item $string = $device->driver_version |
940 | |
1050 | |
941 | Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. |
1051 | Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result. |
942 | |
1052 | |
943 | =item $string = $device->profile |
1053 | =item $string = $device->profile |
944 | |
1054 | |
945 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. |
1055 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result. |
946 | |
1056 | |
947 | =item $string = $device->version |
1057 | =item $string = $device->version |
948 | |
1058 | |
949 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. |
1059 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result. |
950 | |
1060 | |
951 | =item $string = $device->extensions |
1061 | =item $string = $device->extensions |
952 | |
1062 | |
953 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. |
1063 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result. |
954 | |
1064 | |
955 | =item $uint = $device->preferred_vector_width_half |
1065 | =item $uint = $device->preferred_vector_width_half |
956 | |
1066 | |
957 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. |
1067 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. |
958 | |
1068 | |
959 | =item $uint = $device->native_vector_width_char |
1069 | =item $uint = $device->native_vector_width_char |
960 | |
1070 | |
961 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. |
1071 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. |
962 | |
1072 | |
963 | =item $uint = $device->native_vector_width_short |
1073 | =item $uint = $device->native_vector_width_short |
964 | |
1074 | |
965 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. |
1075 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. |
966 | |
1076 | |
967 | =item $uint = $device->native_vector_width_int |
1077 | =item $uint = $device->native_vector_width_int |
968 | |
1078 | |
969 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. |
1079 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. |
970 | |
1080 | |
971 | =item $uint = $device->native_vector_width_long |
1081 | =item $uint = $device->native_vector_width_long |
972 | |
1082 | |
973 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. |
1083 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. |
974 | |
1084 | |
975 | =item $uint = $device->native_vector_width_float |
1085 | =item $uint = $device->native_vector_width_float |
976 | |
1086 | |
977 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. |
1087 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. |
978 | |
1088 | |
979 | =item $uint = $device->native_vector_width_double |
1089 | =item $uint = $device->native_vector_width_double |
980 | |
1090 | |
981 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. |
1091 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. |
982 | |
1092 | |
983 | =item $uint = $device->native_vector_width_half |
1093 | =item $uint = $device->native_vector_width_half |
984 | |
1094 | |
985 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. |
1095 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. |
986 | |
1096 | |
987 | =item $device_fp_config = $device->double_fp_config |
1097 | =item $device_fp_config = $device->double_fp_config |
988 | |
1098 | |
989 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. |
1099 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result. |
990 | |
1100 | |
991 | =item $device_fp_config = $device->half_fp_config |
1101 | =item $device_fp_config = $device->half_fp_config |
992 | |
1102 | |
993 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. |
1103 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result. |
994 | |
1104 | |
995 | =item $boolean = $device->host_unified_memory |
1105 | =item $boolean = $device->host_unified_memory |
996 | |
1106 | |
997 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. |
1107 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result. |
998 | |
1108 | |
999 | =item $device = $device->parent_device_ext |
1109 | =item $device = $device->parent_device_ext |
1000 | |
1110 | |
1001 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. |
1111 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result. |
1002 | |
1112 | |
1003 | =item @device_partition_property_exts = $device->partition_types_ext |
1113 | =item @device_partition_property_exts = $device->partition_types_ext |
1004 | |
1114 | |
1005 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. |
1115 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result. |
1006 | |
1116 | |
1007 | =item @device_partition_property_exts = $device->affinity_domains_ext |
1117 | =item @device_partition_property_exts = $device->affinity_domains_ext |
1008 | |
1118 | |
1009 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. |
1119 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. |
1010 | |
1120 | |
1011 | =item $uint = $device->reference_count_ext |
1121 | =item $uint = $device->reference_count_ext |
1012 | |
1122 | |
1013 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. |
1123 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result. |
1014 | |
1124 | |
1015 | =item @device_partition_property_exts = $device->partition_style_ext |
1125 | =item @device_partition_property_exts = $device->partition_style_ext |
1016 | |
1126 | |
1017 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. |
1127 | Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result. |
1018 | |
1128 | |
1019 | =for gengetinfo end device |
1129 | =for gengetinfo end device |
1020 | |
1130 | |
1021 | =back |
1131 | =back |
1022 | |
1132 | |
1023 | =head2 THE OpenCL::Context CLASS |
1133 | =head2 THE OpenCL::Context CLASS |
|
|
1134 | |
|
|
1135 | An OpenCL::Context is basically a container, or manager, for a number of |
|
|
1136 | devices of a platform. It is used to create all sorts of secondary objects |
|
|
1137 | such as buffers, queues, programs and so on. |
|
|
1138 | |
|
|
1139 | All context creation functions and methods take a list of properties |
|
|
1140 | (type-value pairs). All property values can be specified as integers - |
|
|
1141 | some additionally support other types: |
|
|
1142 | |
|
|
1143 | =over 4 |
|
|
1144 | |
|
|
1145 | =item OpenCL::CONTEXT_PLATFORM |
|
|
1146 | |
|
|
1147 | Also accepts OpenCL::Platform objects. |
|
|
1148 | |
|
|
1149 | =item OpenCL::GLX_DISPLAY_KHR |
|
|
1150 | |
|
|
1151 | Also accepts C<undef>, in which case a deep and troubling hack is engaged |
|
|
1152 | to find the current glx display (see L<GLX SUPPORT>). |
|
|
1153 | |
|
|
1154 | =item OpenCL::GL_CONTEXT_KHR |
|
|
1155 | |
|
|
1156 | Also accepts C<undef>, in which case a deep and troubling hack is engaged |
|
|
1157 | to find the current glx context (see L<GLX SUPPORT>). |
|
|
1158 | |
|
|
1159 | =back |
1024 | |
1160 | |
1025 | =over 4 |
1161 | =over 4 |
1026 | |
1162 | |
1027 | =item $prog = $ctx->build_program ($program, $options = "") |
1163 | =item $prog = $ctx->build_program ($program, $options = "") |
1028 | |
1164 | |
… | |
… | |
1076 | =item $buf = $ctx->buffer ($flags, $len) |
1212 | =item $buf = $ctx->buffer ($flags, $len) |
1077 | |
1213 | |
1078 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the |
1214 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the |
1079 | given flags and octet-size. |
1215 | given flags and octet-size. |
1080 | |
1216 | |
|
|
1217 | flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY, |
|
|
1218 | OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR, |
|
|
1219 | OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS. |
|
|
1220 | |
1081 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> |
1221 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> |
1082 | |
1222 | |
1083 | =item $buf = $ctx->buffer_sv ($flags, $data) |
1223 | =item $buf = $ctx->buffer_sv ($flags, $data) |
1084 | |
1224 | |
1085 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and |
1225 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and |
… | |
… | |
1088 | =item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef) |
1228 | =item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef) |
1089 | |
1229 | |
1090 | Creates a new OpenCL::Image object and optionally initialises it with |
1230 | Creates a new OpenCL::Image object and optionally initialises it with |
1091 | the given data values. |
1231 | the given data values. |
1092 | |
1232 | |
|
|
1233 | channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB, |
|
|
1234 | OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE, |
|
|
1235 | OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx. |
|
|
1236 | |
|
|
1237 | channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8, |
|
|
1238 | OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555, |
|
|
1239 | OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16, |
|
|
1240 | OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16, |
|
|
1241 | OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT. |
|
|
1242 | |
|
|
1243 | type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D, |
|
|
1244 | OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY, |
|
|
1245 | OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY, |
|
|
1246 | OpenCL::MEM_OBJECT_IMAGE1D_BUFFER. |
|
|
1247 | |
1093 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> |
1248 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> |
1094 | |
1249 | |
1095 | =item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) |
1250 | =item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) |
1096 | |
1251 | |
1097 | Creates a new OpenCL::Image2D object and optionally initialises it with |
1252 | Creates a new OpenCL::Image2D object and optionally initialises it with |
… | |
… | |
1109 | =item $buffer = $ctx->gl_buffer ($flags, $bufobj) |
1264 | =item $buffer = $ctx->gl_buffer ($flags, $bufobj) |
1110 | |
1265 | |
1111 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given |
1266 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given |
1112 | OpenGL buffer object. |
1267 | OpenGL buffer object. |
1113 | |
1268 | |
|
|
1269 | flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY. |
|
|
1270 | |
1114 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html |
1271 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html |
1115 | |
1272 | |
1116 | =item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) |
1273 | =item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) |
1117 | |
1274 | |
1118 | Creates a new OpenCL::Image object that refers to the given OpenGL |
1275 | Creates a new OpenCL::Image object that refers to the given OpenGL |
1119 | texture object or buffer. |
1276 | texture object or buffer. |
1120 | |
1277 | |
|
|
1278 | target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER, |
|
|
1279 | GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D, |
|
|
1280 | GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y, |
|
|
1281 | GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X, |
|
|
1282 | GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z, |
|
|
1283 | GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB. |
|
|
1284 | |
1121 | http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html |
1285 | http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html |
1122 | |
1286 | |
1123 | =item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) |
1287 | =item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) |
1124 | |
1288 | |
1125 | Creates a new OpenCL::Image2D object that refers to the given OpenGL |
1289 | Creates a new OpenCL::Image2D object that refers to the given OpenGL |
… | |
… | |
1150 | |
1314 | |
1151 | =item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) |
1315 | =item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode) |
1152 | |
1316 | |
1153 | Creates a new OpenCL::Sampler object. |
1317 | Creates a new OpenCL::Sampler object. |
1154 | |
1318 | |
|
|
1319 | addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE, |
|
|
1320 | OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT. |
|
|
1321 | |
|
|
1322 | filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR. |
|
|
1323 | |
1155 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> |
1324 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html> |
1156 | |
1325 | |
1157 | =item $program = $ctx->program_with_source ($string) |
1326 | =item $program = $ctx->program_with_source ($string) |
1158 | |
1327 | |
1159 | Creates a new OpenCL::Program object from the given source code. |
1328 | Creates a new OpenCL::Program object from the given source code. |
1160 | |
1329 | |
1161 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> |
1330 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> |
1162 | |
1331 | |
|
|
1332 | =item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries) |
|
|
1333 | |
|
|
1334 | Creates a new OpenCL::Program object from the given binaries. |
|
|
1335 | |
|
|
1336 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html> |
|
|
1337 | |
|
|
1338 | Example: clone an existing program object that contains a successfully |
|
|
1339 | compiled program, no matter how useless this is. |
|
|
1340 | |
|
|
1341 | my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]); |
|
|
1342 | |
|
|
1343 | =item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names) |
|
|
1344 | |
|
|
1345 | Creates a new OpenCL::Program object from the given built-in kernel names. |
|
|
1346 | |
|
|
1347 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html> |
|
|
1348 | |
|
|
1349 | =item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef) |
|
|
1350 | |
|
|
1351 | Links all (already compiled) program objects specified in C<@programs> |
|
|
1352 | together and returns a new OpenCL::Program object with the result. |
|
|
1353 | |
|
|
1354 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html> |
|
|
1355 | |
1163 | =item $packed_value = $ctx->info ($name) |
1356 | =item $packed_value = $ctx->info ($name) |
1164 | |
1357 | |
1165 | See C<< $platform->info >> for details. |
1358 | See C<< $platform->info >> for details. |
1166 | |
1359 | |
1167 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> |
1360 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> |
1168 | |
1361 | |
1169 | =for gengetinfo begin context |
1362 | =for gengetinfo begin context |
1170 | |
1363 | |
1171 | =item $uint = $context->reference_count |
1364 | =item $uint = $context->reference_count |
1172 | |
1365 | |
1173 | Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. |
1366 | Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result. |
1174 | |
1367 | |
1175 | =item @devices = $context->devices |
1368 | =item @devices = $context->devices |
1176 | |
1369 | |
1177 | Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. |
1370 | Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result. |
1178 | |
1371 | |
1179 | =item @property_ints = $context->properties |
1372 | =item @property_ints = $context->properties |
1180 | |
1373 | |
1181 | Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. |
1374 | Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result. |
1182 | |
1375 | |
1183 | =item $uint = $context->num_devices |
1376 | =item $uint = $context->num_devices |
1184 | |
1377 | |
1185 | Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. |
1378 | Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result. |
1186 | |
1379 | |
1187 | =for gengetinfo end context |
1380 | =for gengetinfo end context |
1188 | |
1381 | |
1189 | =back |
1382 | =back |
1190 | |
1383 | |
… | |
… | |
1306 | reference to an array of local work sizes, with the same number of |
1499 | reference to an array of local work sizes, with the same number of |
1307 | elements as \@global_work_size. |
1500 | elements as \@global_work_size. |
1308 | |
1501 | |
1309 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> |
1502 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> |
1310 | |
1503 | |
|
|
1504 | =item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...) |
|
|
1505 | |
|
|
1506 | Migrates a number of OpenCL::Memory objects to or from the device. |
|
|
1507 | |
|
|
1508 | flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED |
|
|
1509 | |
|
|
1510 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html> |
|
|
1511 | |
1311 | =item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) |
1512 | =item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) |
1312 | |
1513 | |
1313 | Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired |
1514 | Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired |
1314 | for subsequent OpenCL usage. |
1515 | for subsequent OpenCL usage. |
1315 | |
1516 | |
… | |
… | |
1350 | |
1551 | |
1351 | =for gengetinfo begin command_queue |
1552 | =for gengetinfo begin command_queue |
1352 | |
1553 | |
1353 | =item $ctx = $command_queue->context |
1554 | =item $ctx = $command_queue->context |
1354 | |
1555 | |
1355 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. |
1556 | Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result. |
1356 | |
1557 | |
1357 | =item $device = $command_queue->device |
1558 | =item $device = $command_queue->device |
1358 | |
1559 | |
1359 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. |
1560 | Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result. |
1360 | |
1561 | |
1361 | =item $uint = $command_queue->reference_count |
1562 | =item $uint = $command_queue->reference_count |
1362 | |
1563 | |
1363 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. |
1564 | Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result. |
1364 | |
1565 | |
1365 | =item $command_queue_properties = $command_queue->properties |
1566 | =item $command_queue_properties = $command_queue->properties |
1366 | |
1567 | |
1367 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. |
1568 | Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result. |
1368 | |
1569 | |
1369 | =for gengetinfo end command_queue |
1570 | =for gengetinfo end command_queue |
1370 | |
1571 | |
1371 | =back |
1572 | =back |
1372 | |
1573 | |
… | |
… | |
1374 | |
1575 | |
1375 | OpenCL allows you to map buffers and images to host memory (read: perl |
1576 | OpenCL allows you to map buffers and images to host memory (read: perl |
1376 | scalars). This is done much like reading or copying a buffer, by enqueuing |
1577 | scalars). This is done much like reading or copying a buffer, by enqueuing |
1377 | a map or unmap operation on the command queue. |
1578 | a map or unmap operation on the command queue. |
1378 | |
1579 | |
1379 | The map operations return a C<OpenCL::Mapped> object - see L<THE |
1580 | The map operations return an C<OpenCL::Mapped> object - see L<THE |
1380 | OpenCL::Mapped CLASS> section for details on what to do with these |
1581 | OpenCL::Mapped CLASS> section for details on what to do with these |
1381 | objects. |
1582 | objects. |
1382 | |
1583 | |
1383 | The object will be unmapped automatically when the mapped object is |
1584 | The object will be unmapped automatically when the mapped object is |
1384 | destroyed (you can use a barrier to make sure the unmap has finished, |
1585 | destroyed (you can use a barrier to make sure the unmap has finished, |
1385 | before using the buffer in a kernel), but you can also enqueue an unmap |
1586 | before using the buffer in a kernel), but you can also enqueue an unmap |
1386 | operation manually. |
1587 | operation manually. |
1387 | |
1588 | |
1388 | =over 4 |
1589 | =over 4 |
1389 | |
1590 | |
1390 | =item $mapped_buffer = $queue->map_buffer ($buf, $data, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=0, $wait_events...) |
1591 | =item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...) |
1391 | |
1592 | |
1392 | Maps the given buffer into host memory and returns a C<OpenCL::MappedBuffer> object. |
1593 | Maps the given buffer into host memory and returns an |
|
|
1594 | C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then |
|
|
1595 | the map will extend to the end of the buffer. |
|
|
1596 | |
|
|
1597 | map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION. |
1393 | |
1598 | |
1394 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html> |
1599 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html> |
1395 | |
1600 | |
|
|
1601 | Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap. |
|
|
1602 | |
|
|
1603 | { |
|
|
1604 | my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE); |
|
|
1605 | substr $$mapped, 0, 4, "abcd"; |
|
|
1606 | } # asynchronously unmap because $mapped is destroyed |
|
|
1607 | |
1396 | =item $mapped_image = $queue->map_image ($img, $data, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=0, $height=0, $depth=0, $wait_events...) |
1608 | =item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...) |
1397 | |
1609 | |
1398 | Maps the given image area into host memory and return a |
1610 | Maps the given image area into host memory and return an |
1399 | C<OpenCL::MappedImage> object. Although there are default values for most |
1611 | C<OpenCL::MappedImage> object. |
1400 | arguments, you currently have to specify all arguments, otherwise the call |
1612 | |
1401 | will fail. |
1613 | If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they |
|
|
1614 | will be replaced by the maximum possible value. |
1402 | |
1615 | |
1403 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html> |
1616 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html> |
|
|
1617 | |
|
|
1618 | Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set |
|
|
1619 | the first channel of the leftmost column to 5, then explicitly unmap |
|
|
1620 | it. You are not necessarily meant to do it this way, this example just |
|
|
1621 | shows you the accessors to use :) |
|
|
1622 | |
|
|
1623 | my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE); |
|
|
1624 | |
|
|
1625 | $mapped->set ($_ * $mapped->row_pitch, pack "C", 5) |
|
|
1626 | for 0..$image->height; |
|
|
1627 | |
|
|
1628 | $mapped->unmap;. |
|
|
1629 | $mapped->wait; # only needed for out of order queues normally |
1404 | |
1630 | |
1405 | =item $ev = $queue->unmap ($mapped, $wait_events...) |
1631 | =item $ev = $queue->unmap ($mapped, $wait_events...) |
1406 | |
1632 | |
1407 | Unmaps the data from host memory. You must not call any methods that |
1633 | Unmaps the data from host memory. You must not call any methods that |
1408 | modify the data, or modify the data scalar directly, after calling this |
1634 | modify the data, or modify the data scalar directly, after calling this |
… | |
… | |
1429 | |
1655 | |
1430 | =for gengetinfo begin mem |
1656 | =for gengetinfo begin mem |
1431 | |
1657 | |
1432 | =item $mem_object_type = $mem->type |
1658 | =item $mem_object_type = $mem->type |
1433 | |
1659 | |
1434 | Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. |
1660 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result. |
1435 | |
1661 | |
1436 | =item $mem_flags = $mem->flags |
1662 | =item $mem_flags = $mem->flags |
1437 | |
1663 | |
1438 | Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. |
1664 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result. |
1439 | |
1665 | |
1440 | =item $int = $mem->size |
1666 | =item $int = $mem->size |
1441 | |
1667 | |
1442 | Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. |
1668 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result. |
1443 | |
1669 | |
1444 | =item $ptr_value = $mem->host_ptr |
1670 | =item $ptr_value = $mem->host_ptr |
1445 | |
1671 | |
1446 | Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. |
1672 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result. |
1447 | |
1673 | |
1448 | =item $uint = $mem->map_count |
1674 | =item $uint = $mem->map_count |
1449 | |
1675 | |
1450 | Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. |
1676 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result. |
1451 | |
1677 | |
1452 | =item $uint = $mem->reference_count |
1678 | =item $uint = $mem->reference_count |
1453 | |
1679 | |
1454 | Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. |
1680 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result. |
1455 | |
1681 | |
1456 | =item $ctx = $mem->context |
1682 | =item $ctx = $mem->context |
1457 | |
1683 | |
1458 | Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. |
1684 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result. |
1459 | |
1685 | |
1460 | =item $mem = $mem->associated_memobject |
1686 | =item $mem = $mem->associated_memobject |
1461 | |
1687 | |
1462 | Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. |
1688 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result. |
1463 | |
1689 | |
1464 | =item $int = $mem->offset |
1690 | =item $int = $mem->offset |
1465 | |
1691 | |
1466 | Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. |
1692 | Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result. |
1467 | |
1693 | |
1468 | =for gengetinfo end mem |
1694 | =for gengetinfo end mem |
1469 | |
1695 | |
1470 | =item ($type, $name) = $mem->gl_object_info |
1696 | =item ($type, $name) = $mem->gl_object_info |
1471 | |
1697 | |
… | |
… | |
1491 | =over 4 |
1717 | =over 4 |
1492 | |
1718 | |
1493 | =item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size) |
1719 | =item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size) |
1494 | |
1720 | |
1495 | Creates an OpenCL::Buffer objects from this buffer and returns it. The |
1721 | Creates an OpenCL::Buffer objects from this buffer and returns it. The |
1496 | C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>. |
1722 | C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>. |
1497 | |
1723 | |
1498 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html> |
1724 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html> |
1499 | |
1725 | |
1500 | =back |
1726 | =back |
1501 | |
1727 | |
… | |
… | |
1517 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> |
1743 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> |
1518 | |
1744 | |
1519 | =item ($channel_order, $channel_data_type) = $image->format |
1745 | =item ($channel_order, $channel_data_type) = $image->format |
1520 | |
1746 | |
1521 | Returns the channel order and type used to create the image by calling |
1747 | Returns the channel order and type used to create the image by calling |
1522 | C<clGetImageInfo> with C<CL_IMAGE_FORMAT>. |
1748 | C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>. |
1523 | |
1749 | |
1524 | =for gengetinfo begin image |
1750 | =for gengetinfo begin image |
1525 | |
1751 | |
1526 | =item $int = $image->element_size |
1752 | =item $int = $image->element_size |
1527 | |
1753 | |
1528 | Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. |
1754 | Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result. |
1529 | |
1755 | |
1530 | =item $int = $image->row_pitch |
1756 | =item $int = $image->row_pitch |
1531 | |
1757 | |
1532 | Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. |
1758 | Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result. |
1533 | |
1759 | |
1534 | =item $int = $image->slice_pitch |
1760 | =item $int = $image->slice_pitch |
1535 | |
1761 | |
1536 | Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. |
1762 | Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result. |
1537 | |
1763 | |
1538 | =item $int = $image->width |
1764 | =item $int = $image->width |
1539 | |
1765 | |
1540 | Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. |
1766 | Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result. |
1541 | |
1767 | |
1542 | =item $int = $image->height |
1768 | =item $int = $image->height |
1543 | |
1769 | |
1544 | Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. |
1770 | Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result. |
1545 | |
1771 | |
1546 | =item $int = $image->depth |
1772 | =item $int = $image->depth |
1547 | |
1773 | |
1548 | Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. |
1774 | Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result. |
1549 | |
1775 | |
1550 | =for gengetinfo end image |
1776 | =for gengetinfo end image |
1551 | |
1777 | |
1552 | =for gengetinfo begin gl_texture |
1778 | =for gengetinfo begin gl_texture |
1553 | |
1779 | |
1554 | =item $GLenum = $gl_texture->target |
1780 | =item $GLenum = $gl_texture->target |
1555 | |
1781 | |
1556 | Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. |
1782 | Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result. |
1557 | |
1783 | |
1558 | =item $GLint = $gl_texture->gl_mipmap_level |
1784 | =item $GLint = $gl_texture->gl_mipmap_level |
1559 | |
1785 | |
1560 | Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. |
1786 | Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result. |
1561 | |
1787 | |
1562 | =for gengetinfo end gl_texture |
1788 | =for gengetinfo end gl_texture |
1563 | |
1789 | |
1564 | =back |
1790 | =back |
1565 | |
1791 | |
… | |
… | |
1575 | |
1801 | |
1576 | =for gengetinfo begin sampler |
1802 | =for gengetinfo begin sampler |
1577 | |
1803 | |
1578 | =item $uint = $sampler->reference_count |
1804 | =item $uint = $sampler->reference_count |
1579 | |
1805 | |
1580 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. |
1806 | Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result. |
1581 | |
1807 | |
1582 | =item $ctx = $sampler->context |
1808 | =item $ctx = $sampler->context |
1583 | |
1809 | |
1584 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. |
1810 | Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result. |
1585 | |
1811 | |
1586 | =item $addressing_mode = $sampler->normalized_coords |
1812 | =item $addressing_mode = $sampler->normalized_coords |
1587 | |
1813 | |
1588 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. |
1814 | Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result. |
1589 | |
1815 | |
1590 | =item $filter_mode = $sampler->addressing_mode |
1816 | =item $filter_mode = $sampler->addressing_mode |
1591 | |
1817 | |
1592 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. |
1818 | Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result. |
1593 | |
1819 | |
1594 | =item $boolean = $sampler->filter_mode |
1820 | =item $boolean = $sampler->filter_mode |
1595 | |
1821 | |
1596 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. |
1822 | Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result. |
1597 | |
1823 | |
1598 | =for gengetinfo end sampler |
1824 | =for gengetinfo end sampler |
1599 | |
1825 | |
1600 | =back |
1826 | =back |
1601 | |
1827 | |
… | |
… | |
1619 | not so. So best make sure you don't pass in invalid values. |
1845 | not so. So best make sure you don't pass in invalid values. |
1620 | |
1846 | |
1621 | Some implementations fail with C<OpenCL::INVALID_BINARY> when the |
1847 | Some implementations fail with C<OpenCL::INVALID_BINARY> when the |
1622 | compilation state is successful but some later stage fails. |
1848 | compilation state is successful but some later stage fails. |
1623 | |
1849 | |
|
|
1850 | options: C<-D name>, C<-D name=definition>, C<-I dir>, |
|
|
1851 | C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>, |
|
|
1852 | C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>, |
|
|
1853 | C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>, |
|
|
1854 | C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>, |
|
|
1855 | C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>, |
|
|
1856 | C<-create-library>, C<-enable-link-options>. |
|
|
1857 | |
|
|
1858 | build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE, |
|
|
1859 | OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS. |
|
|
1860 | |
1624 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> |
1861 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> |
1625 | |
1862 | |
1626 | =item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) |
1863 | =item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) |
1627 | |
1864 | |
1628 | Similar to C<< ->build >>, except it starts a thread, and never fails (you |
1865 | Similar to C<< ->build >>, except it starts a thread, and never fails (you |
1629 | need to check the compilation status form the callback, or by polling). |
1866 | need to check the compilation status form the callback, or by polling). |
1630 | |
1867 | |
|
|
1868 | =item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef) |
|
|
1869 | |
|
|
1870 | Compiles the given program for the given devices (or all devices if |
|
|
1871 | undef). If C<$headers> is given, it must be a hashref with include name => |
|
|
1872 | OpenCL::Program pairs. |
|
|
1873 | |
|
|
1874 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html> |
|
|
1875 | |
1631 | =item $packed_value = $program->build_info ($device, $name) |
1876 | =item $packed_value = $program->build_info ($device, $name) |
1632 | |
1877 | |
1633 | Similar to C<< $platform->info >>, but returns build info for a previous |
1878 | Similar to C<< $platform->info >>, but returns build info for a previous |
1634 | build attempt for the given device. |
1879 | build attempt for the given device. |
1635 | |
1880 | |
|
|
1881 | binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE, |
|
|
1882 | OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT, |
|
|
1883 | OpenCL::PROGRAM_BINARY_TYPE_LIBRARY, |
|
|
1884 | OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE. |
|
|
1885 | |
1636 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html> |
1886 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html> |
1637 | |
1887 | |
1638 | =item $kernel = $program->kernel ($function_name) |
1888 | =item $kernel = $program->kernel ($function_name) |
1639 | |
1889 | |
1640 | Creates an OpenCL::Kernel object out of the named C<__kernel> function in |
1890 | Creates an OpenCL::Kernel object out of the named C<__kernel> function in |
… | |
… | |
1650 | |
1900 | |
1651 | =for gengetinfo begin program_build |
1901 | =for gengetinfo begin program_build |
1652 | |
1902 | |
1653 | =item $build_status = $program->build_status ($device) |
1903 | =item $build_status = $program->build_status ($device) |
1654 | |
1904 | |
1655 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. |
1905 | Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result. |
1656 | |
1906 | |
1657 | =item $string = $program->build_options ($device) |
1907 | =item $string = $program->build_options ($device) |
1658 | |
1908 | |
1659 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. |
1909 | Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result. |
1660 | |
1910 | |
1661 | =item $string = $program->build_log ($device) |
1911 | =item $string = $program->build_log ($device) |
1662 | |
1912 | |
1663 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. |
1913 | Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result. |
|
|
1914 | |
|
|
1915 | =item $binary_type = $program->binary_type ($device) |
|
|
1916 | |
|
|
1917 | Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result. |
1664 | |
1918 | |
1665 | =for gengetinfo end program_build |
1919 | =for gengetinfo end program_build |
1666 | |
1920 | |
1667 | =item $packed_value = $program->info ($name) |
1921 | =item $packed_value = $program->info ($name) |
1668 | |
1922 | |
… | |
… | |
1672 | |
1926 | |
1673 | =for gengetinfo begin program |
1927 | =for gengetinfo begin program |
1674 | |
1928 | |
1675 | =item $uint = $program->reference_count |
1929 | =item $uint = $program->reference_count |
1676 | |
1930 | |
1677 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. |
1931 | Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result. |
1678 | |
1932 | |
1679 | =item $ctx = $program->context |
1933 | =item $ctx = $program->context |
1680 | |
1934 | |
1681 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. |
1935 | Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result. |
1682 | |
1936 | |
1683 | =item $uint = $program->num_devices |
1937 | =item $uint = $program->num_devices |
1684 | |
1938 | |
1685 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. |
1939 | Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result. |
1686 | |
1940 | |
1687 | =item @devices = $program->devices |
1941 | =item @devices = $program->devices |
1688 | |
1942 | |
1689 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. |
1943 | Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result. |
1690 | |
1944 | |
1691 | =item $string = $program->source |
1945 | =item $string = $program->source |
1692 | |
1946 | |
1693 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. |
1947 | Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result. |
1694 | |
1948 | |
1695 | =item @ints = $program->binary_sizes |
1949 | =item @ints = $program->binary_sizes |
1696 | |
1950 | |
1697 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. |
1951 | Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result. |
1698 | |
1952 | |
1699 | =for gengetinfo end program |
1953 | =for gengetinfo end program |
1700 | |
1954 | |
1701 | =item @blobs = $program->binaries |
1955 | =item @blobs = $program->binaries |
1702 | |
1956 | |
… | |
… | |
1723 | |
1977 | |
1724 | =for gengetinfo begin kernel |
1978 | =for gengetinfo begin kernel |
1725 | |
1979 | |
1726 | =item $string = $kernel->function_name |
1980 | =item $string = $kernel->function_name |
1727 | |
1981 | |
1728 | Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. |
1982 | Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result. |
1729 | |
1983 | |
1730 | =item $uint = $kernel->num_args |
1984 | =item $uint = $kernel->num_args |
1731 | |
1985 | |
1732 | Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. |
1986 | Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result. |
1733 | |
1987 | |
1734 | =item $uint = $kernel->reference_count |
1988 | =item $uint = $kernel->reference_count |
1735 | |
1989 | |
1736 | Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. |
1990 | Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result. |
1737 | |
1991 | |
1738 | =item $ctx = $kernel->context |
1992 | =item $ctx = $kernel->context |
1739 | |
1993 | |
1740 | Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. |
1994 | Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result. |
1741 | |
1995 | |
1742 | =item $program = $kernel->program |
1996 | =item $program = $kernel->program |
1743 | |
1997 | |
1744 | Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. |
1998 | Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result. |
1745 | |
1999 | |
1746 | =for gengetinfo end kernel |
2000 | =for gengetinfo end kernel |
1747 | |
2001 | |
1748 | =item $packed_value = $kernel->work_group_info ($device, $name) |
2002 | =item $packed_value = $kernel->work_group_info ($device, $name) |
1749 | |
2003 | |
1750 | See C<< $platform->info >> for details. |
2004 | See C<< $platform->info >> for details. |
1751 | |
2005 | |
1752 | The reason this method is not called C<info> is that there already is an |
|
|
1753 | C<< ->info >> method. |
|
|
1754 | |
|
|
1755 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> |
2006 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> |
1756 | |
2007 | |
1757 | =for gengetinfo begin kernel_work_group |
2008 | =for gengetinfo begin kernel_work_group |
1758 | |
2009 | |
1759 | =item $int = $kernel->work_group_size ($device) |
2010 | =item $int = $kernel->work_group_size ($device) |
1760 | |
2011 | |
1761 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. |
2012 | Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result. |
1762 | |
2013 | |
1763 | =item @ints = $kernel->compile_work_group_size ($device) |
2014 | =item @ints = $kernel->compile_work_group_size ($device) |
1764 | |
2015 | |
1765 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. |
2016 | Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. |
1766 | |
2017 | |
1767 | =item $ulong = $kernel->local_mem_size ($device) |
2018 | =item $ulong = $kernel->local_mem_size ($device) |
1768 | |
2019 | |
1769 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. |
2020 | Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result. |
1770 | |
2021 | |
1771 | =item $int = $kernel->preferred_work_group_size_multiple ($device) |
2022 | =item $int = $kernel->preferred_work_group_size_multiple ($device) |
1772 | |
2023 | |
1773 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. |
2024 | Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. |
1774 | |
2025 | |
1775 | =item $ulong = $kernel->private_mem_size ($device) |
2026 | =item $ulong = $kernel->private_mem_size ($device) |
1776 | |
2027 | |
1777 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. |
2028 | Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result. |
1778 | |
2029 | |
1779 | =for gengetinfo end kernel_work_group |
2030 | =for gengetinfo end kernel_work_group |
|
|
2031 | |
|
|
2032 | =item $packed_value = $kernel->arg_info ($idx, $name) |
|
|
2033 | |
|
|
2034 | See C<< $platform->info >> for details. |
|
|
2035 | |
|
|
2036 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html> |
|
|
2037 | |
|
|
2038 | =for gengetinfo begin kernel_arg |
|
|
2039 | |
|
|
2040 | =item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx) |
|
|
2041 | |
|
|
2042 | Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result. |
|
|
2043 | |
|
|
2044 | =item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx) |
|
|
2045 | |
|
|
2046 | Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result. |
|
|
2047 | |
|
|
2048 | =item $string = $kernel->arg_type_name ($idx) |
|
|
2049 | |
|
|
2050 | Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result. |
|
|
2051 | |
|
|
2052 | =item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx) |
|
|
2053 | |
|
|
2054 | Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result. |
|
|
2055 | |
|
|
2056 | =item $string = $kernel->arg_name ($idx) |
|
|
2057 | |
|
|
2058 | Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result. |
|
|
2059 | |
|
|
2060 | =for gengetinfo end kernel_arg |
1780 | |
2061 | |
1781 | =item $kernel->setf ($format, ...) |
2062 | =item $kernel->setf ($format, ...) |
1782 | |
2063 | |
1783 | Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic |
2064 | Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic |
1784 | way to set arguments (and with OpenCL 1.2 it might be rather slow), you |
2065 | way to set arguments (and with OpenCL 1.2 it might be rather slow), you |
… | |
… | |
1896 | |
2177 | |
1897 | =for gengetinfo begin event |
2178 | =for gengetinfo begin event |
1898 | |
2179 | |
1899 | =item $queue = $event->command_queue |
2180 | =item $queue = $event->command_queue |
1900 | |
2181 | |
1901 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. |
2182 | Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result. |
1902 | |
2183 | |
1903 | =item $command_type = $event->command_type |
2184 | =item $command_type = $event->command_type |
1904 | |
2185 | |
1905 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. |
2186 | Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result. |
1906 | |
2187 | |
1907 | =item $uint = $event->reference_count |
2188 | =item $uint = $event->reference_count |
1908 | |
2189 | |
1909 | Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. |
2190 | Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result. |
1910 | |
2191 | |
1911 | =item $uint = $event->command_execution_status |
2192 | =item $uint = $event->command_execution_status |
1912 | |
2193 | |
1913 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. |
2194 | Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result. |
1914 | |
2195 | |
1915 | =item $ctx = $event->context |
2196 | =item $ctx = $event->context |
1916 | |
2197 | |
1917 | Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. |
2198 | Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result. |
1918 | |
2199 | |
1919 | =for gengetinfo end event |
2200 | =for gengetinfo end event |
1920 | |
2201 | |
1921 | =item $packed_value = $ev->profiling_info ($name) |
2202 | =item $packed_value = $ev->profiling_info ($name) |
1922 | |
2203 | |
… | |
… | |
1929 | |
2210 | |
1930 | =for gengetinfo begin profiling |
2211 | =for gengetinfo begin profiling |
1931 | |
2212 | |
1932 | =item $ulong = $event->profiling_command_queued |
2213 | =item $ulong = $event->profiling_command_queued |
1933 | |
2214 | |
1934 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. |
2215 | Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result. |
1935 | |
2216 | |
1936 | =item $ulong = $event->profiling_command_submit |
2217 | =item $ulong = $event->profiling_command_submit |
1937 | |
2218 | |
1938 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. |
2219 | Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result. |
1939 | |
2220 | |
1940 | =item $ulong = $event->profiling_command_start |
2221 | =item $ulong = $event->profiling_command_start |
1941 | |
2222 | |
1942 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. |
2223 | Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result. |
1943 | |
2224 | |
1944 | =item $ulong = $event->profiling_command_end |
2225 | =item $ulong = $event->profiling_command_end |
1945 | |
2226 | |
1946 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. |
2227 | Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result. |
1947 | |
2228 | |
1948 | =for gengetinfo end profiling |
2229 | =for gengetinfo end profiling |
1949 | |
2230 | |
1950 | =back |
2231 | =back |
1951 | |
2232 | |
… | |
… | |
1957 | |
2238 | |
1958 | =item $ev->set_status ($execution_status) |
2239 | =item $ev->set_status ($execution_status) |
1959 | |
2240 | |
1960 | Sets the execution status of the user event. Can only be called once, |
2241 | Sets the execution status of the user event. Can only be called once, |
1961 | either with OpenCL::COMPLETE or a negative number as status. |
2242 | either with OpenCL::COMPLETE or a negative number as status. |
|
|
2243 | |
|
|
2244 | execution_status: OpenCL::COMPLETE or a negative integer. |
1962 | |
2245 | |
1963 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> |
2246 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> |
1964 | |
2247 | |
1965 | =back |
2248 | =back |
1966 | |
2249 | |