ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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