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.86 by root, Mon May 7 01:00:31 2012 UTC

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

Diff Legend

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