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.78 by root, Sat May 5 13:07:19 2012 UTC

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

Diff Legend

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