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.77 by root, Sat May 5 12:54:03 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
…		…
492		810
493	See C<< $platform->info >> for details.	811	See C<< $platform->info >> for details.
494		812
495	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	813	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
496		814
		815	=item @devices = $device->sub_devices (\@properties)
		816
		817	Creates OpencL::SubDevice objects by partitioning an existing device.
		818
		819	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		820
497	=for gengetinfo begin device	821	=for gengetinfo begin device
498		822
499	=item $device_type = $device->type	823	=item $device_type = $device->type
500		824
501	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	825	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
502		826
503	=item $uint = $device->vendor_id	827	=item $uint = $device->vendor_id
504		828
505	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	829	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
506		830
507	=item $uint = $device->max_compute_units	831	=item $uint = $device->max_compute_units
508		832
509	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	833	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
510		834
511	=item $uint = $device->max_work_item_dimensions	835	=item $uint = $device->max_work_item_dimensions
512		836
513	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	837	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
514		838
515	=item $int = $device->max_work_group_size	839	=item $int = $device->max_work_group_size
516		840
517	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	841	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
518		842
519	=item @ints = $device->max_work_item_sizes	843	=item @ints = $device->max_work_item_sizes
520		844
521	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	845	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
522		846
523	=item $uint = $device->preferred_vector_width_char	847	=item $uint = $device->preferred_vector_width_char
524		848
525	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	849	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
526		850
527	=item $uint = $device->preferred_vector_width_short	851	=item $uint = $device->preferred_vector_width_short
528		852
529	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	853	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
530		854
531	=item $uint = $device->preferred_vector_width_int	855	=item $uint = $device->preferred_vector_width_int
532		856
533	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	857	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
534		858
535	=item $uint = $device->preferred_vector_width_long	859	=item $uint = $device->preferred_vector_width_long
536		860
537	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	861	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
538		862
539	=item $uint = $device->preferred_vector_width_float	863	=item $uint = $device->preferred_vector_width_float
540		864
541	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	865	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
542		866
543	=item $uint = $device->preferred_vector_width_double	867	=item $uint = $device->preferred_vector_width_double
544		868
545	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	869	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
546		870
547	=item $uint = $device->max_clock_frequency	871	=item $uint = $device->max_clock_frequency
548		872
549	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	873	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
550		874
551	=item $bitfield = $device->address_bits	875	=item $bitfield = $device->address_bits
552		876
553	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	877	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
554		878
555	=item $uint = $device->max_read_image_args	879	=item $uint = $device->max_read_image_args
556		880
557	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	881	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
558		882
559	=item $uint = $device->max_write_image_args	883	=item $uint = $device->max_write_image_args
560		884
561	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	885	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
562		886
563	=item $ulong = $device->max_mem_alloc_size	887	=item $ulong = $device->max_mem_alloc_size
564		888
565	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	889	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
566		890
567	=item $int = $device->image2d_max_width	891	=item $int = $device->image2d_max_width
568		892
569	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	893	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
570		894
571	=item $int = $device->image2d_max_height	895	=item $int = $device->image2d_max_height
572		896
573	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	897	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
574		898
575	=item $int = $device->image3d_max_width	899	=item $int = $device->image3d_max_width
576		900
577	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	901	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
578		902
579	=item $int = $device->image3d_max_height	903	=item $int = $device->image3d_max_height
580		904
581	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	905	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
582		906
583	=item $int = $device->image3d_max_depth	907	=item $int = $device->image3d_max_depth
584		908
585	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	909	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
586		910
587	=item $uint = $device->image_support	911	=item $uint = $device->image_support
588		912
589	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	913	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
590		914
591	=item $int = $device->max_parameter_size	915	=item $int = $device->max_parameter_size
592		916
593	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	917	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
594		918
595	=item $uint = $device->max_samplers	919	=item $uint = $device->max_samplers
596		920
597	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	921	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
598		922
599	=item $uint = $device->mem_base_addr_align	923	=item $uint = $device->mem_base_addr_align
600		924
601	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	925	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
602		926
603	=item $uint = $device->min_data_type_align_size	927	=item $uint = $device->min_data_type_align_size
604		928
605	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	929	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
606		930
607	=item $device_fp_config = $device->single_fp_config	931	=item $device_fp_config = $device->single_fp_config
608		932
609	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	933	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
610		934
611	=item $device_mem_cache_type = $device->global_mem_cache_type	935	=item $device_mem_cache_type = $device->global_mem_cache_type
612		936
613	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	937	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
614		938
615	=item $uint = $device->global_mem_cacheline_size	939	=item $uint = $device->global_mem_cacheline_size
616		940
617	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	941	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
618		942
619	=item $ulong = $device->global_mem_cache_size	943	=item $ulong = $device->global_mem_cache_size
620		944
621	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	945	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
622		946
623	=item $ulong = $device->global_mem_size	947	=item $ulong = $device->global_mem_size
624		948
625	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	949	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
626		950
627	=item $ulong = $device->max_constant_buffer_size	951	=item $ulong = $device->max_constant_buffer_size
628		952
629	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	953	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
630		954
631	=item $uint = $device->max_constant_args	955	=item $uint = $device->max_constant_args
632		956
633	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	957	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
634		958
635	=item $device_local_mem_type = $device->local_mem_type	959	=item $device_local_mem_type = $device->local_mem_type
636		960
637	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	961	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
638		962
639	=item $ulong = $device->local_mem_size	963	=item $ulong = $device->local_mem_size
640		964
641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	965	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
642		966
643	=item $boolean = $device->error_correction_support	967	=item $boolean = $device->error_correction_support
644		968
645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	969	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
646		970
647	=item $int = $device->profiling_timer_resolution	971	=item $int = $device->profiling_timer_resolution
648		972
649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	973	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
650		974
651	=item $boolean = $device->endian_little	975	=item $boolean = $device->endian_little
652		976
653	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	977	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
654		978
655	=item $boolean = $device->available	979	=item $boolean = $device->available
656		980
657	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	981	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
658		982
659	=item $boolean = $device->compiler_available	983	=item $boolean = $device->compiler_available
660		984
661	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	985	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
662		986
663	=item $device_exec_capabilities = $device->execution_capabilities	987	=item $device_exec_capabilities = $device->execution_capabilities
664		988
665	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	989	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
666		990
667	=item $command_queue_properties = $device->properties	991	=item $command_queue_properties = $device->properties
668		992
669	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	993	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
670		994
671	=item $ = $device->platform	995	=item $ = $device->platform
672		996
673	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	997	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
674		998
675	=item $string = $device->name	999	=item $string = $device->name
676		1000
677	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	1001	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
678		1002
679	=item $string = $device->vendor	1003	=item $string = $device->vendor
680		1004
681	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	1005	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
682		1006
683	=item $string = $device->driver_version	1007	=item $string = $device->driver_version
684		1008
685	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	1009	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
686		1010
687	=item $string = $device->profile	1011	=item $string = $device->profile
688		1012
689	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	1013	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
690		1014
691	=item $string = $device->version	1015	=item $string = $device->version
692		1016
693	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	1017	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
694		1018
695	=item $string = $device->extensions	1019	=item $string = $device->extensions
696		1020
697	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	1021	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
698		1022
699	=item $uint = $device->preferred_vector_width_half	1023	=item $uint = $device->preferred_vector_width_half
700		1024
701	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	1025	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
702		1026
703	=item $uint = $device->native_vector_width_char	1027	=item $uint = $device->native_vector_width_char
704		1028
705	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	1029	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
706		1030
707	=item $uint = $device->native_vector_width_short	1031	=item $uint = $device->native_vector_width_short
708		1032
709	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1033	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
710		1034
711	=item $uint = $device->native_vector_width_int	1035	=item $uint = $device->native_vector_width_int
712		1036
713	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1037	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
714		1038
715	=item $uint = $device->native_vector_width_long	1039	=item $uint = $device->native_vector_width_long
716		1040
717	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1041	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
718		1042
719	=item $uint = $device->native_vector_width_float	1043	=item $uint = $device->native_vector_width_float
720		1044
721	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1045	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
722		1046
723	=item $uint = $device->native_vector_width_double	1047	=item $uint = $device->native_vector_width_double
724		1048
725	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1049	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
726		1050
727	=item $uint = $device->native_vector_width_half	1051	=item $uint = $device->native_vector_width_half
728		1052
729	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1053	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
730		1054
731	=item $device_fp_config = $device->double_fp_config	1055	=item $device_fp_config = $device->double_fp_config
732		1056
733	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1057	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
734		1058
735	=item $device_fp_config = $device->half_fp_config	1059	=item $device_fp_config = $device->half_fp_config
736		1060
737	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1061	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
738		1062
739	=item $boolean = $device->host_unified_memory	1063	=item $boolean = $device->host_unified_memory
740		1064
741	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1065	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
742		1066
743	=item $device = $device->parent_device_ext	1067	=item $device = $device->parent_device_ext
744		1068
745	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1069	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
746		1070
747	=item @device_partition_property_exts = $device->partition_types_ext	1071	=item @device_partition_property_exts = $device->partition_types_ext
748		1072
749	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1073	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
750		1074
751	=item @device_partition_property_exts = $device->affinity_domains_ext	1075	=item @device_partition_property_exts = $device->affinity_domains_ext
752		1076
753	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1077	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
754		1078
755	=item $uint = $device->reference_count_ext	1079	=item $uint = $device->reference_count_ext
756		1080
757	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1081	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
758		1082
759	=item @device_partition_property_exts = $device->partition_style_ext	1083	=item @device_partition_property_exts = $device->partition_style_ext
760		1084
761	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1085	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
762		1086
763	=for gengetinfo end device	1087	=for gengetinfo end device
764		1088
765	=back	1089	=back
766		1090
767	=head2 THE OpenCL::Context CLASS	1091	=head2 THE OpenCL::Context CLASS
		1092
		1093	An OpenCL::Context is basically a container, or manager, for a number of
		1094	devices of a platform. It is used to create all sorts of secondary objects
		1095	such as buffers, queues, programs and so on.
		1096
		1097	All context creation functions and methods take a list of properties
		1098	(type-value pairs). All property values can be specified as integers -
		1099	some additionally support other types:
		1100
		1101	=over 4
		1102
		1103	=item OpenCL::CONTEXT_PLATFORM
		1104
		1105	Also accepts OpenCL::Platform objects.
		1106
		1107	=item OpenCL::GLX_DISPLAY_KHR
		1108
		1109	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1110	to find the current glx display (see L<GLX SUPPORT>).
		1111
		1112	=item OpenCL::GL_CONTEXT_KHR
		1113
		1114	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1115	to find the current glx context (see L<GLX SUPPORT>).
		1116
		1117	=back
768		1118
769	=over 4	1119	=over 4
770		1120
771	=item $prog = $ctx->build_program ($program, $options = "")	1121	=item $prog = $ctx->build_program ($program, $options = "")
772		1122
…		…
784	my ($self, $prog, $options) = @_;	1134	my ($self, $prog, $options) = @_;
785		1135
786	$prog = $self->program_with_source ($prog)	1136	$prog = $self->program_with_source ($prog)
787	unless ref $prog;	1137	unless ref $prog;
788		1138
		1139	eval { $prog->build (undef, $options); 1 }
		1140	or errno == BUILD_PROGRAM_FAILURE
		1141	or errno == INVALID_BINARY # workaround nvidia bug
		1142	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1143
		1144	# we check status for all devices
789	for my $dev ($self->devices) {	1145	for my $dev ($self->devices) {
790	eval { $prog->build ($dev, $options); 1 }	1146	$prog->build_status ($dev) == BUILD_SUCCESS
791	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"	1147	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
792	. $prog->build_log ($dev);	1148	. $prog->build_log ($dev);
793	}	1149	}
794		1150
795	$prog	1151	$prog
796	}	1152	}
797		1153
…		…
814	=item $buf = $ctx->buffer ($flags, $len)	1170	=item $buf = $ctx->buffer ($flags, $len)
815		1171
816	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1172	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
817	given flags and octet-size.	1173	given flags and octet-size.
818		1174
		1175	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1176	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1177	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1178
819	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1179	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
820		1180
821	=item $buf = $ctx->buffer_sv ($flags, $data)	1181	=item $buf = $ctx->buffer_sv ($flags, $data)
822		1182
823	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1183	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
824	initialise it with the given data values.	1184	initialise it with the given data values.
825		1185
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)	1186	=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		1187
828	Creates a new OpenCL::Image object and optionally initialises it with	1188	Creates a new OpenCL::Image object and optionally initialises it with
829	the given data values.	1189	the given data values.
830		1190
		1191	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1192	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1193	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1194
		1195	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1196	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1197	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1198	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1199	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1200
		1201
		1202	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1203	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1204	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1205	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1206
831	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1207	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
832		1208
833	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1209	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
834		1210
835	Creates a new OpenCL::Image2D object and optionally initialises it with	1211	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
847	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1223	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
848		1224
849	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1225	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
850	OpenGL buffer object.	1226	OpenGL buffer object.
851		1227
		1228	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1229
852	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1230	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
853		1231
854	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1232	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
855		1233
856	Creates a new OpenCL::Image object that refers to the given OpenGL	1234	Creates a new OpenCL::Image object that refers to the given OpenGL
857	texture object or buffer.	1235	texture object or buffer.
858		1236
		1237	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1238	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1239	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1240	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1241	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1242	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1243
859	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1244	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
860		1245
861	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1246	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
862		1247
863	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1248	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
888		1273
889	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1274	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
890		1275
891	Creates a new OpenCL::Sampler object.	1276	Creates a new OpenCL::Sampler object.
892		1277
		1278	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1279	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1280
		1281	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1282
893	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1283	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
894		1284
895	=item $program = $ctx->program_with_source ($string)	1285	=item $program = $ctx->program_with_source ($string)
896		1286
897	Creates a new OpenCL::Program object from the given source code.	1287	Creates a new OpenCL::Program object from the given source code.
898		1288
899	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1289	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
900		1290
		1291	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1292
		1293	Creates a new OpenCL::Program object from the given binaries.
		1294
		1295	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1296
		1297	Example: clone an existing program object that contains a successfully
		1298	compiled program, no matter how useless this is.
		1299
		1300	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1301
		1302	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1303
		1304	Creates a new OpenCL::Program object from the given built-in kernel names.
		1305
		1306	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1307
		1308	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1309
		1310	Links all (already compiled) program objects specified in C<@programs>
		1311	together and returns a new OpenCL::Program object with the result.
		1312
		1313	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1314
901	=item $packed_value = $ctx->info ($name)	1315	=item $packed_value = $ctx->info ($name)
902		1316
903	See C<< $platform->info >> for details.	1317	See C<< $platform->info >> for details.
904		1318
905	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1319	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
906		1320
907	=for gengetinfo begin context	1321	=for gengetinfo begin context
908		1322
909	=item $uint = $context->reference_count	1323	=item $uint = $context->reference_count
910		1324
911	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1325	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
912		1326
913	=item @devices = $context->devices	1327	=item @devices = $context->devices
914		1328
915	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1329	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
916		1330
917	=item @property_ints = $context->properties	1331	=item @property_ints = $context->properties
918		1332
919	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1333	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
920		1334
921	=item $uint = $context->num_devices	1335	=item $uint = $context->num_devices
922		1336
923	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1337	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
924		1338
925	=for gengetinfo end context	1339	=for gengetinfo end context
926		1340
927	=back	1341	=back
928		1342
929	=head2 THE OpenCL::Queue CLASS	1343	=head2 THE OpenCL::Queue CLASS
930		1344
931	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1345	An OpenCL::Queue represents an execution queue for OpenCL. You execute
932	requests by calling their respective C<enqueue_xxx> method and waitinf for	1346	requests by calling their respective method and waiting for it to complete
933	it to complete in some way.	1347	in some way.
934		1348
935	All the enqueue methods return an event object that can be used to wait	1349	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	1350	be used to wait for completion (optionally using a callback), unless
937	no event object is created.	1351	the method is called in void context, in which case no event object is
		1352	created.
938		1353
939	They also allow you to specify any number of other event objects that this	1354	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	1355	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	1356	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	1357	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	1358	events. This makes it possible to code operations such as this, without
944	having to put a valid event object into C<$event> first:	1359	having to put a valid event object into C<$event> first:
945		1360
946	$event = $queue->enqueue_xxx (..., $event);	1361	$event = $queue->xxx (..., $event);
947		1362
948	Queues execute in-order by default, without any parallelism, so in most	1363	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	1364	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	1365	create event objects, althoguh an our of order queue is often a bit
951	faster.	1366	faster.
952		1367
953	=over 4	1368	=over 4
954		1369
955	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1370	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
956		1371
957	Reads data from buffer into the given string.	1372	Reads data from buffer into the given string.
958		1373
959	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1374	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
960		1375
961	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1376	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
962		1377
963	Writes data to buffer from the given string.	1378	Writes data to buffer from the given string.
964		1379
965	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1380	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
966		1381
967	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1382	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
968		1383
969	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1384	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
970		1385
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...)	1386	=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		1387
973	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1388	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
974		1389
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...)	1390	=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		1391
977	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1392	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
978		1393
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...)	1394	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1395
		1396	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1397
		1398	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1399
		1400	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1401	module uses the image width (and height) to supply default values.
984		1402
985	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
986		1404
987	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1405	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
988		1406
		1407	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1408	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>	1409	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
990		1410
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...)	1411	=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		1412
993	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1413	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
994		1414
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...)	1415	=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		1416
997	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1417	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
998		1418
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...)	1419	=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		1420
1001	Yeah.	1421	Yeah.
1002		1422
1003	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1423	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1004		1424
		1425	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
		1426
		1427	Fills the given buffer object with repeated applications of C<$pattern>,
		1428	starting at C<$offset> for C<$size> octets.
		1429
		1430	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1431
		1432	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1433
		1434	Fills the given image area with the given rgba colour components. The
		1435	components are normally floating point values between C<0> and C<1>,
		1436	except when the image channel data type is a signe dor unsigned
		1437	unnormalised format, in which case the range is determined by the format.
		1438
		1439	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
		1440
1005	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1441	=item $ev = $queue->task ($kernel, $wait_events...)
1006		1442
1007	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1443	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1008		1444
1009	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1445	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1010		1446
1011	Enqueues a kernel execution.	1447	Enqueues a kernel execution.
1012		1448
1013	@$global_work_size must be specified as a reference to an array of	1449	\@global_work_size must be specified as a reference to an array of
1014	integers specifying the work sizes (element counts).	1450	integers specifying the work sizes (element counts).
1015		1451
1016	@$global_work_offset must be either C<undef> (in which case all offsets	1452	\@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	1453	are C<0>), or a reference to an array of work offsets, with the same number
1018	of elements as @$global_work_size.	1454	of elements as \@global_work_size.
1019		1455
1020	@$local_work_size must be either C<undef> (in which case the	1456	\@local_work_size must be either C<undef> (in which case the
1021	implementation is supposed to choose good local work sizes), or a	1457	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	1458	reference to an array of local work sizes, with the same number of
1023	elements as @$global_work_size.	1459	elements as \@global_work_size.
1024		1460
1025	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1461	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1026		1462
		1463	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1464
		1465	Migrates a number of OpenCL::Memory objects to or from the device.
		1466
		1467	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1468
		1469	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1470
1027	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1471	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1028		1472
1029	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1473	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1030	for subsequent OpenCL usage.	1474	for subsequent OpenCL usage.
1031		1475
1032	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1476	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1033		1477
1034	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1478	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1035		1479
1036	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1480	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1037	for subsequent OpenGL usage.	1481	for subsequent OpenGL usage.
1038		1482
1039	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1483	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1040		1484
1041	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1485	=item $ev = $queue->wait_for_events ($wait_events...)
1042		1486
1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1487	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1044		1488
1045	=item $ev = $queue->enqueue_marker ($wait_events...)	1489	=item $ev = $queue->marker ($wait_events...)
1046		1490
1047	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1491	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1048		1492
1049	=item $ev = $queue->enqueue_barrier ($wait_events...)	1493	=item $ev = $queue->barrier ($wait_events...)
1050		1494
1051	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1495	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1052		1496
1053	=item $queue->flush	1497	=item $queue->flush
1054		1498
…		…
1066		1510
1067	=for gengetinfo begin command_queue	1511	=for gengetinfo begin command_queue
1068		1512
1069	=item $ctx = $command_queue->context	1513	=item $ctx = $command_queue->context
1070		1514
1071	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1515	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1072		1516
1073	=item $device = $command_queue->device	1517	=item $device = $command_queue->device
1074		1518
1075	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1519	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1076		1520
1077	=item $uint = $command_queue->reference_count	1521	=item $uint = $command_queue->reference_count
1078		1522
1079	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1523	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1080		1524
1081	=item $command_queue_properties = $command_queue->properties	1525	=item $command_queue_properties = $command_queue->properties
1082		1526
1083	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1527	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1084		1528
1085	=for gengetinfo end command_queue	1529	=for gengetinfo end command_queue
		1530
		1531	=back
		1532
		1533	=head3 MEMORY MAPPED BUFFERS
		1534
		1535	OpenCL allows you to map buffers and images to host memory (read: perl
		1536	scalars). This is done much like reading or copying a buffer, by enqueuing
		1537	a map or unmap operation on the command queue.
		1538
		1539	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1540	OpenCL::Mapped CLASS> section for details on what to do with these
		1541	objects.
		1542
		1543	The object will be unmapped automatically when the mapped object is
		1544	destroyed (you can use a barrier to make sure the unmap has finished,
		1545	before using the buffer in a kernel), but you can also enqueue an unmap
		1546	operation manually.
		1547
		1548	=over 4
		1549
		1550	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1551
		1552	Maps the given buffer into host memory and returns an
		1553	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1554	the map will extend to the end of the buffer.
		1555
		1556	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1557
		1558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1559
		1560	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1561
		1562	{
		1563	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1564	substr $$mapped, 0, 4, "abcd";
		1565	} # asynchronously unmap because $mapped is destroyed
		1566
		1567	=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...)
		1568
		1569	Maps the given image area into host memory and return an
		1570	C<OpenCL::MappedImage> object.
		1571
		1572	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1573	will be replaced by the maximum possible value.
		1574
		1575	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1576
		1577	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1578	the first channel of the leftmost column to 5, then explicitly unmap
		1579	it. You are not necessarily meant to do it this way, this example just
		1580	shows you the accessors to use :)
		1581
		1582	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1583
		1584	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1585	for 0..$image->height;
		1586
		1587	$mapped->unmap;.
		1588	$mapped->wait; # only needed for out of order queues normally
		1589
		1590	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1591
		1592	Unmaps the data from host memory. You must not call any methods that
		1593	modify the data, or modify the data scalar directly, after calling this
		1594	method.
		1595
		1596	The mapped event object will always be passed as part of the
		1597	$wait_events. The mapped event object will be replaced by the new event
		1598	object that this request creates.
1086		1599
1087	=back	1600	=back
1088		1601
1089	=head2 THE OpenCL::Memory CLASS	1602	=head2 THE OpenCL::Memory CLASS
1090		1603
…		…
1101		1614
1102	=for gengetinfo begin mem	1615	=for gengetinfo begin mem
1103		1616
1104	=item $mem_object_type = $mem->type	1617	=item $mem_object_type = $mem->type
1105		1618
1106	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1619	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1107		1620
1108	=item $mem_flags = $mem->flags	1621	=item $mem_flags = $mem->flags
1109		1622
1110	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1623	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1111		1624
1112	=item $int = $mem->size	1625	=item $int = $mem->size
1113		1626
1114	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1627	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1115		1628
1116	=item $ptr_value = $mem->host_ptr	1629	=item $ptr_value = $mem->host_ptr
1117		1630
1118	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1631	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1119		1632
1120	=item $uint = $mem->map_count	1633	=item $uint = $mem->map_count
1121		1634
1122	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1635	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1123		1636
1124	=item $uint = $mem->reference_count	1637	=item $uint = $mem->reference_count
1125		1638
1126	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1639	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1127		1640
1128	=item $ctx = $mem->context	1641	=item $ctx = $mem->context
1129		1642
1130	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1643	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1131		1644
1132	=item $mem = $mem->associated_memobject	1645	=item $mem = $mem->associated_memobject
1133		1646
1134	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1647	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1135		1648
1136	=item $int = $mem->offset	1649	=item $int = $mem->offset
1137		1650
1138	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1651	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1139		1652
1140	=for gengetinfo end mem	1653	=for gengetinfo end mem
1141		1654
1142	=item ($type, $name) = $mem->gl_object_info	1655	=item ($type, $name) = $mem->gl_object_info
1143		1656
…		…
1177	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,	1690	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1178	OpenCL::Image2DArray and OpenCL::Image3D.	1691	OpenCL::Image2DArray and OpenCL::Image3D.
1179		1692
1180	=over 4	1693	=over 4
1181		1694
1182	=item $packed_value = $ev->image_info ($name)	1695	=item $packed_value = $image->image_info ($name)
1183		1696
1184	See C<< $platform->info >> for details.	1697	See C<< $platform->info >> for details.
1185		1698
1186	The reason this method is not called C<info> is that there already is an	1699	The reason this method is not called C<info> is that there already is an
1187	C<< ->info >> method inherited from C<OpenCL::Memory>.	1700	C<< ->info >> method inherited from C<OpenCL::Memory>.
1188		1701
1189	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1702	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1190		1703
		1704	=item ($channel_order, $channel_data_type) = $image->format
		1705
		1706	Returns the channel order and type used to create the image by calling
		1707	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1708
1191	=for gengetinfo begin image	1709	=for gengetinfo begin image
1192		1710
1193	=item $int = $image->element_size	1711	=item $int = $image->element_size
1194		1712
1195	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1713	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1196		1714
1197	=item $int = $image->row_pitch	1715	=item $int = $image->row_pitch
1198		1716
1199	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1717	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1200		1718
1201	=item $int = $image->slice_pitch	1719	=item $int = $image->slice_pitch
1202		1720
1203	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1721	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1204		1722
1205	=item $int = $image->width	1723	=item $int = $image->width
1206		1724
1207	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1725	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1208		1726
1209	=item $int = $image->height	1727	=item $int = $image->height
1210		1728
1211	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1729	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1212		1730
1213	=item $int = $image->depth	1731	=item $int = $image->depth
1214		1732
1215	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1733	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1216		1734
1217	=for gengetinfo end image	1735	=for gengetinfo end image
1218		1736
1219	=for gengetinfo begin gl_texture	1737	=for gengetinfo begin gl_texture
1220		1738
1221	=item $GLenum = $gl_texture->target	1739	=item $GLenum = $gl_texture->target
1222		1740
1223	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1741	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1224		1742
1225	=item $GLint = $gl_texture->gl_mipmap_level	1743	=item $GLint = $gl_texture->gl_mipmap_level
1226		1744
1227	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1745	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1228		1746
1229	=for gengetinfo end gl_texture	1747	=for gengetinfo end gl_texture
1230		1748
1231	=back	1749	=back
1232		1750
…		…
1242		1760
1243	=for gengetinfo begin sampler	1761	=for gengetinfo begin sampler
1244		1762
1245	=item $uint = $sampler->reference_count	1763	=item $uint = $sampler->reference_count
1246		1764
1247	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1765	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1248		1766
1249	=item $ctx = $sampler->context	1767	=item $ctx = $sampler->context
1250		1768
1251	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1769	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1252		1770
1253	=item $addressing_mode = $sampler->normalized_coords	1771	=item $addressing_mode = $sampler->normalized_coords
1254		1772
1255	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1773	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1256		1774
1257	=item $filter_mode = $sampler->addressing_mode	1775	=item $filter_mode = $sampler->addressing_mode
1258		1776
1259	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1777	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1260		1778
1261	=item $boolean = $sampler->filter_mode	1779	=item $boolean = $sampler->filter_mode
1262		1780
1263	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1781	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1264		1782
1265	=for gengetinfo end sampler	1783	=for gengetinfo end sampler
1266		1784
1267	=back	1785	=back
1268		1786
1269	=head2 THE OpenCL::Program CLASS	1787	=head2 THE OpenCL::Program CLASS
1270		1788
1271	=over 4	1789	=over 4
1272		1790
1273	=item $program->build ($device, $options = "")	1791	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1274		1792
1275	Tries to build the program with the given options. See also the	1793	Tries to build the program with the given options. See also the
1276	C<$ctx->build> convenience function.	1794	C<$ctx->build> convenience function.
1277		1795
		1796	If a callback is specified, then it will be called when compilation is
		1797	finished. Note that many OpenCL implementations block your program while
		1798	compiling whether you use a callback or not. See C<build_async> if you
		1799	want to make sure the build is done in the background.
		1800
		1801	Note that some OpenCL implementations act up badly, and don't call the
		1802	callback in some error cases (but call it in others). This implementation
		1803	assumes the callback will always be called, and leaks memory if this is
		1804	not so. So best make sure you don't pass in invalid values.
		1805
		1806	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1807	compilation state is successful but some later stage fails.
		1808
		1809	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1810	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1811	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1812	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1813	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1814	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1815	C<-create-library>, C<-enable-link-options>.
		1816
		1817	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1818	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1819
1278	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1820	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1821
		1822	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1823
		1824	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1825	need to check the compilation status form the callback, or by polling).
		1826
		1827	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1828
		1829	Compiles the given program for the given devices (or all devices if
		1830	undef). If C<$headers> is given, it must be a hashref with include name =>
		1831	OpenCL::Program pairs.
		1832
		1833	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
1279		1834
1280	=item $packed_value = $program->build_info ($device, $name)	1835	=item $packed_value = $program->build_info ($device, $name)
1281		1836
1282	Similar to C<< $platform->info >>, but returns build info for a previous	1837	Similar to C<< $platform->info >>, but returns build info for a previous
1283	build attempt for the given device.	1838	build attempt for the given device.
…		…
1299		1854
1300	=for gengetinfo begin program_build	1855	=for gengetinfo begin program_build
1301		1856
1302	=item $build_status = $program->build_status ($device)	1857	=item $build_status = $program->build_status ($device)
1303		1858
1304	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1859	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1305		1860
1306	=item $string = $program->build_options ($device)	1861	=item $string = $program->build_options ($device)
1307		1862
1308	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1863	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1309		1864
1310	=item $string = $program->build_log ($device)	1865	=item $string = $program->build_log ($device)
1311		1866
1312	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1867	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1313		1868
1314	=for gengetinfo end program_build	1869	=for gengetinfo end program_build
1315		1870
1316	=item $packed_value = $program->info ($name)	1871	=item $packed_value = $program->info ($name)
1317		1872
…		…
1321		1876
1322	=for gengetinfo begin program	1877	=for gengetinfo begin program
1323		1878
1324	=item $uint = $program->reference_count	1879	=item $uint = $program->reference_count
1325		1880
1326	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1881	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1327		1882
1328	=item $ctx = $program->context	1883	=item $ctx = $program->context
1329		1884
1330	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1885	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1331		1886
1332	=item $uint = $program->num_devices	1887	=item $uint = $program->num_devices
1333		1888
1334	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1889	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1335		1890
1336	=item @devices = $program->devices	1891	=item @devices = $program->devices
1337		1892
1338	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1893	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1339		1894
1340	=item $string = $program->source	1895	=item $string = $program->source
1341		1896
1342	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1897	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1343		1898
1344	=item @ints = $program->binary_sizes	1899	=item @ints = $program->binary_sizes
1345		1900
1346	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1901	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1347		1902
1348	=for gengetinfo end program	1903	=for gengetinfo end program
1349		1904
1350	=item @blobs = $program->binaries	1905	=item @blobs = $program->binaries
1351		1906
…		…
1372		1927
1373	=for gengetinfo begin kernel	1928	=for gengetinfo begin kernel
1374		1929
1375	=item $string = $kernel->function_name	1930	=item $string = $kernel->function_name
1376		1931
1377	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1932	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1378		1933
1379	=item $uint = $kernel->num_args	1934	=item $uint = $kernel->num_args
1380		1935
1381	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1936	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1382		1937
1383	=item $uint = $kernel->reference_count	1938	=item $uint = $kernel->reference_count
1384		1939
1385	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1940	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1386		1941
1387	=item $ctx = $kernel->context	1942	=item $ctx = $kernel->context
1388		1943
1389	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1944	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1390		1945
1391	=item $program = $kernel->program	1946	=item $program = $kernel->program
1392		1947
1393	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1948	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1394		1949
1395	=for gengetinfo end kernel	1950	=for gengetinfo end kernel
1396		1951
1397	=item $packed_value = $kernel->work_group_info ($device, $name)	1952	=item $packed_value = $kernel->work_group_info ($device, $name)
1398		1953
1399	See C<< $platform->info >> for details.	1954	See C<< $platform->info >> for details.
1400		1955
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>	1956	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1405		1957
1406	=for gengetinfo begin kernel_work_group	1958	=for gengetinfo begin kernel_work_group
1407		1959
1408	=item $int = $kernel->work_group_size ($device)	1960	=item $int = $kernel->work_group_size ($device)
1409		1961
1410	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1962	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1411		1963
1412	=item @ints = $kernel->compile_work_group_size ($device)	1964	=item @ints = $kernel->compile_work_group_size ($device)
1413		1965
1414	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	1966	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1415		1967
1416	=item $ulong = $kernel->local_mem_size ($device)	1968	=item $ulong = $kernel->local_mem_size ($device)
1417		1969
1418	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	1970	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1419		1971
1420	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1972	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1421		1973
1422	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	1974	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1423		1975
1424	=item $ulong = $kernel->private_mem_size ($device)	1976	=item $ulong = $kernel->private_mem_size ($device)
1425		1977
1426	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1978	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1427		1979
1428	=for gengetinfo end kernel_work_group	1980	=for gengetinfo end kernel_work_group
1429		1981
		1982	=item $packed_value = $kernel->arg_info ($idx, $name)
		1983
		1984	See C<< $platform->info >> for details.
		1985
		1986	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		1987
		1988	=for gengetinfo begin kernel_arg
		1989
		1990	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		1991
		1992	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		1993
		1994	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		1995
		1996	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		1997
		1998	=item $string = $kernel->arg_type_name ($idx)
		1999
		2000	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		2001
		2002	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		2003
		2004	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		2005
		2006	=item $string = $kernel->arg_name ($idx)
		2007
		2008	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		2009
		2010	=for gengetinfo end kernel_arg
		2011
		2012	=item $kernel->setf ($format, ...)
		2013
		2014	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		2015	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		2016	need to specify a format argument, much as with C<printf>, to tell OpenCL
		2017	what type of argument it is.
		2018
		2019	The format arguments are single letters:
		2020
		2021	c char
		2022	C unsigned char
		2023	s short
		2024	S unsigned short
		2025	i int
		2026	I unsigned int
		2027	l long
		2028	L unsigned long
		2029
		2030	h half float (0..65535)
		2031	f float
		2032	d double
		2033
		2034	z local (octet size)
		2035
		2036	m memory object (buffer or image)
		2037	a sampler
		2038	e event
		2039
		2040	Space characters in the format string are ignored.
		2041
		2042	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		2043
		2044	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		2045
1430	=item $kernel->set_TYPE ($index, $value)	2046	=item $kernel->set_TYPE ($index, $value)
1431		2047
		2048	=item $kernel->set_char ($index, $value)
		2049
		2050	=item $kernel->set_uchar ($index, $value)
		2051
		2052	=item $kernel->set_short ($index, $value)
		2053
		2054	=item $kernel->set_ushort ($index, $value)
		2055
		2056	=item $kernel->set_int ($index, $value)
		2057
		2058	=item $kernel->set_uint ($index, $value)
		2059
		2060	=item $kernel->set_long ($index, $value)
		2061
		2062	=item $kernel->set_ulong ($index, $value)
		2063
		2064	=item $kernel->set_half ($index, $value)
		2065
		2066	=item $kernel->set_float ($index, $value)
		2067
		2068	=item $kernel->set_double ($index, $value)
		2069
		2070	=item $kernel->set_memory ($index, $value)
		2071
		2072	=item $kernel->set_buffer ($index, $value)
		2073
		2074	=item $kernel->set_image ($index, $value)
		2075
		2076	=item $kernel->set_sampler ($index, $value)
		2077
		2078	=item $kernel->set_local ($index, $value)
		2079
		2080	=item $kernel->set_event ($index, $value)
		2081
1432	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	2082	This is a family of methods to set the kernel argument with the number
1433		2083	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		2084
1438	Chars and integers (including the half type) are specified as integers,	2085	Chars and integers (including the half type) are specified as integers,
1439	float and double as floating point values, memory/buffer/image2d/image3d	2086	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	2087	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	2088	specifying the size, and sampler and event must be objects of that type.
1442	type.	2089
		2090	Note that C<set_memory> works for all memory objects (all types of buffers
		2091	and images) - the main purpose of the more specific C<set_TYPE> functions
		2092	is type checking.
1443		2093
1444	Setting an argument for a kernel does NOT keep a reference to the object -	2094	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,	2095	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.	2096	and call the kernel, you will run into undefined behaviour.
1447		2097
…		…
1460		2110
1461	Waits for the event to complete.	2111	Waits for the event to complete.
1462		2112
1463	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	2113	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1464		2114
		2115	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		2116
		2117	Adds a callback to the callback stack for the given event type. There is
		2118	no way to remove a callback again.
		2119
		2120	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		2121
1465	=item $packed_value = $ev->info ($name)	2122	=item $packed_value = $ev->info ($name)
1466		2123
1467	See C<< $platform->info >> for details.	2124	See C<< $platform->info >> for details.
1468		2125
1469	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	2126	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1470		2127
1471	=for gengetinfo begin event	2128	=for gengetinfo begin event
1472		2129
1473	=item $queue = $event->command_queue	2130	=item $queue = $event->command_queue
1474		2131
1475	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2132	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1476		2133
1477	=item $command_type = $event->command_type	2134	=item $command_type = $event->command_type
1478		2135
1479	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2136	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1480		2137
1481	=item $uint = $event->reference_count	2138	=item $uint = $event->reference_count
1482		2139
1483	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2140	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1484		2141
1485	=item $uint = $event->command_execution_status	2142	=item $uint = $event->command_execution_status
1486		2143
1487	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2144	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1488		2145
1489	=item $ctx = $event->context	2146	=item $ctx = $event->context
1490		2147
1491	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2148	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1492		2149
1493	=for gengetinfo end event	2150	=for gengetinfo end event
1494		2151
1495	=item $packed_value = $ev->profiling_info ($name)	2152	=item $packed_value = $ev->profiling_info ($name)
1496		2153
…		…
1503		2160
1504	=for gengetinfo begin profiling	2161	=for gengetinfo begin profiling
1505		2162
1506	=item $ulong = $event->profiling_command_queued	2163	=item $ulong = $event->profiling_command_queued
1507		2164
1508	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2165	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1509		2166
1510	=item $ulong = $event->profiling_command_submit	2167	=item $ulong = $event->profiling_command_submit
1511		2168
1512	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2169	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1513		2170
1514	=item $ulong = $event->profiling_command_start	2171	=item $ulong = $event->profiling_command_start
1515		2172
1516	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2173	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1517		2174
1518	=item $ulong = $event->profiling_command_end	2175	=item $ulong = $event->profiling_command_end
1519		2176
1520	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2177	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1521		2178
1522	=for gengetinfo end profiling	2179	=for gengetinfo end profiling
1523		2180
1524	=back	2181	=back
1525		2182
…		…
1529		2186
1530	=over 4	2187	=over 4
1531		2188
1532	=item $ev->set_status ($execution_status)	2189	=item $ev->set_status ($execution_status)
1533		2190
		2191	Sets the execution status of the user event. Can only be called once,
		2192	either with OpenCL::COMPLETE or a negative number as status.
		2193
		2194	execution_status: OpenCL::COMPLETE or a negative integer.
		2195
1534	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2196	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1535		2197
1536	=back	2198	=back
1537		2199
		2200	=head2 THE OpenCL::Mapped CLASS
		2201
		2202	This class represents objects mapped into host memory. They are
		2203	represented by a blessed string scalar. The string data is the mapped
		2204	memory area, that is, if you read or write it, then the mapped object is
		2205	accessed directly.
		2206
		2207	You must only ever use operations that modify the string in-place - for
		2208	example, a C<substr> that doesn't change the length, or maybe a regex that
		2209	doesn't change the length. Any other operation might cause the data to be
		2210	copied.
		2211
		2212	When the object is destroyed it will enqueue an implicit unmap operation
		2213	on the queue that was used to create it.
		2214
		2215	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2216	OpenCL sees the changes, even if some implementations don't need this
		2217	sometimes.
		2218
		2219	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2220
		2221	my $mapped = $queue->map_buffer ($buf, ...
		2222	$mapped->event->wait; # make sure it's there
		2223
		2224	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2225	# we blindly assume device endianness to equal host endianness
		2226	# (and of course, we assume iee 754 single precision floats :)
		2227	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2228
		2229	=over 4
		2230
		2231	=item $ev = $mapped->unmap ($wait_events...)
		2232
		2233	Unmaps the mapped memory object, using the queue originally used to create
		2234	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2235
		2236	=item $bool = $mapped->mapped
		2237
		2238	Returns whether the object is still mapped - true before an C<unmap> is
		2239	enqueued, false afterwards.
		2240
		2241	=item $ev = $mapped->event
		2242
		2243	Return the event object associated with the mapped object. Initially, this
		2244	will be the event object created when mapping the object, and after an
		2245	unmap, this will be the event object that the unmap operation created.
		2246
		2247	=item $mapped->wait
		2248
		2249	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2250	mapped object are outstanding.
		2251
		2252	=item $bytes = $mapped->size
		2253
		2254	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2255
		2256	=item $ptr = $mapped->ptr
		2257
		2258	Returns the raw memory address of the mapped area.
		2259
		2260	=item $mapped->set ($offset, $data)
		2261
		2262	Replaces the data at the given C<$offset> in the memory area by the new
		2263	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2264	because it does bounds-checking, but also slower.
		2265
		2266	=item $data = $mapped->get ($offset, $length)
		2267
		2268	Returns (without copying) a scalar representing the data at the given
		2269	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2270	the following substr, except much slower;
		2271
		2272	$data = substr $$mapped, $offset, $length
		2273
1538	=cut	2274	=cut
1539		2275
1540	package OpenCL;	2276	sub OpenCL::Mapped::get {
1541		2277	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	}	2278	}
		2279
		2280	=back
		2281
		2282	=head2 THE OpenCL::MappedBuffer CLASS
		2283
		2284	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2285
		2286	=head2 THE OpenCL::MappedImage CLASS
		2287
		2288	This is a subclass of OpenCL::Mapped, representing mapped images.
		2289
		2290	=over 4
		2291
		2292	=item $bytes = $mapped->row_pitch
		2293
		2294	=item $bytes = $mapped->slice_pitch
		2295
		2296	Return the row or slice pitch of the image that has been mapped.
		2297
		2298	=back
		2299
		2300
		2301	=cut
1564		2302
1565	1;	2303	1;
1566		2304
1567	=head1 AUTHOR	2305	=head1 AUTHOR
1568		2306

Diff Legend

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