ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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