ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.54 by root, Tue Apr 24 14:57:06 2012 UTC vs.
Revision 1.82 by root, Sat May 5 14:18:35 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 spec used to develop this module (1.2 spec was available, but	48	The OpenCL specs used to develop this module - download these and keept
49	no implementation was available to me :).	49	hema round, they are required reference material:
50		50
51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
		52	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
		53	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
52		54
53	OpenCL manpages:	55	OpenCL manpages:
54		56
55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	57	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
		58	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
56		59
57	If you are into UML class diagrams, the following diagram might help - if	60	If you are into UML class diagrams, the following diagram might help - if
58	not, it will be mildly cobfusing:	61	not, it will be mildly confusing (also, the class hierarchy of this module
		62	is much more fine-grained):
59		63
60	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html	64	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/classDiagram.html
61		65
62	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it	66	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
63	is, but at least it's free of charge:	67	is, but at least it's free of charge:
64		68
65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf	69	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
…		…
138	=head2 Create a buffer with some predefined data, read it back synchronously,	142	=head2 Create a buffer with some predefined data, read it back synchronously,
139	then asynchronously.	143	then asynchronously.
140		144
141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	145	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
142		146
143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	147	$queue->read_buffer ($buf, 1, 1, 3, my $data);
144	print "$data\n";	148	print "$data\n";
145		149
146	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	150	my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
147	$ev->wait;	151	$ev->wait;
148	print "$data\n"; # prints "elm"	152	print "$data\n"; # prints "elm"
149		153
150	=head2 Create and build a program, then create a kernel out of one of its	154	=head2 Create and build a program, then create a kernel out of one of its
151	functions.	155	functions.
…		…
171	# set buffer	175	# set buffer
172	$kernel->set_buffer (0, $input);	176	$kernel->set_buffer (0, $input);
173	$kernel->set_buffer (1, $output);	177	$kernel->set_buffer (1, $output);
174		178
175	# execute it for all 4 numbers	179	# execute it for all 4 numbers
176	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	180	$queue->nd_range_kernel ($kernel, undef, [4], undef);
177		181
178	# enqueue a synchronous read	182	# enqueue a synchronous read
179	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	183	$queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
180		184
181	# print the results:	185	# print the results:
182	printf "%s\n", join ", ", unpack "f*", $data;	186	printf "%s\n", join ", ", unpack "f*", $data;
183		187
184	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	188	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
185	showing off barriers.	189	showing off barriers.
186		190
187	# execute it for all 4 numbers	191	# execute it for all 4 numbers
188	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	192	$queue->nd_range_kernel ($kernel, undef, [4], undef);
189		193
190	# enqueue a barrier to ensure in-order execution	194	# enqueue a barrier to ensure in-order execution
191	$queue->enqueue_barrier;	195	$queue->barrier;
192		196
193	# enqueue an async read	197	# enqueue an async read
194	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	198	$queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
195		199
196	# wait for all requests to finish	200	# wait for all requests to finish
197	$queue->finish;	201	$queue->finish;
198		202
199	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	203	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
200	showing off event objects and wait lists.	204	showing off event objects and wait lists.
201		205
202	# execute it for all 4 numbers	206	# execute it for all 4 numbers
203	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	207	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
204		208
205	# enqueue an async read	209	# enqueue an async read
206	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	210	$ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
207		211
208	# wait for the last event to complete	212	# wait for the last event to complete
209	$ev->wait;	213	$ev->wait;
210		214
211	=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
212	set tunnel effect.	216	set flight effect.
213		217
214	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>.
215		220
216	use OpenGL ":all";	221	use OpenGL ":all";
217	use OpenCL;	222	use OpenCL;
218		223
		224	my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
		225
219	# open a window and create a gl texture	226	# open a window and create a gl texture
220	OpenGL::glpOpenWindow width => 256, height => 256;	227	OpenGL::glpOpenWindow width => $S, height => $S;
221	my $texid = glGenTextures_p 1;	228	my $texid = glGenTextures_p 1;
222	glBindTexture GL_TEXTURE_2D, $texid;	229	glBindTexture GL_TEXTURE_2D, $texid;
223	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;
224		231
225	# 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
226	my $platform;	233	my $platform;
227	my $dev;	234	my $dev;
228	my $ctx;	235	my $ctx;
…		…
247	# now the boring opencl code	254	# now the boring opencl code
248	my $src = <<EOF;	255	my $src = <<EOF;
249	kernel void	256	kernel void
250	juliatunnel (write_only image2d_t img, float time)	257	juliatunnel (write_only image2d_t img, float time)
251	{	258	{
252	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;
253		261
254	float2 m = (float2)(1.f, p.y) / fabs (p.x);	262	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
255	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);
256		264
257	float2 z = m;	265	float2 z = m;
258	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	266	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
259		267
260	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
261	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;
262		270
263	float3 colour = (float3)(z.x, z.y, z.x * z.y);	271	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
264	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.));
265	}	273	}
266	EOF	274	EOF
267		275
268	my $prog = $ctx->build_program ($src);	276	my $prog = $ctx->build_program ($src);
269	my $kernel = $prog->kernel ("juliatunnel");	277	my $kernel = $prog->kernel ("juliatunnel");
270		278
271	# program compiled, kernel ready, now draw and loop	279	# program compiled, kernel ready, now draw and loop
272		280
273	for (my $time; ; ++$time) {	281	for (my $time; ; ++$time) {
274	# acquire objects from opengl	282	# acquire objects from opengl
275	$queue->enqueue_acquire_gl_objects ([$tex]);	283	$queue->acquire_gl_objects ([$tex]);
276		284
277	# configure and run our kernel	285	# configure and run our kernel
278	$kernel->set_image2d (0, $tex);	286	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
279	$kernel->set_float (1, $time);
280	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);	287	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
281		288
282	# release objects to opengl again	289	# release objects to opengl again
283	$queue->enqueue_release_gl_objects ([$tex]);	290	$queue->release_gl_objects ([$tex]);
284		291
285	# wait	292	# wait
286	$queue->finish;	293	$queue->finish;
287		294
288	# now draw the texture, the defaults should be all right	295	# now draw the texture, the defaults should be all right
…		…
299	glXSwapBuffers;	306	glXSwapBuffers;
300		307
301	select undef, undef, undef, 1/60;	308	select undef, undef, undef, 1/60;
302	}	309	}
303		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
304	=head1 DOCUMENTATION	355	=head1 DOCUMENTATION
305		356
306	=head2 BASIC CONVENTIONS	357	=head2 BASIC CONVENTIONS
307		358
308	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
…		…
337		388
338	=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
339	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
340	by the method.	391	by the method.
341		392
342	=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
343	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
344	don't normally have to to any error checking.	395	don't normally have to to any error checking.
345		396
346	=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.
347		439
348	=head2 PERL AND OPENCL TYPES	440	=head2 PERL AND OPENCL TYPES
349		441
350	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
351	format equivalents:	443	format equivalents:
…		…
376		468
377	For this to work, the OpenGL library must be loaded, a GLX context must	469	For this to work, the OpenGL library must be loaded, a GLX context must
378	have been created and be made current, and C<dlsym> must be available and	470	have been created and be made current, and C<dlsym> must be available and
379	capable of finding the function via C<RTLD_DEFAULT>.	471	capable of finding the function via C<RTLD_DEFAULT>.
380		472
		473	=head2 EVENT SYSTEM
		474
		475	OpenCL can generate a number of (potentially) asynchronous events, for
		476	example, after compiling a program, to signal a context-related error or,
		477	perhaps most important, to signal completion of queued jobs (by setting
		478	callbacks on OpenCL::Event objects).
		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
		487	To facilitate this, this module maintains an event queue - each
		488	time an asynchronous event happens, it is queued, and perl will be
		489	interrupted. This is implemented via the L<Async::Interrupt> module. In
		490	addition, this module has L<AnyEvent> support, so it can seamlessly
		491	integrate itself into many event loops.
		492
		493	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
		494
		495	=head3 Don't use callbacks.
		496
		497	When your program never uses any callbacks, then there will never be any
		498	notifications you need to take care of, and therefore no need to worry
		499	about all this.
		500
		501	You can achieve a great deal by explicitly waiting for events, or using
		502	barriers and flush calls. In many programs, there is no need at all to
		503	tinker with asynchronous events.
		504
		505	=head3 Use AnyEvent
		506
		507	This module automatically registers a watcher that invokes all outstanding
		508	event callbacks when AnyEvent is initialised (and block asynchronous
		509	interruptions). Using this mode of operations is the safest and most
		510	recommended one.
		511
		512	To use this, simply use AnyEvent and this module normally, make sure you
		513	have an event loop running:
		514
		515	use Gtk2 -init;
		516	use AnyEvent;
		517
		518	# initialise AnyEvent, by creating a watcher, or:
		519	AnyEvent::detect;
		520
		521	my $e = $queue->marker;
		522	$e->cb (sub {
		523	warn "opencl is finished\n";
		524	})
		525
		526	main Gtk2;
		527
		528	Note that this module will not initialise AnyEvent for you. Before
		529	AnyEvent is initialised, the module will asynchronously interrupt perl
		530	instead. To avoid any surprises, it's best to explicitly initialise
		531	AnyEvent.
		532
		533	You can temporarily enable asynchronous interruptions (see next paragraph)
		534	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		535	calling C<$OpenCL::INTERRUPT->block>.
		536
		537	=head3 Let yourself be interrupted at any time
		538
		539	This mode is the default unless AnyEvent is loaded and initialised. In
		540	this mode, OpenCL asynchronously interrupts a running perl program. The
		541	emphasis is on both I<asynchronously> and I<running> here.
		542
		543	Asynchronously means that perl might execute your callbacks at any
		544	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		545	the C<until> loop following the marker call will be interrupted by the
		546	callback:
		547
		548	my $e = $queue->marker;
		549	my $flag;
		550	$e->cb (sub { $flag = 1 });
		551	1 until $flag;
		552	# $flag is now 1
		553
		554	The reason why you shouldn't blindly copy the above code is that
		555	busy waiting is a really really bad thing, and really really bad for
		556	performance.
		557
		558	While at first this asynchronous business might look exciting, it can be
		559	really hard, because you need to be prepared for the callback code to be
		560	executed at any time, which limits the amount of things the callback code
		561	can do safely.
		562
		563	This can be mitigated somewhat by using C<<
		564	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		565	documentation for details).
		566
		567	The other problem is that your program must be actively I<running> to be
		568	interrupted. When you calculate stuff, your program is running. When you
		569	hang in some C functions or other block execution (by calling C<sleep>,
		570	C<select>, running an event loop and so on), your program is waiting, not
		571	running.
		572
		573	One way around that would be to attach a read watcher to your event loop,
		574	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		575	dummy callback (C<sub { }>) to temporarily execute some perl code.
		576
		577	That is then awfully close to using the built-in AnyEvent support above,
		578	though, so consider that one instead.
		579
		580	=head3 Be creative
		581
		582	OpenCL exports the L<Async::Interrupt> object it uses in the global
		583	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		584
		585	So if you want to feel like a real pro, err, wait, if you feel no risk
		586	menas no fun, you can experiment by implementing your own mode of
		587	operations.
		588
381	=cut	589	=cut
382		590
383	package OpenCL;	591	package OpenCL;
384		592
385	use common::sense;	593	use common::sense;
		594	use Carp ();
		595	use Async::Interrupt ();
		596
		597	our $POLL_FUNC; # set by XS
386		598
387	BEGIN {	599	BEGIN {
388	our $VERSION = '0.97';	600	our $VERSION = '0.99';
389		601
390	require XSLoader;	602	require XSLoader;
391	XSLoader::load (__PACKAGE__, $VERSION);	603	XSLoader::load (__PACKAGE__, $VERSION);
392		604
393	@OpenCL::Platform::ISA =	605	@OpenCL::Platform::ISA =
…		…
398	@OpenCL::Sampler::ISA =	610	@OpenCL::Sampler::ISA =
399	@OpenCL::Program::ISA =	611	@OpenCL::Program::ISA =
400	@OpenCL::Kernel::ISA =	612	@OpenCL::Kernel::ISA =
401	@OpenCL::Event::ISA = OpenCL::Object::;	613	@OpenCL::Event::ISA = OpenCL::Object::;
402		614
		615	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		616
403	@OpenCL::Buffer::ISA =	617	@OpenCL::Buffer::ISA =
404	@OpenCL::Image::ISA = OpenCL::Memory::;	618	@OpenCL::Image::ISA = OpenCL::Memory::;
405		619
406	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	620	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
407		621
…		…
411	@OpenCL::Image1D::ISA =	625	@OpenCL::Image1D::ISA =
412	@OpenCL::Image1DArray::ISA =	626	@OpenCL::Image1DArray::ISA =
413	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	627	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
414		628
415	@OpenCL::UserEvent::ISA = OpenCL::Event::;	629	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		630
		631	@OpenCL::MappedBuffer::ISA =
		632	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
416	}	633	}
417		634
418	=head2 THE OpenCL PACKAGE	635	=head2 THE OpenCL PACKAGE
419		636
420	=over 4	637	=over 4
…		…
422	=item $int = OpenCL::errno	639	=item $int = OpenCL::errno
423		640
424	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
425	and before calling another OpenCL function.	642	and before calling another OpenCL function.
426		643
427	=item $str = OpenCL::err2str $errval	644	=item $str = OpenCL::err2str [$errval]
428		645
429	Comverts an error value into a human readable string.	646	Converts an error value into a human readable string. If no error value is
		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>.
430		651
431	=item $str = OpenCL::enum2str $enum	652	=item $str = OpenCL::enum2str $enum
432		653
433	Converts most enum values (of parameter names, image format constants,	654	Converts most enum values (of parameter names, image format constants,
434	object types, addressing and filter modes, command types etc.) into a	655	object types, addressing and filter modes, command types etc.) into a
435	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
436	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
437	string out of it.	658	string out of it.
438		659
		660	The latest version of this module knows the enumaration constants
		661	listed in L<http://cvs.schmorp.de/OpenCL/enumstr.h>.
		662
439	=item @platforms = OpenCL::platforms	663	=item @platforms = OpenCL::platforms
440		664
441	Returns all available OpenCL::Platform objects.	665	Returns all available OpenCL::Platform objects.
442		666
443	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>
444		668
445	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	669	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
446		670
447	Tries to create a context from a default device and platform - 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.
448		676
449	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>
450		678
		679	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		680
		681	Create a new OpenCL::Context object using the given device object(s).
		682	Consider using C<< $platform->context >> instead.
		683
		684	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		685
451	=item OpenCL::wait_for_events $wait_events...	686	=item OpenCL::wait_for_events $wait_events...
452		687
453	Waits for all events to complete.	688	Waits for all events to complete.
454		689
455	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	690	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		691
		692	=item OpenCL::poll
		693
		694	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		695	invokes their callbacks.
		696
		697	=item $OpenCL::INTERRUPT
		698
		699	The L<Async::Interrupt> object used to signal asynchronous events (see
		700	L<EVENT SYSTEM>).
		701
		702	=cut
		703
		704	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		705
		706	&_eq_initialise ($INTERRUPT->signal_func);
		707
		708	=item $OpenCL::WATCHER
		709
		710	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		711	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		712	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		713
		714	=cut
		715
		716	our $WATCHER;
		717
		718	sub _init_anyevent {
		719	$INTERRUPT->block;
		720	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		721	}
		722
		723	if (defined $AnyEvent::MODEL) {
		724	_init_anyevent;
		725	} else {
		726	push @AnyEvent::post_detect, \&_init_anyevent;
		727	}
456		728
457	=back	729	=back
458		730
459	=head2 THE OpenCL::Object CLASS	731	=head2 THE OpenCL::Object CLASS
460		732
…		…
472	C<IV> type in your code and cast that to the correct type.	744	C<IV> type in your code and cast that to the correct type.
473		745
474	=cut	746	=cut
475		747
476	sub OpenCL::Object::id {	748	sub OpenCL::Object::id {
		749	ref $_[0] eq "SCALAR"
477	${$_[0]}	750	? ${ $_[0] }
		751	: $_[0][0]
478	}	752	}
479		753
480	=back	754	=back
481		755
482	=head2 THE OpenCL::Platform CLASS	756	=head2 THE OpenCL::Platform CLASS
…		…
485		759
486	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	760	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
487		761
488	Returns a list of matching OpenCL::Device objects.	762	Returns a list of matching OpenCL::Device objects.
489		763
490	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	764	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
491		765
492	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	766	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
493		767
494	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>
495		769
496	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)	770	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
497		771
498	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
499	CL_CONTEXT_PLATFORM property is supplied automatically.	773	OpenCL::CONTEXT_PLATFORM property is supplied automatically.
500		774
501	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>
502		776
503	=item $packed_value = $platform->info ($name)	777	=item $packed_value = $platform->info ($name)
504		778
…		…
520		794
521	=for gengetinfo begin platform	795	=for gengetinfo begin platform
522		796
523	=item $string = $platform->profile	797	=item $string = $platform->profile
524		798
525	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.
526		800
527	=item $string = $platform->version	801	=item $string = $platform->version
528		802
529	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.
530		804
531	=item $string = $platform->name	805	=item $string = $platform->name
532		806
533	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.
534		808
535	=item $string = $platform->vendor	809	=item $string = $platform->vendor
536		810
537	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.
538		812
539	=item $string = $platform->extensions	813	=item $string = $platform->extensions
540		814
541	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.
542		816
543	=for gengetinfo end platform	817	=for gengetinfo end platform
544		818
545	=back	819	=back
546		820
…		…
550		824
551	=item $packed_value = $device->info ($name)	825	=item $packed_value = $device->info ($name)
552		826
553	See C<< $platform->info >> for details.	827	See C<< $platform->info >> for details.
554		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
555	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>
556		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
557	=for gengetinfo begin device	863	=for gengetinfo begin device
558		864
559	=item $device_type = $device->type	865	=item $device_type = $device->type
560		866
561	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.
562		868
563	=item $uint = $device->vendor_id	869	=item $uint = $device->vendor_id
564		870
565	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.
566		872
567	=item $uint = $device->max_compute_units	873	=item $uint = $device->max_compute_units
568		874
569	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.
570		876
571	=item $uint = $device->max_work_item_dimensions	877	=item $uint = $device->max_work_item_dimensions
572		878
573	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.
574		880
575	=item $int = $device->max_work_group_size	881	=item $int = $device->max_work_group_size
576		882
577	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.
578		884
579	=item @ints = $device->max_work_item_sizes	885	=item @ints = $device->max_work_item_sizes
580		886
581	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.
582		888
583	=item $uint = $device->preferred_vector_width_char	889	=item $uint = $device->preferred_vector_width_char
584		890
585	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.
586		892
587	=item $uint = $device->preferred_vector_width_short	893	=item $uint = $device->preferred_vector_width_short
588		894
589	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.
590		896
591	=item $uint = $device->preferred_vector_width_int	897	=item $uint = $device->preferred_vector_width_int
592		898
593	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.
594		900
595	=item $uint = $device->preferred_vector_width_long	901	=item $uint = $device->preferred_vector_width_long
596		902
597	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.
598		904
599	=item $uint = $device->preferred_vector_width_float	905	=item $uint = $device->preferred_vector_width_float
600		906
601	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.
602		908
603	=item $uint = $device->preferred_vector_width_double	909	=item $uint = $device->preferred_vector_width_double
604		910
605	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.
606		912
607	=item $uint = $device->max_clock_frequency	913	=item $uint = $device->max_clock_frequency
608		914
609	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.
610		916
611	=item $bitfield = $device->address_bits	917	=item $bitfield = $device->address_bits
612		918
613	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.
614		920
615	=item $uint = $device->max_read_image_args	921	=item $uint = $device->max_read_image_args
616		922
617	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.
618		924
619	=item $uint = $device->max_write_image_args	925	=item $uint = $device->max_write_image_args
620		926
621	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.
622		928
623	=item $ulong = $device->max_mem_alloc_size	929	=item $ulong = $device->max_mem_alloc_size
624		930
625	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.
626		932
627	=item $int = $device->image2d_max_width	933	=item $int = $device->image2d_max_width
628		934
629	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.
630		936
631	=item $int = $device->image2d_max_height	937	=item $int = $device->image2d_max_height
632		938
633	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.
634		940
635	=item $int = $device->image3d_max_width	941	=item $int = $device->image3d_max_width
636		942
637	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.
638		944
639	=item $int = $device->image3d_max_height	945	=item $int = $device->image3d_max_height
640		946
641	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.
642		948
643	=item $int = $device->image3d_max_depth	949	=item $int = $device->image3d_max_depth
644		950
645	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.
646		952
647	=item $uint = $device->image_support	953	=item $uint = $device->image_support
648		954
649	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.
650		956
651	=item $int = $device->max_parameter_size	957	=item $int = $device->max_parameter_size
652		958
653	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.
654		960
655	=item $uint = $device->max_samplers	961	=item $uint = $device->max_samplers
656		962
657	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.
658		964
659	=item $uint = $device->mem_base_addr_align	965	=item $uint = $device->mem_base_addr_align
660		966
661	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.
662		968
663	=item $uint = $device->min_data_type_align_size	969	=item $uint = $device->min_data_type_align_size
664		970
665	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.
666		972
667	=item $device_fp_config = $device->single_fp_config	973	=item $device_fp_config = $device->single_fp_config
668		974
669	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.
670		976
671	=item $device_mem_cache_type = $device->global_mem_cache_type	977	=item $device_mem_cache_type = $device->global_mem_cache_type
672		978
673	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.
674		980
675	=item $uint = $device->global_mem_cacheline_size	981	=item $uint = $device->global_mem_cacheline_size
676		982
677	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.
678		984
679	=item $ulong = $device->global_mem_cache_size	985	=item $ulong = $device->global_mem_cache_size
680		986
681	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.
682		988
683	=item $ulong = $device->global_mem_size	989	=item $ulong = $device->global_mem_size
684		990
685	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.
686		992
687	=item $ulong = $device->max_constant_buffer_size	993	=item $ulong = $device->max_constant_buffer_size
688		994
689	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.
690		996
691	=item $uint = $device->max_constant_args	997	=item $uint = $device->max_constant_args
692		998
693	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.
694		1000
695	=item $device_local_mem_type = $device->local_mem_type	1001	=item $device_local_mem_type = $device->local_mem_type
696		1002
697	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.
698		1004
699	=item $ulong = $device->local_mem_size	1005	=item $ulong = $device->local_mem_size
700		1006
701	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.
702		1008
703	=item $boolean = $device->error_correction_support	1009	=item $boolean = $device->error_correction_support
704		1010
705	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.
706		1012
707	=item $int = $device->profiling_timer_resolution	1013	=item $int = $device->profiling_timer_resolution
708		1014
709	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.
710		1016
711	=item $boolean = $device->endian_little	1017	=item $boolean = $device->endian_little
712		1018
713	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.
714		1020
715	=item $boolean = $device->available	1021	=item $boolean = $device->available
716		1022
717	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.
718		1024
719	=item $boolean = $device->compiler_available	1025	=item $boolean = $device->compiler_available
720		1026
721	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.
722		1028
723	=item $device_exec_capabilities = $device->execution_capabilities	1029	=item $device_exec_capabilities = $device->execution_capabilities
724		1030
725	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.
726		1032
727	=item $command_queue_properties = $device->properties	1033	=item $command_queue_properties = $device->properties
728		1034
729	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.
730		1036
731	=item $ = $device->platform	1037	=item $ = $device->platform
732		1038
733	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.
734		1040
735	=item $string = $device->name	1041	=item $string = $device->name
736		1042
737	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.
738		1044
739	=item $string = $device->vendor	1045	=item $string = $device->vendor
740		1046
741	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.
742		1048
743	=item $string = $device->driver_version	1049	=item $string = $device->driver_version
744		1050
745	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.
746		1052
747	=item $string = $device->profile	1053	=item $string = $device->profile
748		1054
749	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.
750		1056
751	=item $string = $device->version	1057	=item $string = $device->version
752		1058
753	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.
754		1060
755	=item $string = $device->extensions	1061	=item $string = $device->extensions
756		1062
757	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.
758		1064
759	=item $uint = $device->preferred_vector_width_half	1065	=item $uint = $device->preferred_vector_width_half
760		1066
761	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.
762		1068
763	=item $uint = $device->native_vector_width_char	1069	=item $uint = $device->native_vector_width_char
764		1070
765	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.
766		1072
767	=item $uint = $device->native_vector_width_short	1073	=item $uint = $device->native_vector_width_short
768		1074
769	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.
770		1076
771	=item $uint = $device->native_vector_width_int	1077	=item $uint = $device->native_vector_width_int
772		1078
773	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.
774		1080
775	=item $uint = $device->native_vector_width_long	1081	=item $uint = $device->native_vector_width_long
776		1082
777	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.
778		1084
779	=item $uint = $device->native_vector_width_float	1085	=item $uint = $device->native_vector_width_float
780		1086
781	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.
782		1088
783	=item $uint = $device->native_vector_width_double	1089	=item $uint = $device->native_vector_width_double
784		1090
785	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.
786		1092
787	=item $uint = $device->native_vector_width_half	1093	=item $uint = $device->native_vector_width_half
788		1094
789	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.
790		1096
791	=item $device_fp_config = $device->double_fp_config	1097	=item $device_fp_config = $device->double_fp_config
792		1098
793	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.
794		1100
795	=item $device_fp_config = $device->half_fp_config	1101	=item $device_fp_config = $device->half_fp_config
796		1102
797	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.
798		1104
799	=item $boolean = $device->host_unified_memory	1105	=item $boolean = $device->host_unified_memory
800		1106
801	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.
802		1108
803	=item $device = $device->parent_device_ext	1109	=item $device = $device->parent_device_ext
804		1110
805	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.
806		1112
807	=item @device_partition_property_exts = $device->partition_types_ext	1113	=item @device_partition_property_exts = $device->partition_types_ext
808		1114
809	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.
810		1116
811	=item @device_partition_property_exts = $device->affinity_domains_ext	1117	=item @device_partition_property_exts = $device->affinity_domains_ext
812		1118
813	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.
814		1120
815	=item $uint = $device->reference_count_ext	1121	=item $uint = $device->reference_count_ext
816		1122
817	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.
818		1124
819	=item @device_partition_property_exts = $device->partition_style_ext	1125	=item @device_partition_property_exts = $device->partition_style_ext
820		1126
821	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.
822		1128
823	=for gengetinfo end device	1129	=for gengetinfo end device
824		1130
825	=back	1131	=back
826		1132
827	=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
828		1160
829	=over 4	1161	=over 4
830		1162
831	=item $prog = $ctx->build_program ($program, $options = "")	1163	=item $prog = $ctx->build_program ($program, $options = "")
832		1164
…		…
841	=cut	1173	=cut
842		1174
843	sub OpenCL::Context::build_program {	1175	sub OpenCL::Context::build_program {
844	my ($self, $prog, $options) = @_;	1176	my ($self, $prog, $options) = @_;
845		1177
846	require Carp;
847
848	$prog = $self->program_with_source ($prog)	1178	$prog = $self->program_with_source ($prog)
849	unless ref $prog;	1179	unless ref $prog;
850		1180
		1181	eval { $prog->build (undef, $options); 1 }
		1182	or errno == BUILD_PROGRAM_FAILURE
		1183	or errno == INVALID_BINARY # workaround nvidia bug
		1184	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1185
		1186	# we check status for all devices
851	for my $dev ($self->devices) {	1187	for my $dev ($self->devices) {
852	eval { $prog->build ($dev, $options); 1 }	1188	$prog->build_status ($dev) == BUILD_SUCCESS
853	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"	1189	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
854	. $prog->build_log ($dev));	1190	. $prog->build_log ($dev);
855	}	1191	}
856		1192
857	$prog	1193	$prog
858	}	1194	}
859		1195
…		…
876	=item $buf = $ctx->buffer ($flags, $len)	1212	=item $buf = $ctx->buffer ($flags, $len)
877		1213
878	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1214	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
879	given flags and octet-size.	1215	given flags and octet-size.
880		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
881	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>
882		1222
883	=item $buf = $ctx->buffer_sv ($flags, $data)	1223	=item $buf = $ctx->buffer_sv ($flags, $data)
884		1224
885	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1225	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
886	initialise it with the given data values.	1226	initialise it with the given data values.
887		1227
888	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $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)
889		1229
890	Creates a new OpenCL::Image object and optionally initialises it with	1230	Creates a new OpenCL::Image object and optionally initialises it with
891	the given data values.	1231	the given data values.
892		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
893	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>
894		1249
895	=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)
896		1251
897	Creates a new OpenCL::Image2D object and optionally initialises it with	1252	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
909	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1264	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
910		1265
911	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
912	OpenGL buffer object.	1267	OpenGL buffer object.
913		1268
		1269	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1270
914	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
915		1272
916	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1273	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
917		1274
918	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
919	texture object or buffer.	1276	texture object or buffer.
920		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
921	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
922		1286
923	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1287	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
924		1288
925	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
…		…
950		1314
951	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1315	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
952		1316
953	Creates a new OpenCL::Sampler object.	1317	Creates a new OpenCL::Sampler object.
954		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
955	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>
956		1325
957	=item $program = $ctx->program_with_source ($string)	1326	=item $program = $ctx->program_with_source ($string)
958		1327
959	Creates a new OpenCL::Program object from the given source code.	1328	Creates a new OpenCL::Program object from the given source code.
960		1329
961	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>
962		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
963	=item $packed_value = $ctx->info ($name)	1356	=item $packed_value = $ctx->info ($name)
964		1357
965	See C<< $platform->info >> for details.	1358	See C<< $platform->info >> for details.
966		1359
967	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>
968		1361
969	=for gengetinfo begin context	1362	=for gengetinfo begin context
970		1363
971	=item $uint = $context->reference_count	1364	=item $uint = $context->reference_count
972		1365
973	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.
974		1367
975	=item @devices = $context->devices	1368	=item @devices = $context->devices
976		1369
977	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.
978		1371
979	=item @property_ints = $context->properties	1372	=item @property_ints = $context->properties
980		1373
981	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.
982		1375
983	=item $uint = $context->num_devices	1376	=item $uint = $context->num_devices
984		1377
985	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.
986		1379
987	=for gengetinfo end context	1380	=for gengetinfo end context
988		1381
989	=back	1382	=back
990		1383
991	=head2 THE OpenCL::Queue CLASS	1384	=head2 THE OpenCL::Queue CLASS
992		1385
993	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1386	An OpenCL::Queue represents an execution queue for OpenCL. You execute
994	requests by calling their respective C<enqueue_xxx> method and waitinf for	1387	requests by calling their respective method and waiting for it to complete
995	it to complete in some way.	1388	in some way.
996		1389
997	All the enqueue methods return an event object that can be used to wait	1390	Most methods that enqueue some request return an event object that can
998	for completion, unless the method is called in void context, in which case	1391	be used to wait for completion (optionally using a callback), unless
999	no event object is created.	1392	the method is called in void context, in which case no event object is
		1393	created.
1000		1394
1001	They also allow you to specify any number of other event objects that this	1395	They also allow you to specify any number of other event objects that this
1002	request has to wait for before it starts executing, by simply passing the	1396	request has to wait for before it starts executing, by simply passing the
1003	event objects as extra parameters to the enqueue methods. To simplify	1397	event objects as extra parameters to the enqueue methods. To simplify
1004	program design, this module ignores any C<undef> values in the list of	1398	program design, this module ignores any C<undef> values in the list of
1005	events. This makes it possible to code operations such as this, without	1399	events. This makes it possible to code operations such as this, without
1006	having to put a valid event object into C<$event> first:	1400	having to put a valid event object into C<$event> first:
1007		1401
1008	$event = $queue->enqueue_xxx (..., $event);	1402	$event = $queue->xxx (..., $event);
1009		1403
1010	Queues execute in-order by default, without any parallelism, so in most	1404	Queues execute in-order by default, without any parallelism, so in most
1011	cases (i.e. you use only one queue) it's not necessary to wait for or	1405	cases (i.e. you use only one queue) it's not necessary to wait for or
1012	create event objects, althoguh an our of order queue is often a bit	1406	create event objects, althoguh an our of order queue is often a bit
1013	faster.	1407	faster.
1014		1408
1015	=over 4	1409	=over 4
1016		1410
1017	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1411	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
1018		1412
1019	Reads data from buffer into the given string.	1413	Reads data from buffer into the given string.
1020		1414
1021	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1415	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
1022		1416
1023	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1417	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1024		1418
1025	Writes data to buffer from the given string.	1419	Writes data to buffer from the given string.
1026		1420
1027	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1421	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
1028		1422
1029	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1423	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1030		1424
1031	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1425	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1032		1426
1033	=item $ev = $queue->enqueue_read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)	1427	=item $ev = $queue->read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
1034		1428
1035	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1429	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1036		1430
1037	=item $ev = $queue->enqueue_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...)
1038		1432
1039	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
1040		1434
1041	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1042
1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1044
1045	=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)	1435	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1436
		1437	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1438
		1439	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1440
		1441	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1442	module uses the image width (and height) to supply default values.
1046		1443
1047	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>
1048		1445
1049	=item $ev = $queue->enqueue_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...)
1050		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.
1051	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>
1052		1451
1053	=item $ev = $queue->enqueue_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...)
1054		1453
1055	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>
1056		1455
1057	=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)	1456	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1058		1457
1059	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1458	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1060		1459
1061	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)	1460	=item $ev = $queue->copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
1062		1461
1063	Yeah.	1462	Yeah.
1064		1463
1065	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1464	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1066		1465
1067	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1466	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1068		1467
1069	Fills the given buffer object with repeated applications of C<$pattern>,	1468	Fills the given buffer object with repeated applications of C<$pattern>,
1070	starting at C<$offset> for C<$size> octets.	1469	starting at C<$offset> for C<$size> octets.
1071		1470
1072	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>	1471	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1073		1472
1074	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)	1473	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1075		1474
1076	Fills the given image area with the given rgba colour components. The	1475	Fills the given image area with the given rgba colour components. The
1077	components are normally floating point values between C<0> and C<1>,	1476	components are normally floating point values between C<0> and C<1>,
1078	except when the image channel data type is a signe dor unsigned	1477	except when the image channel data type is a signe dor unsigned
1079	unnormalised format, in which case the range is determined by the format.	1478	unnormalised format, in which case the range is determined by the format.
1080		1479
1081	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>	1480	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1082		1481
1083	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1482	=item $ev = $queue->task ($kernel, $wait_events...)
1084		1483
1085	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1484	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1086		1485
1087	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1486	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1088		1487
1089	Enqueues a kernel execution.	1488	Enqueues a kernel execution.
1090		1489
1091	@$global_work_size must be specified as a reference to an array of	1490	\@global_work_size must be specified as a reference to an array of
1092	integers specifying the work sizes (element counts).	1491	integers specifying the work sizes (element counts).
1093		1492
1094	@$global_work_offset must be either C<undef> (in which case all offsets	1493	\@global_work_offset must be either C<undef> (in which case all offsets
1095	are C<0>), or a reference to an array of work offsets, with the same number	1494	are C<0>), or a reference to an array of work offsets, with the same number
1096	of elements as @$global_work_size.	1495	of elements as \@global_work_size.
1097		1496
1098	@$local_work_size must be either C<undef> (in which case the	1497	\@local_work_size must be either C<undef> (in which case the
1099	implementation is supposed to choose good local work sizes), or a	1498	implementation is supposed to choose good local work sizes), or a
1100	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
1101	elements as @$global_work_size.	1500	elements as \@global_work_size.
1102		1501
1103	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>
1104		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
1105	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1512	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1106		1513
1107	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
1108	for subsequent OpenCL usage.	1515	for subsequent OpenCL usage.
1109		1516
1110	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1517	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1111		1518
1112	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1519	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1113		1520
1114	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1521	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1115	for subsequent OpenGL usage.	1522	for subsequent OpenGL usage.
1116		1523
1117	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1524	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1118		1525
1119	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1526	=item $ev = $queue->wait_for_events ($wait_events...)
1120		1527
1121	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1528	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1122		1529
1123	=item $ev = $queue->enqueue_marker ($wait_events...)	1530	=item $ev = $queue->marker ($wait_events...)
1124		1531
1125	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1532	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1126		1533
1127	=item $ev = $queue->enqueue_barrier ($wait_events...)	1534	=item $ev = $queue->barrier ($wait_events...)
1128		1535
1129	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1536	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1130		1537
1131	=item $queue->flush	1538	=item $queue->flush
1132		1539
…		…
1144		1551
1145	=for gengetinfo begin command_queue	1552	=for gengetinfo begin command_queue
1146		1553
1147	=item $ctx = $command_queue->context	1554	=item $ctx = $command_queue->context
1148		1555
1149	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.
1150		1557
1151	=item $device = $command_queue->device	1558	=item $device = $command_queue->device
1152		1559
1153	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.
1154		1561
1155	=item $uint = $command_queue->reference_count	1562	=item $uint = $command_queue->reference_count
1156		1563
1157	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.
1158		1565
1159	=item $command_queue_properties = $command_queue->properties	1566	=item $command_queue_properties = $command_queue->properties
1160		1567
1161	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.
1162		1569
1163	=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.
1164		1640
1165	=back	1641	=back
1166		1642
1167	=head2 THE OpenCL::Memory CLASS	1643	=head2 THE OpenCL::Memory CLASS
1168		1644
…		…
1179		1655
1180	=for gengetinfo begin mem	1656	=for gengetinfo begin mem
1181		1657
1182	=item $mem_object_type = $mem->type	1658	=item $mem_object_type = $mem->type
1183		1659
1184	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.
1185		1661
1186	=item $mem_flags = $mem->flags	1662	=item $mem_flags = $mem->flags
1187		1663
1188	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.
1189		1665
1190	=item $int = $mem->size	1666	=item $int = $mem->size
1191		1667
1192	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.
1193		1669
1194	=item $ptr_value = $mem->host_ptr	1670	=item $ptr_value = $mem->host_ptr
1195		1671
1196	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.
1197		1673
1198	=item $uint = $mem->map_count	1674	=item $uint = $mem->map_count
1199		1675
1200	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.
1201		1677
1202	=item $uint = $mem->reference_count	1678	=item $uint = $mem->reference_count
1203		1679
1204	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.
1205		1681
1206	=item $ctx = $mem->context	1682	=item $ctx = $mem->context
1207		1683
1208	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.
1209		1685
1210	=item $mem = $mem->associated_memobject	1686	=item $mem = $mem->associated_memobject
1211		1687
1212	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.
1213		1689
1214	=item $int = $mem->offset	1690	=item $int = $mem->offset
1215		1691
1216	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.
1217		1693
1218	=for gengetinfo end mem	1694	=for gengetinfo end mem
1219		1695
1220	=item ($type, $name) = $mem->gl_object_info	1696	=item ($type, $name) = $mem->gl_object_info
1221		1697
…		…
1241	=over 4	1717	=over 4
1242		1718
1243	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)	1719	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1244		1720
1245	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
1246	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>.
1247		1723
1248	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>
1249		1725
1250	=back	1726	=back
1251		1727
…		…
1267	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>
1268		1744
1269	=item ($channel_order, $channel_data_type) = $image->format	1745	=item ($channel_order, $channel_data_type) = $image->format
1270		1746
1271	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
1272	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.	1748	C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1273		1749
1274	=for gengetinfo begin image	1750	=for gengetinfo begin image
1275		1751
1276	=item $int = $image->element_size	1752	=item $int = $image->element_size
1277		1753
1278	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.
1279		1755
1280	=item $int = $image->row_pitch	1756	=item $int = $image->row_pitch
1281		1757
1282	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.
1283		1759
1284	=item $int = $image->slice_pitch	1760	=item $int = $image->slice_pitch
1285		1761
1286	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.
1287		1763
1288	=item $int = $image->width	1764	=item $int = $image->width
1289		1765
1290	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.
1291		1767
1292	=item $int = $image->height	1768	=item $int = $image->height
1293		1769
1294	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.
1295		1771
1296	=item $int = $image->depth	1772	=item $int = $image->depth
1297		1773
1298	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.
1299		1775
1300	=for gengetinfo end image	1776	=for gengetinfo end image
1301		1777
1302	=for gengetinfo begin gl_texture	1778	=for gengetinfo begin gl_texture
1303		1779
1304	=item $GLenum = $gl_texture->target	1780	=item $GLenum = $gl_texture->target
1305		1781
1306	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.
1307		1783
1308	=item $GLint = $gl_texture->gl_mipmap_level	1784	=item $GLint = $gl_texture->gl_mipmap_level
1309		1785
1310	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.
1311		1787
1312	=for gengetinfo end gl_texture	1788	=for gengetinfo end gl_texture
1313		1789
1314	=back	1790	=back
1315		1791
…		…
1325		1801
1326	=for gengetinfo begin sampler	1802	=for gengetinfo begin sampler
1327		1803
1328	=item $uint = $sampler->reference_count	1804	=item $uint = $sampler->reference_count
1329		1805
1330	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.
1331		1807
1332	=item $ctx = $sampler->context	1808	=item $ctx = $sampler->context
1333		1809
1334	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.
1335		1811
1336	=item $addressing_mode = $sampler->normalized_coords	1812	=item $addressing_mode = $sampler->normalized_coords
1337		1813
1338	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.
1339		1815
1340	=item $filter_mode = $sampler->addressing_mode	1816	=item $filter_mode = $sampler->addressing_mode
1341		1817
1342	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.
1343		1819
1344	=item $boolean = $sampler->filter_mode	1820	=item $boolean = $sampler->filter_mode
1345		1821
1346	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.
1347		1823
1348	=for gengetinfo end sampler	1824	=for gengetinfo end sampler
1349		1825
1350	=back	1826	=back
1351		1827
1352	=head2 THE OpenCL::Program CLASS	1828	=head2 THE OpenCL::Program CLASS
1353		1829
1354	=over 4	1830	=over 4
1355		1831
1356	=item $program->build ($device, $options = "")	1832	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1357		1833
1358	Tries to build the program with the given options. See also the	1834	Tries to build the program with the given options. See also the
1359	C<$ctx->build> convenience function.	1835	C<$ctx->build> convenience function.
1360		1836
		1837	If a callback is specified, then it will be called when compilation is
		1838	finished. Note that many OpenCL implementations block your program while
		1839	compiling whether you use a callback or not. See C<build_async> if you
		1840	want to make sure the build is done in the background.
		1841
		1842	Note that some OpenCL implementations act up badly, and don't call the
		1843	callback in some error cases (but call it in others). This implementation
		1844	assumes the callback will always be called, and leaks memory if this is
		1845	not so. So best make sure you don't pass in invalid values.
		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
1361	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>
		1862
		1863	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1864
		1865	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1866	need to check the compilation status form the callback, or by polling).
		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>
1362		1875
1363	=item $packed_value = $program->build_info ($device, $name)	1876	=item $packed_value = $program->build_info ($device, $name)
1364		1877
1365	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
1366	build attempt for the given device.	1879	build attempt for the given device.
1367		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
1368	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>
1369		1887
1370	=item $kernel = $program->kernel ($function_name)	1888	=item $kernel = $program->kernel ($function_name)
1371		1889
1372	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
…		…
1382		1900
1383	=for gengetinfo begin program_build	1901	=for gengetinfo begin program_build
1384		1902
1385	=item $build_status = $program->build_status ($device)	1903	=item $build_status = $program->build_status ($device)
1386		1904
1387	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.
1388		1906
1389	=item $string = $program->build_options ($device)	1907	=item $string = $program->build_options ($device)
1390		1908
1391	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.
1392		1910
1393	=item $string = $program->build_log ($device)	1911	=item $string = $program->build_log ($device)
1394		1912
1395	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.
1396		1918
1397	=for gengetinfo end program_build	1919	=for gengetinfo end program_build
1398		1920
1399	=item $packed_value = $program->info ($name)	1921	=item $packed_value = $program->info ($name)
1400		1922
…		…
1404		1926
1405	=for gengetinfo begin program	1927	=for gengetinfo begin program
1406		1928
1407	=item $uint = $program->reference_count	1929	=item $uint = $program->reference_count
1408		1930
1409	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.
1410		1932
1411	=item $ctx = $program->context	1933	=item $ctx = $program->context
1412		1934
1413	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.
1414		1936
1415	=item $uint = $program->num_devices	1937	=item $uint = $program->num_devices
1416		1938
1417	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.
1418		1940
1419	=item @devices = $program->devices	1941	=item @devices = $program->devices
1420		1942
1421	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.
1422		1944
1423	=item $string = $program->source	1945	=item $string = $program->source
1424		1946
1425	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.
1426		1948
1427	=item @ints = $program->binary_sizes	1949	=item @ints = $program->binary_sizes
1428		1950
1429	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.
1430		1952
1431	=for gengetinfo end program	1953	=for gengetinfo end program
1432		1954
1433	=item @blobs = $program->binaries	1955	=item @blobs = $program->binaries
1434		1956
…		…
1455		1977
1456	=for gengetinfo begin kernel	1978	=for gengetinfo begin kernel
1457		1979
1458	=item $string = $kernel->function_name	1980	=item $string = $kernel->function_name
1459		1981
1460	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.
1461		1983
1462	=item $uint = $kernel->num_args	1984	=item $uint = $kernel->num_args
1463		1985
1464	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.
1465		1987
1466	=item $uint = $kernel->reference_count	1988	=item $uint = $kernel->reference_count
1467		1989
1468	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.
1469		1991
1470	=item $ctx = $kernel->context	1992	=item $ctx = $kernel->context
1471		1993
1472	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.
1473		1995
1474	=item $program = $kernel->program	1996	=item $program = $kernel->program
1475		1997
1476	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.
1477		1999
1478	=for gengetinfo end kernel	2000	=for gengetinfo end kernel
1479		2001
1480	=item $packed_value = $kernel->work_group_info ($device, $name)	2002	=item $packed_value = $kernel->work_group_info ($device, $name)
1481		2003
1482	See C<< $platform->info >> for details.	2004	See C<< $platform->info >> for details.
1483		2005
1484	The reason this method is not called C<info> is that there already is an
1485	C<< ->info >> method.
1486
1487	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>
1488		2007
1489	=for gengetinfo begin kernel_work_group	2008	=for gengetinfo begin kernel_work_group
1490		2009
1491	=item $int = $kernel->work_group_size ($device)	2010	=item $int = $kernel->work_group_size ($device)
1492		2011
1493	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.
1494		2013
1495	=item @ints = $kernel->compile_work_group_size ($device)	2014	=item @ints = $kernel->compile_work_group_size ($device)
1496		2015
1497	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.
1498		2017
1499	=item $ulong = $kernel->local_mem_size ($device)	2018	=item $ulong = $kernel->local_mem_size ($device)
1500		2019
1501	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.
1502		2021
1503	=item $int = $kernel->preferred_work_group_size_multiple ($device)	2022	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1504		2023
1505	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.
1506		2025
1507	=item $ulong = $kernel->private_mem_size ($device)	2026	=item $ulong = $kernel->private_mem_size ($device)
1508		2027
1509	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.
1510		2029
1511	=for gengetinfo end kernel_work_group	2030	=for gengetinfo end kernel_work_group
1512		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
		2061
		2062	=item $kernel->setf ($format, ...)
		2063
		2064	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		2065	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		2066	need to specify a format argument, much as with C<printf>, to tell OpenCL
		2067	what type of argument it is.
		2068
		2069	The format arguments are single letters:
		2070
		2071	c char
		2072	C unsigned char
		2073	s short
		2074	S unsigned short
		2075	i int
		2076	I unsigned int
		2077	l long
		2078	L unsigned long
		2079
		2080	h half float (0..65535)
		2081	f float
		2082	d double
		2083
		2084	z local (octet size)
		2085
		2086	m memory object (buffer or image)
		2087	a sampler
		2088	e event
		2089
		2090	Space characters in the format string are ignored.
		2091
		2092	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		2093
		2094	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		2095
1513	=item $kernel->set_TYPE ($index, $value)	2096	=item $kernel->set_TYPE ($index, $value)
1514		2097
		2098	=item $kernel->set_char ($index, $value)
		2099
		2100	=item $kernel->set_uchar ($index, $value)
		2101
		2102	=item $kernel->set_short ($index, $value)
		2103
		2104	=item $kernel->set_ushort ($index, $value)
		2105
		2106	=item $kernel->set_int ($index, $value)
		2107
		2108	=item $kernel->set_uint ($index, $value)
		2109
		2110	=item $kernel->set_long ($index, $value)
		2111
		2112	=item $kernel->set_ulong ($index, $value)
		2113
		2114	=item $kernel->set_half ($index, $value)
		2115
		2116	=item $kernel->set_float ($index, $value)
		2117
		2118	=item $kernel->set_double ($index, $value)
		2119
		2120	=item $kernel->set_memory ($index, $value)
		2121
		2122	=item $kernel->set_buffer ($index, $value)
		2123
		2124	=item $kernel->set_image ($index, $value)
		2125
		2126	=item $kernel->set_sampler ($index, $value)
		2127
		2128	=item $kernel->set_local ($index, $value)
		2129
		2130	=item $kernel->set_event ($index, $value)
		2131
1515	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	2132	This is a family of methods to set the kernel argument with the number
1516		2133	C<$index> to the give C<$value>.
1517	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1518	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1519	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1520		2134
1521	Chars and integers (including the half type) are specified as integers,	2135	Chars and integers (including the half type) are specified as integers,
1522	float and double as floating point values, memory/buffer/image2d/image3d	2136	float and double as floating point values, memory/buffer/image must be
1523	must be an object of that type or C<undef>, local-memory arguments are	2137	an object of that type or C<undef>, local-memory arguments are set by
1524	set by specifying the size, and sampler and event must be objects of that	2138	specifying the size, and sampler and event must be objects of that type.
1525	type.	2139
		2140	Note that C<set_memory> works for all memory objects (all types of buffers
		2141	and images) - the main purpose of the more specific C<set_TYPE> functions
		2142	is type checking.
1526		2143
1527	Setting an argument for a kernel does NOT keep a reference to the object -	2144	Setting an argument for a kernel does NOT keep a reference to the object -
1528	for example, if you set an argument to some image object, free the image,	2145	for example, if you set an argument to some image object, free the image,
1529	and call the kernel, you will run into undefined behaviour.	2146	and call the kernel, you will run into undefined behaviour.
1530		2147
…		…
1543		2160
1544	Waits for the event to complete.	2161	Waits for the event to complete.
1545		2162
1546	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	2163	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1547		2164
		2165	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		2166
		2167	Adds a callback to the callback stack for the given event type. There is
		2168	no way to remove a callback again.
		2169
		2170	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		2171
1548	=item $packed_value = $ev->info ($name)	2172	=item $packed_value = $ev->info ($name)
1549		2173
1550	See C<< $platform->info >> for details.	2174	See C<< $platform->info >> for details.
1551		2175
1552	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	2176	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1553		2177
1554	=for gengetinfo begin event	2178	=for gengetinfo begin event
1555		2179
1556	=item $queue = $event->command_queue	2180	=item $queue = $event->command_queue
1557		2181
1558	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.
1559		2183
1560	=item $command_type = $event->command_type	2184	=item $command_type = $event->command_type
1561		2185
1562	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.
1563		2187
1564	=item $uint = $event->reference_count	2188	=item $uint = $event->reference_count
1565		2189
1566	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.
1567		2191
1568	=item $uint = $event->command_execution_status	2192	=item $uint = $event->command_execution_status
1569		2193
1570	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.
1571		2195
1572	=item $ctx = $event->context	2196	=item $ctx = $event->context
1573		2197
1574	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.
1575		2199
1576	=for gengetinfo end event	2200	=for gengetinfo end event
1577		2201
1578	=item $packed_value = $ev->profiling_info ($name)	2202	=item $packed_value = $ev->profiling_info ($name)
1579		2203
…		…
1586		2210
1587	=for gengetinfo begin profiling	2211	=for gengetinfo begin profiling
1588		2212
1589	=item $ulong = $event->profiling_command_queued	2213	=item $ulong = $event->profiling_command_queued
1590		2214
1591	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.
1592		2216
1593	=item $ulong = $event->profiling_command_submit	2217	=item $ulong = $event->profiling_command_submit
1594		2218
1595	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.
1596		2220
1597	=item $ulong = $event->profiling_command_start	2221	=item $ulong = $event->profiling_command_start
1598		2222
1599	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.
1600		2224
1601	=item $ulong = $event->profiling_command_end	2225	=item $ulong = $event->profiling_command_end
1602		2226
1603	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.
1604		2228
1605	=for gengetinfo end profiling	2229	=for gengetinfo end profiling
1606		2230
1607	=back	2231	=back
1608		2232
…		…
1612		2236
1613	=over 4	2237	=over 4
1614		2238
1615	=item $ev->set_status ($execution_status)	2239	=item $ev->set_status ($execution_status)
1616		2240
		2241	Sets the execution status of the user event. Can only be called once,
		2242	either with OpenCL::COMPLETE or a negative number as status.
		2243
		2244	execution_status: OpenCL::COMPLETE or a negative integer.
		2245
1617	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>
1618		2247
1619	=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
1620		2350
1621	=cut	2351	=cut
1622		2352
1623	1;	2353	1;
1624		2354

Diff Legend

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