ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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