ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.24 by root, Sun Nov 20 22:31:48 2011 UTC vs.
Revision 1.87 by root, Mon May 7 01:01:33 2012 UTC

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

Diff Legend

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