[ViewVC] Diff of: cvs/OpenCL/OpenCL.pm

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

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.52 by root, Tue Apr 24 14:24:42 2012 UTC vs. Revision 1.73 by root, Fri May 4 14:56:50 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.52 by root, Tue Apr 24 14:24:42 2012 UTC vs.
Revision 1.73 by root, Fri May 4 14:56:50 2012 UTC