ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.2 by root, Tue Nov 15 09:24:40 2011 UTC vs.
Revision 1.79 by root, Sat May 5 13:30:07 2012 UTC

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

Diff Legend

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