ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.53 by root, Tue Apr 24 14:30:57 2012 UTC vs.
Revision 1.79 by root, Sat May 5 13:30:07 2012 UTC

…		…
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
…		…
92	initialised at creation time).	96	initialised at creation time).
93		97
94	Enqueue the kernel execution.	98	Enqueue the kernel execution.
95		99
96	Enqueue buffer reads for your output buffer to read results.	100	Enqueue buffer reads for your output buffer to read results.
		101
		102	=head1 OPENCL 1.1 VS. OPENCL 1.2
		103
		104	This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
		105	1.2 interface hasn't been tested much for lack of availability of an
		106	actual implementation.
		107
		108	Every function or method in this manual page that interfaces to a
		109	particular OpenCL function has a link to the its C manual page.
		110
		111	If the link contains a F<1.1>, then this function is an OpenCL 1.1
		112	function. Most but not all also exist in OpenCL 1.2, and this module
		113	tries to emulate the missing ones for you, when told to do so at
		114	compiletime. You cna check whether a function was removed in OpenCL 1.2 by
		115	replacing the F<1.1> component in the URL by F<1.2>.
		116
		117	If the link contains a F<1.2>, then this is a OpenCL 1.2-only
		118	function. Even if the module was compiled with OpenCL 1.2 header files
		119	and has an 1.2 OpenCL library, calling such a function on a platform that
		120	doesn't implement 1.2 causes undefined behaviour, usually a crash (But
		121	this is not guaranteed).
		122
		123	You can find out whether this module was compiled to prefer 1.1
		124	functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
		125	1.1 functions generally are implemented using 1.1 OpenCL functions. If it
		126	is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
		127	fucntions.
		128
		129	This is a somewhat sorry state of affairs, but the Khronos group choose to
		130	make every release of OpenCL source and binary incompatible with previous
		131	releases.
97		132
98	=head1 EXAMPLES	133	=head1 EXAMPLES
99		134
100	=head2 Enumerate all devices and get contexts for them.	135	=head2 Enumerate all devices and get contexts for them.
101		136
…		…
138	=head2 Create a buffer with some predefined data, read it back synchronously,	173	=head2 Create a buffer with some predefined data, read it back synchronously,
139	then asynchronously.	174	then asynchronously.
140		175
141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	176	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
142		177
143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	178	$queue->read_buffer ($buf, 1, 1, 3, my $data);
144	print "$data\n";	179	print "$data\n";
145		180
146	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	181	my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
147	$ev->wait;	182	$ev->wait;
148	print "$data\n"; # prints "elm"	183	print "$data\n"; # prints "elm"
149		184
150	=head2 Create and build a program, then create a kernel out of one of its	185	=head2 Create and build a program, then create a kernel out of one of its
151	functions.	186	functions.
…		…
171	# set buffer	206	# set buffer
172	$kernel->set_buffer (0, $input);	207	$kernel->set_buffer (0, $input);
173	$kernel->set_buffer (1, $output);	208	$kernel->set_buffer (1, $output);
174		209
175	# execute it for all 4 numbers	210	# execute it for all 4 numbers
176	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	211	$queue->nd_range_kernel ($kernel, undef, [4], undef);
177		212
178	# enqueue a synchronous read	213	# enqueue a synchronous read
179	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	214	$queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
180		215
181	# print the results:	216	# print the results:
182	printf "%s\n", join ", ", unpack "f*", $data;	217	printf "%s\n", join ", ", unpack "f*", $data;
183		218
184	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	219	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
185	showing off barriers.	220	showing off barriers.
186		221
187	# execute it for all 4 numbers	222	# execute it for all 4 numbers
188	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	223	$queue->nd_range_kernel ($kernel, undef, [4], undef);
189		224
190	# enqueue a barrier to ensure in-order execution	225	# enqueue a barrier to ensure in-order execution
191	$queue->enqueue_barrier;	226	$queue->barrier;
192		227
193	# enqueue an async read	228	# enqueue an async read
194	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	229	$queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
195		230
196	# wait for all requests to finish	231	# wait for all requests to finish
197	$queue->finish;	232	$queue->finish;
198		233
199	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	234	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
200	showing off event objects and wait lists.	235	showing off event objects and wait lists.
201		236
202	# execute it for all 4 numbers	237	# execute it for all 4 numbers
203	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	238	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
204		239
205	# enqueue an async read	240	# enqueue an async read
206	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	241	$ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
207		242
208	# wait for the last event to complete	243	# wait for the last event to complete
209	$ev->wait;	244	$ev->wait;
210		245
211	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia	246	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
212	set tunnel effect.	247	set flight effect.
213		248
214	This is quite a long example to get you going.	249	This is quite a long example to get you going - you can download it from
		250	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
215		251
216	use OpenGL ":all";	252	use OpenGL ":all";
217	use OpenCL;	253	use OpenCL;
218		254
		255	my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
		256
219	# open a window and create a gl texture	257	# open a window and create a gl texture
220	OpenGL::glpOpenWindow width => 256, height => 256;	258	OpenGL::glpOpenWindow width => $S, height => $S;
221	my $texid = glGenTextures_p 1;	259	my $texid = glGenTextures_p 1;
222	glBindTexture GL_TEXTURE_2D, $texid;	260	glBindTexture GL_TEXTURE_2D, $texid;
223	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;	261	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
224		262
225	# find and use the first opencl device that let's us get a shared opengl context	263	# find and use the first opencl device that let's us get a shared opengl context
226	my $platform;	264	my $platform;
227	my $dev;	265	my $dev;
228	my $ctx;	266	my $ctx;
…		…
247	# now the boring opencl code	285	# now the boring opencl code
248	my $src = <<EOF;	286	my $src = <<EOF;
249	kernel void	287	kernel void
250	juliatunnel (write_only image2d_t img, float time)	288	juliatunnel (write_only image2d_t img, float time)
251	{	289	{
252	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;	290	int2 xy = (int2)(get_global_id (0), get_global_id (1));
		291	float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
253		292
254	float2 m = (float2)(1.f, p.y) / fabs (p.x);	293	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;	294	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
256		295
257	float2 z = m;	296	float2 z = m;
258	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	297	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
259		298
260	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)	299	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;	300	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
262		301
263	float3 colour = (float3)(z.x, z.y, z.x * z.y);	302	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.));	303	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
265	}	304	}
266	EOF	305	EOF
267		306
268	my $prog = $ctx->build_program ($src);	307	my $prog = $ctx->build_program ($src);
269	my $kernel = $prog->kernel ("juliatunnel");	308	my $kernel = $prog->kernel ("juliatunnel");
270		309
271	# program compiled, kernel ready, now draw and loop	310	# program compiled, kernel ready, now draw and loop
272		311
273	for (my $time; ; ++$time) {	312	for (my $time; ; ++$time) {
274	# acquire objects from opengl	313	# acquire objects from opengl
275	$queue->enqueue_acquire_gl_objects ([$tex]);	314	$queue->acquire_gl_objects ([$tex]);
276		315
277	# configure and run our kernel	316	# configure and run our kernel
278	$kernel->set_image2d (0, $tex);	317	$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);	318	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
281		319
282	# release objects to opengl again	320	# release objects to opengl again
283	$queue->enqueue_release_gl_objects ([$tex]);	321	$queue->release_gl_objects ([$tex]);
284		322
285	# wait	323	# wait
286	$queue->finish;	324	$queue->finish;
287		325
288	# now draw the texture, the defaults should be all right	326	# now draw the texture, the defaults should be all right
…		…
299	glXSwapBuffers;	337	glXSwapBuffers;
300		338
301	select undef, undef, undef, 1/60;	339	select undef, undef, undef, 1/60;
302	}	340	}
303		341
		342	=head2 How to modify the previous example to not rely on GL sharing.
		343
		344	For those poor souls with only a sucky CPU OpenCL implementation, you
		345	currently have to read the image into some perl scalar, and then modify a
		346	texture or use glDrawPixels or so).
		347
		348	First, when you don't need gl sharing, you can create the context much simpler:
		349
		350	$ctx = $platform->context (undef, [$dev])
		351
		352	To use a texture, you would modify the above example by creating an
		353	OpenCL::Image manually instead of deriving it from a texture:
		354
		355	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
		356
		357	And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
		358	would read the image2d after the kernel has written it:
		359
		360	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
		361
		362	And then you would upload the pixel data to the texture (or use glDrawPixels):
		363
		364	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
		365
		366	The fully modified example can be found at
		367	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
		368
		369	=head2 Julia sets look soooo 80ies.
		370
		371	Then colour them differently, e.g. using orbit traps! Replace the loop and
		372	colour calculation from the previous examples by this:
		373
		374	float2 dm = (float2)(1.f, 1.f);
		375
		376	for (int i = 0; i < 25; ++i)
		377	{
		378	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		379	dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
		380	}
		381
		382	float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
		383
		384	Also try C<-10.f> instead of C<-1.f>.
		385
304	=head1 DOCUMENTATION	386	=head1 DOCUMENTATION
305		387
306	=head2 BASIC CONVENTIONS	388	=head2 BASIC CONVENTIONS
307		389
308	This is not a one-to-one C-style translation of OpenCL to Perl - instead	390	This is not a one-to-one C-style translation of OpenCL to Perl - instead
…		…
337		419
338	=item * When enqueuing commands, if the enqueue method is called in void	420	=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	421	context, no event is created. In all other contexts an event is returned
340	by the method.	422	by the method.
341		423
342	=item * This module expects all functions to return C<CL_SUCCESS>. If any	424	=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	425	other status is returned the function will throw an exception, so you
344	don't normally have to to any error checking.	426	don't normally have to to any error checking.
345		427
346	=back	428	=back
347		429
…		…
376		458
377	For this to work, the OpenGL library must be loaded, a GLX context must	459	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	460	have been created and be made current, and C<dlsym> must be available and
379	capable of finding the function via C<RTLD_DEFAULT>.	461	capable of finding the function via C<RTLD_DEFAULT>.
380		462
		463	=head2 EVENT SYSTEM
		464
		465	OpenCL can generate a number of (potentially) asynchronous events, for
		466	example, after compiling a program, to signal a context-related error or,
		467	perhaps most important, to signal completion of queued jobs (by setting
		468	callbacks on OpenCL::Event objects).
		469
		470	The OpenCL module converts all these callbacks into events - you can
		471	still register callbacks, but they are not executed when your OpenCL
		472	implementation calls the actual callback, but only later. Therefore, none
		473	of the limitations of OpenCL callbacks apply to the perl implementation:
		474	it is perfectly safe to make blocking operations from event callbacks, and
		475	enqueued operations don't need to be flushed.
		476
		477	To facilitate this, this module maintains an event queue - each
		478	time an asynchronous event happens, it is queued, and perl will be
		479	interrupted. This is implemented via the L<Async::Interrupt> module. In
		480	addition, this module has L<AnyEvent> support, so it can seamlessly
		481	integrate itself into many event loops.
		482
		483	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
		484
		485	=head3 Don't use callbacks.
		486
		487	When your program never uses any callbacks, then there will never be any
		488	notifications you need to take care of, and therefore no need to worry
		489	about all this.
		490
		491	You can achieve a great deal by explicitly waiting for events, or using
		492	barriers and flush calls. In many programs, there is no need at all to
		493	tinker with asynchronous events.
		494
		495	=head3 Use AnyEvent
		496
		497	This module automatically registers a watcher that invokes all outstanding
		498	event callbacks when AnyEvent is initialised (and block asynchronous
		499	interruptions). Using this mode of operations is the safest and most
		500	recommended one.
		501
		502	To use this, simply use AnyEvent and this module normally, make sure you
		503	have an event loop running:
		504
		505	use Gtk2 -init;
		506	use AnyEvent;
		507
		508	# initialise AnyEvent, by creating a watcher, or:
		509	AnyEvent::detect;
		510
		511	my $e = $queue->marker;
		512	$e->cb (sub {
		513	warn "opencl is finished\n";
		514	})
		515
		516	main Gtk2;
		517
		518	Note that this module will not initialise AnyEvent for you. Before
		519	AnyEvent is initialised, the module will asynchronously interrupt perl
		520	instead. To avoid any surprises, it's best to explicitly initialise
		521	AnyEvent.
		522
		523	You can temporarily enable asynchronous interruptions (see next paragraph)
		524	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		525	calling C<$OpenCL::INTERRUPT->block>.
		526
		527	=head3 Let yourself be interrupted at any time
		528
		529	This mode is the default unless AnyEvent is loaded and initialised. In
		530	this mode, OpenCL asynchronously interrupts a running perl program. The
		531	emphasis is on both I<asynchronously> and I<running> here.
		532
		533	Asynchronously means that perl might execute your callbacks at any
		534	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		535	the C<until> loop following the marker call will be interrupted by the
		536	callback:
		537
		538	my $e = $queue->marker;
		539	my $flag;
		540	$e->cb (sub { $flag = 1 });
		541	1 until $flag;
		542	# $flag is now 1
		543
		544	The reason why you shouldn't blindly copy the above code is that
		545	busy waiting is a really really bad thing, and really really bad for
		546	performance.
		547
		548	While at first this asynchronous business might look exciting, it can be
		549	really hard, because you need to be prepared for the callback code to be
		550	executed at any time, which limits the amount of things the callback code
		551	can do safely.
		552
		553	This can be mitigated somewhat by using C<<
		554	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		555	documentation for details).
		556
		557	The other problem is that your program must be actively I<running> to be
		558	interrupted. When you calculate stuff, your program is running. When you
		559	hang in some C functions or other block execution (by calling C<sleep>,
		560	C<select>, running an event loop and so on), your program is waiting, not
		561	running.
		562
		563	One way around that would be to attach a read watcher to your event loop,
		564	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		565	dummy callback (C<sub { }>) to temporarily execute some perl code.
		566
		567	That is then awfully close to using the built-in AnyEvent support above,
		568	though, so consider that one instead.
		569
		570	=head3 Be creative
		571
		572	OpenCL exports the L<Async::Interrupt> object it uses in the global
		573	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		574
		575	So if you want to feel like a real pro, err, wait, if you feel no risk
		576	menas no fun, you can experiment by implementing your own mode of
		577	operations.
		578
381	=cut	579	=cut
382		580
383	package OpenCL;	581	package OpenCL;
384		582
385	use common::sense;	583	use common::sense;
		584	use Carp ();
		585	use Async::Interrupt ();
		586
		587	our $POLL_FUNC; # set by XS
386		588
387	BEGIN {	589	BEGIN {
388	our $VERSION = '0.96';	590	our $VERSION = '0.99';
389		591
390	require XSLoader;	592	require XSLoader;
391	XSLoader::load (__PACKAGE__, $VERSION);	593	XSLoader::load (__PACKAGE__, $VERSION);
392		594
393	@OpenCL::Platform::ISA =	595	@OpenCL::Platform::ISA =
…		…
398	@OpenCL::Sampler::ISA =	600	@OpenCL::Sampler::ISA =
399	@OpenCL::Program::ISA =	601	@OpenCL::Program::ISA =
400	@OpenCL::Kernel::ISA =	602	@OpenCL::Kernel::ISA =
401	@OpenCL::Event::ISA = OpenCL::Object::;	603	@OpenCL::Event::ISA = OpenCL::Object::;
402		604
		605	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		606
403	@OpenCL::Buffer::ISA =	607	@OpenCL::Buffer::ISA =
404	@OpenCL::Image::ISA = OpenCL::Memory::;	608	@OpenCL::Image::ISA = OpenCL::Memory::;
405		609
406	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	610	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
407		611
…		…
411	@OpenCL::Image1D::ISA =	615	@OpenCL::Image1D::ISA =
412	@OpenCL::Image1DArray::ISA =	616	@OpenCL::Image1DArray::ISA =
413	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	617	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
414		618
415	@OpenCL::UserEvent::ISA = OpenCL::Event::;	619	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		620
		621	@OpenCL::MappedBuffer::ISA =
		622	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
416	}	623	}
417		624
418	=head2 THE OpenCL PACKAGE	625	=head2 THE OpenCL PACKAGE
419		626
420	=over 4	627	=over 4
…		…
422	=item $int = OpenCL::errno	629	=item $int = OpenCL::errno
423		630
424	The last error returned by a function - it's only valid after an error occured	631	The last error returned by a function - it's only valid after an error occured
425	and before calling another OpenCL function.	632	and before calling another OpenCL function.
426		633
427	=item $str = OpenCL::err2str $errval	634	=item $str = OpenCL::err2str [$errval]
428		635
429	Comverts an error value into a human readable string.	636	Converts an error value into a human readable string. IF no error value is
		637	given, then the last error will be used (as returned by OpenCL::errno).
430		638
431	=item $str = OpenCL::enum2str $enum	639	=item $str = OpenCL::enum2str $enum
432		640
433	Converts most enum values (of parameter names, image format constants,	641	Converts most enum values (of parameter names, image format constants,
434	object types, addressing and filter modes, command types etc.) into a	642	object types, addressing and filter modes, command types etc.) into a
…		…
440		648
441	Returns all available OpenCL::Platform objects.	649	Returns all available OpenCL::Platform objects.
442		650
443	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	651	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
444		652
445	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	653	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
446		654
447	Tries to create a context from a default device and platform - never worked for me.	655	Tries to create a context from a default device and platform type - never worked for me.
		656	Consider using C<< $platform->context_from_type >> instead.
		657
		658	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		659	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
448		660
449	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	661	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
450		662
		663	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		664
		665	Create a new OpenCL::Context object using the given device object(s).
		666	Consider using C<< $platform->context >> instead.
		667
		668	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		669
451	=item OpenCL::wait_for_events $wait_events...	670	=item OpenCL::wait_for_events $wait_events...
452		671
453	Waits for all events to complete.	672	Waits for all events to complete.
454		673
455	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	674	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		675
		676	=item OpenCL::poll
		677
		678	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		679	invokes their callbacks.
		680
		681	=item $OpenCL::INTERRUPT
		682
		683	The L<Async::Interrupt> object used to signal asynchronous events (see
		684	L<EVENT SYSTEM>).
		685
		686	=cut
		687
		688	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		689
		690	&_eq_initialise ($INTERRUPT->signal_func);
		691
		692	=item $OpenCL::WATCHER
		693
		694	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		695	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		696	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		697
		698	=cut
		699
		700	our $WATCHER;
		701
		702	sub _init_anyevent {
		703	$INTERRUPT->block;
		704	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		705	}
		706
		707	if (defined $AnyEvent::MODEL) {
		708	_init_anyevent;
		709	} else {
		710	push @AnyEvent::post_detect, \&_init_anyevent;
		711	}
456		712
457	=back	713	=back
458		714
459	=head2 THE OpenCL::Object CLASS	715	=head2 THE OpenCL::Object CLASS
460		716
…		…
472	C<IV> type in your code and cast that to the correct type.	728	C<IV> type in your code and cast that to the correct type.
473		729
474	=cut	730	=cut
475		731
476	sub OpenCL::Object::id {	732	sub OpenCL::Object::id {
		733	ref $_[0] eq "SCALAR"
477	${$_[0]}	734	? ${ $_[0] }
		735	: $_[0][0]
478	}	736	}
479		737
480	=back	738	=back
481		739
482	=head2 THE OpenCL::Platform CLASS	740	=head2 THE OpenCL::Platform CLASS
…		…
485		743
486	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	744	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
487		745
488	Returns a list of matching OpenCL::Device objects.	746	Returns a list of matching OpenCL::Device objects.
489		747
490	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	748	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
491		749
492	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	750	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
493		751
494	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	752	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
495		753
496	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)	754	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
497		755
498	Create a new OpenCL::Context object using the given device object(s)- a	756	Create a new OpenCL::Context object using the given device object(s)- a
499	CL_CONTEXT_PLATFORM property is supplied automatically.	757	OpenCL::CONTEXT_PLATFORM property is supplied automatically.
500		758
501	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	759	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
502		760
503	=item $packed_value = $platform->info ($name)	761	=item $packed_value = $platform->info ($name)
504		762
…		…
520		778
521	=for gengetinfo begin platform	779	=for gengetinfo begin platform
522		780
523	=item $string = $platform->profile	781	=item $string = $platform->profile
524		782
525	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	783	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
526		784
527	=item $string = $platform->version	785	=item $string = $platform->version
528		786
529	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	787	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
530		788
531	=item $string = $platform->name	789	=item $string = $platform->name
532		790
533	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	791	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
534		792
535	=item $string = $platform->vendor	793	=item $string = $platform->vendor
536		794
537	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	795	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
538		796
539	=item $string = $platform->extensions	797	=item $string = $platform->extensions
540		798
541	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	799	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
542		800
543	=for gengetinfo end platform	801	=for gengetinfo end platform
544		802
545	=back	803	=back
546		804
…		…
550		808
551	=item $packed_value = $device->info ($name)	809	=item $packed_value = $device->info ($name)
552		810
553	See C<< $platform->info >> for details.	811	See C<< $platform->info >> for details.
554		812
		813	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
		814	OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
		815	OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
		816
		817	fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
		818	OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
		819	OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
		820
		821	mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
		822
		823	local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
		824
		825	exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
		826
		827	command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
		828	OpenCL::QUEUE_PROFILING_ENABLE.
		829
		830	partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
		831	OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
		832	OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
		833
		834	affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
		835	OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
		836	OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
		837	OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
		838
555	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	839	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
556		840
		841	=item @devices = $device->sub_devices (\@properties)
		842
		843	Creates OpencL::SubDevice objects by partitioning an existing device.
		844
		845	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		846
557	=for gengetinfo begin device	847	=for gengetinfo begin device
558		848
559	=item $device_type = $device->type	849	=item $device_type = $device->type
560		850
561	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	851	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
562		852
563	=item $uint = $device->vendor_id	853	=item $uint = $device->vendor_id
564		854
565	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	855	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
566		856
567	=item $uint = $device->max_compute_units	857	=item $uint = $device->max_compute_units
568		858
569	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	859	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
570		860
571	=item $uint = $device->max_work_item_dimensions	861	=item $uint = $device->max_work_item_dimensions
572		862
573	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	863	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
574		864
575	=item $int = $device->max_work_group_size	865	=item $int = $device->max_work_group_size
576		866
577	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	867	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
578		868
579	=item @ints = $device->max_work_item_sizes	869	=item @ints = $device->max_work_item_sizes
580		870
581	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	871	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
582		872
583	=item $uint = $device->preferred_vector_width_char	873	=item $uint = $device->preferred_vector_width_char
584		874
585	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	875	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
586		876
587	=item $uint = $device->preferred_vector_width_short	877	=item $uint = $device->preferred_vector_width_short
588		878
589	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	879	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
590		880
591	=item $uint = $device->preferred_vector_width_int	881	=item $uint = $device->preferred_vector_width_int
592		882
593	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	883	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
594		884
595	=item $uint = $device->preferred_vector_width_long	885	=item $uint = $device->preferred_vector_width_long
596		886
597	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	887	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
598		888
599	=item $uint = $device->preferred_vector_width_float	889	=item $uint = $device->preferred_vector_width_float
600		890
601	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	891	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
602		892
603	=item $uint = $device->preferred_vector_width_double	893	=item $uint = $device->preferred_vector_width_double
604		894
605	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	895	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
606		896
607	=item $uint = $device->max_clock_frequency	897	=item $uint = $device->max_clock_frequency
608		898
609	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	899	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
610		900
611	=item $bitfield = $device->address_bits	901	=item $bitfield = $device->address_bits
612		902
613	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	903	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
614		904
615	=item $uint = $device->max_read_image_args	905	=item $uint = $device->max_read_image_args
616		906
617	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	907	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
618		908
619	=item $uint = $device->max_write_image_args	909	=item $uint = $device->max_write_image_args
620		910
621	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	911	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
622		912
623	=item $ulong = $device->max_mem_alloc_size	913	=item $ulong = $device->max_mem_alloc_size
624		914
625	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	915	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
626		916
627	=item $int = $device->image2d_max_width	917	=item $int = $device->image2d_max_width
628		918
629	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	919	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
630		920
631	=item $int = $device->image2d_max_height	921	=item $int = $device->image2d_max_height
632		922
633	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	923	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
634		924
635	=item $int = $device->image3d_max_width	925	=item $int = $device->image3d_max_width
636		926
637	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	927	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
638		928
639	=item $int = $device->image3d_max_height	929	=item $int = $device->image3d_max_height
640		930
641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	931	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
642		932
643	=item $int = $device->image3d_max_depth	933	=item $int = $device->image3d_max_depth
644		934
645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	935	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
646		936
647	=item $uint = $device->image_support	937	=item $uint = $device->image_support
648		938
649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	939	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
650		940
651	=item $int = $device->max_parameter_size	941	=item $int = $device->max_parameter_size
652		942
653	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	943	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
654		944
655	=item $uint = $device->max_samplers	945	=item $uint = $device->max_samplers
656		946
657	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	947	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
658		948
659	=item $uint = $device->mem_base_addr_align	949	=item $uint = $device->mem_base_addr_align
660		950
661	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	951	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
662		952
663	=item $uint = $device->min_data_type_align_size	953	=item $uint = $device->min_data_type_align_size
664		954
665	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	955	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
666		956
667	=item $device_fp_config = $device->single_fp_config	957	=item $device_fp_config = $device->single_fp_config
668		958
669	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	959	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
670		960
671	=item $device_mem_cache_type = $device->global_mem_cache_type	961	=item $device_mem_cache_type = $device->global_mem_cache_type
672		962
673	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	963	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
674		964
675	=item $uint = $device->global_mem_cacheline_size	965	=item $uint = $device->global_mem_cacheline_size
676		966
677	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	967	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
678		968
679	=item $ulong = $device->global_mem_cache_size	969	=item $ulong = $device->global_mem_cache_size
680		970
681	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	971	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
682		972
683	=item $ulong = $device->global_mem_size	973	=item $ulong = $device->global_mem_size
684		974
685	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	975	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
686		976
687	=item $ulong = $device->max_constant_buffer_size	977	=item $ulong = $device->max_constant_buffer_size
688		978
689	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	979	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
690		980
691	=item $uint = $device->max_constant_args	981	=item $uint = $device->max_constant_args
692		982
693	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	983	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
694		984
695	=item $device_local_mem_type = $device->local_mem_type	985	=item $device_local_mem_type = $device->local_mem_type
696		986
697	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	987	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
698		988
699	=item $ulong = $device->local_mem_size	989	=item $ulong = $device->local_mem_size
700		990
701	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	991	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
702		992
703	=item $boolean = $device->error_correction_support	993	=item $boolean = $device->error_correction_support
704		994
705	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	995	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
706		996
707	=item $int = $device->profiling_timer_resolution	997	=item $int = $device->profiling_timer_resolution
708		998
709	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	999	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
710		1000
711	=item $boolean = $device->endian_little	1001	=item $boolean = $device->endian_little
712		1002
713	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	1003	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
714		1004
715	=item $boolean = $device->available	1005	=item $boolean = $device->available
716		1006
717	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	1007	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
718		1008
719	=item $boolean = $device->compiler_available	1009	=item $boolean = $device->compiler_available
720		1010
721	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	1011	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
722		1012
723	=item $device_exec_capabilities = $device->execution_capabilities	1013	=item $device_exec_capabilities = $device->execution_capabilities
724		1014
725	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	1015	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
726		1016
727	=item $command_queue_properties = $device->properties	1017	=item $command_queue_properties = $device->properties
728		1018
729	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	1019	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
730		1020
731	=item $ = $device->platform	1021	=item $ = $device->platform
732		1022
733	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	1023	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
734		1024
735	=item $string = $device->name	1025	=item $string = $device->name
736		1026
737	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	1027	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
738		1028
739	=item $string = $device->vendor	1029	=item $string = $device->vendor
740		1030
741	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	1031	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
742		1032
743	=item $string = $device->driver_version	1033	=item $string = $device->driver_version
744		1034
745	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	1035	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
746		1036
747	=item $string = $device->profile	1037	=item $string = $device->profile
748		1038
749	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	1039	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
750		1040
751	=item $string = $device->version	1041	=item $string = $device->version
752		1042
753	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	1043	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
754		1044
755	=item $string = $device->extensions	1045	=item $string = $device->extensions
756		1046
757	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	1047	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
758		1048
759	=item $uint = $device->preferred_vector_width_half	1049	=item $uint = $device->preferred_vector_width_half
760		1050
761	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	1051	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
762		1052
763	=item $uint = $device->native_vector_width_char	1053	=item $uint = $device->native_vector_width_char
764		1054
765	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	1055	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
766		1056
767	=item $uint = $device->native_vector_width_short	1057	=item $uint = $device->native_vector_width_short
768		1058
769	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1059	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
770		1060
771	=item $uint = $device->native_vector_width_int	1061	=item $uint = $device->native_vector_width_int
772		1062
773	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1063	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
774		1064
775	=item $uint = $device->native_vector_width_long	1065	=item $uint = $device->native_vector_width_long
776		1066
777	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1067	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
778		1068
779	=item $uint = $device->native_vector_width_float	1069	=item $uint = $device->native_vector_width_float
780		1070
781	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1071	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
782		1072
783	=item $uint = $device->native_vector_width_double	1073	=item $uint = $device->native_vector_width_double
784		1074
785	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1075	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
786		1076
787	=item $uint = $device->native_vector_width_half	1077	=item $uint = $device->native_vector_width_half
788		1078
789	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1079	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
790		1080
791	=item $device_fp_config = $device->double_fp_config	1081	=item $device_fp_config = $device->double_fp_config
792		1082
793	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1083	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
794		1084
795	=item $device_fp_config = $device->half_fp_config	1085	=item $device_fp_config = $device->half_fp_config
796		1086
797	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1087	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
798		1088
799	=item $boolean = $device->host_unified_memory	1089	=item $boolean = $device->host_unified_memory
800		1090
801	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1091	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
802		1092
803	=item $device = $device->parent_device_ext	1093	=item $device = $device->parent_device_ext
804		1094
805	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1095	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
806		1096
807	=item @device_partition_property_exts = $device->partition_types_ext	1097	=item @device_partition_property_exts = $device->partition_types_ext
808		1098
809	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1099	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
810		1100
811	=item @device_partition_property_exts = $device->affinity_domains_ext	1101	=item @device_partition_property_exts = $device->affinity_domains_ext
812		1102
813	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1103	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
814		1104
815	=item $uint = $device->reference_count_ext	1105	=item $uint = $device->reference_count_ext
816		1106
817	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1107	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
818		1108
819	=item @device_partition_property_exts = $device->partition_style_ext	1109	=item @device_partition_property_exts = $device->partition_style_ext
820		1110
821	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1111	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
822		1112
823	=for gengetinfo end device	1113	=for gengetinfo end device
824		1114
825	=back	1115	=back
826		1116
827	=head2 THE OpenCL::Context CLASS	1117	=head2 THE OpenCL::Context CLASS
		1118
		1119	An OpenCL::Context is basically a container, or manager, for a number of
		1120	devices of a platform. It is used to create all sorts of secondary objects
		1121	such as buffers, queues, programs and so on.
		1122
		1123	All context creation functions and methods take a list of properties
		1124	(type-value pairs). All property values can be specified as integers -
		1125	some additionally support other types:
		1126
		1127	=over 4
		1128
		1129	=item OpenCL::CONTEXT_PLATFORM
		1130
		1131	Also accepts OpenCL::Platform objects.
		1132
		1133	=item OpenCL::GLX_DISPLAY_KHR
		1134
		1135	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1136	to find the current glx display (see L<GLX SUPPORT>).
		1137
		1138	=item OpenCL::GL_CONTEXT_KHR
		1139
		1140	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1141	to find the current glx context (see L<GLX SUPPORT>).
		1142
		1143	=back
828		1144
829	=over 4	1145	=over 4
830		1146
831	=item $prog = $ctx->build_program ($program, $options = "")	1147	=item $prog = $ctx->build_program ($program, $options = "")
832		1148
…		…
844	my ($self, $prog, $options) = @_;	1160	my ($self, $prog, $options) = @_;
845		1161
846	$prog = $self->program_with_source ($prog)	1162	$prog = $self->program_with_source ($prog)
847	unless ref $prog;	1163	unless ref $prog;
848		1164
		1165	eval { $prog->build (undef, $options); 1 }
		1166	or errno == BUILD_PROGRAM_FAILURE
		1167	or errno == INVALID_BINARY # workaround nvidia bug
		1168	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1169
		1170	# we check status for all devices
849	for my $dev ($self->devices) {	1171	for my $dev ($self->devices) {
850	eval { $prog->build ($dev, $options); 1 }	1172	$prog->build_status ($dev) == BUILD_SUCCESS
851	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"	1173	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
852	. $prog->build_log ($dev);	1174	. $prog->build_log ($dev);
853	}	1175	}
854		1176
855	$prog	1177	$prog
856	}	1178	}
857		1179
…		…
874	=item $buf = $ctx->buffer ($flags, $len)	1196	=item $buf = $ctx->buffer ($flags, $len)
875		1197
876	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1198	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
877	given flags and octet-size.	1199	given flags and octet-size.
878		1200
		1201	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1202	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1203	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1204
879	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1205	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
880		1206
881	=item $buf = $ctx->buffer_sv ($flags, $data)	1207	=item $buf = $ctx->buffer_sv ($flags, $data)
882		1208
883	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1209	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
884	initialise it with the given data values.	1210	initialise it with the given data values.
885		1211
886	=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)	1212	=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)
887		1213
888	Creates a new OpenCL::Image object and optionally initialises it with	1214	Creates a new OpenCL::Image object and optionally initialises it with
889	the given data values.	1215	the given data values.
890		1216
		1217	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1218	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1219	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1220
		1221	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1222	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1223	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1224	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1225	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1226
		1227	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1228	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1229	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1230	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1231
891	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1232	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
892		1233
893	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1234	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
894		1235
895	Creates a new OpenCL::Image2D object and optionally initialises it with	1236	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
907	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1248	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
908		1249
909	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1250	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
910	OpenGL buffer object.	1251	OpenGL buffer object.
911		1252
		1253	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1254
912	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1255	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
913		1256
914	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1257	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
915		1258
916	Creates a new OpenCL::Image object that refers to the given OpenGL	1259	Creates a new OpenCL::Image object that refers to the given OpenGL
917	texture object or buffer.	1260	texture object or buffer.
918		1261
		1262	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1263	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1264	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1265	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1266	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1267	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1268
919	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1269	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
920		1270
921	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1271	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
922		1272
923	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1273	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
948		1298
949	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1299	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
950		1300
951	Creates a new OpenCL::Sampler object.	1301	Creates a new OpenCL::Sampler object.
952		1302
		1303	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1304	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1305
		1306	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1307
953	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1308	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
954		1309
955	=item $program = $ctx->program_with_source ($string)	1310	=item $program = $ctx->program_with_source ($string)
956		1311
957	Creates a new OpenCL::Program object from the given source code.	1312	Creates a new OpenCL::Program object from the given source code.
958		1313
959	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1314	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
960		1315
		1316	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1317
		1318	Creates a new OpenCL::Program object from the given binaries.
		1319
		1320	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1321
		1322	Example: clone an existing program object that contains a successfully
		1323	compiled program, no matter how useless this is.
		1324
		1325	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1326
		1327	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1328
		1329	Creates a new OpenCL::Program object from the given built-in kernel names.
		1330
		1331	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1332
		1333	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1334
		1335	Links all (already compiled) program objects specified in C<@programs>
		1336	together and returns a new OpenCL::Program object with the result.
		1337
		1338	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1339
961	=item $packed_value = $ctx->info ($name)	1340	=item $packed_value = $ctx->info ($name)
962		1341
963	See C<< $platform->info >> for details.	1342	See C<< $platform->info >> for details.
964		1343
965	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1344	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
966		1345
967	=for gengetinfo begin context	1346	=for gengetinfo begin context
968		1347
969	=item $uint = $context->reference_count	1348	=item $uint = $context->reference_count
970		1349
971	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1350	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
972		1351
973	=item @devices = $context->devices	1352	=item @devices = $context->devices
974		1353
975	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1354	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
976		1355
977	=item @property_ints = $context->properties	1356	=item @property_ints = $context->properties
978		1357
979	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1358	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
980		1359
981	=item $uint = $context->num_devices	1360	=item $uint = $context->num_devices
982		1361
983	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1362	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
984		1363
985	=for gengetinfo end context	1364	=for gengetinfo end context
986		1365
987	=back	1366	=back
988		1367
989	=head2 THE OpenCL::Queue CLASS	1368	=head2 THE OpenCL::Queue CLASS
990		1369
991	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1370	An OpenCL::Queue represents an execution queue for OpenCL. You execute
992	requests by calling their respective C<enqueue_xxx> method and waitinf for	1371	requests by calling their respective method and waiting for it to complete
993	it to complete in some way.	1372	in some way.
994		1373
995	All the enqueue methods return an event object that can be used to wait	1374	Most methods that enqueue some request return an event object that can
996	for completion, unless the method is called in void context, in which case	1375	be used to wait for completion (optionally using a callback), unless
997	no event object is created.	1376	the method is called in void context, in which case no event object is
		1377	created.
998		1378
999	They also allow you to specify any number of other event objects that this	1379	They also allow you to specify any number of other event objects that this
1000	request has to wait for before it starts executing, by simply passing the	1380	request has to wait for before it starts executing, by simply passing the
1001	event objects as extra parameters to the enqueue methods. To simplify	1381	event objects as extra parameters to the enqueue methods. To simplify
1002	program design, this module ignores any C<undef> values in the list of	1382	program design, this module ignores any C<undef> values in the list of
1003	events. This makes it possible to code operations such as this, without	1383	events. This makes it possible to code operations such as this, without
1004	having to put a valid event object into C<$event> first:	1384	having to put a valid event object into C<$event> first:
1005		1385
1006	$event = $queue->enqueue_xxx (..., $event);	1386	$event = $queue->xxx (..., $event);
1007		1387
1008	Queues execute in-order by default, without any parallelism, so in most	1388	Queues execute in-order by default, without any parallelism, so in most
1009	cases (i.e. you use only one queue) it's not necessary to wait for or	1389	cases (i.e. you use only one queue) it's not necessary to wait for or
1010	create event objects, althoguh an our of order queue is often a bit	1390	create event objects, althoguh an our of order queue is often a bit
1011	faster.	1391	faster.
1012		1392
1013	=over 4	1393	=over 4
1014		1394
1015	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1395	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
1016		1396
1017	Reads data from buffer into the given string.	1397	Reads data from buffer into the given string.
1018		1398
1019	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1399	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
1020		1400
1021	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1401	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1022		1402
1023	Writes data to buffer from the given string.	1403	Writes data to buffer from the given string.
1024		1404
1025	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1405	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
1026		1406
1027	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1407	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1028		1408
1029	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1409	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1030		1410
1031	=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...)	1411	=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...)
1032		1412
1033	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1413	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1034		1414
1035	=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...)	1415	=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...)
1036		1416
1037	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1417	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1038		1418
1039	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1040
1041	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1042
1043	=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...)	1419	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1420
		1421	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1422
		1423	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1424
		1425	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1426	module uses the image width (and height) to supply default values.
1044		1427
1045	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1428	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1046		1429
1047	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1430	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1048		1431
		1432	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1433	module uses the image width (and height) to supply default values.
1049	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1434	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1050		1435
1051	=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...)	1436	=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...)
1052		1437
1053	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1438	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1054		1439
1055	=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...)	1440	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1056		1441
1057	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1442	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1058		1443
1059	=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...)	1444	=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...)
1060		1445
1061	Yeah.	1446	Yeah.
1062		1447
1063	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1064		1449
1065	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1450	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1066		1451
1067	Fills the given buffer object with repeated applications of C<$pattern>,	1452	Fills the given buffer object with repeated applications of C<$pattern>,
1068	starting at C<$offset> for C<$size> octets.	1453	starting at C<$offset> for C<$size> octets.
1069		1454
1070	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>	1455	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1071		1456
1072	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)	1457	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1073		1458
1074	Fills the given image area with the given rgba colour components. The	1459	Fills the given image area with the given rgba colour components. The
1075	components are normally floating point values between C<0> and C<1>,	1460	components are normally floating point values between C<0> and C<1>,
1076	except when the image channel data type is a signe dor unsigned	1461	except when the image channel data type is a signe dor unsigned
1077	unnormalised format, in which case the range is determined by the format.	1462	unnormalised format, in which case the range is determined by the format.
1078		1463
1079	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>	1464	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1080		1465
1081	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1466	=item $ev = $queue->task ($kernel, $wait_events...)
1082		1467
1083	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1468	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1084		1469
1085	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1470	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1086		1471
1087	Enqueues a kernel execution.	1472	Enqueues a kernel execution.
1088		1473
1089	@$global_work_size must be specified as a reference to an array of	1474	\@global_work_size must be specified as a reference to an array of
1090	integers specifying the work sizes (element counts).	1475	integers specifying the work sizes (element counts).
1091		1476
1092	@$global_work_offset must be either C<undef> (in which case all offsets	1477	\@global_work_offset must be either C<undef> (in which case all offsets
1093	are C<0>), or a reference to an array of work offsets, with the same number	1478	are C<0>), or a reference to an array of work offsets, with the same number
1094	of elements as @$global_work_size.	1479	of elements as \@global_work_size.
1095		1480
1096	@$local_work_size must be either C<undef> (in which case the	1481	\@local_work_size must be either C<undef> (in which case the
1097	implementation is supposed to choose good local work sizes), or a	1482	implementation is supposed to choose good local work sizes), or a
1098	reference to an array of local work sizes, with the same number of	1483	reference to an array of local work sizes, with the same number of
1099	elements as @$global_work_size.	1484	elements as \@global_work_size.
1100		1485
1101	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1486	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1102		1487
		1488	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1489
		1490	Migrates a number of OpenCL::Memory objects to or from the device.
		1491
		1492	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1493
		1494	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1495
1103	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1496	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1104		1497
1105	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1498	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1106	for subsequent OpenCL usage.	1499	for subsequent OpenCL usage.
1107		1500
1108	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1501	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1109		1502
1110	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1503	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1111		1504
1112	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1505	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1113	for subsequent OpenGL usage.	1506	for subsequent OpenGL usage.
1114		1507
1115	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1508	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1116		1509
1117	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1510	=item $ev = $queue->wait_for_events ($wait_events...)
1118		1511
1119	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1512	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1120		1513
1121	=item $ev = $queue->enqueue_marker ($wait_events...)	1514	=item $ev = $queue->marker ($wait_events...)
1122		1515
1123	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1516	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1124		1517
1125	=item $ev = $queue->enqueue_barrier ($wait_events...)	1518	=item $ev = $queue->barrier ($wait_events...)
1126		1519
1127	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1520	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1128		1521
1129	=item $queue->flush	1522	=item $queue->flush
1130		1523
…		…
1142		1535
1143	=for gengetinfo begin command_queue	1536	=for gengetinfo begin command_queue
1144		1537
1145	=item $ctx = $command_queue->context	1538	=item $ctx = $command_queue->context
1146		1539
1147	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1540	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1148		1541
1149	=item $device = $command_queue->device	1542	=item $device = $command_queue->device
1150		1543
1151	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1544	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1152		1545
1153	=item $uint = $command_queue->reference_count	1546	=item $uint = $command_queue->reference_count
1154		1547
1155	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1548	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1156		1549
1157	=item $command_queue_properties = $command_queue->properties	1550	=item $command_queue_properties = $command_queue->properties
1158		1551
1159	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1552	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1160		1553
1161	=for gengetinfo end command_queue	1554	=for gengetinfo end command_queue
		1555
		1556	=back
		1557
		1558	=head3 MEMORY MAPPED BUFFERS
		1559
		1560	OpenCL allows you to map buffers and images to host memory (read: perl
		1561	scalars). This is done much like reading or copying a buffer, by enqueuing
		1562	a map or unmap operation on the command queue.
		1563
		1564	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1565	OpenCL::Mapped CLASS> section for details on what to do with these
		1566	objects.
		1567
		1568	The object will be unmapped automatically when the mapped object is
		1569	destroyed (you can use a barrier to make sure the unmap has finished,
		1570	before using the buffer in a kernel), but you can also enqueue an unmap
		1571	operation manually.
		1572
		1573	=over 4
		1574
		1575	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1576
		1577	Maps the given buffer into host memory and returns an
		1578	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1579	the map will extend to the end of the buffer.
		1580
		1581	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1582
		1583	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1584
		1585	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1586
		1587	{
		1588	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1589	substr $$mapped, 0, 4, "abcd";
		1590	} # asynchronously unmap because $mapped is destroyed
		1591
		1592	=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...)
		1593
		1594	Maps the given image area into host memory and return an
		1595	C<OpenCL::MappedImage> object.
		1596
		1597	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1598	will be replaced by the maximum possible value.
		1599
		1600	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1601
		1602	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1603	the first channel of the leftmost column to 5, then explicitly unmap
		1604	it. You are not necessarily meant to do it this way, this example just
		1605	shows you the accessors to use :)
		1606
		1607	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1608
		1609	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1610	for 0..$image->height;
		1611
		1612	$mapped->unmap;.
		1613	$mapped->wait; # only needed for out of order queues normally
		1614
		1615	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1616
		1617	Unmaps the data from host memory. You must not call any methods that
		1618	modify the data, or modify the data scalar directly, after calling this
		1619	method.
		1620
		1621	The mapped event object will always be passed as part of the
		1622	$wait_events. The mapped event object will be replaced by the new event
		1623	object that this request creates.
1162		1624
1163	=back	1625	=back
1164		1626
1165	=head2 THE OpenCL::Memory CLASS	1627	=head2 THE OpenCL::Memory CLASS
1166		1628
…		…
1177		1639
1178	=for gengetinfo begin mem	1640	=for gengetinfo begin mem
1179		1641
1180	=item $mem_object_type = $mem->type	1642	=item $mem_object_type = $mem->type
1181		1643
1182	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1644	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1183		1645
1184	=item $mem_flags = $mem->flags	1646	=item $mem_flags = $mem->flags
1185		1647
1186	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1648	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1187		1649
1188	=item $int = $mem->size	1650	=item $int = $mem->size
1189		1651
1190	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1652	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1191		1653
1192	=item $ptr_value = $mem->host_ptr	1654	=item $ptr_value = $mem->host_ptr
1193		1655
1194	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1656	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1195		1657
1196	=item $uint = $mem->map_count	1658	=item $uint = $mem->map_count
1197		1659
1198	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1660	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1199		1661
1200	=item $uint = $mem->reference_count	1662	=item $uint = $mem->reference_count
1201		1663
1202	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1664	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1203		1665
1204	=item $ctx = $mem->context	1666	=item $ctx = $mem->context
1205		1667
1206	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1668	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1207		1669
1208	=item $mem = $mem->associated_memobject	1670	=item $mem = $mem->associated_memobject
1209		1671
1210	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1672	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1211		1673
1212	=item $int = $mem->offset	1674	=item $int = $mem->offset
1213		1675
1214	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1676	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1215		1677
1216	=for gengetinfo end mem	1678	=for gengetinfo end mem
1217		1679
1218	=item ($type, $name) = $mem->gl_object_info	1680	=item ($type, $name) = $mem->gl_object_info
1219		1681
…		…
1239	=over 4	1701	=over 4
1240		1702
1241	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)	1703	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1242		1704
1243	Creates an OpenCL::Buffer objects from this buffer and returns it. The	1705	Creates an OpenCL::Buffer objects from this buffer and returns it. The
1244	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.	1706	C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1245		1707
1246	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>	1708	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1247		1709
1248	=back	1710	=back
1249		1711
…		…
1265	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1727	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1266		1728
1267	=item ($channel_order, $channel_data_type) = $image->format	1729	=item ($channel_order, $channel_data_type) = $image->format
1268		1730
1269	Returns the channel order and type used to create the image by calling	1731	Returns the channel order and type used to create the image by calling
1270	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.	1732	C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1271		1733
1272	=for gengetinfo begin image	1734	=for gengetinfo begin image
1273		1735
1274	=item $int = $image->element_size	1736	=item $int = $image->element_size
1275		1737
1276	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1738	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1277		1739
1278	=item $int = $image->row_pitch	1740	=item $int = $image->row_pitch
1279		1741
1280	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1742	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1281		1743
1282	=item $int = $image->slice_pitch	1744	=item $int = $image->slice_pitch
1283		1745
1284	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1746	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1285		1747
1286	=item $int = $image->width	1748	=item $int = $image->width
1287		1749
1288	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1750	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1289		1751
1290	=item $int = $image->height	1752	=item $int = $image->height
1291		1753
1292	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1754	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1293		1755
1294	=item $int = $image->depth	1756	=item $int = $image->depth
1295		1757
1296	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1758	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1297		1759
1298	=for gengetinfo end image	1760	=for gengetinfo end image
1299		1761
1300	=for gengetinfo begin gl_texture	1762	=for gengetinfo begin gl_texture
1301		1763
1302	=item $GLenum = $gl_texture->target	1764	=item $GLenum = $gl_texture->target
1303		1765
1304	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1766	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1305		1767
1306	=item $GLint = $gl_texture->gl_mipmap_level	1768	=item $GLint = $gl_texture->gl_mipmap_level
1307		1769
1308	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1770	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1309		1771
1310	=for gengetinfo end gl_texture	1772	=for gengetinfo end gl_texture
1311		1773
1312	=back	1774	=back
1313		1775
…		…
1323		1785
1324	=for gengetinfo begin sampler	1786	=for gengetinfo begin sampler
1325		1787
1326	=item $uint = $sampler->reference_count	1788	=item $uint = $sampler->reference_count
1327		1789
1328	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1790	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1329		1791
1330	=item $ctx = $sampler->context	1792	=item $ctx = $sampler->context
1331		1793
1332	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1794	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1333		1795
1334	=item $addressing_mode = $sampler->normalized_coords	1796	=item $addressing_mode = $sampler->normalized_coords
1335		1797
1336	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1798	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1337		1799
1338	=item $filter_mode = $sampler->addressing_mode	1800	=item $filter_mode = $sampler->addressing_mode
1339		1801
1340	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1802	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1341		1803
1342	=item $boolean = $sampler->filter_mode	1804	=item $boolean = $sampler->filter_mode
1343		1805
1344	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1806	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1345		1807
1346	=for gengetinfo end sampler	1808	=for gengetinfo end sampler
1347		1809
1348	=back	1810	=back
1349		1811
1350	=head2 THE OpenCL::Program CLASS	1812	=head2 THE OpenCL::Program CLASS
1351		1813
1352	=over 4	1814	=over 4
1353		1815
1354	=item $program->build ($device, $options = "")	1816	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1355		1817
1356	Tries to build the program with the given options. See also the	1818	Tries to build the program with the given options. See also the
1357	C<$ctx->build> convenience function.	1819	C<$ctx->build> convenience function.
1358		1820
		1821	If a callback is specified, then it will be called when compilation is
		1822	finished. Note that many OpenCL implementations block your program while
		1823	compiling whether you use a callback or not. See C<build_async> if you
		1824	want to make sure the build is done in the background.
		1825
		1826	Note that some OpenCL implementations act up badly, and don't call the
		1827	callback in some error cases (but call it in others). This implementation
		1828	assumes the callback will always be called, and leaks memory if this is
		1829	not so. So best make sure you don't pass in invalid values.
		1830
		1831	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1832	compilation state is successful but some later stage fails.
		1833
		1834	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1835	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1836	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1837	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1838	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1839	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1840	C<-create-library>, C<-enable-link-options>.
		1841
		1842	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1843	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1844
1359	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1845	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1846
		1847	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1848
		1849	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1850	need to check the compilation status form the callback, or by polling).
		1851
		1852	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1853
		1854	Compiles the given program for the given devices (or all devices if
		1855	undef). If C<$headers> is given, it must be a hashref with include name =>
		1856	OpenCL::Program pairs.
		1857
		1858	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1360		1859
1361	=item $packed_value = $program->build_info ($device, $name)	1860	=item $packed_value = $program->build_info ($device, $name)
1362		1861
1363	Similar to C<< $platform->info >>, but returns build info for a previous	1862	Similar to C<< $platform->info >>, but returns build info for a previous
1364	build attempt for the given device.	1863	build attempt for the given device.
1365		1864
		1865	binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
		1866	OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
		1867	OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
		1868	OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
		1869
1366	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>	1870	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1367		1871
1368	=item $kernel = $program->kernel ($function_name)	1872	=item $kernel = $program->kernel ($function_name)
1369		1873
1370	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1874	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
…		…
1380		1884
1381	=for gengetinfo begin program_build	1885	=for gengetinfo begin program_build
1382		1886
1383	=item $build_status = $program->build_status ($device)	1887	=item $build_status = $program->build_status ($device)
1384		1888
1385	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1889	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1386		1890
1387	=item $string = $program->build_options ($device)	1891	=item $string = $program->build_options ($device)
1388		1892
1389	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1893	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1390		1894
1391	=item $string = $program->build_log ($device)	1895	=item $string = $program->build_log ($device)
1392		1896
1393	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1897	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
		1898
		1899	=item $binary_type = $program->binary_type ($device)
		1900
		1901	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1394		1902
1395	=for gengetinfo end program_build	1903	=for gengetinfo end program_build
1396		1904
1397	=item $packed_value = $program->info ($name)	1905	=item $packed_value = $program->info ($name)
1398		1906
…		…
1402		1910
1403	=for gengetinfo begin program	1911	=for gengetinfo begin program
1404		1912
1405	=item $uint = $program->reference_count	1913	=item $uint = $program->reference_count
1406		1914
1407	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1915	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1408		1916
1409	=item $ctx = $program->context	1917	=item $ctx = $program->context
1410		1918
1411	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1919	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1412		1920
1413	=item $uint = $program->num_devices	1921	=item $uint = $program->num_devices
1414		1922
1415	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1923	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1416		1924
1417	=item @devices = $program->devices	1925	=item @devices = $program->devices
1418		1926
1419	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1927	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1420		1928
1421	=item $string = $program->source	1929	=item $string = $program->source
1422		1930
1423	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1931	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1424		1932
1425	=item @ints = $program->binary_sizes	1933	=item @ints = $program->binary_sizes
1426		1934
1427	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1935	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1428		1936
1429	=for gengetinfo end program	1937	=for gengetinfo end program
1430		1938
1431	=item @blobs = $program->binaries	1939	=item @blobs = $program->binaries
1432		1940
…		…
1453		1961
1454	=for gengetinfo begin kernel	1962	=for gengetinfo begin kernel
1455		1963
1456	=item $string = $kernel->function_name	1964	=item $string = $kernel->function_name
1457		1965
1458	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1966	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1459		1967
1460	=item $uint = $kernel->num_args	1968	=item $uint = $kernel->num_args
1461		1969
1462	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1970	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1463		1971
1464	=item $uint = $kernel->reference_count	1972	=item $uint = $kernel->reference_count
1465		1973
1466	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1974	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1467		1975
1468	=item $ctx = $kernel->context	1976	=item $ctx = $kernel->context
1469		1977
1470	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1978	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1471		1979
1472	=item $program = $kernel->program	1980	=item $program = $kernel->program
1473		1981
1474	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1982	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1475		1983
1476	=for gengetinfo end kernel	1984	=for gengetinfo end kernel
1477		1985
1478	=item $packed_value = $kernel->work_group_info ($device, $name)	1986	=item $packed_value = $kernel->work_group_info ($device, $name)
1479		1987
1480	See C<< $platform->info >> for details.	1988	See C<< $platform->info >> for details.
1481		1989
1482	The reason this method is not called C<info> is that there already is an
1483	C<< ->info >> method.
1484
1485	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1990	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1486		1991
1487	=for gengetinfo begin kernel_work_group	1992	=for gengetinfo begin kernel_work_group
1488		1993
1489	=item $int = $kernel->work_group_size ($device)	1994	=item $int = $kernel->work_group_size ($device)
1490		1995
1491	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1996	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1492		1997
1493	=item @ints = $kernel->compile_work_group_size ($device)	1998	=item @ints = $kernel->compile_work_group_size ($device)
1494		1999
1495	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	2000	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1496		2001
1497	=item $ulong = $kernel->local_mem_size ($device)	2002	=item $ulong = $kernel->local_mem_size ($device)
1498		2003
1499	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	2004	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1500		2005
1501	=item $int = $kernel->preferred_work_group_size_multiple ($device)	2006	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1502		2007
1503	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	2008	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1504		2009
1505	=item $ulong = $kernel->private_mem_size ($device)	2010	=item $ulong = $kernel->private_mem_size ($device)
1506		2011
1507	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	2012	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1508		2013
1509	=for gengetinfo end kernel_work_group	2014	=for gengetinfo end kernel_work_group
1510		2015
		2016	=item $packed_value = $kernel->arg_info ($idx, $name)
		2017
		2018	See C<< $platform->info >> for details.
		2019
		2020	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		2021
		2022	=for gengetinfo begin kernel_arg
		2023
		2024	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		2025
		2026	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		2027
		2028	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		2029
		2030	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		2031
		2032	=item $string = $kernel->arg_type_name ($idx)
		2033
		2034	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		2035
		2036	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		2037
		2038	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		2039
		2040	=item $string = $kernel->arg_name ($idx)
		2041
		2042	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		2043
		2044	=for gengetinfo end kernel_arg
		2045
		2046	=item $kernel->setf ($format, ...)
		2047
		2048	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		2049	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		2050	need to specify a format argument, much as with C<printf>, to tell OpenCL
		2051	what type of argument it is.
		2052
		2053	The format arguments are single letters:
		2054
		2055	c char
		2056	C unsigned char
		2057	s short
		2058	S unsigned short
		2059	i int
		2060	I unsigned int
		2061	l long
		2062	L unsigned long
		2063
		2064	h half float (0..65535)
		2065	f float
		2066	d double
		2067
		2068	z local (octet size)
		2069
		2070	m memory object (buffer or image)
		2071	a sampler
		2072	e event
		2073
		2074	Space characters in the format string are ignored.
		2075
		2076	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		2077
		2078	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		2079
1511	=item $kernel->set_TYPE ($index, $value)	2080	=item $kernel->set_TYPE ($index, $value)
1512		2081
		2082	=item $kernel->set_char ($index, $value)
		2083
		2084	=item $kernel->set_uchar ($index, $value)
		2085
		2086	=item $kernel->set_short ($index, $value)
		2087
		2088	=item $kernel->set_ushort ($index, $value)
		2089
		2090	=item $kernel->set_int ($index, $value)
		2091
		2092	=item $kernel->set_uint ($index, $value)
		2093
		2094	=item $kernel->set_long ($index, $value)
		2095
		2096	=item $kernel->set_ulong ($index, $value)
		2097
		2098	=item $kernel->set_half ($index, $value)
		2099
		2100	=item $kernel->set_float ($index, $value)
		2101
		2102	=item $kernel->set_double ($index, $value)
		2103
		2104	=item $kernel->set_memory ($index, $value)
		2105
		2106	=item $kernel->set_buffer ($index, $value)
		2107
		2108	=item $kernel->set_image ($index, $value)
		2109
		2110	=item $kernel->set_sampler ($index, $value)
		2111
		2112	=item $kernel->set_local ($index, $value)
		2113
		2114	=item $kernel->set_event ($index, $value)
		2115
1513	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	2116	This is a family of methods to set the kernel argument with the number
1514		2117	C<$index> to the give C<$value>.
1515	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1516	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1517	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1518		2118
1519	Chars and integers (including the half type) are specified as integers,	2119	Chars and integers (including the half type) are specified as integers,
1520	float and double as floating point values, memory/buffer/image2d/image3d	2120	float and double as floating point values, memory/buffer/image must be
1521	must be an object of that type or C<undef>, local-memory arguments are	2121	an object of that type or C<undef>, local-memory arguments are set by
1522	set by specifying the size, and sampler and event must be objects of that	2122	specifying the size, and sampler and event must be objects of that type.
1523	type.	2123
		2124	Note that C<set_memory> works for all memory objects (all types of buffers
		2125	and images) - the main purpose of the more specific C<set_TYPE> functions
		2126	is type checking.
1524		2127
1525	Setting an argument for a kernel does NOT keep a reference to the object -	2128	Setting an argument for a kernel does NOT keep a reference to the object -
1526	for example, if you set an argument to some image object, free the image,	2129	for example, if you set an argument to some image object, free the image,
1527	and call the kernel, you will run into undefined behaviour.	2130	and call the kernel, you will run into undefined behaviour.
1528		2131
…		…
1541		2144
1542	Waits for the event to complete.	2145	Waits for the event to complete.
1543		2146
1544	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	2147	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1545		2148
		2149	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		2150
		2151	Adds a callback to the callback stack for the given event type. There is
		2152	no way to remove a callback again.
		2153
		2154	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		2155
1546	=item $packed_value = $ev->info ($name)	2156	=item $packed_value = $ev->info ($name)
1547		2157
1548	See C<< $platform->info >> for details.	2158	See C<< $platform->info >> for details.
1549		2159
1550	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	2160	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1551		2161
1552	=for gengetinfo begin event	2162	=for gengetinfo begin event
1553		2163
1554	=item $queue = $event->command_queue	2164	=item $queue = $event->command_queue
1555		2165
1556	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2166	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1557		2167
1558	=item $command_type = $event->command_type	2168	=item $command_type = $event->command_type
1559		2169
1560	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2170	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1561		2171
1562	=item $uint = $event->reference_count	2172	=item $uint = $event->reference_count
1563		2173
1564	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2174	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1565		2175
1566	=item $uint = $event->command_execution_status	2176	=item $uint = $event->command_execution_status
1567		2177
1568	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2178	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1569		2179
1570	=item $ctx = $event->context	2180	=item $ctx = $event->context
1571		2181
1572	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2182	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1573		2183
1574	=for gengetinfo end event	2184	=for gengetinfo end event
1575		2185
1576	=item $packed_value = $ev->profiling_info ($name)	2186	=item $packed_value = $ev->profiling_info ($name)
1577		2187
…		…
1584		2194
1585	=for gengetinfo begin profiling	2195	=for gengetinfo begin profiling
1586		2196
1587	=item $ulong = $event->profiling_command_queued	2197	=item $ulong = $event->profiling_command_queued
1588		2198
1589	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2199	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1590		2200
1591	=item $ulong = $event->profiling_command_submit	2201	=item $ulong = $event->profiling_command_submit
1592		2202
1593	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2203	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1594		2204
1595	=item $ulong = $event->profiling_command_start	2205	=item $ulong = $event->profiling_command_start
1596		2206
1597	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2207	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1598		2208
1599	=item $ulong = $event->profiling_command_end	2209	=item $ulong = $event->profiling_command_end
1600		2210
1601	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2211	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1602		2212
1603	=for gengetinfo end profiling	2213	=for gengetinfo end profiling
1604		2214
1605	=back	2215	=back
1606		2216
…		…
1610		2220
1611	=over 4	2221	=over 4
1612		2222
1613	=item $ev->set_status ($execution_status)	2223	=item $ev->set_status ($execution_status)
1614		2224
		2225	Sets the execution status of the user event. Can only be called once,
		2226	either with OpenCL::COMPLETE or a negative number as status.
		2227
		2228	execution_status: OpenCL::COMPLETE or a negative integer.
		2229
1615	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2230	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1616		2231
1617	=back	2232	=back
		2233
		2234	=head2 THE OpenCL::Mapped CLASS
		2235
		2236	This class represents objects mapped into host memory. They are
		2237	represented by a blessed string scalar. The string data is the mapped
		2238	memory area, that is, if you read or write it, then the mapped object is
		2239	accessed directly.
		2240
		2241	You must only ever use operations that modify the string in-place - for
		2242	example, a C<substr> that doesn't change the length, or maybe a regex that
		2243	doesn't change the length. Any other operation might cause the data to be
		2244	copied.
		2245
		2246	When the object is destroyed it will enqueue an implicit unmap operation
		2247	on the queue that was used to create it.
		2248
		2249	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2250	OpenCL sees the changes, even if some implementations don't need this
		2251	sometimes.
		2252
		2253	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2254
		2255	my $mapped = $queue->map_buffer ($buf, ...
		2256	$mapped->event->wait; # make sure it's there
		2257
		2258	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2259	# we blindly assume device endianness to equal host endianness
		2260	# (and of course, we assume iee 754 single precision floats :)
		2261	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2262
		2263	=over 4
		2264
		2265	=item $ev = $mapped->unmap ($wait_events...)
		2266
		2267	Unmaps the mapped memory object, using the queue originally used to create
		2268	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2269
		2270	=item $bool = $mapped->mapped
		2271
		2272	Returns whether the object is still mapped - true before an C<unmap> is
		2273	enqueued, false afterwards.
		2274
		2275	=item $ev = $mapped->event
		2276
		2277	Return the event object associated with the mapped object. Initially, this
		2278	will be the event object created when mapping the object, and after an
		2279	unmap, this will be the event object that the unmap operation created.
		2280
		2281	=item $mapped->wait
		2282
		2283	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2284	mapped object are outstanding.
		2285
		2286	=item $bytes = $mapped->size
		2287
		2288	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2289
		2290	=item $ptr = $mapped->ptr
		2291
		2292	Returns the raw memory address of the mapped area.
		2293
		2294	=item $mapped->set ($offset, $data)
		2295
		2296	Replaces the data at the given C<$offset> in the memory area by the new
		2297	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2298	because it does bounds-checking, but also slower.
		2299
		2300	=item $data = $mapped->get ($offset, $length)
		2301
		2302	Returns (without copying) a scalar representing the data at the given
		2303	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2304	the following substr, except much slower;
		2305
		2306	$data = substr $$mapped, $offset, $length
		2307
		2308	=cut
		2309
		2310	sub OpenCL::Mapped::get {
		2311	substr ${$_[0]}, $_[1], $_[2]
		2312	}
		2313
		2314	=back
		2315
		2316	=head2 THE OpenCL::MappedBuffer CLASS
		2317
		2318	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2319
		2320	=head2 THE OpenCL::MappedImage CLASS
		2321
		2322	This is a subclass of OpenCL::Mapped, representing mapped images.
		2323
		2324	=over 4
		2325
		2326	=item $bytes = $mapped->row_pitch
		2327
		2328	=item $bytes = $mapped->slice_pitch
		2329
		2330	Return the row or slice pitch of the image that has been mapped.
		2331
		2332	=back
		2333
1618		2334
1619	=cut	2335	=cut
1620		2336
1621	1;	2337	1;
1622		2338

Diff Legend

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