ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.52 by root, Tue Apr 24 14:24:42 2012 UTC vs.
Revision 1.80 by root, Sat May 5 13:55:59 2012 UTC

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

Diff Legend

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