ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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