[ViewVC] Diff of: cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.65 by root, Mon Apr 30 23:35:16 2012 UTC vs.
Revision 1.66 by root, Tue May 1 16:37:23 2012 UTC

…		…
305	glXSwapBuffers;	305	glXSwapBuffers;
306		306
307	select undef, undef, undef, 1/60;	307	select undef, undef, undef, 1/60;
308	}	308	}
309		309
310	=item How to modify the previous example to not rely on GL sharing.	310	=head2 How to modify the previous example to not rely on GL sharing.
311		311
312	For those poor souls with only a sucky CPU OpenCL implementation, you	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	313	currently have to read the image into some perl scalar, and then modify a
314	texture or use glDrawPixels or so).	314	texture or use glDrawPixels or so).
315		315
…		…
557	@OpenCL::Image1D::ISA =	557	@OpenCL::Image1D::ISA =
558	@OpenCL::Image1DArray::ISA =	558	@OpenCL::Image1DArray::ISA =
559	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	559	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
560		560
561	@OpenCL::UserEvent::ISA = OpenCL::Event::;	561	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		562
		563	@OpenCL::MappedBuffer =
		564	@OpenCL::MappedImage = OpenCL::Mapped::;
562	}	565	}
563		566
564	=head2 THE OpenCL PACKAGE	567	=head2 THE OpenCL PACKAGE
565		568
566	=over 4	569	=over 4
…		…
1362	=item $command_queue_properties = $command_queue->properties	1365	=item $command_queue_properties = $command_queue->properties
1363		1366
1364	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.
1365		1368
1366	=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.
1367		1414
1368	=back	1415	=back
1369		1416
1370	=head2 THE OpenCL::Memory CLASS	1417	=head2 THE OpenCL::Memory CLASS
1371		1418
…		…
1915		1962
1916	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>
1917		1964
1918	=back	1965	=back
1919		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	Example, replace the first two floats in the mapped buffer by 1 and 2.
		1983
		1984	my $mapped = $queue->map_buffer ($buf, ...
		1985	$mapped->event->wait; # make sure it's there
		1986
		1987	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		1988	# we blindly assume device endianness to equal host endianness
		1989	# (and of course, we assume iee 754 single precision floats :)
		1990	substr $$mapped, 0, 8, pack "f*", 1, 2;
		1991
		1992	=over 4
		1993
		1994	=item $bool = $mapped->mapped
		1995
		1996	Returns whether the object is still mapped - true before an C<unmap> is
		1997	enqueued, false afterwards.
		1998
		1999	=item $ev = $mapped->event
		2000
		2001	Return the event object associated with the mapped object. Initially, this
		2002	will be the event object created when mapping the object, and after an
		2003	unmap, this will be the event object that the unmap operation created.
		2004
		2005	=item $mapped->wait
		2006
		2007	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2008	mapped object are outstanding.
		2009
		2010	=item $bytes = $mapped->size
		2011
		2012	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2013
		2014	=item $ptr = $mapped->ptr
		2015
		2016	Returns the raw memory address of the mapped area - same as C<$mapped+0>.
		2017
		2018	=back
		2019
		2020	=head2 THE OpenCL::MappedBuffer CLASS
		2021
		2022	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2023
		2024	=over 4
		2025
		2026	=back
		2027
		2028	=head2 THE OpenCL::MappedImage CLASS
		2029
		2030	This is a subclass of OpenCL::Mapped, representing mapped images.
		2031
		2032	=over 4
		2033
		2034	=back
		2035
		2036
1920	=cut	2037	=cut
1921		2038
1922	1;	2039	1;
1923		2040
1924	=head1 AUTHOR	2041	=head1 AUTHOR

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.65 by root, Mon Apr 30 23:35:16 2012 UTC vs. Revision 1.66 by root, Tue May 1 16:37:23 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.65 by root, Mon Apr 30 23:35:16 2012 UTC vs.
Revision 1.66 by root, Tue May 1 16:37:23 2012 UTC