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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.72 by root, Fri May 4 14:49:42 2012 UTC vs.
Revision 1.85 by root, Sat May 5 16:52:17 2012 UTC

…		…
28	specific device ("compiling and linking"), also binary programs. For each	28	specific device ("compiling and linking"), also binary programs. For each
29	kernel function in a program you can then create an OpenCL::Kernel object	29	kernel function in a program you can then create an OpenCL::Kernel object
30	which represents basically a function call with argument values.	30	which represents basically a function call with argument values.
31		31
32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat	32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2D
34	or 3d array) for bulk data and input and output for kernels.	34	or 3D array) for bulk data and input and output for kernels.
35		35
36	OpenCL::Sampler objects, which are kind of like texture filter modes in	36	OpenCL::Sampler objects, which are kind of like texture filter modes in
37	OpenGL.	37	OpenGL.
38		38
39	OpenCL::Queue objects - command queues, which allow you to submit memory	39	OpenCL::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
216	set flight effect.	216	set flight effect.
217		217
218	This is quite a long example to get you going - you can download it from	218	This is quite a long example to get you going - you can also download it
219	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.	219	from 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
390	context, no event is created. In all other contexts an event is returned	390	context, no event is created. In all other contexts an event is returned
391	by the method.	391	by 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
394	other status is returned the function will throw an exception, so you	394	other status is returned the function will throw an exception, so you
395	don't normally have to to any error checking.	395	don't normally have to to any error checking.
396		396
397	=back	397	=back
		398
		399	=head2 CONSTANTS
		400
		401	All C<CL_xxx> constants that this module supports are always available
		402	in the C<OpenCL> namespace as C<OpenCL::xxx> (i.e. without the C<CL_>
		403	prefix). Constants which are not defined in the header files used during
		404	compilation, or otherwise are not available, will have the value C<-1>.
		405
		406	The latest version of this module knows and exports the constants
		407	listed in L<http://cvs.schmorp.de/OpenCL/constiv.h>.
		408
		409	=head2 OPENCL 1.1 VS. OPENCL 1.2
		410
		411	This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
		412	1.2 interface hasn't been tested much for lack of availability of an
		413	actual implementation.
		414
		415	Every function or method in this manual page that interfaces to a
		416	particular OpenCL function has a link to the its C manual page.
		417
		418	If the link contains a F<1.1>, then this function is an OpenCL 1.1
		419	function. Most but not all also exist in OpenCL 1.2, and this module
		420	tries to emulate the missing ones for you, when told to do so at
		421	compiletime. You can check whether a function was removed in OpenCL 1.2 by
		422	replacing the F<1.1> component in the URL by F<1.2>.
		423
		424	If the link contains a F<1.2>, then this is a OpenCL 1.2-only
		425	function. Even if the module was compiled with OpenCL 1.2 header files
		426	and has an 1.2 OpenCL library, calling such a function on a platform that
		427	doesn't implement 1.2 causes undefined behaviour, usually a crash (But
		428	this is not guaranteed).
		429
		430	You can find out whether this module was compiled to prefer 1.1
		431	functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
		432	1.1 functions generally are implemented using 1.1 OpenCL functions. If it
		433	is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
		434	fucntions.
		435
		436	This is a somewhat sorry state of affairs, but the Khronos group choose to
		437	make every release of OpenCL source and binary incompatible with previous
		438	releases.
398		439
399	=head2 PERL AND OPENCL TYPES	440	=head2 PERL AND OPENCL TYPES
400		441
401	This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack	442	This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
402	format equivalents:	443	format equivalents:
…		…
434	OpenCL can generate a number of (potentially) asynchronous events, for	475	OpenCL can generate a number of (potentially) asynchronous events, for
435	example, after compiling a program, to signal a context-related error or,	476	example, after compiling a program, to signal a context-related error or,
436	perhaps most important, to signal completion of queued jobs (by setting	477	perhaps most important, to signal completion of queued jobs (by setting
437	callbacks on OpenCL::Event objects).	478	callbacks on OpenCL::Event objects).
438		479
		480	The OpenCL module converts all these callbacks into events - you can
		481	still register callbacks, but they are not executed when your OpenCL
		482	implementation calls the actual callback, but only later. Therefore, none
		483	of the limitations of OpenCL callbacks apply to the perl implementation:
		484	it is perfectly safe to make blocking operations from event callbacks, and
		485	enqueued operations don't need to be flushed.
		486
439	To facilitate this, this module maintains an event queue - each	487	To facilitate this, this module maintains an event queue - each
440	time an asynchronous event happens, it is queued, and perl will be	488	time an asynchronous event happens, it is queued, and perl will be
441	interrupted. This is implemented via the L<Async::Interrupt> module. In	489	interrupted. This is implemented via the L<Async::Interrupt> module. In
442	addition, this module has L<AnyEvent> support, so it can seamlessly	490	addition, this module has L<AnyEvent> support, so it can seamlessly
443	integrate itself into many event loops.	491	integrate itself into many event loops.
444		492
445	Since this module is a bit hard to understand, here are some case examples:	493	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
446		494
447	=head3 Don't use callbacks.	495	=head3 Don't use callbacks.
448		496
449	When your program never uses any callbacks, then there will never be any	497	When your program never uses any callbacks, then there will never be any
450	notifications you need to take care of, and therefore no need to worry	498	notifications you need to take care of, and therefore no need to worry
…		…
547	use Async::Interrupt ();	595	use Async::Interrupt ();
548		596
549	our $POLL_FUNC; # set by XS	597	our $POLL_FUNC; # set by XS
550		598
551	BEGIN {	599	BEGIN {
552	our $VERSION = '0.99';	600	our $VERSION = '1.0';
553		601
554	require XSLoader;	602	require XSLoader;
555	XSLoader::load (__PACKAGE__, $VERSION);	603	XSLoader::load (__PACKAGE__, $VERSION);
556		604
557	@OpenCL::Platform::ISA =	605	@OpenCL::Platform::ISA =
…		…
593	The last error returned by a function - it's only valid after an error occured	641	The last error returned by a function - it's only valid after an error occured
594	and before calling another OpenCL function.	642	and before calling another OpenCL function.
595		643
596	=item $str = OpenCL::err2str [$errval]	644	=item $str = OpenCL::err2str [$errval]
597		645
598	Converts an error value into a human readable string. IF no error value is	646	Converts an error value into a human readable string. If no error value is
599	given, then the last error will be used (as returned by OpenCL::errno).	647	given, then the last error will be used (as returned by OpenCL::errno).
		648
		649	The latest version of this module knows the error constants
		650	listed in L<http://cvs.schmorp.de/OpenCL/errstr.h>.
600		651
601	=item $str = OpenCL::enum2str $enum	652	=item $str = OpenCL::enum2str $enum
602		653
603	Converts most enum values (of parameter names, image format constants,	654	Converts most enum values (of parameter names, image format constants,
604	object types, addressing and filter modes, command types etc.) into a	655	object types, addressing and filter modes, command types etc.) into a
605	human readable string. When confronted with some random integer it can be	656	human readable string. When confronted with some random integer it can be
606	very helpful to pass it through this function to maybe get some readable	657	very helpful to pass it through this function to maybe get some readable
607	string out of it.	658	string out of it.
608		659
		660	The latest version of this module knows the enumaration constants
		661	listed in L<http://cvs.schmorp.de/OpenCL/enumstr.h>.
		662
609	=item @platforms = OpenCL::platforms	663	=item @platforms = OpenCL::platforms
610		664
611	Returns all available OpenCL::Platform objects.	665	Returns all available OpenCL::Platform objects.
612		666
613	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	667	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
614		668
615	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	669	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
616		670
617	Tries to create a context from a default device and platform type - never worked for me.	671	Tries to create a context from a default device and platform type - never worked for me.
		672	Consider using C<< $platform->context_from_type >> instead.
618		673
619	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,	674	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
620	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.	675	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
621		676
622	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	677	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
623		678
624	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	679	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
625		680
626	Create a new OpenCL::Context object using the given device object(s). This	681	Create a new OpenCL::Context object using the given device object(s).
627	function isn't implemented yet, use C<< $platform->context >> instead.	682	Consider using C<< $platform->context >> instead.
628		683
629	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	684	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
630		685
631	=item OpenCL::wait_for_events $wait_events...	686	=item OpenCL::wait_for_events $wait_events...
632		687
…		…
713	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	768	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
714		769
715	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)	770	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
716		771
717	Create a new OpenCL::Context object using the given device object(s)- a	772	Create a new OpenCL::Context object using the given device object(s)- a
718	CL_CONTEXT_PLATFORM property is supplied automatically.	773	OpenCL::CONTEXT_PLATFORM property is supplied automatically.
719		774
720	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	775	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
721		776
722	=item $packed_value = $platform->info ($name)	777	=item $packed_value = $platform->info ($name)
723		778
…		…
768	=over 4	823	=over 4
769		824
770	=item $packed_value = $device->info ($name)	825	=item $packed_value = $device->info ($name)
771		826
772	See C<< $platform->info >> for details.	827	See C<< $platform->info >> for details.
		828
		829	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
		830	OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
		831	OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
		832
		833	fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
		834	OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
		835	OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
		836
		837	mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
		838
		839	local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
		840
		841	exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
		842
		843	command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
		844	OpenCL::QUEUE_PROFILING_ENABLE.
		845
		846	partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
		847	OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
		848	OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
		849
		850	affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
		851	OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
		852	OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
		853	OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
773		854
774	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	855	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
775		856
776	=item @devices = $device->sub_devices (\@properties)	857	=item @devices = $device->sub_devices (\@properties)
777		858
…		…
1157	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,	1238	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1158	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,	1239	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1159	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,	1240	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1160	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.	1241	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1161		1242
1162
1163	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,	1243	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1164	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,	1244	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1165	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,	1245	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1166	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.	1246	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1167		1247
…		…
1264		1344
1265	Creates a new OpenCL::Program object from the given built-in kernel names.	1345	Creates a new OpenCL::Program object from the given built-in kernel names.
1266		1346
1267	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>	1347	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
1268		1348
		1349	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1350
		1351	Links all (already compiled) program objects specified in C<@programs>
		1352	together and returns a new OpenCL::Program object with the result.
		1353
		1354	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1355
1269	=item $packed_value = $ctx->info ($name)	1356	=item $packed_value = $ctx->info ($name)
1270		1357
1271	See C<< $platform->info >> for details.	1358	See C<< $platform->info >> for details.
1272		1359
1273	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1360	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
…		…
1335		1422
1336	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1423	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1337		1424
1338	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1425	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1339		1426
1340	=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...)	1427	$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...)
1341		1428
1342	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1429	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1343		1430
1344	=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...)	1431	=item $ev = $queue->write_buffer_rect ($buf, $blocking, $buf_y, $host_x, $host_z, $height, $buf_row_pitch, $host_row_pitch, $data, $wait_events...)
1345		1432
1346	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1433	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1347		1434
1348	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)	1435	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1349		1436
…		…
1533	it. You are not necessarily meant to do it this way, this example just	1620	it. You are not necessarily meant to do it this way, this example just
1534	shows you the accessors to use :)	1621	shows you the accessors to use :)
1535		1622
1536	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);	1623	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
1537		1624
1538	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)	1625	$mapped->write ($_ * $mapped->row_pitch, pack "C", 5)
1539	for 0..$image->height;	1626	for 0 .. $mapped->height - 1;
1540		1627
1541	$mapped->unmap;.	1628	$mapped->unmap;.
1542	$mapped->wait; # only needed for out of order queues normally	1629	$mapped->wait; # only needed for out of order queues normally
1543		1630
1544	=item $ev = $queue->unmap ($mapped, $wait_events...)	1631	=item $ev = $queue->unmap ($mapped, $wait_events...)
…		…
1564		1651
1565	See C<< $platform->info >> for details.	1652	See C<< $platform->info >> for details.
1566		1653
1567	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1654	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
1568		1655
		1656	=item $memory->destructor_callback ($cb->())
		1657
		1658	Sets a callback that will be invoked after the memory object is destructed.
		1659
		1660	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetMemObjectDestructorCallback.html>
		1661
1569	=for gengetinfo begin mem	1662	=for gengetinfo begin mem
1570		1663
1571	=item $mem_object_type = $mem->type	1664	=item $mem_object_type = $mem->type
1572		1665
1573	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.	1666	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
…		…
1630	=over 4	1723	=over 4
1631		1724
1632	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)	1725	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1633		1726
1634	Creates an OpenCL::Buffer objects from this buffer and returns it. The	1727	Creates an OpenCL::Buffer objects from this buffer and returns it. The
1635	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.	1728	C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1636		1729
1637	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>	1730	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1638		1731
1639	=back	1732	=back
1640		1733
…		…
1656	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1749	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1657		1750
1658	=item ($channel_order, $channel_data_type) = $image->format	1751	=item ($channel_order, $channel_data_type) = $image->format
1659		1752
1660	Returns the channel order and type used to create the image by calling	1753	Returns the channel order and type used to create the image by calling
1661	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.	1754	C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1662		1755
1663	=for gengetinfo begin image	1756	=for gengetinfo begin image
1664		1757
1665	=item $int = $image->element_size	1758	=item $int = $image->element_size
1666		1759
…		…
1766	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,	1859	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1767	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,	1860	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1768	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,	1861	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1769	C<-create-library>, C<-enable-link-options>.	1862	C<-create-library>, C<-enable-link-options>.
1770		1863
		1864	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1865	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1866
1771	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1867	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1772		1868
1773	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1869	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1774		1870
1775	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1871	Similar to C<< ->build >>, except it starts a thread, and never fails (you
1776	need to check the compilation status form the callback, or by polling).	1872	need to check the compilation status form the callback, or by polling).
1777		1873
1778	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,	1874	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1779	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.	1875
		1876	Compiles the given program for the given devices (or all devices if
		1877	undef). If C<$headers> is given, it must be a hashref with include name =>
		1878	OpenCL::Program pairs.
		1879
		1880	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1780		1881
1781	=item $packed_value = $program->build_info ($device, $name)	1882	=item $packed_value = $program->build_info ($device, $name)
1782		1883
1783	Similar to C<< $platform->info >>, but returns build info for a previous	1884	Similar to C<< $platform->info >>, but returns build info for a previous
1784	build attempt for the given device.	1885	build attempt for the given device.
1785		1886
		1887	binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
		1888	OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
		1889	OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
		1890	OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
		1891
1786	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>	1892	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1787		1893
1788	=item $kernel = $program->kernel ($function_name)	1894	=item $kernel = $program->kernel ($function_name)
1789		1895
1790	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1896	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
…		…
1809	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.	1915	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1810		1916
1811	=item $string = $program->build_log ($device)	1917	=item $string = $program->build_log ($device)
1812		1918
1813	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.	1919	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
		1920
		1921	=item $binary_type = $program->binary_type ($device)
		1922
		1923	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1814		1924
1815	=for gengetinfo end program_build	1925	=for gengetinfo end program_build
1816		1926
1817	=item $packed_value = $program->info ($name)	1927	=item $packed_value = $program->info ($name)
1818		1928
…		…
1897		2007
1898	=item $packed_value = $kernel->work_group_info ($device, $name)	2008	=item $packed_value = $kernel->work_group_info ($device, $name)
1899		2009
1900	See C<< $platform->info >> for details.	2010	See C<< $platform->info >> for details.
1901		2011
1902	The reason this method is not called C<info> is that there already is an
1903	C<< ->info >> method.
1904
1905	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	2012	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1906		2013
1907	=for gengetinfo begin kernel_work_group	2014	=for gengetinfo begin kernel_work_group
1908		2015
1909	=item $int = $kernel->work_group_size ($device)	2016	=item $int = $kernel->work_group_size ($device)
…		…
1926		2033
1927	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.	2034	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1928		2035
1929	=for gengetinfo end kernel_work_group	2036	=for gengetinfo end kernel_work_group
1930		2037
		2038	=item $packed_value = $kernel->arg_info ($idx, $name)
		2039
		2040	See C<< $platform->info >> for details.
		2041
		2042	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		2043
1931	=for gengetinfo begin kernel_arg_info	2044	=for gengetinfo begin kernel_arg
1932		2045
		2046	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		2047
		2048	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		2049
		2050	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		2051
		2052	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		2053
		2054	=item $string = $kernel->arg_type_name ($idx)
		2055
		2056	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		2057
		2058	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		2059
		2060	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		2061
		2062	=item $string = $kernel->arg_name ($idx)
		2063
		2064	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		2065
1933	=for gengetinfo end kernel_arg_info	2066	=for gengetinfo end kernel_arg
1934		2067
1935	=item $kernel->setf ($format, ...)	2068	=item $kernel->setf ($format, ...)
1936		2069
1937	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic	2070	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1938	way to set arguments (and with OpenCL 1.2 it might be rather slow), you	2071	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
…		…
2210		2343
2211	This is a subclass of OpenCL::Mapped, representing mapped images.	2344	This is a subclass of OpenCL::Mapped, representing mapped images.
2212		2345
2213	=over 4	2346	=over 4
2214		2347
		2348	=item $pixels = $mapped->width
		2349
		2350	=item $pixels = $mapped->height
		2351
		2352	=item $pixels = $mapped->depth
		2353
		2354	Return the width/height/depth of the mapped image region, in pixels.
		2355
2215	=item $bytes = $mapped->row_pitch	2356	=item $bytes = $mapped->row_pitch
2216		2357
2217	=item $bytes = $mapped->slice_pitch	2358	=item $bytes = $mapped->slice_pitch
2218		2359
2219	Return the row or slice pitch of the image that has been mapped.	2360	Return the row or slice pitch of the image that has been mapped.
2220		2361
		2362	=item $bytes = $mapped->element_size
		2363
		2364	Return the size of a single pixel.
		2365
		2366	=item $data = $mapped->get_row ($count, $x=0, $y=0, $z=0)
		2367
		2368	Return C<$count> pixels from the given coordinates. The pixel data must
		2369	be completely contained within a single row.
		2370
		2371	If C<$count> is C<undef>, then all the remaining pixels in that row are
		2372	returned.
		2373
		2374	=item $mapped->set_row ($data, $x=0, $y=0, $z=0)
		2375
		2376	Write the given pixel data at the given coordinate. The pixel data must
		2377	be completely contained within a single row.
		2378
2221	=back	2379	=back
2222
2223		2380
2224	=cut	2381	=cut
2225		2382
2226	1;	2383	1;
2227		2384

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.72 by root, Fri May 4 14:49:42 2012 UTC vs. Revision 1.85 by root, Sat May 5 16:52:17 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.72 by root, Fri May 4 14:49:42 2012 UTC vs.
Revision 1.85 by root, Sat May 5 16:52:17 2012 UTC