ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.15 by root, Thu Nov 17 03:05:56 2011 UTC vs.
Revision 1.75 by root, Sat May 5 02:30:27 2012 UTC

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

Diff Legend

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