ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.50 by root, Tue Apr 24 13:30:49 2012 UTC vs.
Revision 1.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.
…		…
157	$id = get_global_id (0);	192	$id = get_global_id (0);
158	output [id] = input [id] * input [id];	193	output [id] = input [id] * input [id];
159	}	194	}
160	';	195	';
161		196
162	my $prog = $ctx->program_with_source ($src);	197	my $prog = $ctx->build_program ($src);
163
164	# build croaks on compile errors, so catch it and print the compile errors
165	eval { $prog->build ($dev, "-cl-fast-relaxed-math"); 1 }
166	or die $prog->build_log;
167
168	my $kernel = $prog->kernel ("squareit");	198	my $kernel = $prog->kernel ("squareit");
169		199
170	=head2 Create some input and output float buffers, then call the	200	=head2 Create some input and output float buffers, then call the
171	'squareit' kernel on them.	201	'squareit' kernel on them.
172		202
…		…
176	# set buffer	206	# set buffer
177	$kernel->set_buffer (0, $input);	207	$kernel->set_buffer (0, $input);
178	$kernel->set_buffer (1, $output);	208	$kernel->set_buffer (1, $output);
179		209
180	# execute it for all 4 numbers	210	# execute it for all 4 numbers
181	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	211	$queue->nd_range_kernel ($kernel, undef, [4], undef);
182		212
183	# enqueue a synchronous read	213	# enqueue a synchronous read
184	$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);
185		215
186	# print the results:	216	# print the results:
187	printf "%s\n", join ", ", unpack "f*", $data;	217	printf "%s\n", join ", ", unpack "f*", $data;
188		218
189	=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,
190	showing off barriers.	220	showing off barriers.
191		221
192	# execute it for all 4 numbers	222	# execute it for all 4 numbers
193	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	223	$queue->nd_range_kernel ($kernel, undef, [4], undef);
194		224
195	# enqueue a barrier to ensure in-order execution	225	# enqueue a barrier to ensure in-order execution
196	$queue->enqueue_barrier;	226	$queue->barrier;
197		227
198	# enqueue an async read	228	# enqueue an async read
199	$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);
200		230
201	# wait for all requests to finish	231	# wait for all requests to finish
202	$queue->finish;	232	$queue->finish;
203		233
204	=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,
205	showing off event objects and wait lists.	235	showing off event objects and wait lists.
206		236
207	# execute it for all 4 numbers	237	# execute it for all 4 numbers
208	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	238	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
209		239
210	# enqueue an async read	240	# enqueue an async read
211	$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);
212		242
213	# wait for the last event to complete	243	# wait for the last event to complete
214	$ev->wait;	244	$ev->wait;
215		245
216	=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
217	set tunnel effect.	247	set flight effect.
218		248
219	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>.
220		251
221	use OpenGL ":all";	252	use OpenGL ":all";
222	use OpenCL;	253	use OpenCL;
223		254
		255	my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
		256
224	# open a window and create a gl texture	257	# open a window and create a gl texture
225	OpenGL::glpOpenWindow width => 256, height => 256;	258	OpenGL::glpOpenWindow width => $S, height => $S;
226	my $texid = glGenTextures_p 1;	259	my $texid = glGenTextures_p 1;
227	glBindTexture GL_TEXTURE_2D, $texid;	260	glBindTexture GL_TEXTURE_2D, $texid;
228	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;
229		262
230	# 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
231	my $platform;	264	my $platform;
232	my $dev;	265	my $dev;
233	my $ctx;	266	my $ctx;
…		…
252	# now the boring opencl code	285	# now the boring opencl code
253	my $src = <<EOF;	286	my $src = <<EOF;
254	kernel void	287	kernel void
255	juliatunnel (write_only image2d_t img, float time)	288	juliatunnel (write_only image2d_t img, float time)
256	{	289	{
257	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;
258		292
259	float2 m = (float2)(1.f, p.y) / fabs (p.x);	293	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
260	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;	294	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
261		295
262	float2 z = m;	296	float2 z = m;
263	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	297	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
264		298
265	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
266	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;
267		301
268	float3 colour = (float3)(z.x, z.y, z.x * z.y);	302	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
269	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));	303	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
270	}	304	}
271	EOF	305	EOF
		306
272	my $prog = $ctx->program_with_source ($src);	307	my $prog = $ctx->build_program ($src);
273	eval { $prog->build ($dev); 1 }
274	or die $prog->build_log ($dev);
275
276	my $kernel = $prog->kernel ("juliatunnel");	308	my $kernel = $prog->kernel ("juliatunnel");
277		309
278	# program compiled, kernel ready, now draw and loop	310	# program compiled, kernel ready, now draw and loop
279		311
280	for (my $time; ; ++$time) {	312	for (my $time; ; ++$time) {
281	# acquire objects from opengl	313	# acquire objects from opengl
282	$queue->enqueue_acquire_gl_objects ([$tex]);	314	$queue->acquire_gl_objects ([$tex]);
283		315
284	# configure and run our kernel	316	# configure and run our kernel
285	$kernel->set_image2d (0, $tex);	317	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
286	$kernel->set_float (1, $time);
287	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);	318	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
288		319
289	# release objects to opengl again	320	# release objects to opengl again
290	$queue->enqueue_release_gl_objects ([$tex]);	321	$queue->release_gl_objects ([$tex]);
291		322
292	# wait	323	# wait
293	$queue->finish;	324	$queue->finish;
294		325
295	# now draw the texture, the defaults should be all right	326	# now draw the texture, the defaults should be all right
…		…
305		336
306	glXSwapBuffers;	337	glXSwapBuffers;
307		338
308	select undef, undef, undef, 1/60;	339	select undef, undef, undef, 1/60;
309	}	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>.
310		385
311	=head1 DOCUMENTATION	386	=head1 DOCUMENTATION
312		387
313	=head2 BASIC CONVENTIONS	388	=head2 BASIC CONVENTIONS
314		389
…		…
383		458
384	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
385	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
386	capable of finding the function via C<RTLD_DEFAULT>.	461	capable of finding the function via C<RTLD_DEFAULT>.
387		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
388	=head2 THE OpenCL PACKAGE	625	=head2 THE OpenCL PACKAGE
389		626
390	=over 4	627	=over 4
391		628
392	=item $int = OpenCL::errno	629	=item $int = OpenCL::errno
393		630
394	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
395	and before calling another OpenCL function.	632	and before calling another OpenCL function.
396		633
397	=item $str = OpenCL::err2str $errval	634	=item $str = OpenCL::err2str [$errval]
398		635
399	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).
400		638
401	=item $str = OpenCL::enum2str $enum	639	=item $str = OpenCL::enum2str $enum
402		640
403	Converts most enum values (of parameter names, image format constants,	641	Converts most enum values (of parameter names, image format constants,
404	object types, addressing and filter modes, command types etc.) into a	642	object types, addressing and filter modes, command types etc.) into a
…		…
410		648
411	Returns all available OpenCL::Platform objects.	649	Returns all available OpenCL::Platform objects.
412		650
413	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>
414		652
415	=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
416		654
417	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.
418		660
419	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>
420		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
421	=item OpenCL::wait_for_events $wait_events...	670	=item OpenCL::wait_for_events $wait_events...
422		671
423	Waits for all events to complete.	672	Waits for all events to complete.
424		673
425	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>
426		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
427	=back	713	=back
428		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
429	=head2 THE OpenCL::Platform CLASS	740	=head2 THE OpenCL::Platform CLASS
430		741
431	=over 4	742	=over 4
432		743
433	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	744	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
434		745
435	Returns a list of matching OpenCL::Device objects.	746	Returns a list of matching OpenCL::Device objects.
436		747
437	=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)
438		749
439	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.
440		751
441	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>
442		753
443	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)	754	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
444		755
445	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
446	CL_CONTEXT_PLATFORM property is supplied automatically.	757	CL_CONTEXT_PLATFORM property is supplied automatically.
447		758
448	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>
…		…
467		778
468	=for gengetinfo begin platform	779	=for gengetinfo begin platform
469		780
470	=item $string = $platform->profile	781	=item $string = $platform->profile
471		782
472	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.
473		784
474	=item $string = $platform->version	785	=item $string = $platform->version
475		786
476	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.
477		788
478	=item $string = $platform->name	789	=item $string = $platform->name
479		790
480	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.
481		792
482	=item $string = $platform->vendor	793	=item $string = $platform->vendor
483		794
484	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.
485		796
486	=item $string = $platform->extensions	797	=item $string = $platform->extensions
487		798
488	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.
489		800
490	=for gengetinfo end platform	801	=for gengetinfo end platform
491		802
492	=back	803	=back
493		804
…		…
499		810
500	See C<< $platform->info >> for details.	811	See C<< $platform->info >> for details.
501		812
502	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>
503		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
504	=for gengetinfo begin device	821	=for gengetinfo begin device
505		822
506	=item $device_type = $device->type	823	=item $device_type = $device->type
507		824
508	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.
509		826
510	=item $uint = $device->vendor_id	827	=item $uint = $device->vendor_id
511		828
512	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.
513		830
514	=item $uint = $device->max_compute_units	831	=item $uint = $device->max_compute_units
515		832
516	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.
517		834
518	=item $uint = $device->max_work_item_dimensions	835	=item $uint = $device->max_work_item_dimensions
519		836
520	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.
521		838
522	=item $int = $device->max_work_group_size	839	=item $int = $device->max_work_group_size
523		840
524	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.
525		842
526	=item @ints = $device->max_work_item_sizes	843	=item @ints = $device->max_work_item_sizes
527		844
528	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.
529		846
530	=item $uint = $device->preferred_vector_width_char	847	=item $uint = $device->preferred_vector_width_char
531		848
532	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.
533		850
534	=item $uint = $device->preferred_vector_width_short	851	=item $uint = $device->preferred_vector_width_short
535		852
536	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.
537		854
538	=item $uint = $device->preferred_vector_width_int	855	=item $uint = $device->preferred_vector_width_int
539		856
540	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.
541		858
542	=item $uint = $device->preferred_vector_width_long	859	=item $uint = $device->preferred_vector_width_long
543		860
544	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.
545		862
546	=item $uint = $device->preferred_vector_width_float	863	=item $uint = $device->preferred_vector_width_float
547		864
548	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.
549		866
550	=item $uint = $device->preferred_vector_width_double	867	=item $uint = $device->preferred_vector_width_double
551		868
552	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.
553		870
554	=item $uint = $device->max_clock_frequency	871	=item $uint = $device->max_clock_frequency
555		872
556	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.
557		874
558	=item $bitfield = $device->address_bits	875	=item $bitfield = $device->address_bits
559		876
560	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.
561		878
562	=item $uint = $device->max_read_image_args	879	=item $uint = $device->max_read_image_args
563		880
564	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.
565		882
566	=item $uint = $device->max_write_image_args	883	=item $uint = $device->max_write_image_args
567		884
568	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.
569		886
570	=item $ulong = $device->max_mem_alloc_size	887	=item $ulong = $device->max_mem_alloc_size
571		888
572	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.
573		890
574	=item $int = $device->image2d_max_width	891	=item $int = $device->image2d_max_width
575		892
576	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.
577		894
578	=item $int = $device->image2d_max_height	895	=item $int = $device->image2d_max_height
579		896
580	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.
581		898
582	=item $int = $device->image3d_max_width	899	=item $int = $device->image3d_max_width
583		900
584	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.
585		902
586	=item $int = $device->image3d_max_height	903	=item $int = $device->image3d_max_height
587		904
588	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.
589		906
590	=item $int = $device->image3d_max_depth	907	=item $int = $device->image3d_max_depth
591		908
592	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.
593		910
594	=item $uint = $device->image_support	911	=item $uint = $device->image_support
595		912
596	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.
597		914
598	=item $int = $device->max_parameter_size	915	=item $int = $device->max_parameter_size
599		916
600	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.
601		918
602	=item $uint = $device->max_samplers	919	=item $uint = $device->max_samplers
603		920
604	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.
605		922
606	=item $uint = $device->mem_base_addr_align	923	=item $uint = $device->mem_base_addr_align
607		924
608	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.
609		926
610	=item $uint = $device->min_data_type_align_size	927	=item $uint = $device->min_data_type_align_size
611		928
612	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.
613		930
614	=item $device_fp_config = $device->single_fp_config	931	=item $device_fp_config = $device->single_fp_config
615		932
616	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.
617		934
618	=item $device_mem_cache_type = $device->global_mem_cache_type	935	=item $device_mem_cache_type = $device->global_mem_cache_type
619		936
620	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.
621		938
622	=item $uint = $device->global_mem_cacheline_size	939	=item $uint = $device->global_mem_cacheline_size
623		940
624	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.
625		942
626	=item $ulong = $device->global_mem_cache_size	943	=item $ulong = $device->global_mem_cache_size
627		944
628	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.
629		946
630	=item $ulong = $device->global_mem_size	947	=item $ulong = $device->global_mem_size
631		948
632	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.
633		950
634	=item $ulong = $device->max_constant_buffer_size	951	=item $ulong = $device->max_constant_buffer_size
635		952
636	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.
637		954
638	=item $uint = $device->max_constant_args	955	=item $uint = $device->max_constant_args
639		956
640	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.
641		958
642	=item $device_local_mem_type = $device->local_mem_type	959	=item $device_local_mem_type = $device->local_mem_type
643		960
644	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.
645		962
646	=item $ulong = $device->local_mem_size	963	=item $ulong = $device->local_mem_size
647		964
648	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.
649		966
650	=item $boolean = $device->error_correction_support	967	=item $boolean = $device->error_correction_support
651		968
652	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.
653		970
654	=item $int = $device->profiling_timer_resolution	971	=item $int = $device->profiling_timer_resolution
655		972
656	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.
657		974
658	=item $boolean = $device->endian_little	975	=item $boolean = $device->endian_little
659		976
660	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.
661		978
662	=item $boolean = $device->available	979	=item $boolean = $device->available
663		980
664	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.
665		982
666	=item $boolean = $device->compiler_available	983	=item $boolean = $device->compiler_available
667		984
668	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.
669		986
670	=item $device_exec_capabilities = $device->execution_capabilities	987	=item $device_exec_capabilities = $device->execution_capabilities
671		988
672	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.
673		990
674	=item $command_queue_properties = $device->properties	991	=item $command_queue_properties = $device->properties
675		992
676	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.
677		994
678	=item $ = $device->platform	995	=item $ = $device->platform
679		996
680	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.
681		998
682	=item $string = $device->name	999	=item $string = $device->name
683		1000
684	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.
685		1002
686	=item $string = $device->vendor	1003	=item $string = $device->vendor
687		1004
688	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.
689		1006
690	=item $string = $device->driver_version	1007	=item $string = $device->driver_version
691		1008
692	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.
693		1010
694	=item $string = $device->profile	1011	=item $string = $device->profile
695		1012
696	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.
697		1014
698	=item $string = $device->version	1015	=item $string = $device->version
699		1016
700	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.
701		1018
702	=item $string = $device->extensions	1019	=item $string = $device->extensions
703		1020
704	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.
705		1022
706	=item $uint = $device->preferred_vector_width_half	1023	=item $uint = $device->preferred_vector_width_half
707		1024
708	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.
709		1026
710	=item $uint = $device->native_vector_width_char	1027	=item $uint = $device->native_vector_width_char
711		1028
712	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.
713		1030
714	=item $uint = $device->native_vector_width_short	1031	=item $uint = $device->native_vector_width_short
715		1032
716	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.
717		1034
718	=item $uint = $device->native_vector_width_int	1035	=item $uint = $device->native_vector_width_int
719		1036
720	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.
721		1038
722	=item $uint = $device->native_vector_width_long	1039	=item $uint = $device->native_vector_width_long
723		1040
724	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.
725		1042
726	=item $uint = $device->native_vector_width_float	1043	=item $uint = $device->native_vector_width_float
727		1044
728	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.
729		1046
730	=item $uint = $device->native_vector_width_double	1047	=item $uint = $device->native_vector_width_double
731		1048
732	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.
733		1050
734	=item $uint = $device->native_vector_width_half	1051	=item $uint = $device->native_vector_width_half
735		1052
736	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.
737		1054
738	=item $device_fp_config = $device->double_fp_config	1055	=item $device_fp_config = $device->double_fp_config
739		1056
740	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.
741		1058
742	=item $device_fp_config = $device->half_fp_config	1059	=item $device_fp_config = $device->half_fp_config
743		1060
744	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.
745		1062
746	=item $boolean = $device->host_unified_memory	1063	=item $boolean = $device->host_unified_memory
747		1064
748	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.
749		1066
750	=item $device = $device->parent_device_ext	1067	=item $device = $device->parent_device_ext
751		1068
752	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.
753		1070
754	=item @device_partition_property_exts = $device->partition_types_ext	1071	=item @device_partition_property_exts = $device->partition_types_ext
755		1072
756	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.
757		1074
758	=item @device_partition_property_exts = $device->affinity_domains_ext	1075	=item @device_partition_property_exts = $device->affinity_domains_ext
759		1076
760	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.
761		1078
762	=item $uint = $device->reference_count_ext	1079	=item $uint = $device->reference_count_ext
763		1080
764	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.
765		1082
766	=item @device_partition_property_exts = $device->partition_style_ext	1083	=item @device_partition_property_exts = $device->partition_style_ext
767		1084
768	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.
769		1086
770	=for gengetinfo end device	1087	=for gengetinfo end device
771		1088
772	=back	1089	=back
773		1090
774	=head2 THE OpenCL::Context CLASS	1091	=head2 THE OpenCL::Context CLASS
775		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
776	=over 4	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
		1118
		1119	=over 4
		1120
		1121	=item $prog = $ctx->build_program ($program, $options = "")
		1122
		1123	This convenience function tries to build the program on all devices in
		1124	the context. If the build fails, then the function will C<croak> with the
		1125	build log. Otherwise ti returns the program object.
		1126
		1127	The C<$program> can either be a C<OpenCL::Program> object or a string
		1128	containing the program. In the latter case, a program objetc will be
		1129	created automatically.
		1130
		1131	=cut
		1132
		1133	sub OpenCL::Context::build_program {
		1134	my ($self, $prog, $options) = @_;
		1135
		1136	$prog = $self->program_with_source ($prog)
		1137	unless ref $prog;
		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
		1145	for my $dev ($self->devices) {
		1146	$prog->build_status ($dev) == BUILD_SUCCESS
		1147	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1148	. $prog->build_log ($dev);
		1149	}
		1150
		1151	$prog
		1152	}
777		1153
778	=item $queue = $ctx->queue ($device, $properties)	1154	=item $queue = $ctx->queue ($device, $properties)
779		1155
780	Create a new OpenCL::Queue object from the context and the given device.	1156	Create a new OpenCL::Queue object from the context and the given device.
781		1157
…		…
794	=item $buf = $ctx->buffer ($flags, $len)	1170	=item $buf = $ctx->buffer ($flags, $len)
795		1171
796	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1172	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
797	given flags and octet-size.	1173	given flags and octet-size.
798		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
799	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>
800		1180
801	=item $buf = $ctx->buffer_sv ($flags, $data)	1181	=item $buf = $ctx->buffer_sv ($flags, $data)
802		1182
803	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1183	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
804	initialise it with the given data values.	1184	initialise it with the given data values.
805		1185
806	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)	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)
807		1187
808	Creates a new OpenCL::Image object and optionally initialises it with	1188	Creates a new OpenCL::Image object and optionally initialises it with
809	the given data values.	1189	the given data values.
810		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
811	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>
812		1208
813	=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)
814		1210
815	Creates a new OpenCL::Image2D object and optionally initialises it with	1211	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
827	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1223	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
828		1224
829	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
830	OpenGL buffer object.	1226	OpenGL buffer object.
831		1227
		1228	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1229
832	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
833		1231
834	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1232	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
835		1233
836	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
837	texture object or buffer.	1235	texture object or buffer.
838		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
839	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
840		1245
841	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1246	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
842		1247
843	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
…		…
868		1273
869	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1274	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
870		1275
871	Creates a new OpenCL::Sampler object.	1276	Creates a new OpenCL::Sampler object.
872		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
873	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>
874		1284
875	=item $program = $ctx->program_with_source ($string)	1285	=item $program = $ctx->program_with_source ($string)
876		1286
877	Creates a new OpenCL::Program object from the given source code.	1287	Creates a new OpenCL::Program object from the given source code.
878		1288
879	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>
880		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
881	=item $packed_value = $ctx->info ($name)	1315	=item $packed_value = $ctx->info ($name)
882		1316
883	See C<< $platform->info >> for details.	1317	See C<< $platform->info >> for details.
884		1318
885	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>
886		1320
887	=for gengetinfo begin context	1321	=for gengetinfo begin context
888		1322
889	=item $uint = $context->reference_count	1323	=item $uint = $context->reference_count
890		1324
891	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.
892		1326
893	=item @devices = $context->devices	1327	=item @devices = $context->devices
894		1328
895	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.
896		1330
897	=item @property_ints = $context->properties	1331	=item @property_ints = $context->properties
898		1332
899	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.
900		1334
901	=item $uint = $context->num_devices	1335	=item $uint = $context->num_devices
902		1336
903	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.
904		1338
905	=for gengetinfo end context	1339	=for gengetinfo end context
906		1340
907	=back	1341	=back
908		1342
909	=head2 THE OpenCL::Queue CLASS	1343	=head2 THE OpenCL::Queue CLASS
910		1344
911	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1345	An OpenCL::Queue represents an execution queue for OpenCL. You execute
912	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
913	it to complete in some way.	1347	in some way.
914		1348
915	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
916	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
917	no event object is created.	1351	the method is called in void context, in which case no event object is
		1352	created.
918		1353
919	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
920	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
921	event objects as extra parameters to the enqueue methods. To simplify	1356	event objects as extra parameters to the enqueue methods. To simplify
922	program design, this module ignores any C<undef> values in the list of	1357	program design, this module ignores any C<undef> values in the list of
923	events. This makes it possible to code operations such as this, without	1358	events. This makes it possible to code operations such as this, without
924	having to put a valid event object into C<$event> first:	1359	having to put a valid event object into C<$event> first:
925		1360
926	$event = $queue->enqueue_xxx (..., $event);	1361	$event = $queue->xxx (..., $event);
927		1362
928	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
929	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
930	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
931	faster.	1366	faster.
932		1367
933	=over 4	1368	=over 4
934		1369
935	=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...)
936		1371
937	Reads data from buffer into the given string.	1372	Reads data from buffer into the given string.
938		1373
939	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>
940		1375
941	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1376	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
942		1377
943	Writes data to buffer from the given string.	1378	Writes data to buffer from the given string.
944		1379
945	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>
946		1381
947	=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...)
948		1383
949	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>
950		1385
951	=item $ev = $queue->enqueue_read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)	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...)
952		1387
953	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
954		1389
955	=item $ev = $queue->enqueue_write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)	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...)
956		1391
957	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
958		1393
959	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
960
961	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
962
963	=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)	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.
964		1402
965	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>
966		1404
967	=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...)
968		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.
969	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>
970		1410
971	=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)	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...)
972		1412
973	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>
974		1414
975	=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)	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...)
976		1416
977	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>
978		1418
979	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)	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...)
980		1420
981	Yeah.	1421	Yeah.
982		1422
983	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>.
984		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
985	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1441	=item $ev = $queue->task ($kernel, $wait_events...)
986		1442
987	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>
988		1444
989	=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...)
990		1446
991	Enqueues a kernel execution.	1447	Enqueues a kernel execution.
992		1448
993	@$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
994	integers specifying the work sizes (element counts).	1450	integers specifying the work sizes (element counts).
995		1451
996	@$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
997	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
998	of elements as @$global_work_size.	1454	of elements as \@global_work_size.
999		1455
1000	@$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
1001	implementation is supposed to choose good local work sizes), or a	1457	implementation is supposed to choose good local work sizes), or a
1002	reference to an array of local work sizes, with the same number of	1458	reference to an array of local work sizes, with the same number of
1003	elements as @$global_work_size.	1459	elements as \@global_work_size.
1004		1460
1005	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>
1006		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
1007	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1471	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1008		1472
1009	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
1010	for subsequent OpenCL usage.	1474	for subsequent OpenCL usage.
1011		1475
1012	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>
1013		1477
1014	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1478	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1015		1479
1016	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
1017	for subsequent OpenGL usage.	1481	for subsequent OpenGL usage.
1018		1482
1019	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>
1020		1484
1021	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1485	=item $ev = $queue->wait_for_events ($wait_events...)
1022		1486
1023	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>
1024		1488
1025	=item $ev = $queue->enqueue_marker ($wait_events...)	1489	=item $ev = $queue->marker ($wait_events...)
1026		1490
1027	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>
1028		1492
1029	=item $ev = $queue->enqueue_barrier ($wait_events...)	1493	=item $ev = $queue->barrier ($wait_events...)
1030		1494
1031	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>
1032		1496
1033	=item $queue->flush	1497	=item $queue->flush
1034		1498
…		…
1046		1510
1047	=for gengetinfo begin command_queue	1511	=for gengetinfo begin command_queue
1048		1512
1049	=item $ctx = $command_queue->context	1513	=item $ctx = $command_queue->context
1050		1514
1051	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.
1052		1516
1053	=item $device = $command_queue->device	1517	=item $device = $command_queue->device
1054		1518
1055	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.
1056		1520
1057	=item $uint = $command_queue->reference_count	1521	=item $uint = $command_queue->reference_count
1058		1522
1059	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.
1060		1524
1061	=item $command_queue_properties = $command_queue->properties	1525	=item $command_queue_properties = $command_queue->properties
1062		1526
1063	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.
1064		1528
1065	=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.
1066		1599
1067	=back	1600	=back
1068		1601
1069	=head2 THE OpenCL::Memory CLASS	1602	=head2 THE OpenCL::Memory CLASS
1070		1603
…		…
1081		1614
1082	=for gengetinfo begin mem	1615	=for gengetinfo begin mem
1083		1616
1084	=item $mem_object_type = $mem->type	1617	=item $mem_object_type = $mem->type
1085		1618
1086	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.
1087		1620
1088	=item $mem_flags = $mem->flags	1621	=item $mem_flags = $mem->flags
1089		1622
1090	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.
1091		1624
1092	=item $int = $mem->size	1625	=item $int = $mem->size
1093		1626
1094	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.
1095		1628
1096	=item $ptr_value = $mem->host_ptr	1629	=item $ptr_value = $mem->host_ptr
1097		1630
1098	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.
1099		1632
1100	=item $uint = $mem->map_count	1633	=item $uint = $mem->map_count
1101		1634
1102	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.
1103		1636
1104	=item $uint = $mem->reference_count	1637	=item $uint = $mem->reference_count
1105		1638
1106	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.
1107		1640
1108	=item $ctx = $mem->context	1641	=item $ctx = $mem->context
1109		1642
1110	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.
1111		1644
1112	=item $mem = $mem->associated_memobject	1645	=item $mem = $mem->associated_memobject
1113		1646
1114	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.
1115		1648
1116	=item $int = $mem->offset	1649	=item $int = $mem->offset
1117		1650
1118	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.
1119		1652
1120	=for gengetinfo end mem	1653	=for gengetinfo end mem
1121		1654
1122	=item ($type, $name) = $mem->gl_object_info	1655	=item ($type, $name) = $mem->gl_object_info
1123		1656
…		…
1157	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,	1690	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1158	OpenCL::Image2DArray and OpenCL::Image3D.	1691	OpenCL::Image2DArray and OpenCL::Image3D.
1159		1692
1160	=over 4	1693	=over 4
1161		1694
1162	=item $packed_value = $ev->image_info ($name)	1695	=item $packed_value = $image->image_info ($name)
1163		1696
1164	See C<< $platform->info >> for details.	1697	See C<< $platform->info >> for details.
1165		1698
1166	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
1167	C<< ->info >> method inherited from C<OpenCL::Memory>.	1700	C<< ->info >> method inherited from C<OpenCL::Memory>.
1168		1701
1169	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>
1170		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
1171	=for gengetinfo begin image	1709	=for gengetinfo begin image
1172		1710
1173	=item $int = $image->element_size	1711	=item $int = $image->element_size
1174		1712
1175	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.
1176		1714
1177	=item $int = $image->row_pitch	1715	=item $int = $image->row_pitch
1178		1716
1179	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.
1180		1718
1181	=item $int = $image->slice_pitch	1719	=item $int = $image->slice_pitch
1182		1720
1183	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.
1184		1722
1185	=item $int = $image->width	1723	=item $int = $image->width
1186		1724
1187	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.
1188		1726
1189	=item $int = $image->height	1727	=item $int = $image->height
1190		1728
1191	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.
1192		1730
1193	=item $int = $image->depth	1731	=item $int = $image->depth
1194		1732
1195	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.
1196		1734
1197	=for gengetinfo end image	1735	=for gengetinfo end image
1198		1736
1199	=for gengetinfo begin gl_texture	1737	=for gengetinfo begin gl_texture
1200		1738
1201	=item $GLenum = $gl_texture->target	1739	=item $GLenum = $gl_texture->target
1202		1740
1203	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.
1204		1742
1205	=item $GLint = $gl_texture->gl_mipmap_level	1743	=item $GLint = $gl_texture->gl_mipmap_level
1206		1744
1207	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.
1208		1746
1209	=for gengetinfo end gl_texture	1747	=for gengetinfo end gl_texture
1210		1748
1211	=back	1749	=back
1212		1750
…		…
1222		1760
1223	=for gengetinfo begin sampler	1761	=for gengetinfo begin sampler
1224		1762
1225	=item $uint = $sampler->reference_count	1763	=item $uint = $sampler->reference_count
1226		1764
1227	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.
1228		1766
1229	=item $ctx = $sampler->context	1767	=item $ctx = $sampler->context
1230		1768
1231	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.
1232		1770
1233	=item $addressing_mode = $sampler->normalized_coords	1771	=item $addressing_mode = $sampler->normalized_coords
1234		1772
1235	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.
1236		1774
1237	=item $filter_mode = $sampler->addressing_mode	1775	=item $filter_mode = $sampler->addressing_mode
1238		1776
1239	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.
1240		1778
1241	=item $boolean = $sampler->filter_mode	1779	=item $boolean = $sampler->filter_mode
1242		1780
1243	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.
1244		1782
1245	=for gengetinfo end sampler	1783	=for gengetinfo end sampler
1246		1784
1247	=back	1785	=back
1248		1786
1249	=head2 THE OpenCL::Program CLASS	1787	=head2 THE OpenCL::Program CLASS
1250		1788
1251	=over 4	1789	=over 4
1252		1790
1253	=item $program->build ($device, $options = "")	1791	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1254		1792
1255	Tries to build the program with the givne options.	1793	Tries to build the program with the given options. See also the
		1794	C<$ctx->build> convenience function.
		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.
1256		1819
1257	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>
1258		1834
1259	=item $packed_value = $program->build_info ($device, $name)	1835	=item $packed_value = $program->build_info ($device, $name)
1260		1836
1261	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
1262	build attempt for the given device.	1838	build attempt for the given device.
…		…
1278		1854
1279	=for gengetinfo begin program_build	1855	=for gengetinfo begin program_build
1280		1856
1281	=item $build_status = $program->build_status ($device)	1857	=item $build_status = $program->build_status ($device)
1282		1858
1283	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.
1284		1860
1285	=item $string = $program->build_options ($device)	1861	=item $string = $program->build_options ($device)
1286		1862
1287	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.
1288		1864
1289	=item $string = $program->build_log ($device)	1865	=item $string = $program->build_log ($device)
1290		1866
1291	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.
1292		1868
1293	=for gengetinfo end program_build	1869	=for gengetinfo end program_build
1294		1870
1295	=item $packed_value = $program->info ($name)	1871	=item $packed_value = $program->info ($name)
1296		1872
…		…
1300		1876
1301	=for gengetinfo begin program	1877	=for gengetinfo begin program
1302		1878
1303	=item $uint = $program->reference_count	1879	=item $uint = $program->reference_count
1304		1880
1305	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.
1306		1882
1307	=item $ctx = $program->context	1883	=item $ctx = $program->context
1308		1884
1309	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.
1310		1886
1311	=item $uint = $program->num_devices	1887	=item $uint = $program->num_devices
1312		1888
1313	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.
1314		1890
1315	=item @devices = $program->devices	1891	=item @devices = $program->devices
1316		1892
1317	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.
1318		1894
1319	=item $string = $program->source	1895	=item $string = $program->source
1320		1896
1321	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.
1322		1898
1323	=item @ints = $program->binary_sizes	1899	=item @ints = $program->binary_sizes
1324		1900
1325	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.
1326		1902
1327	=for gengetinfo end program	1903	=for gengetinfo end program
1328		1904
1329	=item @blobs = $program->binaries	1905	=item @blobs = $program->binaries
1330		1906
…		…
1351		1927
1352	=for gengetinfo begin kernel	1928	=for gengetinfo begin kernel
1353		1929
1354	=item $string = $kernel->function_name	1930	=item $string = $kernel->function_name
1355		1931
1356	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.
1357		1933
1358	=item $uint = $kernel->num_args	1934	=item $uint = $kernel->num_args
1359		1935
1360	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.
1361		1937
1362	=item $uint = $kernel->reference_count	1938	=item $uint = $kernel->reference_count
1363		1939
1364	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.
1365		1941
1366	=item $ctx = $kernel->context	1942	=item $ctx = $kernel->context
1367		1943
1368	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.
1369		1945
1370	=item $program = $kernel->program	1946	=item $program = $kernel->program
1371		1947
1372	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.
1373		1949
1374	=for gengetinfo end kernel	1950	=for gengetinfo end kernel
1375		1951
1376	=item $packed_value = $kernel->work_group_info ($device, $name)	1952	=item $packed_value = $kernel->work_group_info ($device, $name)
1377		1953
1378	See C<< $platform->info >> for details.	1954	See C<< $platform->info >> for details.
1379		1955
1380	The reason this method is not called C<info> is that there already is an
1381	C<< ->info >> method.
1382
1383	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1956	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1384		1957
1385	=for gengetinfo begin kernel_work_group	1958	=for gengetinfo begin kernel_work_group
1386		1959
1387	=item $int = $kernel->work_group_size ($device)	1960	=item $int = $kernel->work_group_size ($device)
1388		1961
1389	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.
1390		1963
1391	=item @ints = $kernel->compile_work_group_size ($device)	1964	=item @ints = $kernel->compile_work_group_size ($device)
1392		1965
1393	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.
1394		1967
1395	=item $ulong = $kernel->local_mem_size ($device)	1968	=item $ulong = $kernel->local_mem_size ($device)
1396		1969
1397	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.
1398		1971
1399	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1972	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1400		1973
1401	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.
1402		1975
1403	=item $ulong = $kernel->private_mem_size ($device)	1976	=item $ulong = $kernel->private_mem_size ($device)
1404		1977
1405	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.
1406		1979
1407	=for gengetinfo end kernel_work_group	1980	=for gengetinfo end kernel_work_group
1408		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
1409	=item $kernel->set_TYPE ($index, $value)	2046	=item $kernel->set_TYPE ($index, $value)
1410		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
1411	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
1412		2083	C<$index> to the give C<$value>.
1413	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1414	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1415	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1416		2084
1417	Chars and integers (including the half type) are specified as integers,	2085	Chars and integers (including the half type) are specified as integers,
1418	float and double as floating point values, memory/buffer/image2d/image3d	2086	float and double as floating point values, memory/buffer/image must be
1419	must be an object of that type or C<undef>, local-memory arguments are	2087	an object of that type or C<undef>, local-memory arguments are set by
1420	set by specifying the size, and sampler and event must be objects of that	2088	specifying the size, and sampler and event must be objects of that type.
1421	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.
1422		2093
1423	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 -
1424	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,
1425	and call the kernel, you will run into undefined behaviour.	2096	and call the kernel, you will run into undefined behaviour.
1426		2097
…		…
1439		2110
1440	Waits for the event to complete.	2111	Waits for the event to complete.
1441		2112
1442	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>
1443		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
1444	=item $packed_value = $ev->info ($name)	2122	=item $packed_value = $ev->info ($name)
1445		2123
1446	See C<< $platform->info >> for details.	2124	See C<< $platform->info >> for details.
1447		2125
1448	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>
1449		2127
1450	=for gengetinfo begin event	2128	=for gengetinfo begin event
1451		2129
1452	=item $queue = $event->command_queue	2130	=item $queue = $event->command_queue
1453		2131
1454	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.
1455		2133
1456	=item $command_type = $event->command_type	2134	=item $command_type = $event->command_type
1457		2135
1458	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.
1459		2137
1460	=item $uint = $event->reference_count	2138	=item $uint = $event->reference_count
1461		2139
1462	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.
1463		2141
1464	=item $uint = $event->command_execution_status	2142	=item $uint = $event->command_execution_status
1465		2143
1466	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.
1467		2145
1468	=item $ctx = $event->context	2146	=item $ctx = $event->context
1469		2147
1470	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.
1471		2149
1472	=for gengetinfo end event	2150	=for gengetinfo end event
1473		2151
1474	=item $packed_value = $ev->profiling_info ($name)	2152	=item $packed_value = $ev->profiling_info ($name)
1475		2153
…		…
1482		2160
1483	=for gengetinfo begin profiling	2161	=for gengetinfo begin profiling
1484		2162
1485	=item $ulong = $event->profiling_command_queued	2163	=item $ulong = $event->profiling_command_queued
1486		2164
1487	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.
1488		2166
1489	=item $ulong = $event->profiling_command_submit	2167	=item $ulong = $event->profiling_command_submit
1490		2168
1491	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.
1492		2170
1493	=item $ulong = $event->profiling_command_start	2171	=item $ulong = $event->profiling_command_start
1494		2172
1495	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.
1496		2174
1497	=item $ulong = $event->profiling_command_end	2175	=item $ulong = $event->profiling_command_end
1498		2176
1499	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.
1500		2178
1501	=for gengetinfo end profiling	2179	=for gengetinfo end profiling
1502		2180
1503	=back	2181	=back
1504		2182
…		…
1508		2186
1509	=over 4	2187	=over 4
1510		2188
1511	=item $ev->set_status ($execution_status)	2189	=item $ev->set_status ($execution_status)
1512		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
1513	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>
1514		2197
1515	=back	2198	=back
1516		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
1517	=cut	2274	=cut
1518		2275
1519	package OpenCL;	2276	sub OpenCL::Mapped::get {
1520		2277	substr ${$_[0]}, $_[1], $_[2]
1521	use common::sense;
1522
1523	BEGIN {
1524	our $VERSION = '0.96';
1525
1526	require XSLoader;
1527	XSLoader::load (__PACKAGE__, $VERSION);
1528
1529	@OpenCL::Buffer::ISA =
1530	@OpenCL::Image::ISA = OpenCL::Memory::;
1531
1532	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1533
1534	@OpenCL::Image2D::ISA =
1535	@OpenCL::Image3D::ISA =
1536	@OpenCL::Image2DArray::ISA =
1537	@OpenCL::Image1D::ISA =
1538	@OpenCL::Image1DArray::ISA =
1539	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
1540
1541	@OpenCL::UserEvent::ISA = OpenCL::Event::;
1542	}	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
1543		2302
1544	1;	2303	1;
1545		2304
1546	=head1 AUTHOR	2305	=head1 AUTHOR
1547		2306

Diff Legend

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