ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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