ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.51 by root, Tue Apr 24 13:45:58 2012 UTC vs.
Revision 1.85 by root, Sat May 5 16:52:17 2012 UTC

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

Diff Legend

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