ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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