ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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