… | |
… | |
304 | |
304 | |
305 | glXSwapBuffers; |
305 | glXSwapBuffers; |
306 | |
306 | |
307 | select undef, undef, undef, 1/60; |
307 | select undef, undef, undef, 1/60; |
308 | } |
308 | } |
|
|
309 | |
|
|
310 | =head2 How to modify the previous example to not rely on GL sharing. |
|
|
311 | |
|
|
312 | For those poor souls with only a sucky CPU OpenCL implementation, you |
|
|
313 | currently have to read the image into some perl scalar, and then modify a |
|
|
314 | texture or use glDrawPixels or so). |
|
|
315 | |
|
|
316 | First, when you don't need gl sharing, you can create the context much simpler: |
|
|
317 | |
|
|
318 | $ctx = $platform->context (undef, [$dev]) |
|
|
319 | |
|
|
320 | 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 | |
|
|
323 | my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S); |
|
|
324 | |
|
|
325 | And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you |
|
|
326 | would read the image2d after the kernel has written it: |
|
|
327 | |
|
|
328 | $queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data); |
|
|
329 | |
|
|
330 | And then you would upload the pixel data to the texture (or use glDrawPixels): |
|
|
331 | |
|
|
332 | glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data; |
|
|
333 | |
|
|
334 | The fully modified example can be found at |
|
|
335 | L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>. |
309 | |
336 | |
310 | =head1 DOCUMENTATION |
337 | =head1 DOCUMENTATION |
311 | |
338 | |
312 | =head2 BASIC CONVENTIONS |
339 | =head2 BASIC CONVENTIONS |
313 | |
340 | |
… | |
… | |
530 | @OpenCL::Image1D::ISA = |
557 | @OpenCL::Image1D::ISA = |
531 | @OpenCL::Image1DArray::ISA = |
558 | @OpenCL::Image1DArray::ISA = |
532 | @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; |
559 | @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; |
533 | |
560 | |
534 | @OpenCL::UserEvent::ISA = OpenCL::Event::; |
561 | @OpenCL::UserEvent::ISA = OpenCL::Event::; |
|
|
562 | |
|
|
563 | @OpenCL::MappedBuffer::ISA = |
|
|
564 | @OpenCL::MappedImage::ISA = OpenCL::Mapped::; |
535 | } |
565 | } |
536 | |
566 | |
537 | =head2 THE OpenCL PACKAGE |
567 | =head2 THE OpenCL PACKAGE |
538 | |
568 | |
539 | =over 4 |
569 | =over 4 |
… | |
… | |
1207 | |
1237 | |
1208 | =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...) |
1238 | =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...) |
1209 | |
1239 | |
1210 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html |
1240 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html |
1211 | |
1241 | |
|
|
1242 | =item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) |
|
|
1243 | |
|
|
1244 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html> |
|
|
1245 | |
1212 | =item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
1246 | =item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
1213 | |
1247 | |
1214 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> |
1248 | C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL |
1215 | |
1249 | module uses the image width (and height) to supply default values. |
1216 | =item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) |
|
|
1217 | |
1250 | |
1218 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> |
1251 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> |
1219 | |
1252 | |
1220 | =item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
1253 | =item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
1221 | |
1254 | |
|
|
1255 | C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL |
|
|
1256 | module uses the image width (and height) to supply default values. |
1222 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> |
1257 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> |
1223 | |
1258 | |
1224 | =item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) |
1259 | =item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) |
1225 | |
1260 | |
1226 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> |
1261 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> |
… | |
… | |
1330 | =item $command_queue_properties = $command_queue->properties |
1365 | =item $command_queue_properties = $command_queue->properties |
1331 | |
1366 | |
1332 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. |
1367 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. |
1333 | |
1368 | |
1334 | =for gengetinfo end command_queue |
1369 | =for gengetinfo end command_queue |
|
|
1370 | |
|
|
1371 | =back |
|
|
1372 | |
|
|
1373 | =head3 MEMORY MAPPED BUFFERS |
|
|
1374 | |
|
|
1375 | 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 |
|
|
1377 | a map or unmap operation on the command queue. |
|
|
1378 | |
|
|
1379 | The map operations return a C<OpenCL::Mapped> object - see L<THE |
|
|
1380 | OpenCL::Mapped CLASS> section for details on what to do with these |
|
|
1381 | objects. |
|
|
1382 | |
|
|
1383 | 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, |
|
|
1385 | before using the buffer in a kernel), but you can also enqueue an unmap |
|
|
1386 | operation manually. |
|
|
1387 | |
|
|
1388 | =over 4 |
|
|
1389 | |
|
|
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...) |
|
|
1391 | |
|
|
1392 | Maps the given buffer into host memory and returns a C<OpenCL::MappedBuffer> object. |
|
|
1393 | |
|
|
1394 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html> |
|
|
1395 | |
|
|
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...) |
|
|
1397 | |
|
|
1398 | Maps the given image area into host memory and return a |
|
|
1399 | C<OpenCL::MappedImage> object. Although there are default values for most |
|
|
1400 | arguments, you currently have to specify all arguments, otherwise the call |
|
|
1401 | will fail. |
|
|
1402 | |
|
|
1403 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html> |
|
|
1404 | |
|
|
1405 | =item $ev = $queue->unmap ($mapped, $wait_events...) |
|
|
1406 | |
|
|
1407 | 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 |
|
|
1409 | method. |
|
|
1410 | |
|
|
1411 | The mapped event object will always be passed as part of the |
|
|
1412 | $wait_events. The mapped event object will be replaced by the new event |
|
|
1413 | object that this request creates. |
1335 | |
1414 | |
1336 | =back |
1415 | =back |
1337 | |
1416 | |
1338 | =head2 THE OpenCL::Memory CLASS |
1417 | =head2 THE OpenCL::Memory CLASS |
1339 | |
1418 | |
… | |
… | |
1883 | |
1962 | |
1884 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> |
1963 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> |
1885 | |
1964 | |
1886 | =back |
1965 | =back |
1887 | |
1966 | |
|
|
1967 | =head2 THE OpenCL::Mapped CLASS |
|
|
1968 | |
|
|
1969 | This class represents objects mapped into host memory. They are |
|
|
1970 | represented by a blessed string scalar. The string data is the mapped |
|
|
1971 | memory area, that is, if you read or write it, then the mapped object is |
|
|
1972 | accessed directly. |
|
|
1973 | |
|
|
1974 | You must only ever use operations that modify the string in-place - for |
|
|
1975 | example, a C<substr> that doesn't change the length, or maybe a regex that |
|
|
1976 | doesn't change the length. Any other operation might cause the data to be |
|
|
1977 | copied. |
|
|
1978 | |
|
|
1979 | When the object is destroyed it will enqueue an implicit unmap operation |
|
|
1980 | on the queue that was used to create it. |
|
|
1981 | |
|
|
1982 | Keep in mind that you I<need> to unmap (or destroy) mapped objects before |
|
|
1983 | OpenCL sees the changes, even if some implementations don't need this |
|
|
1984 | sometimes. |
|
|
1985 | |
|
|
1986 | Example, replace the first two floats in the mapped buffer by 1 and 2. |
|
|
1987 | |
|
|
1988 | my $mapped = $queue->map_buffer ($buf, ... |
|
|
1989 | $mapped->event->wait; # make sure it's there |
|
|
1990 | |
|
|
1991 | # now replace first 8 bytes by new data, which is exactly 8 bytes long |
|
|
1992 | # we blindly assume device endianness to equal host endianness |
|
|
1993 | # (and of course, we assume iee 754 single precision floats :) |
|
|
1994 | substr $$mapped, 0, 8, pack "f*", 1, 2; |
|
|
1995 | |
|
|
1996 | =over 4 |
|
|
1997 | |
|
|
1998 | =item $ev = $mapped->unmap ($wait_events...) |
|
|
1999 | |
|
|
2000 | Unmaps the mapped memory object, using the queue originally used to create |
|
|
2001 | it, quite similarly to C<< $queue->unmap ($mapped, ...) >>. |
|
|
2002 | |
|
|
2003 | =item $bool = $mapped->mapped |
|
|
2004 | |
|
|
2005 | Returns whether the object is still mapped - true before an C<unmap> is |
|
|
2006 | enqueued, false afterwards. |
|
|
2007 | |
|
|
2008 | =item $ev = $mapped->event |
|
|
2009 | |
|
|
2010 | Return the event object associated with the mapped object. Initially, this |
|
|
2011 | will be the event object created when mapping the object, and after an |
|
|
2012 | unmap, this will be the event object that the unmap operation created. |
|
|
2013 | |
|
|
2014 | =item $mapped->wait |
|
|
2015 | |
|
|
2016 | Same as C<< $mapped->event->wait >> - makes sure no operations on this |
|
|
2017 | mapped object are outstanding. |
|
|
2018 | |
|
|
2019 | =item $bytes = $mapped->size |
|
|
2020 | |
|
|
2021 | Returns the size of the mapped area, in bytes. Same as C<length $$mapped>. |
|
|
2022 | |
|
|
2023 | =item $ptr = $mapped->ptr |
|
|
2024 | |
|
|
2025 | Returns the raw memory address of the mapped area - same as C<$mapped+0>. |
|
|
2026 | |
|
|
2027 | =item $mapped->set ($offset, $data) |
|
|
2028 | |
|
|
2029 | Replaces the data at the given C<$offset> in the memory area by the new |
|
|
2030 | C<$data>. This method is safer but slower than direct manipulation of |
|
|
2031 | C<$$mapped> with substr. |
|
|
2032 | |
|
|
2033 | =item $data = $mapped->get ($offset, $length) |
|
|
2034 | |
|
|
2035 | Returns (without copying) a scalar representing the data at the given |
|
|
2036 | C<$offset> and C<$length> in the mapped memory area. This is the same as |
|
|
2037 | the following substr, except much slower: |
|
|
2038 | |
|
|
2039 | $data = substr $$mapped, $offset, $length |
|
|
2040 | |
|
|
2041 | #TODO: really? |
|
|
2042 | |
|
|
2043 | =cut |
|
|
2044 | |
|
|
2045 | sub get { |
|
|
2046 | substr ${$_[0]}, $_[1], $_[2] |
|
|
2047 | } |
|
|
2048 | |
|
|
2049 | =back |
|
|
2050 | |
|
|
2051 | =head2 THE OpenCL::MappedBuffer CLASS |
|
|
2052 | |
|
|
2053 | This is a subclass of OpenCL::Mapped, representing mapped buffers. |
|
|
2054 | |
|
|
2055 | =head2 THE OpenCL::MappedImage CLASS |
|
|
2056 | |
|
|
2057 | This is a subclass of OpenCL::Mapped, representing mapped images. |
|
|
2058 | |
|
|
2059 | =over 4 |
|
|
2060 | |
|
|
2061 | =item $bytes = $mapped->row_pitch |
|
|
2062 | |
|
|
2063 | =item $bytes = $mapped->slice_pitch |
|
|
2064 | |
|
|
2065 | Return the row or slice pitch of the image that has been mapped. |
|
|
2066 | |
|
|
2067 | =back |
|
|
2068 | |
|
|
2069 | |
1888 | =cut |
2070 | =cut |
1889 | |
2071 | |
1890 | 1; |
2072 | 1; |
1891 | |
2073 | |
1892 | =head1 AUTHOR |
2074 | =head1 AUTHOR |