ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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