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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC vs.
Revision 1.81 by root, Sat May 5 14:17:39 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
…		…
43		43
44	OpenCL::Event objects are used to signal when something is complete.	44	OpenCL::Event objects are used to signal when something is complete.
45		45
46	=head2 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
47		47
48	The OpenCL specs used to develop this module:	48	The OpenCL specs used to develop this module - download these and keept
		49	hema round, they are required reference material:
49		50
50	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf	52	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf	53	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53		54
…		…
210		211
211	# wait for the last event to complete	212	# wait for the last event to complete
212	$ev->wait;	213	$ev->wait;
213		214
214	=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
215	set tunnel effect.	216	set flight effect.
216		217
217	This is quite a long example to get you going.	218	This is quite a long example to get you going - you can also download it
		219	from L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
218		220
219	use OpenGL ":all";	221	use OpenGL ":all";
220	use OpenCL;	222	use OpenCL;
221		223
		224	my $S = $ARGV[0] \|\| 256; # window/texture size, smaller is faster
		225
222	# open a window and create a gl texture	226	# open a window and create a gl texture
223	OpenGL::glpOpenWindow width => 256, height => 256;	227	OpenGL::glpOpenWindow width => $S, height => $S;
224	my $texid = glGenTextures_p 1;	228	my $texid = glGenTextures_p 1;
225	glBindTexture GL_TEXTURE_2D, $texid;	229	glBindTexture GL_TEXTURE_2D, $texid;
226	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;	230	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
227		231
228	# find and use the first opencl device that let's us get a shared opengl context	232	# find and use the first opencl device that let's us get a shared opengl context
229	my $platform;	233	my $platform;
230	my $dev;	234	my $dev;
231	my $ctx;	235	my $ctx;
…		…
250	# now the boring opencl code	254	# now the boring opencl code
251	my $src = <<EOF;	255	my $src = <<EOF;
252	kernel void	256	kernel void
253	juliatunnel (write_only image2d_t img, float time)	257	juliatunnel (write_only image2d_t img, float time)
254	{	258	{
255	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;	259	int2 xy = (int2)(get_global_id (0), get_global_id (1));
		260	float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
256		261
257	float2 m = (float2)(1.f, p.y) / fabs (p.x);	262	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
258	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;	263	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
259		264
260	float2 z = m;	265	float2 z = m;
261	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	266	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
262		267
263	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)	268	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
264	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;	269	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
265		270
266	float3 colour = (float3)(z.x, z.y, z.x * z.y);	271	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
267	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));	272	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
268	}	273	}
269	EOF	274	EOF
270		275
271	my $prog = $ctx->build_program ($src);	276	my $prog = $ctx->build_program ($src);
272	my $kernel = $prog->kernel ("juliatunnel");	277	my $kernel = $prog->kernel ("juliatunnel");
…		…
276	for (my $time; ; ++$time) {	281	for (my $time; ; ++$time) {
277	# acquire objects from opengl	282	# acquire objects from opengl
278	$queue->acquire_gl_objects ([$tex]);	283	$queue->acquire_gl_objects ([$tex]);
279		284
280	# configure and run our kernel	285	# configure and run our kernel
281	$kernel->set_image2d (0, $tex);	286	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
282	$kernel->set_float (1, $time);
283	$queue->nd_range_kernel ($kernel, undef, [256, 256], undef);	287	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
284		288
285	# release objects to opengl again	289	# release objects to opengl again
286	$queue->release_gl_objects ([$tex]);	290	$queue->release_gl_objects ([$tex]);
287		291
288	# wait	292	# wait
…		…
302	glXSwapBuffers;	306	glXSwapBuffers;
303		307
304	select undef, undef, undef, 1/60;	308	select undef, undef, undef, 1/60;
305	}	309	}
306		310
		311	=head2 How to modify the previous example to not rely on GL sharing.
		312
		313	For those poor souls with only a sucky CPU OpenCL implementation, you
		314	currently have to read the image into some perl scalar, and then modify a
		315	texture or use glDrawPixels or so).
		316
		317	First, when you don't need gl sharing, you can create the context much simpler:
		318
		319	$ctx = $platform->context (undef, [$dev])
		320
		321	To use a texture, you would modify the above example by creating an
		322	OpenCL::Image manually instead of deriving it from a texture:
		323
		324	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
		325
		326	And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
		327	would read the image2d after the kernel has written it:
		328
		329	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
		330
		331	And then you would upload the pixel data to the texture (or use glDrawPixels):
		332
		333	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
		334
		335	The fully modified example can be found at
		336	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
		337
		338	=head2 Julia sets look soooo 80ies.
		339
		340	Then colour them differently, e.g. using orbit traps! Replace the loop and
		341	colour calculation from the previous examples by this:
		342
		343	float2 dm = (float2)(1.f, 1.f);
		344
		345	for (int i = 0; i < 25; ++i)
		346	{
		347	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		348	dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
		349	}
		350
		351	float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
		352
		353	Also try C<-10.f> instead of C<-1.f>.
		354
307	=head1 DOCUMENTATION	355	=head1 DOCUMENTATION
308		356
309	=head2 BASIC CONVENTIONS	357	=head2 BASIC CONVENTIONS
310		358
311	This is not a one-to-one C-style translation of OpenCL to Perl - instead	359	This is not a one-to-one C-style translation of OpenCL to Perl - instead
…		…
340		388
341	=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
342	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
343	by the method.	391	by the method.
344		392
345	=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
346	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
347	don't normally have to to any error checking.	395	don't normally have to to any error checking.
348		396
349	=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.
350		439
351	=head2 PERL AND OPENCL TYPES	440	=head2 PERL AND OPENCL TYPES
352		441
353	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
354	format equivalents:	443	format equivalents:
…		…
386	OpenCL can generate a number of (potentially) asynchronous events, for	475	OpenCL can generate a number of (potentially) asynchronous events, for
387	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,
388	perhaps most important, to signal completion of queued jobs (by setting	477	perhaps most important, to signal completion of queued jobs (by setting
389	callbacks on OpenCL::Event objects).	478	callbacks on OpenCL::Event objects).
390		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
391	To facilitate this, this module maintains an event queue - each	487	To facilitate this, this module maintains an event queue - each
392	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
393	interrupted. This is implemented via the L<Async::Interrupt> module. In	489	interrupted. This is implemented via the L<Async::Interrupt> module. In
394	addition, this module has L<AnyEvent> support, so it can seamlessly	490	addition, this module has L<AnyEvent> support, so it can seamlessly
395	integrate itself into many event loops.	491	integrate itself into many event loops.
396		492
397	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:
398		494
399	=head3 Don't use callbacks.	495	=head3 Don't use callbacks.
400		496
401	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
402	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
…		…
499	use Async::Interrupt ();	595	use Async::Interrupt ();
500		596
501	our $POLL_FUNC; # set by XS	597	our $POLL_FUNC; # set by XS
502		598
503	BEGIN {	599	BEGIN {
504	our $VERSION = '0.98';	600	our $VERSION = '0.99';
505		601
506	require XSLoader;	602	require XSLoader;
507	XSLoader::load (__PACKAGE__, $VERSION);	603	XSLoader::load (__PACKAGE__, $VERSION);
508		604
509	@OpenCL::Platform::ISA =	605	@OpenCL::Platform::ISA =
…		…
514	@OpenCL::Sampler::ISA =	610	@OpenCL::Sampler::ISA =
515	@OpenCL::Program::ISA =	611	@OpenCL::Program::ISA =
516	@OpenCL::Kernel::ISA =	612	@OpenCL::Kernel::ISA =
517	@OpenCL::Event::ISA = OpenCL::Object::;	613	@OpenCL::Event::ISA = OpenCL::Object::;
518		614
		615	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		616
519	@OpenCL::Buffer::ISA =	617	@OpenCL::Buffer::ISA =
520	@OpenCL::Image::ISA = OpenCL::Memory::;	618	@OpenCL::Image::ISA = OpenCL::Memory::;
521		619
522	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	620	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
523		621
…		…
527	@OpenCL::Image1D::ISA =	625	@OpenCL::Image1D::ISA =
528	@OpenCL::Image1DArray::ISA =	626	@OpenCL::Image1DArray::ISA =
529	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	627	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
530		628
531	@OpenCL::UserEvent::ISA = OpenCL::Event::;	629	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		630
		631	@OpenCL::MappedBuffer::ISA =
		632	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
532	}	633	}
533		634
534	=head2 THE OpenCL PACKAGE	635	=head2 THE OpenCL PACKAGE
535		636
536	=over 4	637	=over 4
…		…
540	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
541	and before calling another OpenCL function.	642	and before calling another OpenCL function.
542		643
543	=item $str = OpenCL::err2str [$errval]	644	=item $str = OpenCL::err2str [$errval]
544		645
545	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
546	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>.
547		651
548	=item $str = OpenCL::enum2str $enum	652	=item $str = OpenCL::enum2str $enum
549		653
550	Converts most enum values (of parameter names, image format constants,	654	Converts most enum values (of parameter names, image format constants,
551	object types, addressing and filter modes, command types etc.) into a	655	object types, addressing and filter modes, command types etc.) into a
552	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
553	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
554	string out of it.	658	string out of it.
555		659
		660	The latest version of this module knows the enumaration constants
		661	listed in L<http://cvs.schmorp.de/OpenCL/errstr.h>.
		662
556	=item @platforms = OpenCL::platforms	663	=item @platforms = OpenCL::platforms
557		664
558	Returns all available OpenCL::Platform objects.	665	Returns all available OpenCL::Platform objects.
559		666
560	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>
561		668
562	=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
563		670
564	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.
		673
		674	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		675	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
565		676
566	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>
567		678
568	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	679	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
569		680
570	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).
571	function isn't implemented yet, use C<< $platform->context >> instead.	682	Consider using C<< $platform->context >> instead.
572		683
573	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>
574		685
575	=item OpenCL::wait_for_events $wait_events...	686	=item OpenCL::wait_for_events $wait_events...
576		687
…		…
657	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>
658		769
659	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)	770	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
660		771
661	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
662	CL_CONTEXT_PLATFORM property is supplied automatically.	773	OpenCL::CONTEXT_PLATFORM property is supplied automatically.
663		774
664	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>
665		776
666	=item $packed_value = $platform->info ($name)	777	=item $packed_value = $platform->info ($name)
667		778
…		…
683		794
684	=for gengetinfo begin platform	795	=for gengetinfo begin platform
685		796
686	=item $string = $platform->profile	797	=item $string = $platform->profile
687		798
688	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	799	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
689		800
690	=item $string = $platform->version	801	=item $string = $platform->version
691		802
692	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	803	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
693		804
694	=item $string = $platform->name	805	=item $string = $platform->name
695		806
696	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	807	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
697		808
698	=item $string = $platform->vendor	809	=item $string = $platform->vendor
699		810
700	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	811	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
701		812
702	=item $string = $platform->extensions	813	=item $string = $platform->extensions
703		814
704	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	815	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
705		816
706	=for gengetinfo end platform	817	=for gengetinfo end platform
707		818
708	=back	819	=back
709		820
…		…
713		824
714	=item $packed_value = $device->info ($name)	825	=item $packed_value = $device->info ($name)
715		826
716	See C<< $platform->info >> for details.	827	See C<< $platform->info >> for details.
717		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.
		854
718	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>
719		856
		857	=item @devices = $device->sub_devices (\@properties)
		858
		859	Creates OpencL::SubDevice objects by partitioning an existing device.
		860
		861	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		862
720	=for gengetinfo begin device	863	=for gengetinfo begin device
721		864
722	=item $device_type = $device->type	865	=item $device_type = $device->type
723		866
724	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	867	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
725		868
726	=item $uint = $device->vendor_id	869	=item $uint = $device->vendor_id
727		870
728	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	871	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
729		872
730	=item $uint = $device->max_compute_units	873	=item $uint = $device->max_compute_units
731		874
732	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	875	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
733		876
734	=item $uint = $device->max_work_item_dimensions	877	=item $uint = $device->max_work_item_dimensions
735		878
736	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	879	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
737		880
738	=item $int = $device->max_work_group_size	881	=item $int = $device->max_work_group_size
739		882
740	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	883	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
741		884
742	=item @ints = $device->max_work_item_sizes	885	=item @ints = $device->max_work_item_sizes
743		886
744	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	887	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
745		888
746	=item $uint = $device->preferred_vector_width_char	889	=item $uint = $device->preferred_vector_width_char
747		890
748	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	891	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
749		892
750	=item $uint = $device->preferred_vector_width_short	893	=item $uint = $device->preferred_vector_width_short
751		894
752	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	895	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
753		896
754	=item $uint = $device->preferred_vector_width_int	897	=item $uint = $device->preferred_vector_width_int
755		898
756	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	899	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
757		900
758	=item $uint = $device->preferred_vector_width_long	901	=item $uint = $device->preferred_vector_width_long
759		902
760	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	903	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
761		904
762	=item $uint = $device->preferred_vector_width_float	905	=item $uint = $device->preferred_vector_width_float
763		906
764	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	907	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
765		908
766	=item $uint = $device->preferred_vector_width_double	909	=item $uint = $device->preferred_vector_width_double
767		910
768	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	911	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
769		912
770	=item $uint = $device->max_clock_frequency	913	=item $uint = $device->max_clock_frequency
771		914
772	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	915	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
773		916
774	=item $bitfield = $device->address_bits	917	=item $bitfield = $device->address_bits
775		918
776	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	919	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
777		920
778	=item $uint = $device->max_read_image_args	921	=item $uint = $device->max_read_image_args
779		922
780	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	923	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
781		924
782	=item $uint = $device->max_write_image_args	925	=item $uint = $device->max_write_image_args
783		926
784	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	927	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
785		928
786	=item $ulong = $device->max_mem_alloc_size	929	=item $ulong = $device->max_mem_alloc_size
787		930
788	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	931	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
789		932
790	=item $int = $device->image2d_max_width	933	=item $int = $device->image2d_max_width
791		934
792	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	935	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
793		936
794	=item $int = $device->image2d_max_height	937	=item $int = $device->image2d_max_height
795		938
796	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	939	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
797		940
798	=item $int = $device->image3d_max_width	941	=item $int = $device->image3d_max_width
799		942
800	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	943	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
801		944
802	=item $int = $device->image3d_max_height	945	=item $int = $device->image3d_max_height
803		946
804	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	947	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
805		948
806	=item $int = $device->image3d_max_depth	949	=item $int = $device->image3d_max_depth
807		950
808	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	951	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
809		952
810	=item $uint = $device->image_support	953	=item $uint = $device->image_support
811		954
812	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	955	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
813		956
814	=item $int = $device->max_parameter_size	957	=item $int = $device->max_parameter_size
815		958
816	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	959	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
817		960
818	=item $uint = $device->max_samplers	961	=item $uint = $device->max_samplers
819		962
820	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	963	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
821		964
822	=item $uint = $device->mem_base_addr_align	965	=item $uint = $device->mem_base_addr_align
823		966
824	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	967	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
825		968
826	=item $uint = $device->min_data_type_align_size	969	=item $uint = $device->min_data_type_align_size
827		970
828	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	971	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
829		972
830	=item $device_fp_config = $device->single_fp_config	973	=item $device_fp_config = $device->single_fp_config
831		974
832	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	975	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
833		976
834	=item $device_mem_cache_type = $device->global_mem_cache_type	977	=item $device_mem_cache_type = $device->global_mem_cache_type
835		978
836	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	979	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
837		980
838	=item $uint = $device->global_mem_cacheline_size	981	=item $uint = $device->global_mem_cacheline_size
839		982
840	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	983	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
841		984
842	=item $ulong = $device->global_mem_cache_size	985	=item $ulong = $device->global_mem_cache_size
843		986
844	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	987	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
845		988
846	=item $ulong = $device->global_mem_size	989	=item $ulong = $device->global_mem_size
847		990
848	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	991	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
849		992
850	=item $ulong = $device->max_constant_buffer_size	993	=item $ulong = $device->max_constant_buffer_size
851		994
852	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	995	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
853		996
854	=item $uint = $device->max_constant_args	997	=item $uint = $device->max_constant_args
855		998
856	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	999	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
857		1000
858	=item $device_local_mem_type = $device->local_mem_type	1001	=item $device_local_mem_type = $device->local_mem_type
859		1002
860	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	1003	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
861		1004
862	=item $ulong = $device->local_mem_size	1005	=item $ulong = $device->local_mem_size
863		1006
864	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	1007	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
865		1008
866	=item $boolean = $device->error_correction_support	1009	=item $boolean = $device->error_correction_support
867		1010
868	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	1011	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
869		1012
870	=item $int = $device->profiling_timer_resolution	1013	=item $int = $device->profiling_timer_resolution
871		1014
872	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	1015	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
873		1016
874	=item $boolean = $device->endian_little	1017	=item $boolean = $device->endian_little
875		1018
876	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	1019	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
877		1020
878	=item $boolean = $device->available	1021	=item $boolean = $device->available
879		1022
880	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	1023	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
881		1024
882	=item $boolean = $device->compiler_available	1025	=item $boolean = $device->compiler_available
883		1026
884	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	1027	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
885		1028
886	=item $device_exec_capabilities = $device->execution_capabilities	1029	=item $device_exec_capabilities = $device->execution_capabilities
887		1030
888	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	1031	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
889		1032
890	=item $command_queue_properties = $device->properties	1033	=item $command_queue_properties = $device->properties
891		1034
892	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	1035	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
893		1036
894	=item $ = $device->platform	1037	=item $ = $device->platform
895		1038
896	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	1039	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
897		1040
898	=item $string = $device->name	1041	=item $string = $device->name
899		1042
900	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	1043	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
901		1044
902	=item $string = $device->vendor	1045	=item $string = $device->vendor
903		1046
904	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	1047	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
905		1048
906	=item $string = $device->driver_version	1049	=item $string = $device->driver_version
907		1050
908	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	1051	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
909		1052
910	=item $string = $device->profile	1053	=item $string = $device->profile
911		1054
912	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	1055	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
913		1056
914	=item $string = $device->version	1057	=item $string = $device->version
915		1058
916	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	1059	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
917		1060
918	=item $string = $device->extensions	1061	=item $string = $device->extensions
919		1062
920	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	1063	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
921		1064
922	=item $uint = $device->preferred_vector_width_half	1065	=item $uint = $device->preferred_vector_width_half
923		1066
924	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	1067	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
925		1068
926	=item $uint = $device->native_vector_width_char	1069	=item $uint = $device->native_vector_width_char
927		1070
928	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	1071	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
929		1072
930	=item $uint = $device->native_vector_width_short	1073	=item $uint = $device->native_vector_width_short
931		1074
932	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1075	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
933		1076
934	=item $uint = $device->native_vector_width_int	1077	=item $uint = $device->native_vector_width_int
935		1078
936	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1079	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
937		1080
938	=item $uint = $device->native_vector_width_long	1081	=item $uint = $device->native_vector_width_long
939		1082
940	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1083	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
941		1084
942	=item $uint = $device->native_vector_width_float	1085	=item $uint = $device->native_vector_width_float
943		1086
944	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1087	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
945		1088
946	=item $uint = $device->native_vector_width_double	1089	=item $uint = $device->native_vector_width_double
947		1090
948	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1091	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
949		1092
950	=item $uint = $device->native_vector_width_half	1093	=item $uint = $device->native_vector_width_half
951		1094
952	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1095	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
953		1096
954	=item $device_fp_config = $device->double_fp_config	1097	=item $device_fp_config = $device->double_fp_config
955		1098
956	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1099	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
957		1100
958	=item $device_fp_config = $device->half_fp_config	1101	=item $device_fp_config = $device->half_fp_config
959		1102
960	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1103	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
961		1104
962	=item $boolean = $device->host_unified_memory	1105	=item $boolean = $device->host_unified_memory
963		1106
964	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1107	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
965		1108
966	=item $device = $device->parent_device_ext	1109	=item $device = $device->parent_device_ext
967		1110
968	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1111	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
969		1112
970	=item @device_partition_property_exts = $device->partition_types_ext	1113	=item @device_partition_property_exts = $device->partition_types_ext
971		1114
972	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1115	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
973		1116
974	=item @device_partition_property_exts = $device->affinity_domains_ext	1117	=item @device_partition_property_exts = $device->affinity_domains_ext
975		1118
976	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1119	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
977		1120
978	=item $uint = $device->reference_count_ext	1121	=item $uint = $device->reference_count_ext
979		1122
980	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1123	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
981		1124
982	=item @device_partition_property_exts = $device->partition_style_ext	1125	=item @device_partition_property_exts = $device->partition_style_ext
983		1126
984	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1127	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
985		1128
986	=for gengetinfo end device	1129	=for gengetinfo end device
987		1130
988	=back	1131	=back
989		1132
990	=head2 THE OpenCL::Context CLASS	1133	=head2 THE OpenCL::Context CLASS
		1134
		1135	An OpenCL::Context is basically a container, or manager, for a number of
		1136	devices of a platform. It is used to create all sorts of secondary objects
		1137	such as buffers, queues, programs and so on.
		1138
		1139	All context creation functions and methods take a list of properties
		1140	(type-value pairs). All property values can be specified as integers -
		1141	some additionally support other types:
		1142
		1143	=over 4
		1144
		1145	=item OpenCL::CONTEXT_PLATFORM
		1146
		1147	Also accepts OpenCL::Platform objects.
		1148
		1149	=item OpenCL::GLX_DISPLAY_KHR
		1150
		1151	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1152	to find the current glx display (see L<GLX SUPPORT>).
		1153
		1154	=item OpenCL::GL_CONTEXT_KHR
		1155
		1156	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1157	to find the current glx context (see L<GLX SUPPORT>).
		1158
		1159	=back
991		1160
992	=over 4	1161	=over 4
993		1162
994	=item $prog = $ctx->build_program ($program, $options = "")	1163	=item $prog = $ctx->build_program ($program, $options = "")
995		1164
…		…
1009	$prog = $self->program_with_source ($prog)	1178	$prog = $self->program_with_source ($prog)
1010	unless ref $prog;	1179	unless ref $prog;
1011		1180
1012	eval { $prog->build (undef, $options); 1 }	1181	eval { $prog->build (undef, $options); 1 }
1013	or errno == BUILD_PROGRAM_FAILURE	1182	or errno == BUILD_PROGRAM_FAILURE
		1183	or errno == INVALID_BINARY # workaround nvidia bug
1014	or Carp::croak "OpenCL::Context->build_program: " . err2str;	1184	or Carp::croak "OpenCL::Context->build_program: " . err2str;
1015		1185
1016	# we check status for all devices	1186	# we check status for all devices
1017	for my $dev ($self->devices) {	1187	for my $dev ($self->devices) {
1018	$prog->build_status ($dev) == BUILD_SUCCESS	1188	$prog->build_status ($dev) == BUILD_SUCCESS
…		…
1042	=item $buf = $ctx->buffer ($flags, $len)	1212	=item $buf = $ctx->buffer ($flags, $len)
1043		1213
1044	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1214	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1045	given flags and octet-size.	1215	given flags and octet-size.
1046		1216
		1217	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1218	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1219	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1220
1047	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1221	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1048		1222
1049	=item $buf = $ctx->buffer_sv ($flags, $data)	1223	=item $buf = $ctx->buffer_sv ($flags, $data)
1050		1224
1051	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1225	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
…		…
1054	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)	1228	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
1055		1229
1056	Creates a new OpenCL::Image object and optionally initialises it with	1230	Creates a new OpenCL::Image object and optionally initialises it with
1057	the given data values.	1231	the given data values.
1058		1232
		1233	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1234	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1235	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1236
		1237	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1238	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1239	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1240	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1241	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1242
		1243	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1244	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1245	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1246	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1247
1059	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1248	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1060		1249
1061	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1250	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1062		1251
1063	Creates a new OpenCL::Image2D object and optionally initialises it with	1252	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1075	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1264	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1076		1265
1077	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1266	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1078	OpenGL buffer object.	1267	OpenGL buffer object.
1079		1268
		1269	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1270
1080	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1271	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1081		1272
1082	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1273	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1083		1274
1084	Creates a new OpenCL::Image object that refers to the given OpenGL	1275	Creates a new OpenCL::Image object that refers to the given OpenGL
1085	texture object or buffer.	1276	texture object or buffer.
1086		1277
		1278	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1279	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1280	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1281	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1282	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1283	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1284
1087	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1285	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1088		1286
1089	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1287	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1090		1288
1091	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1289	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1116		1314
1117	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1315	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1118		1316
1119	Creates a new OpenCL::Sampler object.	1317	Creates a new OpenCL::Sampler object.
1120		1318
		1319	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1320	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1321
		1322	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1323
1121	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1122		1325
1123	=item $program = $ctx->program_with_source ($string)	1326	=item $program = $ctx->program_with_source ($string)
1124		1327
1125	Creates a new OpenCL::Program object from the given source code.	1328	Creates a new OpenCL::Program object from the given source code.
1126		1329
1127	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1330	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1128		1331
		1332	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1333
		1334	Creates a new OpenCL::Program object from the given binaries.
		1335
		1336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1337
		1338	Example: clone an existing program object that contains a successfully
		1339	compiled program, no matter how useless this is.
		1340
		1341	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1342
		1343	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1344
		1345	Creates a new OpenCL::Program object from the given built-in kernel names.
		1346
		1347	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		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
1129	=item $packed_value = $ctx->info ($name)	1356	=item $packed_value = $ctx->info ($name)
1130		1357
1131	See C<< $platform->info >> for details.	1358	See C<< $platform->info >> for details.
1132		1359
1133	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>
1134		1361
1135	=for gengetinfo begin context	1362	=for gengetinfo begin context
1136		1363
1137	=item $uint = $context->reference_count	1364	=item $uint = $context->reference_count
1138		1365
1139	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1366	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1140		1367
1141	=item @devices = $context->devices	1368	=item @devices = $context->devices
1142		1369
1143	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1370	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1144		1371
1145	=item @property_ints = $context->properties	1372	=item @property_ints = $context->properties
1146		1373
1147	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1374	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1148		1375
1149	=item $uint = $context->num_devices	1376	=item $uint = $context->num_devices
1150		1377
1151	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1378	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1152		1379
1153	=for gengetinfo end context	1380	=for gengetinfo end context
1154		1381
1155	=back	1382	=back
1156		1383
…		…
1203		1430
1204	=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 (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...)
1205		1432
1206	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
1207		1434
		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...)
		1436
		1437	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1438
1208	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1439	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1209		1440
1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1441	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1211		1442	module uses the image width (and height) to supply default values.
1212	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1213		1443
1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1444	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1215		1445
1216	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1446	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1217		1447
		1448	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1449	module uses the image width (and height) to supply default values.
1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1450	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1219		1451
1220	=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...)	1452	=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...)
1221		1453
1222	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1454	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
…		…
1267	reference to an array of local work sizes, with the same number of	1499	reference to an array of local work sizes, with the same number of
1268	elements as \@global_work_size.	1500	elements as \@global_work_size.
1269		1501
1270	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1502	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1271		1503
		1504	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1505
		1506	Migrates a number of OpenCL::Memory objects to or from the device.
		1507
		1508	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1509
		1510	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1511
1272	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1512	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1273		1513
1274	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1514	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1275	for subsequent OpenCL usage.	1515	for subsequent OpenCL usage.
1276		1516
…		…
1311		1551
1312	=for gengetinfo begin command_queue	1552	=for gengetinfo begin command_queue
1313		1553
1314	=item $ctx = $command_queue->context	1554	=item $ctx = $command_queue->context
1315		1555
1316	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1556	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1317		1557
1318	=item $device = $command_queue->device	1558	=item $device = $command_queue->device
1319		1559
1320	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1560	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1321		1561
1322	=item $uint = $command_queue->reference_count	1562	=item $uint = $command_queue->reference_count
1323		1563
1324	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1564	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1325		1565
1326	=item $command_queue_properties = $command_queue->properties	1566	=item $command_queue_properties = $command_queue->properties
1327		1567
1328	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1568	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1329		1569
1330	=for gengetinfo end command_queue	1570	=for gengetinfo end command_queue
		1571
		1572	=back
		1573
		1574	=head3 MEMORY MAPPED BUFFERS
		1575
		1576	OpenCL allows you to map buffers and images to host memory (read: perl
		1577	scalars). This is done much like reading or copying a buffer, by enqueuing
		1578	a map or unmap operation on the command queue.
		1579
		1580	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1581	OpenCL::Mapped CLASS> section for details on what to do with these
		1582	objects.
		1583
		1584	The object will be unmapped automatically when the mapped object is
		1585	destroyed (you can use a barrier to make sure the unmap has finished,
		1586	before using the buffer in a kernel), but you can also enqueue an unmap
		1587	operation manually.
		1588
		1589	=over 4
		1590
		1591	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1592
		1593	Maps the given buffer into host memory and returns an
		1594	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1595	the map will extend to the end of the buffer.
		1596
		1597	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1598
		1599	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1600
		1601	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1602
		1603	{
		1604	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1605	substr $$mapped, 0, 4, "abcd";
		1606	} # asynchronously unmap because $mapped is destroyed
		1607
		1608	=item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...)
		1609
		1610	Maps the given image area into host memory and return an
		1611	C<OpenCL::MappedImage> object.
		1612
		1613	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1614	will be replaced by the maximum possible value.
		1615
		1616	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1617
		1618	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1619	the first channel of the leftmost column to 5, then explicitly unmap
		1620	it. You are not necessarily meant to do it this way, this example just
		1621	shows you the accessors to use :)
		1622
		1623	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1624
		1625	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1626	for 0..$image->height;
		1627
		1628	$mapped->unmap;.
		1629	$mapped->wait; # only needed for out of order queues normally
		1630
		1631	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1632
		1633	Unmaps the data from host memory. You must not call any methods that
		1634	modify the data, or modify the data scalar directly, after calling this
		1635	method.
		1636
		1637	The mapped event object will always be passed as part of the
		1638	$wait_events. The mapped event object will be replaced by the new event
		1639	object that this request creates.
1331		1640
1332	=back	1641	=back
1333		1642
1334	=head2 THE OpenCL::Memory CLASS	1643	=head2 THE OpenCL::Memory CLASS
1335		1644
…		…
1346		1655
1347	=for gengetinfo begin mem	1656	=for gengetinfo begin mem
1348		1657
1349	=item $mem_object_type = $mem->type	1658	=item $mem_object_type = $mem->type
1350		1659
1351	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1660	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1352		1661
1353	=item $mem_flags = $mem->flags	1662	=item $mem_flags = $mem->flags
1354		1663
1355	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1664	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1356		1665
1357	=item $int = $mem->size	1666	=item $int = $mem->size
1358		1667
1359	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1668	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1360		1669
1361	=item $ptr_value = $mem->host_ptr	1670	=item $ptr_value = $mem->host_ptr
1362		1671
1363	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1672	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1364		1673
1365	=item $uint = $mem->map_count	1674	=item $uint = $mem->map_count
1366		1675
1367	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1676	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1368		1677
1369	=item $uint = $mem->reference_count	1678	=item $uint = $mem->reference_count
1370		1679
1371	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1680	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1372		1681
1373	=item $ctx = $mem->context	1682	=item $ctx = $mem->context
1374		1683
1375	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1684	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1376		1685
1377	=item $mem = $mem->associated_memobject	1686	=item $mem = $mem->associated_memobject
1378		1687
1379	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1688	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1380		1689
1381	=item $int = $mem->offset	1690	=item $int = $mem->offset
1382		1691
1383	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1692	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1384		1693
1385	=for gengetinfo end mem	1694	=for gengetinfo end mem
1386		1695
1387	=item ($type, $name) = $mem->gl_object_info	1696	=item ($type, $name) = $mem->gl_object_info
1388		1697
…		…
1408	=over 4	1717	=over 4
1409		1718
1410	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)	1719	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1411		1720
1412	Creates an OpenCL::Buffer objects from this buffer and returns it. The	1721	Creates an OpenCL::Buffer objects from this buffer and returns it. The
1413	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.	1722	C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1414		1723
1415	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>	1724	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1416		1725
1417	=back	1726	=back
1418		1727
…		…
1434	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1743	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1435		1744
1436	=item ($channel_order, $channel_data_type) = $image->format	1745	=item ($channel_order, $channel_data_type) = $image->format
1437		1746
1438	Returns the channel order and type used to create the image by calling	1747	Returns the channel order and type used to create the image by calling
1439	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.	1748	C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1440		1749
1441	=for gengetinfo begin image	1750	=for gengetinfo begin image
1442		1751
1443	=item $int = $image->element_size	1752	=item $int = $image->element_size
1444		1753
1445	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1754	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1446		1755
1447	=item $int = $image->row_pitch	1756	=item $int = $image->row_pitch
1448		1757
1449	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1758	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1450		1759
1451	=item $int = $image->slice_pitch	1760	=item $int = $image->slice_pitch
1452		1761
1453	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1762	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1454		1763
1455	=item $int = $image->width	1764	=item $int = $image->width
1456		1765
1457	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1766	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1458		1767
1459	=item $int = $image->height	1768	=item $int = $image->height
1460		1769
1461	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1770	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1462		1771
1463	=item $int = $image->depth	1772	=item $int = $image->depth
1464		1773
1465	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1774	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1466		1775
1467	=for gengetinfo end image	1776	=for gengetinfo end image
1468		1777
1469	=for gengetinfo begin gl_texture	1778	=for gengetinfo begin gl_texture
1470		1779
1471	=item $GLenum = $gl_texture->target	1780	=item $GLenum = $gl_texture->target
1472		1781
1473	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1782	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1474		1783
1475	=item $GLint = $gl_texture->gl_mipmap_level	1784	=item $GLint = $gl_texture->gl_mipmap_level
1476		1785
1477	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1786	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1478		1787
1479	=for gengetinfo end gl_texture	1788	=for gengetinfo end gl_texture
1480		1789
1481	=back	1790	=back
1482		1791
…		…
1492		1801
1493	=for gengetinfo begin sampler	1802	=for gengetinfo begin sampler
1494		1803
1495	=item $uint = $sampler->reference_count	1804	=item $uint = $sampler->reference_count
1496		1805
1497	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1806	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1498		1807
1499	=item $ctx = $sampler->context	1808	=item $ctx = $sampler->context
1500		1809
1501	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1810	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1502		1811
1503	=item $addressing_mode = $sampler->normalized_coords	1812	=item $addressing_mode = $sampler->normalized_coords
1504		1813
1505	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1814	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1506		1815
1507	=item $filter_mode = $sampler->addressing_mode	1816	=item $filter_mode = $sampler->addressing_mode
1508		1817
1509	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1818	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1510		1819
1511	=item $boolean = $sampler->filter_mode	1820	=item $boolean = $sampler->filter_mode
1512		1821
1513	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1822	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1514		1823
1515	=for gengetinfo end sampler	1824	=for gengetinfo end sampler
1516		1825
1517	=back	1826	=back
1518		1827
…		…
1528	If a callback is specified, then it will be called when compilation is	1837	If a callback is specified, then it will be called when compilation is
1529	finished. Note that many OpenCL implementations block your program while	1838	finished. Note that many OpenCL implementations block your program while
1530	compiling whether you use a callback or not. See C<build_async> if you	1839	compiling whether you use a callback or not. See C<build_async> if you
1531	want to make sure the build is done in the background.	1840	want to make sure the build is done in the background.
1532		1841
1533	Note that some OpenCL implementations atc up badly, and don't call the	1842	Note that some OpenCL implementations act up badly, and don't call the
1534	callback in some error cases (but call it in others). This implementation	1843	callback in some error cases (but call it in others). This implementation
1535	assumes the callback will always be called, and leaks memory if this is	1844	assumes the callback will always be called, and leaks memory if this is
1536	not so. So best make sure you don't pass in invalid values.	1845	not so. So best make sure you don't pass in invalid values.
1537		1846
		1847	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1848	compilation state is successful but some later stage fails.
		1849
		1850	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1851	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1852	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1853	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1854	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1855	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1856	C<-create-library>, C<-enable-link-options>.
		1857
		1858	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1859	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1860
1538	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1861	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1539		1862
1540	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1863	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1541		1864
1542	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1865	Similar to C<< ->build >>, except it starts a thread, and never fails (you
1543	need to check the compilation status form the callback, or by polling).	1866	need to check the compilation status form the callback, or by polling).
1544		1867
		1868	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1869
		1870	Compiles the given program for the given devices (or all devices if
		1871	undef). If C<$headers> is given, it must be a hashref with include name =>
		1872	OpenCL::Program pairs.
		1873
		1874	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
		1875
1545	=item $packed_value = $program->build_info ($device, $name)	1876	=item $packed_value = $program->build_info ($device, $name)
1546		1877
1547	Similar to C<< $platform->info >>, but returns build info for a previous	1878	Similar to C<< $platform->info >>, but returns build info for a previous
1548	build attempt for the given device.	1879	build attempt for the given device.
1549		1880
		1881	binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
		1882	OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
		1883	OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
		1884	OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
		1885
1550	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>	1886	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1551		1887
1552	=item $kernel = $program->kernel ($function_name)	1888	=item $kernel = $program->kernel ($function_name)
1553		1889
1554	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1890	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
…		…
1564		1900
1565	=for gengetinfo begin program_build	1901	=for gengetinfo begin program_build
1566		1902
1567	=item $build_status = $program->build_status ($device)	1903	=item $build_status = $program->build_status ($device)
1568		1904
1569	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1905	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1570		1906
1571	=item $string = $program->build_options ($device)	1907	=item $string = $program->build_options ($device)
1572		1908
1573	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1909	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1574		1910
1575	=item $string = $program->build_log ($device)	1911	=item $string = $program->build_log ($device)
1576		1912
1577	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1913	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
		1914
		1915	=item $binary_type = $program->binary_type ($device)
		1916
		1917	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1578		1918
1579	=for gengetinfo end program_build	1919	=for gengetinfo end program_build
1580		1920
1581	=item $packed_value = $program->info ($name)	1921	=item $packed_value = $program->info ($name)
1582		1922
…		…
1586		1926
1587	=for gengetinfo begin program	1927	=for gengetinfo begin program
1588		1928
1589	=item $uint = $program->reference_count	1929	=item $uint = $program->reference_count
1590		1930
1591	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1931	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1592		1932
1593	=item $ctx = $program->context	1933	=item $ctx = $program->context
1594		1934
1595	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1935	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1596		1936
1597	=item $uint = $program->num_devices	1937	=item $uint = $program->num_devices
1598		1938
1599	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1939	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1600		1940
1601	=item @devices = $program->devices	1941	=item @devices = $program->devices
1602		1942
1603	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1943	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1604		1944
1605	=item $string = $program->source	1945	=item $string = $program->source
1606		1946
1607	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1947	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1608		1948
1609	=item @ints = $program->binary_sizes	1949	=item @ints = $program->binary_sizes
1610		1950
1611	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1951	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1612		1952
1613	=for gengetinfo end program	1953	=for gengetinfo end program
1614		1954
1615	=item @blobs = $program->binaries	1955	=item @blobs = $program->binaries
1616		1956
…		…
1637		1977
1638	=for gengetinfo begin kernel	1978	=for gengetinfo begin kernel
1639		1979
1640	=item $string = $kernel->function_name	1980	=item $string = $kernel->function_name
1641		1981
1642	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1982	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1643		1983
1644	=item $uint = $kernel->num_args	1984	=item $uint = $kernel->num_args
1645		1985
1646	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1986	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1647		1987
1648	=item $uint = $kernel->reference_count	1988	=item $uint = $kernel->reference_count
1649		1989
1650	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1990	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1651		1991
1652	=item $ctx = $kernel->context	1992	=item $ctx = $kernel->context
1653		1993
1654	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1994	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1655		1995
1656	=item $program = $kernel->program	1996	=item $program = $kernel->program
1657		1997
1658	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1998	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1659		1999
1660	=for gengetinfo end kernel	2000	=for gengetinfo end kernel
1661		2001
1662	=item $packed_value = $kernel->work_group_info ($device, $name)	2002	=item $packed_value = $kernel->work_group_info ($device, $name)
1663		2003
1664	See C<< $platform->info >> for details.	2004	See C<< $platform->info >> for details.
1665		2005
1666	The reason this method is not called C<info> is that there already is an
1667	C<< ->info >> method.
1668
1669	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	2006	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1670		2007
1671	=for gengetinfo begin kernel_work_group	2008	=for gengetinfo begin kernel_work_group
1672		2009
1673	=item $int = $kernel->work_group_size ($device)	2010	=item $int = $kernel->work_group_size ($device)
1674		2011
1675	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	2012	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1676		2013
1677	=item @ints = $kernel->compile_work_group_size ($device)	2014	=item @ints = $kernel->compile_work_group_size ($device)
1678		2015
1679	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	2016	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1680		2017
1681	=item $ulong = $kernel->local_mem_size ($device)	2018	=item $ulong = $kernel->local_mem_size ($device)
1682		2019
1683	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	2020	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1684		2021
1685	=item $int = $kernel->preferred_work_group_size_multiple ($device)	2022	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1686		2023
1687	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	2024	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1688		2025
1689	=item $ulong = $kernel->private_mem_size ($device)	2026	=item $ulong = $kernel->private_mem_size ($device)
1690		2027
1691	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	2028	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1692		2029
1693	=for gengetinfo end kernel_work_group	2030	=for gengetinfo end kernel_work_group
		2031
		2032	=item $packed_value = $kernel->arg_info ($idx, $name)
		2033
		2034	See C<< $platform->info >> for details.
		2035
		2036	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		2037
		2038	=for gengetinfo begin kernel_arg
		2039
		2040	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		2041
		2042	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		2043
		2044	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		2045
		2046	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		2047
		2048	=item $string = $kernel->arg_type_name ($idx)
		2049
		2050	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		2051
		2052	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		2053
		2054	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		2055
		2056	=item $string = $kernel->arg_name ($idx)
		2057
		2058	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		2059
		2060	=for gengetinfo end kernel_arg
1694		2061
1695	=item $kernel->setf ($format, ...)	2062	=item $kernel->setf ($format, ...)
1696		2063
1697	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic	2064	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1698	way to set arguments (and with OpenCL 1.2 it might be rather slow), you	2065	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
…		…
1810		2177
1811	=for gengetinfo begin event	2178	=for gengetinfo begin event
1812		2179
1813	=item $queue = $event->command_queue	2180	=item $queue = $event->command_queue
1814		2181
1815	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2182	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1816		2183
1817	=item $command_type = $event->command_type	2184	=item $command_type = $event->command_type
1818		2185
1819	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2186	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1820		2187
1821	=item $uint = $event->reference_count	2188	=item $uint = $event->reference_count
1822		2189
1823	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2190	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1824		2191
1825	=item $uint = $event->command_execution_status	2192	=item $uint = $event->command_execution_status
1826		2193
1827	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2194	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1828		2195
1829	=item $ctx = $event->context	2196	=item $ctx = $event->context
1830		2197
1831	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2198	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1832		2199
1833	=for gengetinfo end event	2200	=for gengetinfo end event
1834		2201
1835	=item $packed_value = $ev->profiling_info ($name)	2202	=item $packed_value = $ev->profiling_info ($name)
1836		2203
…		…
1843		2210
1844	=for gengetinfo begin profiling	2211	=for gengetinfo begin profiling
1845		2212
1846	=item $ulong = $event->profiling_command_queued	2213	=item $ulong = $event->profiling_command_queued
1847		2214
1848	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2215	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1849		2216
1850	=item $ulong = $event->profiling_command_submit	2217	=item $ulong = $event->profiling_command_submit
1851		2218
1852	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2219	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1853		2220
1854	=item $ulong = $event->profiling_command_start	2221	=item $ulong = $event->profiling_command_start
1855		2222
1856	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2223	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1857		2224
1858	=item $ulong = $event->profiling_command_end	2225	=item $ulong = $event->profiling_command_end
1859		2226
1860	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2227	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1861		2228
1862	=for gengetinfo end profiling	2229	=for gengetinfo end profiling
1863		2230
1864	=back	2231	=back
1865		2232
…		…
1872	=item $ev->set_status ($execution_status)	2239	=item $ev->set_status ($execution_status)
1873		2240
1874	Sets the execution status of the user event. Can only be called once,	2241	Sets the execution status of the user event. Can only be called once,
1875	either with OpenCL::COMPLETE or a negative number as status.	2242	either with OpenCL::COMPLETE or a negative number as status.
1876		2243
		2244	execution_status: OpenCL::COMPLETE or a negative integer.
		2245
1877	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2246	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1878		2247
1879	=back	2248	=back
		2249
		2250	=head2 THE OpenCL::Mapped CLASS
		2251
		2252	This class represents objects mapped into host memory. They are
		2253	represented by a blessed string scalar. The string data is the mapped
		2254	memory area, that is, if you read or write it, then the mapped object is
		2255	accessed directly.
		2256
		2257	You must only ever use operations that modify the string in-place - for
		2258	example, a C<substr> that doesn't change the length, or maybe a regex that
		2259	doesn't change the length. Any other operation might cause the data to be
		2260	copied.
		2261
		2262	When the object is destroyed it will enqueue an implicit unmap operation
		2263	on the queue that was used to create it.
		2264
		2265	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2266	OpenCL sees the changes, even if some implementations don't need this
		2267	sometimes.
		2268
		2269	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2270
		2271	my $mapped = $queue->map_buffer ($buf, ...
		2272	$mapped->event->wait; # make sure it's there
		2273
		2274	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2275	# we blindly assume device endianness to equal host endianness
		2276	# (and of course, we assume iee 754 single precision floats :)
		2277	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2278
		2279	=over 4
		2280
		2281	=item $ev = $mapped->unmap ($wait_events...)
		2282
		2283	Unmaps the mapped memory object, using the queue originally used to create
		2284	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2285
		2286	=item $bool = $mapped->mapped
		2287
		2288	Returns whether the object is still mapped - true before an C<unmap> is
		2289	enqueued, false afterwards.
		2290
		2291	=item $ev = $mapped->event
		2292
		2293	Return the event object associated with the mapped object. Initially, this
		2294	will be the event object created when mapping the object, and after an
		2295	unmap, this will be the event object that the unmap operation created.
		2296
		2297	=item $mapped->wait
		2298
		2299	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2300	mapped object are outstanding.
		2301
		2302	=item $bytes = $mapped->size
		2303
		2304	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2305
		2306	=item $ptr = $mapped->ptr
		2307
		2308	Returns the raw memory address of the mapped area.
		2309
		2310	=item $mapped->set ($offset, $data)
		2311
		2312	Replaces the data at the given C<$offset> in the memory area by the new
		2313	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2314	because it does bounds-checking, but also slower.
		2315
		2316	=item $data = $mapped->get ($offset, $length)
		2317
		2318	Returns (without copying) a scalar representing the data at the given
		2319	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2320	the following substr, except much slower;
		2321
		2322	$data = substr $$mapped, $offset, $length
		2323
		2324	=cut
		2325
		2326	sub OpenCL::Mapped::get {
		2327	substr ${$_[0]}, $_[1], $_[2]
		2328	}
		2329
		2330	=back
		2331
		2332	=head2 THE OpenCL::MappedBuffer CLASS
		2333
		2334	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2335
		2336	=head2 THE OpenCL::MappedImage CLASS
		2337
		2338	This is a subclass of OpenCL::Mapped, representing mapped images.
		2339
		2340	=over 4
		2341
		2342	=item $bytes = $mapped->row_pitch
		2343
		2344	=item $bytes = $mapped->slice_pitch
		2345
		2346	Return the row or slice pitch of the image that has been mapped.
		2347
		2348	=back
		2349
1880		2350
1881	=cut	2351	=cut
1882		2352
1883	1;	2353	1;
1884		2354

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC vs. Revision 1.81 by root, Sat May 5 14:17:39 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC vs.
Revision 1.81 by root, Sat May 5 14:17:39 2012 UTC