ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC vs.
Revision 1.79 by root, Sat May 5 13:30:07 2012 UTC

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

Diff Legend

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