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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.44 by root, Sat Apr 21 17:47:23 2012 UTC vs.
Revision 1.50 by root, Tue Apr 24 13:30:49 2012 UTC

… …
456It's best to avoid this method and use one of the following convenience 456It's best to avoid this method and use one of the following convenience
457wrappers. 457wrappers.
458 458
459L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 459L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
460 460
461=item $platform->unload_compiler
462
463Attempts to unload the compiler for this platform, for endless
464profit. Does nothing on OpenCL 1.1.
465
466L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
467
461=for gengetinfo begin platform 468=for gengetinfo begin platform
462 469
463=item $string = $platform->profile 470=item $string = $platform->profile
464 471
465Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 472Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
… …
750 757
751=item @device_partition_property_exts = $device->affinity_domains_ext 758=item @device_partition_property_exts = $device->affinity_domains_ext
752 759
753Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 760Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
754 761
755=item $uint = $device->reference_count_ext 762=item $uint = $device->reference_count_ext
756 763
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result. 764Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
758 765
759=item @device_partition_property_exts = $device->partition_style_ext 766=item @device_partition_property_exts = $device->partition_style_ext
760 767
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 768Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
762 769
… …
771=item $queue = $ctx->queue ($device, $properties) 778=item $queue = $ctx->queue ($device, $properties)
772 779
773Create a new OpenCL::Queue object from the context and the given device. 780Create a new OpenCL::Queue object from the context and the given device.
774 781
775L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 782L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
783
784Example: create an out-of-order queue.
785
786 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
776 787
777=item $ev = $ctx->user_event 788=item $ev = $ctx->user_event
778 789
779Creates a new OpenCL::UserEvent object. 790Creates a new OpenCL::UserEvent object.
780 791
… …
790=item $buf = $ctx->buffer_sv ($flags, $data) 801=item $buf = $ctx->buffer_sv ($flags, $data)
791 802
792Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 803Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
793initialise it with the given data values. 804initialise it with the given data values.
794 805
806=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
807
808Creates a new OpenCL::Image object and optionally initialises it with
809the given data values.
810
811L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
812
795=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 813=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
796 814
797Creates a new OpenCL::Image2D object and optionally initialises it with 815Creates a new OpenCL::Image2D object and optionally initialises it with
798the given data values. 816the given data values.
799 817
… …
811Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 829Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
812OpenGL buffer object. 830OpenGL buffer object.
813 831
814http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 832http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
815 833
834=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
835
836Creates a new OpenCL::Image object that refers to the given OpenGL
837texture object or buffer.
838
839http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
840
816=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 841=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
817 842
818Creates a new OpenCL::Image2D object that refers to the given OpenGL 843Creates a new OpenCL::Image2D object that refers to the given OpenGL
8192D texture object. 8442D texture object.
820 845
821http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html 846http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
822 847
823=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture) 848=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
824 849
825Creates a new OpenCL::Image3D object that refers to the given OpenGL 850Creates a new OpenCL::Image3D object that refers to the given OpenGL
8263D texture object. 8513D texture object.
827 852
828http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html 853http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
… …
891for completion, unless the method is called in void context, in which case 916for completion, unless the method is called in void context, in which case
892no event object is created. 917no event object is created.
893 918
894They also allow you to specify any number of other event objects that this 919They also allow you to specify any number of other event objects that this
895request has to wait for before it starts executing, by simply passing the 920request has to wait for before it starts executing, by simply passing the
896event objects as extra parameters to the enqueue methods. 921event objects as extra parameters to the enqueue methods. To simplify
922program design, this module ignores any C<undef> values in the list of
923events. This makes it possible to code operations such as this, without
924having to put a valid event object into C<$event> first:
925
926 $event = $queue->enqueue_xxx (..., $event);
897 927
898Queues execute in-order by default, without any parallelism, so in most 928Queues execute in-order by default, without any parallelism, so in most
899cases (i.e. you use only one queue) it's not necessary to wait for or 929cases (i.e. you use only one queue) it's not necessary to wait for or
900create event objects. 930create event objects, althoguh an our of order queue is often a bit
931faster.
901 932
902=over 4 933=over 4
903 934
904=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 935=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
905 936
… …
971reference to an array of local work sizes, with the same number of 1002reference to an array of local work sizes, with the same number of
972elements as @$global_work_size. 1003elements as @$global_work_size.
973 1004
974L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1005L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
975 1006
976=item $ev = $queue->enqueue_marker ($wait_events...)
977
978L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
979
980=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...) 1007=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
981 1008
982Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1009Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
983for subsequent OpenCL usage. 1010for subsequent OpenCL usage.
984 1011
… …
993 1020
994=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1021=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
995 1022
996L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1023L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
997 1024
998=item $queue->enqueue_barrier 1025=item $ev = $queue->enqueue_marker ($wait_events...)
999 1026
1027L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1028
1029=item $ev = $queue->enqueue_barrier ($wait_events...)
1030
1000L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1031L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1001 1032
1002=item $queue->flush 1033=item $queue->flush
1003 1034
1004L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1035L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
1005 1036
… …
1120 1151
1121=back 1152=back
1122 1153
1123=head2 THE OpenCL::Image CLASS 1154=head2 THE OpenCL::Image CLASS
1124 1155
1125This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1156This is the superclass of all image objects - OpenCL::Image1D,
1157OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1158OpenCL::Image2DArray and OpenCL::Image3D.
1126 1159
1127=over 4 1160=over 4
1128 1161
1129=item $packed_value = $ev->image_info ($name) 1162=item $packed_value = $ev->image_info ($name)
1130 1163
… …
1234 1267
1235Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1268Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1236the program. 1269the program.
1237 1270
1238L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1271L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1272
1273=item @kernels = $program->kernels_in_program
1274
1275Returns all kernels successfully compiled for all devices in program.
1276
1277http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1239 1278
1240=for gengetinfo begin program_build 1279=for gengetinfo begin program_build
1241 1280
1242=item $build_status = $program->build_status ($device) 1281=item $build_status = $program->build_status ($device)
1243 1282
… …
1379float and double as floating point values, memory/buffer/image2d/image3d 1418float and double as floating point values, memory/buffer/image2d/image3d
1380must be an object of that type or C<undef>, local-memory arguments are 1419must be an object of that type or C<undef>, local-memory arguments are
1381set by specifying the size, and sampler and event must be objects of that 1420set by specifying the size, and sampler and event must be objects of that
1382type. 1421type.
1383 1422
1423Setting an argument for a kernel does NOT keep a reference to the object -
1424for example, if you set an argument to some image object, free the image,
1425and call the kernel, you will run into undefined behaviour.
1426
1384L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1427L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1385 1428
1386=back 1429=back
1387 1430
1388=head2 THE OpenCL::Event CLASS 1431=head2 THE OpenCL::Event CLASS
… …
1481 our $VERSION = '0.96'; 1524 our $VERSION = '0.96';
1482 1525
1483 require XSLoader; 1526 require XSLoader;
1484 XSLoader::load (__PACKAGE__, $VERSION); 1527 XSLoader::load (__PACKAGE__, $VERSION);
1485 1528
1486 @OpenCL::Buffer::ISA = 1529 @OpenCL::Buffer::ISA =
1487 @OpenCL::Image::ISA = OpenCL::Memory::; 1530 @OpenCL::Image::ISA = OpenCL::Memory::;
1488 1531
1489 @OpenCL::BufferObj::ISA = OpenCL::Buffer::; 1532 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1490 1533
1491 @OpenCL::Image2D::ISA = 1534 @OpenCL::Image2D::ISA =
1535 @OpenCL::Image3D::ISA =
1536 @OpenCL::Image2DArray::ISA =
1537 @OpenCL::Image1D::ISA =
1538 @OpenCL::Image1DArray::ISA =
1492 @OpenCL::Image3D::ISA = OpenCL::Image::; 1539 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
1493 1540
1494 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1541 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1495} 1542}
1496 1543
14971; 15441;
1498 1545
1499=head1 AUTHOR 1546=head1 AUTHOR

Diff Legend

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