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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.76 by root, Sat May 5 02:45:38 2012 UTC vs.
Revision 1.87 by root, Mon May 7 01:01:33 2012 UTC

… …
28specific device ("compiling and linking"), also binary programs. For each 28specific device ("compiling and linking"), also binary programs. For each
29kernel function in a program you can then create an OpenCL::Kernel object 29kernel function in a program you can then create an OpenCL::Kernel object
30which represents basically a function call with argument values. 30which represents basically a function call with argument values.
31 31
32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat 32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d 33memory areas, think arrays or structs) and OpenCL::Image objects (think 2D
34or 3d array) for bulk data and input and output for kernels. 34or 3D array) for bulk data and input and output for kernels.
35 35
36OpenCL::Sampler objects, which are kind of like texture filter modes in 36OpenCL::Sampler objects, which are kind of like texture filter modes in
37OpenGL. 37OpenGL.
38 38
39OpenCL::Queue objects - command queues, which allow you to submit memory 39OpenCL::Queue objects - command queues, which allow you to submit memory
… …
213 $ev->wait; 213 $ev->wait;
214 214
215=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
216set flight effect. 216set flight effect.
217 217
218This is quite a long example to get you going - you can download it from 218This is quite a long example to get you going - you can also download it
219L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>. 219from L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
220 220
221 use OpenGL ":all"; 221 use OpenGL ":all";
222 use OpenCL; 222 use OpenCL;
223 223
224 my $S = $ARGV[0] || 256; # window/texture size, smaller is faster 224 my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
… …
388 388
389=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
390context, no event is created. In all other contexts an event is returned 390context, no event is created. In all other contexts an event is returned
391by the method. 391by the method.
392 392
393=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
394other status is returned the function will throw an exception, so you 394other status is returned the function will throw an exception, so you
395don't normally have to to any error checking. 395don't normally have to to any error checking.
396 396
397=back 397=back
398
399=head2 CONSTANTS
400
401All C<CL_xxx> constants that this module supports are always available
402in the C<OpenCL> namespace as C<OpenCL::xxx> (i.e. without the C<CL_>
403prefix). Constants which are not defined in the header files used during
404compilation, or otherwise are not available, will have the value C<0> (in
405some cases, this will make them indistinguishable from real constants,
406sorry).
407
408The latest version of this module knows and exports the constants
409listed in L<http://cvs.schmorp.de/OpenCL/constiv.h>.
410
411=head2 OPENCL 1.1 VS. OPENCL 1.2
412
413This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
4141.2 interface hasn't been tested much for lack of availability of an
415actual implementation.
416
417Every function or method in this manual page that interfaces to a
418particular OpenCL function has a link to the its C manual page.
419
420If the link contains a F<1.1>, then this function is an OpenCL 1.1
421function. Most but not all also exist in OpenCL 1.2, and this module
422tries to emulate the missing ones for you, when told to do so at
423compiletime. You can check whether a function was removed in OpenCL 1.2 by
424replacing the F<1.1> component in the URL by F<1.2>.
425
426If the link contains a F<1.2>, then this is a OpenCL 1.2-only
427function. Even if the module was compiled with OpenCL 1.2 header files
428and has an 1.2 OpenCL library, calling such a function on a platform that
429doesn't implement 1.2 causes undefined behaviour, usually a crash (But
430this is not guaranteed).
431
432You can find out whether this module was compiled to prefer 1.1
433functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
4341.1 functions generally are implemented using 1.1 OpenCL functions. If it
435is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
436fucntions.
437
438This is a somewhat sorry state of affairs, but the Khronos group choose to
439make every release of OpenCL source and binary incompatible with previous
440releases.
398 441
399=head2 PERL AND OPENCL TYPES 442=head2 PERL AND OPENCL TYPES
400 443
401This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack 444This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
402format equivalents: 445format equivalents:
… …
554use Async::Interrupt (); 597use Async::Interrupt ();
555 598
556our $POLL_FUNC; # set by XS 599our $POLL_FUNC; # set by XS
557 600
558BEGIN { 601BEGIN {
559 our $VERSION = '0.99'; 602 our $VERSION = '1.01';
560 603
561 require XSLoader; 604 require XSLoader;
562 XSLoader::load (__PACKAGE__, $VERSION); 605 XSLoader::load (__PACKAGE__, $VERSION);
563 606
564 @OpenCL::Platform::ISA = 607 @OpenCL::Platform::ISA =
… …
600The last error returned by a function - it's only valid after an error occured 643The last error returned by a function - it's only valid after an error occured
601and before calling another OpenCL function. 644and before calling another OpenCL function.
602 645
603=item $str = OpenCL::err2str [$errval] 646=item $str = OpenCL::err2str [$errval]
604 647
605Converts an error value into a human readable string. IF no error value is 648Converts an error value into a human readable string. If no error value is
606given, then the last error will be used (as returned by OpenCL::errno). 649given, then the last error will be used (as returned by OpenCL::errno).
650
651The latest version of this module knows the error constants
652listed in L<http://cvs.schmorp.de/OpenCL/errstr.h>.
607 653
608=item $str = OpenCL::enum2str $enum 654=item $str = OpenCL::enum2str $enum
609 655
610Converts most enum values (of parameter names, image format constants, 656Converts most enum values (of parameter names, image format constants,
611object types, addressing and filter modes, command types etc.) into a 657object types, addressing and filter modes, command types etc.) into a
612human readable string. When confronted with some random integer it can be 658human readable string. When confronted with some random integer it can be
613very helpful to pass it through this function to maybe get some readable 659very helpful to pass it through this function to maybe get some readable
614string out of it. 660string out of it.
615 661
662The latest version of this module knows the enumaration constants
663listed in L<http://cvs.schmorp.de/OpenCL/enumstr.h>.
664
616=item @platforms = OpenCL::platforms 665=item @platforms = OpenCL::platforms
617 666
618Returns all available OpenCL::Platform objects. 667Returns all available OpenCL::Platform objects.
619 668
620L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> 669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
… …
721L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 770L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
722 771
723=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr) 772=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
724 773
725Create a new OpenCL::Context object using the given device object(s)- a 774Create a new OpenCL::Context object using the given device object(s)- a
726CL_CONTEXT_PLATFORM property is supplied automatically. 775OpenCL::CONTEXT_PLATFORM property is supplied automatically.
727 776
728L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 777L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
729 778
730=item $packed_value = $platform->info ($name) 779=item $packed_value = $platform->info ($name)
731 780
… …
776=over 4 825=over 4
777 826
778=item $packed_value = $device->info ($name) 827=item $packed_value = $device->info ($name)
779 828
780See C<< $platform->info >> for details. 829See C<< $platform->info >> for details.
830
831type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
832OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
833OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
834
835fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
836OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
837OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
838
839mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
840
841local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
842
843exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
844
845command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
846OpenCL::QUEUE_PROFILING_ENABLE.
847
848partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
849OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
850OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
851
852affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
853OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
854OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
855OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
781 856
782L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 857L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
783 858
784=item @devices = $device->sub_devices (\@properties) 859=item @devices = $device->sub_devices (\@properties)
785 860
… …
1165OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555, 1240OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1166OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16, 1241OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1167OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16, 1242OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1168OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT. 1243OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1169 1244
1170
1171type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D, 1245type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1172OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY, 1246OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1173OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY, 1247OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1174OpenCL::MEM_OBJECT_IMAGE1D_BUFFER. 1248OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1175 1249
… …
1350 1424
1351=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 1425=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1352 1426
1353L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 1427L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1354 1428
1355=item $ev = $queue->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...) 1429$eue->read_buffer_rect ($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...)
1356 1430
1357http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html 1431http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1358 1432
1359=item $ev = $queue->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...) 1433=item $ev = $queue->write_buffer_rect ($buf, $blocking, $buf_y, $host_x, $host_z, $height, $buf_row_pitch, $host_row_pitch, $data, $wait_events...)
1360 1434
1361http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html 1435http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1362 1436
1363=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) 1437=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1364 1438
… …
1548it. You are not necessarily meant to do it this way, this example just 1622it. You are not necessarily meant to do it this way, this example just
1549shows you the accessors to use :) 1623shows you the accessors to use :)
1550 1624
1551 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE); 1625 my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
1552 1626
1553 $mapped->set ($_ * $mapped->row_pitch, pack "C", 5) 1627 $mapped->write ($_ * $mapped->row_pitch, pack "C", 5)
1554 for 0..$image->height; 1628 for 0 .. $mapped->height - 1;
1555 1629
1556 $mapped->unmap;. 1630 $mapped->unmap;.
1557 $mapped->wait; # only needed for out of order queues normally 1631 $mapped->wait; # only needed for out of order queues normally
1558 1632
1559=item $ev = $queue->unmap ($mapped, $wait_events...) 1633=item $ev = $queue->unmap ($mapped, $wait_events...)
… …
1579 1653
1580See C<< $platform->info >> for details. 1654See C<< $platform->info >> for details.
1581 1655
1582L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1656L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
1583 1657
1658=item $memory->destructor_callback ($cb->())
1659
1660Sets a callback that will be invoked after the memory object is destructed.
1661
1662L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetMemObjectDestructorCallback.html>
1663
1584=for gengetinfo begin mem 1664=for gengetinfo begin mem
1585 1665
1586=item $mem_object_type = $mem->type 1666=item $mem_object_type = $mem->type
1587 1667
1588Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result. 1668Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
… …
1645=over 4 1725=over 4
1646 1726
1647=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size) 1727=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1648 1728
1649Creates an OpenCL::Buffer objects from this buffer and returns it. The 1729Creates an OpenCL::Buffer objects from this buffer and returns it. The
1650C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>. 1730C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1651 1731
1652L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html> 1732L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1653 1733
1654=back 1734=back
1655 1735
… …
1671L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1751L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1672 1752
1673=item ($channel_order, $channel_data_type) = $image->format 1753=item ($channel_order, $channel_data_type) = $image->format
1674 1754
1675Returns the channel order and type used to create the image by calling 1755Returns the channel order and type used to create the image by calling
1676C<clGetImageInfo> with C<CL_IMAGE_FORMAT>. 1756C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1677 1757
1678=for gengetinfo begin image 1758=for gengetinfo begin image
1679 1759
1680=item $int = $image->element_size 1760=item $int = $image->element_size
1681 1761
… …
1804=item $packed_value = $program->build_info ($device, $name) 1884=item $packed_value = $program->build_info ($device, $name)
1805 1885
1806Similar to C<< $platform->info >>, but returns build info for a previous 1886Similar to C<< $platform->info >>, but returns build info for a previous
1807build attempt for the given device. 1887build attempt for the given device.
1808 1888
1889binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
1890OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
1891OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
1892OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
1893
1809L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html> 1894L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1810 1895
1811=item $kernel = $program->kernel ($function_name) 1896=item $kernel = $program->kernel ($function_name)
1812 1897
1813Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1898Creates an OpenCL::Kernel object out of the named C<__kernel> function in
… …
1832Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result. 1917Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1833 1918
1834=item $string = $program->build_log ($device) 1919=item $string = $program->build_log ($device)
1835 1920
1836Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result. 1921Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1922
1923=item $binary_type = $program->binary_type ($device)
1924
1925Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1837 1926
1838=for gengetinfo end program_build 1927=for gengetinfo end program_build
1839 1928
1840=item $packed_value = $program->info ($name) 1929=item $packed_value = $program->info ($name)
1841 1930
… …
2256 2345
2257This is a subclass of OpenCL::Mapped, representing mapped images. 2346This is a subclass of OpenCL::Mapped, representing mapped images.
2258 2347
2259=over 4 2348=over 4
2260 2349
2350=item $pixels = $mapped->width
2351
2352=item $pixels = $mapped->height
2353
2354=item $pixels = $mapped->depth
2355
2356Return the width/height/depth of the mapped image region, in pixels.
2357
2261=item $bytes = $mapped->row_pitch 2358=item $bytes = $mapped->row_pitch
2262 2359
2263=item $bytes = $mapped->slice_pitch 2360=item $bytes = $mapped->slice_pitch
2264 2361
2265Return the row or slice pitch of the image that has been mapped. 2362Return the row or slice pitch of the image that has been mapped.
2266 2363
2364=item $bytes = $mapped->element_size
2365
2366Return the size of a single pixel.
2367
2368=item $data = $mapped->get_row ($count, $x=0, $y=0, $z=0)
2369
2370Return C<$count> pixels from the given coordinates. The pixel data must
2371be completely contained within a single row.
2372
2373If C<$count> is C<undef>, then all the remaining pixels in that row are
2374returned.
2375
2376=item $mapped->set_row ($data, $x=0, $y=0, $z=0)
2377
2378Write the given pixel data at the given coordinate. The pixel data must
2379be completely contained within a single row.
2380
2267=back 2381=back
2268
2269 2382
2270=cut 2383=cut
2271 2384
22721; 23851;
2273 2386

Diff Legend

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