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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.74 by root, Fri May 4 15:04:51 2012 UTC vs.
Revision 1.78 by root, Sat May 5 13:07:19 2012 UTC

…		…
96	initialised at creation time).	96	initialised at creation time).
97		97
98	Enqueue the kernel execution.	98	Enqueue the kernel execution.
99		99
100	Enqueue buffer reads for your output buffer to read results.	100	Enqueue buffer reads for your output buffer to read results.
		101
		102	=head1 OPENCL 1.1 VS. OPENCL 1.2
		103
		104	This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
		105	1.2 interface hasn't been tested much for lack of availability of an
		106	actual implementation.
		107
		108	Every function or method in this manual page that interfaces to a
		109	particular OpenCL function has a link to the its C manual page.
		110
		111	If the link contains a F<1.1>, then this function is an OpenCL 1.1
		112	function. Most but not all also exist in OpenCL 1.2, and this module
		113	tries to emulate the missing ones for you, when told to do so at
		114	compiletime. You cna check whether a function was removed in OpenCL 1.2 by
		115	replacing the F<1.1> component in the URL by F<1.2>.
		116
		117	If the link contains a F<1.2>, then this is a OpenCL 1.2-only
		118	function. Even if the module was compiled with OpenCL 1.2 header files
		119	and has an 1.2 OpenCL library, calling such a function on a platform that
		120	doesn't implement 1.2 causes undefined behaviour, usually a crash (But
		121	this is not guaranteed).
		122
		123	You can find out whether this module was compiled to prefer 1.1
		124	functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
		125	1.1 functions generally are implemented using 1.1 OpenCL functions. If it
		126	is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
		127	fucntions.
		128
		129	This is a somewhat sorry state of affairs, but the Khronos group choose to
		130	make every release of OpenCL source and binary incompatible with previous
		131	releases.
101		132
102	=head1 EXAMPLES	133	=head1 EXAMPLES
103		134
104	=head2 Enumerate all devices and get contexts for them.	135	=head2 Enumerate all devices and get contexts for them.
105		136
…		…
620	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	651	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
621		652
622	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	653	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
623		654
624	Tries to create a context from a default device and platform type - never worked for me.	655	Tries to create a context from a default device and platform type - never worked for me.
		656	Consider using C<< $platform->context_from_type >> instead.
625		657
626	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,	658	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
627	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.	659	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
628		660
629	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	661	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
630		662
631	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	663	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
632		664
633	Create a new OpenCL::Context object using the given device object(s). This	665	Create a new OpenCL::Context object using the given device object(s).
634	function isn't implemented yet, use C<< $platform->context >> instead.	666	Consider using C<< $platform->context >> instead.
635		667
636	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	668	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
637		669
638	=item OpenCL::wait_for_events $wait_events...	670	=item OpenCL::wait_for_events $wait_events...
639		671
…		…
775	=over 4	807	=over 4
776		808
777	=item $packed_value = $device->info ($name)	809	=item $packed_value = $device->info ($name)
778		810
779	See C<< $platform->info >> for details.	811	See C<< $platform->info >> for details.
		812
		813	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
		814	OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
		815	OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
		816
		817	fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
		818	OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
		819	OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
		820
		821	mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
		822
		823	local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
		824
		825	exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
		826
		827	command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
		828	OpenCL::QUEUE_PROFILING_ENABLE.
		829
		830	partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
		831	OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
		832	OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
		833
		834	affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
		835	OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
		836	OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
		837	OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
780		838
781	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	839	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
782		840
783	=item @devices = $device->sub_devices (\@properties)	841	=item @devices = $device->sub_devices (\@properties)
784		842
…		…
1164	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,	1222	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
1165	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,	1223	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
1166	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,	1224	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
1167	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.	1225	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
1168		1226
1169
1170	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,	1227	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
1171	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,	1228	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
1172	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,	1229	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
1173	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.	1230	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
1174		1231
…		…
1270	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)	1327	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
1271		1328
1272	Creates a new OpenCL::Program object from the given built-in kernel names.	1329	Creates a new OpenCL::Program object from the given built-in kernel names.
1273		1330
1274	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>	1331	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1332
		1333	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1334
		1335	Links all (already compiled) program objects specified in C<@programs>
		1336	together and returns a new OpenCL::Program object with the result.
		1337
		1338	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
1275		1339
1276	=item $packed_value = $ctx->info ($name)	1340	=item $packed_value = $ctx->info ($name)
1277		1341
1278	See C<< $platform->info >> for details.	1342	See C<< $platform->info >> for details.
1279		1343
…		…
1773	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,	1837	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
1774	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,	1838	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
1775	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,	1839	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
1776	C<-create-library>, C<-enable-link-options>.	1840	C<-create-library>, C<-enable-link-options>.
1777		1841
		1842	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1843	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1844
1778	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1845	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1779		1846
1780	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1847	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1781		1848
1782	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1849	Similar to C<< ->build >>, except it starts a thread, and never fails (you
1783	need to check the compilation status form the callback, or by polling).	1850	need to check the compilation status form the callback, or by polling).
1784		1851
1785	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,	1852	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
1786	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.	1853
		1854	Compiles the given program for the given devices (or all devices if
		1855	undef). If C<$headers> is given, it must be a hashref with include name =>
		1856	OpenCL::Program pairs.
		1857
		1858	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1787		1859
1788	=item $packed_value = $program->build_info ($device, $name)	1860	=item $packed_value = $program->build_info ($device, $name)
1789		1861
1790	Similar to C<< $platform->info >>, but returns build info for a previous	1862	Similar to C<< $platform->info >>, but returns build info for a previous
1791	build attempt for the given device.	1863	build attempt for the given device.
		1864
		1865	binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
		1866	OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
		1867	OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
		1868	OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
1792		1869
1793	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>	1870	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1794		1871
1795	=item $kernel = $program->kernel ($function_name)	1872	=item $kernel = $program->kernel ($function_name)
1796		1873

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.74 by root, Fri May 4 15:04:51 2012 UTC vs. Revision 1.78 by root, Sat May 5 13:07:19 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.74 by root, Fri May 4 15:04:51 2012 UTC vs.
Revision 1.78 by root, Sat May 5 13:07:19 2012 UTC