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.87 by root, Mon May 7 01:01:33 2012 UTC

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

Diff Legend

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