… | |
… | |
336 | =item * Structures are often specified by flattening out their components |
336 | =item * Structures are often specified by flattening out their components |
337 | as with short vectors, and returned as arrayrefs. |
337 | as with short vectors, and returned as arrayrefs. |
338 | |
338 | |
339 | =item * When enqueuing commands, the wait list is specified by adding |
339 | =item * When enqueuing commands, the wait list is specified by adding |
340 | extra arguments to the function - anywhere a C<$wait_events...> argument |
340 | extra arguments to the function - anywhere a C<$wait_events...> argument |
341 | is documented this can be any number of event objects. |
341 | is documented this can be any number of event objects. As an extsnion |
|
|
342 | implemented by this module, C<undef> values will be ignored in the event |
|
|
343 | list. |
342 | |
344 | |
343 | =item * When enqueuing commands, if the enqueue method is called in void |
345 | =item * When enqueuing commands, if the enqueue method is called in void |
344 | context, no event is created. In all other contexts an event is returned |
346 | context, no event is created. In all other contexts an event is returned |
345 | by the method. |
347 | by the method. |
346 | |
348 | |
… | |
… | |
748 | |
750 | |
749 | =item @device_partition_property_exts = $device->affinity_domains_ext |
751 | =item @device_partition_property_exts = $device->affinity_domains_ext |
750 | |
752 | |
751 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. |
753 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. |
752 | |
754 | |
753 | =item $uint = $device->reference_count_ext |
755 | =item $uint = $device->reference_count_ext |
754 | |
756 | |
755 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result. |
757 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. |
756 | |
758 | |
757 | =item @device_partition_property_exts = $device->partition_style_ext |
759 | =item @device_partition_property_exts = $device->partition_style_ext |
758 | |
760 | |
759 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. |
761 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. |
760 | |
762 | |
… | |
… | |
769 | =item $queue = $ctx->queue ($device, $properties) |
771 | =item $queue = $ctx->queue ($device, $properties) |
770 | |
772 | |
771 | Create a new OpenCL::Queue object from the context and the given device. |
773 | Create a new OpenCL::Queue object from the context and the given device. |
772 | |
774 | |
773 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> |
775 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> |
|
|
776 | |
|
|
777 | Example: create an out-of-order queue. |
|
|
778 | |
|
|
779 | $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE); |
774 | |
780 | |
775 | =item $ev = $ctx->user_event |
781 | =item $ev = $ctx->user_event |
776 | |
782 | |
777 | Creates a new OpenCL::UserEvent object. |
783 | Creates a new OpenCL::UserEvent object. |
778 | |
784 | |
… | |
… | |
788 | =item $buf = $ctx->buffer_sv ($flags, $data) |
794 | =item $buf = $ctx->buffer_sv ($flags, $data) |
789 | |
795 | |
790 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and |
796 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and |
791 | initialise it with the given data values. |
797 | initialise it with the given data values. |
792 | |
798 | |
|
|
799 | =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) |
|
|
800 | |
|
|
801 | Creates a new OpenCL::Image object and optionally initialises it with |
|
|
802 | the given data values. |
|
|
803 | |
|
|
804 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> |
|
|
805 | |
793 | =item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) |
806 | =item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) |
794 | |
807 | |
795 | Creates a new OpenCL::Image2D object and optionally initialises it with |
808 | Creates a new OpenCL::Image2D object and optionally initialises it with |
796 | the given data values. |
809 | the given data values. |
797 | |
810 | |
… | |
… | |
809 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given |
822 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given |
810 | OpenGL buffer object. |
823 | OpenGL buffer object. |
811 | |
824 | |
812 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html |
825 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html |
813 | |
826 | |
|
|
827 | =item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) |
|
|
828 | |
|
|
829 | Creates a new OpenCL::Image object that refers to the given OpenGL |
|
|
830 | texture object or buffer. |
|
|
831 | |
|
|
832 | http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html |
|
|
833 | |
814 | =item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) |
834 | =item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) |
815 | |
835 | |
816 | Creates a new OpenCL::Image2D object that refers to the given OpenGL |
836 | Creates a new OpenCL::Image2D object that refers to the given OpenGL |
817 | 2D texture object. |
837 | 2D texture object. |
818 | |
838 | |
819 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html |
839 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html |
820 | |
840 | |
821 | =item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture) |
841 | =item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture) |
822 | |
842 | |
823 | Creates a new OpenCL::Image3D object that refers to the given OpenGL |
843 | Creates a new OpenCL::Image3D object that refers to the given OpenGL |
824 | 3D texture object. |
844 | 3D texture object. |
825 | |
845 | |
826 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html |
846 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html |
… | |
… | |
889 | for completion, unless the method is called in void context, in which case |
909 | for completion, unless the method is called in void context, in which case |
890 | no event object is created. |
910 | no event object is created. |
891 | |
911 | |
892 | They also allow you to specify any number of other event objects that this |
912 | They also allow you to specify any number of other event objects that this |
893 | request has to wait for before it starts executing, by simply passing the |
913 | request has to wait for before it starts executing, by simply passing the |
894 | event objects as extra parameters to the enqueue methods. |
914 | event objects as extra parameters to the enqueue methods. To simplify |
|
|
915 | program design, this module ignores any C<undef> values in the list of |
|
|
916 | events. This makes it possible to code operations such as this, without |
|
|
917 | having to put a valid event object into C<$event> first: |
|
|
918 | |
|
|
919 | $event = $queue->enqueue_xxx (..., $event); |
895 | |
920 | |
896 | Queues execute in-order by default, without any parallelism, so in most |
921 | Queues execute in-order by default, without any parallelism, so in most |
897 | cases (i.e. you use only one queue) it's not necessary to wait for or |
922 | cases (i.e. you use only one queue) it's not necessary to wait for or |
898 | create event objects. |
923 | create event objects, althoguh an our of order queue is often a bit |
|
|
924 | faster. |
899 | |
925 | |
900 | =over 4 |
926 | =over 4 |
901 | |
927 | |
902 | =item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) |
928 | =item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) |
903 | |
929 | |
… | |
… | |
969 | reference to an array of local work sizes, with the same number of |
995 | reference to an array of local work sizes, with the same number of |
970 | elements as @$global_work_size. |
996 | elements as @$global_work_size. |
971 | |
997 | |
972 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> |
998 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> |
973 | |
999 | |
974 | =item $ev = $queue->enqueue_marker ($wait_events...) |
|
|
975 | |
|
|
976 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> |
|
|
977 | |
|
|
978 | =item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...) |
1000 | =item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...) |
979 | |
1001 | |
980 | Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired |
1002 | Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired |
981 | for subsequent OpenCL usage. |
1003 | for subsequent OpenCL usage. |
982 | |
1004 | |
… | |
… | |
991 | |
1013 | |
992 | =item $ev = $queue->enqueue_wait_for_events ($wait_events...) |
1014 | =item $ev = $queue->enqueue_wait_for_events ($wait_events...) |
993 | |
1015 | |
994 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> |
1016 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> |
995 | |
1017 | |
996 | =item $queue->enqueue_barrier |
1018 | =item $ev = $queue->enqueue_marker ($wait_events...) |
997 | |
1019 | |
|
|
1020 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html> |
|
|
1021 | |
|
|
1022 | =item $ev = $queue->enqueue_barrier ($wait_events...) |
|
|
1023 | |
998 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> |
1024 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html> |
999 | |
1025 | |
1000 | =item $queue->flush |
1026 | =item $queue->flush |
1001 | |
1027 | |
1002 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> |
1028 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> |
1003 | |
1029 | |
… | |
… | |
1118 | |
1144 | |
1119 | =back |
1145 | =back |
1120 | |
1146 | |
1121 | =head2 THE OpenCL::Image CLASS |
1147 | =head2 THE OpenCL::Image CLASS |
1122 | |
1148 | |
1123 | This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. |
1149 | This is the superclass of all image objects - OpenCL::Image1D, |
|
|
1150 | OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D, |
|
|
1151 | OpenCL::Image2DArray and OpenCL::Image3D. |
1124 | |
1152 | |
1125 | =over 4 |
1153 | =over 4 |
1126 | |
1154 | |
1127 | =item $packed_value = $ev->image_info ($name) |
1155 | =item $packed_value = $ev->image_info ($name) |
1128 | |
1156 | |
… | |
… | |
1479 | our $VERSION = '0.96'; |
1507 | our $VERSION = '0.96'; |
1480 | |
1508 | |
1481 | require XSLoader; |
1509 | require XSLoader; |
1482 | XSLoader::load (__PACKAGE__, $VERSION); |
1510 | XSLoader::load (__PACKAGE__, $VERSION); |
1483 | |
1511 | |
1484 | @OpenCL::Buffer::ISA = |
1512 | @OpenCL::Buffer::ISA = |
1485 | @OpenCL::Image::ISA = OpenCL::Memory::; |
1513 | @OpenCL::Image::ISA = OpenCL::Memory::; |
1486 | |
1514 | |
1487 | @OpenCL::BufferObj::ISA = OpenCL::Buffer::; |
1515 | @OpenCL::BufferObj::ISA = OpenCL::Buffer::; |
1488 | |
1516 | |
1489 | @OpenCL::Image2D::ISA = |
1517 | @OpenCL::Image2D::ISA = |
|
|
1518 | @OpenCL::Image3D::ISA = |
|
|
1519 | @OpenCL::Image2DArray::ISA = |
|
|
1520 | @OpenCL::Image1D::ISA = |
|
|
1521 | @OpenCL::Image1DArray::ISA = |
1490 | @OpenCL::Image3D::ISA = OpenCL::Image::; |
1522 | @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; |
1491 | |
1523 | |
1492 | @OpenCL::UserEvent::ISA = OpenCL::Event::; |
1524 | @OpenCL::UserEvent::ISA = OpenCL::Event::; |
1493 | } |
1525 | } |
1494 | |
1526 | |
1495 | 1; |
1527 | 1; |
1496 | |
1528 | |
1497 | =head1 AUTHOR |
1529 | =head1 AUTHOR |