ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.21 by root, Sun Nov 20 10:21:27 2011 UTC vs.
Revision 1.70 by root, Thu May 3 23:32:47 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:
49	no implementation was available to me :).
50		49
51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	50	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
		51	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
		52	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
52		53
53	OpenCL manpages:	54	OpenCL manpages:
54		55
55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	56	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
		57	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
56		58
57	If you are into UML class diagrams, the following diagram might help - if	59	If you are into UML class diagrams, the following diagram might help - if
58	not, it will be mildly cobfusing:	60	not, it will be mildly confusing (also, the class hierarchy of this module
		61	is much more fine-grained):
59		62
60	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html	63	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/classDiagram.html
61		64
62	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it	65	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:	66	is, but at least it's free of charge:
64		67
65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf	68	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
…		…
101		104
102	Best run this once to get a feel for the platforms and devices in your	105	Best run this once to get a feel for the platforms and devices in your
103	system.	106	system.
104		107
105	for my $platform (OpenCL::platforms) {	108	for my $platform (OpenCL::platforms) {
106	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	109	printf "platform: %s\n", $platform->name;
107	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	110	printf "extensions: %s\n", $platform->extensions;
108	for my $device ($platform->devices) {	111	for my $device ($platform->devices) {
109	printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME);	112	printf "+ device: %s\n", $device->name;
110	my $ctx = $device->context;	113	my $ctx = $platform->context (undef, [$device]);
111	# do stuff	114	# do stuff
112	}	115	}
113	}	116	}
114		117
115	=head2 Get a useful context and a command queue.	118	=head2 Get a useful context and a command queue.
…		…
138	=head2 Create a buffer with some predefined data, read it back synchronously,	141	=head2 Create a buffer with some predefined data, read it back synchronously,
139	then asynchronously.	142	then asynchronously.
140		143
141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	144	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
142		145
143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	146	$queue->read_buffer ($buf, 1, 1, 3, my $data);
144	print "$data\n";	147	print "$data\n";
145		148
146	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	149	my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
147	$ev->wait;	150	$ev->wait;
148	print "$data\n"; # prints "elm"	151	print "$data\n"; # prints "elm"
149		152
150	=head2 Create and build a program, then create a kernel out of one of its	153	=head2 Create and build a program, then create a kernel out of one of its
151	functions.	154	functions.
152		155
153	my $src = '	156	my $src = '
154	__kernel void	157	kernel void
155	squareit (__global float *input, __global float *output)	158	squareit (global float *input, global float *output)
156	{	159	{
157	$id = get_global_id (0);	160	$id = get_global_id (0);
158	output [id] = input [id] * input [id];	161	output [id] = input [id] * input [id];
159	}	162	}
160	';	163	';
161		164
162	my $prog = $ctx->program_with_source ($src);	165	my $prog = $ctx->build_program ($src);
163
164	# build croaks on compile errors, so catch it and print the compile errors
165	eval { $prog->build ($dev); 1 }
166	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
167
168	my $kernel = $prog->kernel ("squareit");	166	my $kernel = $prog->kernel ("squareit");
169		167
170	=head2 Create some input and output float buffers, then call the	168	=head2 Create some input and output float buffers, then call the
171	'squareit' kernel on them.	169	'squareit' kernel on them.
172		170
…		…
176	# set buffer	174	# set buffer
177	$kernel->set_buffer (0, $input);	175	$kernel->set_buffer (0, $input);
178	$kernel->set_buffer (1, $output);	176	$kernel->set_buffer (1, $output);
179		177
180	# execute it for all 4 numbers	178	# execute it for all 4 numbers
181	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	179	$queue->nd_range_kernel ($kernel, undef, [4], undef);
182		180
183	# enqueue a synchronous read	181	# enqueue a synchronous read
184	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	182	$queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
185		183
186	# print the results:	184	# print the results:
187	printf "%s\n", join ", ", unpack "f*", $data;	185	printf "%s\n", join ", ", unpack "f*", $data;
188		186
189	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	187	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
190	showing off barriers.	188	showing off barriers.
191		189
192	# execute it for all 4 numbers	190	# execute it for all 4 numbers
193	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	191	$queue->nd_range_kernel ($kernel, undef, [4], undef);
194		192
195	# enqueue a barrier to ensure in-order execution	193	# enqueue a barrier to ensure in-order execution
196	$queue->enqueue_barrier;	194	$queue->barrier;
197		195
198	# enqueue an async read	196	# enqueue an async read
199	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	197	$queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
200		198
201	# wait for all requests to finish	199	# wait for all requests to finish
202	$queue->finish;	200	$queue->finish;
203		201
204	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	202	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
205	showing off event objects and wait lists.	203	showing off event objects and wait lists.
206		204
207	# execute it for all 4 numbers	205	# execute it for all 4 numbers
208	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	206	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
209		207
210	# enqueue an async read	208	# enqueue an async read
211	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	209	$ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212		210
213	# wait for the last event to complete	211	# wait for the last event to complete
214	$ev->wait;	212	$ev->wait;
		213
		214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
		215	set tunnel effect.
		216
		217	This is quite a long example to get you going - you can download it from
		218	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
		219
		220	use OpenGL ":all";
		221	use OpenCL;
		222
		223	my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
		224
		225	# open a window and create a gl texture
		226	OpenGL::glpOpenWindow width => $S, height => $S;
		227	my $texid = glGenTextures_p 1;
		228	glBindTexture GL_TEXTURE_2D, $texid;
		229	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
		230
		231	# find and use the first opencl device that let's us get a shared opengl context
		232	my $platform;
		233	my $dev;
		234	my $ctx;
		235
		236	for (OpenCL::platforms) {
		237	$platform = $_;
		238	for ($platform->devices) {
		239	$dev = $_;
		240	$ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
		241	and last;
		242	}
		243	}
		244
		245	$ctx
		246	or die "cannot find suitable OpenCL device\n";
		247
		248	my $queue = $ctx->queue ($dev);
		249
		250	# now attach an opencl image2d object to the opengl texture
		251	my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
		252
		253	# now the boring opencl code
		254	my $src = <<EOF;
		255	kernel void
		256	juliatunnel (write_only image2d_t img, float time)
		257	{
		258	int2 xy = (int2)(get_global_id (0), get_global_id (1));
		259	float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
		260
		261	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
		262	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
		263
		264	float2 z = m;
		265	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
		266
		267	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
		268	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		269
		270	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
		271	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
		272	}
		273	EOF
		274
		275	my $prog = $ctx->build_program ($src);
		276	my $kernel = $prog->kernel ("juliatunnel");
		277
		278	# program compiled, kernel ready, now draw and loop
		279
		280	for (my $time; ; ++$time) {
		281	# acquire objects from opengl
		282	$queue->acquire_gl_objects ([$tex]);
		283
		284	# configure and run our kernel
		285	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
		286	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
		287
		288	# release objects to opengl again
		289	$queue->release_gl_objects ([$tex]);
		290
		291	# wait
		292	$queue->finish;
		293
		294	# now draw the texture, the defaults should be all right
		295	glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
		296
		297	glEnable GL_TEXTURE_2D;
		298	glBegin GL_QUADS;
		299	glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
		300	glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
		301	glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
		302	glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
		303	glEnd;
		304
		305	glXSwapBuffers;
		306
		307	select undef, undef, undef, 1/60;
		308	}
		309
		310	=head2 How to modify the previous example to not rely on GL sharing.
		311
		312	For those poor souls with only a sucky CPU OpenCL implementation, you
		313	currently have to read the image into some perl scalar, and then modify a
		314	texture or use glDrawPixels or so).
		315
		316	First, when you don't need gl sharing, you can create the context much simpler:
		317
		318	$ctx = $platform->context (undef, [$dev])
		319
		320	To use a texture, you would modify the above example by creating an
		321	OpenCL::Image manually instead of deriving it from a texture:
		322
		323	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
		324
		325	And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you
		326	would read the image2d after the kernel has written it:
		327
		328	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
		329
		330	And then you would upload the pixel data to the texture (or use glDrawPixels):
		331
		332	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
		333
		334	The fully modified example can be found at
		335	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
215		336
216	=head1 DOCUMENTATION	337	=head1 DOCUMENTATION
217		338
218	=head2 BASIC CONVENTIONS	339	=head2 BASIC CONVENTIONS
219		340
…		…
241	=item * Structures are often specified by flattening out their components	362	=item * Structures are often specified by flattening out their components
242	as with short vectors, and returned as arrayrefs.	363	as with short vectors, and returned as arrayrefs.
243		364
244	=item * When enqueuing commands, the wait list is specified by adding	365	=item * When enqueuing commands, the wait list is specified by adding
245	extra arguments to the function - anywhere a C<$wait_events...> argument	366	extra arguments to the function - anywhere a C<$wait_events...> argument
246	is documented this can be any number of event objects.	367	is documented this can be any number of event objects. As an extsnion
		368	implemented by this module, C<undef> values will be ignored in the event
		369	list.
247		370
248	=item * When enqueuing commands, if the enqueue method is called in void	371	=item * When enqueuing commands, if the enqueue method is called in void
249	context, no event is created. In all other contexts an event is returned	372	context, no event is created. In all other contexts an event is returned
250	by the method.	373	by the method.
251		374
…		…
271	ulong IV - Q	394	ulong IV - Q
272	float NV float f	395	float NV float f
273	half IV ushort S	396	half IV ushort S
274	double NV double d	397	double NV double d
275		398
		399	=head2 GLX SUPPORT
		400
		401	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		402	module, which has little to no documentation and has little to no support
		403	for glX), this module, as a special extension, treats context creation
		404	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		405	specially: If either or both of these are C<undef>, then the OpenCL
		406	module tries to dynamically resolve C<glXGetCurrentDisplay> and
		407	C<glXGetCurrentContext>, call these functions and use their return values
		408	instead.
		409
		410	For this to work, the OpenGL library must be loaded, a GLX context must
		411	have been created and be made current, and C<dlsym> must be available and
		412	capable of finding the function via C<RTLD_DEFAULT>.
		413
		414	=head2 EVENT SYSTEM
		415
		416	OpenCL can generate a number of (potentially) asynchronous events, for
		417	example, after compiling a program, to signal a context-related error or,
		418	perhaps most important, to signal completion of queued jobs (by setting
		419	callbacks on OpenCL::Event objects).
		420
		421	To facilitate this, this module maintains an event queue - each
		422	time an asynchronous event happens, it is queued, and perl will be
		423	interrupted. This is implemented via the L<Async::Interrupt> module. In
		424	addition, this module has L<AnyEvent> support, so it can seamlessly
		425	integrate itself into many event loops.
		426
		427	Since this module is a bit hard to understand, here are some case examples:
		428
		429	=head3 Don't use callbacks.
		430
		431	When your program never uses any callbacks, then there will never be any
		432	notifications you need to take care of, and therefore no need to worry
		433	about all this.
		434
		435	You can achieve a great deal by explicitly waiting for events, or using
		436	barriers and flush calls. In many programs, there is no need at all to
		437	tinker with asynchronous events.
		438
		439	=head3 Use AnyEvent
		440
		441	This module automatically registers a watcher that invokes all outstanding
		442	event callbacks when AnyEvent is initialised (and block asynchronous
		443	interruptions). Using this mode of operations is the safest and most
		444	recommended one.
		445
		446	To use this, simply use AnyEvent and this module normally, make sure you
		447	have an event loop running:
		448
		449	use Gtk2 -init;
		450	use AnyEvent;
		451
		452	# initialise AnyEvent, by creating a watcher, or:
		453	AnyEvent::detect;
		454
		455	my $e = $queue->marker;
		456	$e->cb (sub {
		457	warn "opencl is finished\n";
		458	})
		459
		460	main Gtk2;
		461
		462	Note that this module will not initialise AnyEvent for you. Before
		463	AnyEvent is initialised, the module will asynchronously interrupt perl
		464	instead. To avoid any surprises, it's best to explicitly initialise
		465	AnyEvent.
		466
		467	You can temporarily enable asynchronous interruptions (see next paragraph)
		468	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		469	calling C<$OpenCL::INTERRUPT->block>.
		470
		471	=head3 Let yourself be interrupted at any time
		472
		473	This mode is the default unless AnyEvent is loaded and initialised. In
		474	this mode, OpenCL asynchronously interrupts a running perl program. The
		475	emphasis is on both I<asynchronously> and I<running> here.
		476
		477	Asynchronously means that perl might execute your callbacks at any
		478	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		479	the C<until> loop following the marker call will be interrupted by the
		480	callback:
		481
		482	my $e = $queue->marker;
		483	my $flag;
		484	$e->cb (sub { $flag = 1 });
		485	1 until $flag;
		486	# $flag is now 1
		487
		488	The reason why you shouldn't blindly copy the above code is that
		489	busy waiting is a really really bad thing, and really really bad for
		490	performance.
		491
		492	While at first this asynchronous business might look exciting, it can be
		493	really hard, because you need to be prepared for the callback code to be
		494	executed at any time, which limits the amount of things the callback code
		495	can do safely.
		496
		497	This can be mitigated somewhat by using C<<
		498	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		499	documentation for details).
		500
		501	The other problem is that your program must be actively I<running> to be
		502	interrupted. When you calculate stuff, your program is running. When you
		503	hang in some C functions or other block execution (by calling C<sleep>,
		504	C<select>, running an event loop and so on), your program is waiting, not
		505	running.
		506
		507	One way around that would be to attach a read watcher to your event loop,
		508	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		509	dummy callback (C<sub { }>) to temporarily execute some perl code.
		510
		511	That is then awfully close to using the built-in AnyEvent support above,
		512	though, so consider that one instead.
		513
		514	=head3 Be creative
		515
		516	OpenCL exports the L<Async::Interrupt> object it uses in the global
		517	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		518
		519	So if you want to feel like a real pro, err, wait, if you feel no risk
		520	menas no fun, you can experiment by implementing your own mode of
		521	operations.
		522
		523	=cut
		524
		525	package OpenCL;
		526
		527	use common::sense;
		528	use Carp ();
		529	use Async::Interrupt ();
		530
		531	our $POLL_FUNC; # set by XS
		532
		533	BEGIN {
		534	our $VERSION = '0.99';
		535
		536	require XSLoader;
		537	XSLoader::load (__PACKAGE__, $VERSION);
		538
		539	@OpenCL::Platform::ISA =
		540	@OpenCL::Device::ISA =
		541	@OpenCL::Context::ISA =
		542	@OpenCL::Queue::ISA =
		543	@OpenCL::Memory::ISA =
		544	@OpenCL::Sampler::ISA =
		545	@OpenCL::Program::ISA =
		546	@OpenCL::Kernel::ISA =
		547	@OpenCL::Event::ISA = OpenCL::Object::;
		548
		549	@OpenCL::Buffer::ISA =
		550	@OpenCL::Image::ISA = OpenCL::Memory::;
		551
		552	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		553
		554	@OpenCL::Image2D::ISA =
		555	@OpenCL::Image3D::ISA =
		556	@OpenCL::Image2DArray::ISA =
		557	@OpenCL::Image1D::ISA =
		558	@OpenCL::Image1DArray::ISA =
		559	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		560
		561	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		562
		563	@OpenCL::MappedBuffer::ISA =
		564	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
		565	}
		566
276	=head2 THE OpenCL PACKAGE	567	=head2 THE OpenCL PACKAGE
277		568
278	=over 4	569	=over 4
279		570
280	=item $int = OpenCL::errno	571	=item $int = OpenCL::errno
281		572
282	The last error returned by a function - it's only valid after an error occured	573	The last error returned by a function - it's only valid after an error occured
283	and before calling another OpenCL function.	574	and before calling another OpenCL function.
284		575
285	=item $str = OpenCL::err2str $errval	576	=item $str = OpenCL::err2str [$errval]
286		577
287	Comverts an error value into a human readable string.	578	Converts an error value into a human readable string. IF no error value is
		579	given, then the last error will be used (as returned by OpenCL::errno).
288		580
289	=item $str = OpenCL::enum2str $enum	581	=item $str = OpenCL::enum2str $enum
290		582
291	Converts most enum values (inof parameter names, image format constants,	583	Converts most enum values (of parameter names, image format constants,
292	object types, addressing and filter modes, command types etc.) into a	584	object types, addressing and filter modes, command types etc.) into a
293	human readbale string. When confronted with some random integer it can be	585	human readable string. When confronted with some random integer it can be
294	very helpful to pass it through this function to maybe get some readable	586	very helpful to pass it through this function to maybe get some readable
295	string out of it.	587	string out of it.
296		588
297	=item @platforms = OpenCL::platforms	589	=item @platforms = OpenCL::platforms
298		590
299	Returns all available OpenCL::Platform objects.	591	Returns all available OpenCL::Platform objects.
300		592
301	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	593	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
302		594
303	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	595	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
304		596
305	Tries to create a context from a default device and platform - never worked for me.	597	Tries to create a context from a default device and platform type - never worked for me.
306		598
307	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	599	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
308		600
		601	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		602
		603	Create a new OpenCL::Context object using the given device object(s). This
		604	function isn't implemented yet, use C<< $platform->context >> instead.
		605
		606	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		607
309	=item OpenCL::wait_for_events $wait_events...	608	=item OpenCL::wait_for_events $wait_events...
310		609
311	Waits for all events to complete.	610	Waits for all events to complete.
312		611
313	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	612	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314		613
		614	=item OpenCL::poll
		615
		616	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		617	invokes their callbacks.
		618
		619	=item $OpenCL::INTERRUPT
		620
		621	The L<Async::Interrupt> object used to signal asynchronous events (see
		622	L<EVENT SYSTEM>).
		623
		624	=cut
		625
		626	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		627
		628	&_eq_initialise ($INTERRUPT->signal_func);
		629
		630	=item $OpenCL::WATCHER
		631
		632	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		633	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		634	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		635
		636	=cut
		637
		638	our $WATCHER;
		639
		640	sub _init_anyevent {
		641	$INTERRUPT->block;
		642	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		643	}
		644
		645	if (defined $AnyEvent::MODEL) {
		646	_init_anyevent;
		647	} else {
		648	push @AnyEvent::post_detect, \&_init_anyevent;
		649	}
		650
315	=back	651	=back
316		652
		653	=head2 THE OpenCL::Object CLASS
		654
		655	This is the base class for all objects in the OpenCL module. The only
		656	method it implements is the C<id> method, which is only useful if you want
		657	to interface to OpenCL on the C level.
		658
		659	=over 4
		660
		661	=item $iv = $obj->id
		662
		663	OpenCL objects are represented by pointers or integers on the C level. If
		664	you want to interface to an OpenCL object directly on the C level, then
		665	you need this value, which is returned by this method. You should use an
		666	C<IV> type in your code and cast that to the correct type.
		667
		668	=cut
		669
		670	sub OpenCL::Object::id {
		671	ref $_[0] eq "SCALAR"
		672	? ${ $_[0] }
		673	: $_[0][0]
		674	}
		675
		676	=back
		677
317	=head2 THE OpenCL::Platform CLASS	678	=head2 THE OpenCL::Platform CLASS
318		679
319	=over 4	680	=over 4
320		681
321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	682	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322		683
323	Returns a list of matching OpenCL::Device objects.	684	Returns a list of matching OpenCL::Device objects.
324		685
325	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	686	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
326		687
327	Tries to create a context. Never worked for me, and you need devices explitly anyway.	688	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328		689
329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	690	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330		691
331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	692	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
332		693
333	Create a new OpenCL::Context object using the given device object(s)- a	694	Create a new OpenCL::Context object using the given device object(s)- a
334	CL_CONTEXT_PLATFORM property is supplied automatically.	695	CL_CONTEXT_PLATFORM property is supplied automatically.
335		696
336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	697	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
337		698
338	=item $packed_value = $platform->info ($name)	699	=item $packed_value = $platform->info ($name)
339		700
340	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	701	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
341	strings, this will be the string, for other values you probably need to	702	strings, this will be the string (possibly including terminating \0), for
342	use the correct C<unpack>.	703	other values you probably need to use the correct C<unpack>.
343		704
344	It's best to avoid this method and use one of the predefined C<get_*>	705	It's best to avoid this method and use one of the following convenience
345	methods.	706	wrappers.
346		707
347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	708	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348		709
		710	=item $platform->unload_compiler
		711
		712	Attempts to unload the compiler for this platform, for endless
		713	profit. Does nothing on OpenCL 1.1.
		714
		715	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		716
349	=for gengetinfo begin platform	717	=for gengetinfo begin platform
350		718
351
352	=item $string = $platform->profile	719	=item $string = $platform->profile
353		720
354	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s).	721	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
355		722
356	=item $string = $platform->version	723	=item $string = $platform->version
357		724
358	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s).	725	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
359		726
360	=item $string = $platform->name	727	=item $string = $platform->name
361		728
362	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s).	729	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
363		730
364	=item $string = $platform->vendor	731	=item $string = $platform->vendor
365		732
366	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s).	733	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
367		734
368	=item $string = $platform->extensions	735	=item $string = $platform->extensions
369		736
370	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s).	737	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
371		738
372	=for gengetinfo end platform	739	=for gengetinfo end platform
373		740
374	=back	741	=back
375		742
…		…
383		750
384	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	751	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
385		752
386	=for gengetinfo begin device	753	=for gengetinfo begin device
387		754
388
389	=item $device_type = $device->type	755	=item $device_type = $device->type
390		756
391	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s).	757	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
392		758
393	=item $uint = $device->vendor_id	759	=item $uint = $device->vendor_id
394		760
395	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s).	761	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
396		762
397	=item $uint = $device->max_compute_units	763	=item $uint = $device->max_compute_units
398		764
399	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s).	765	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
400		766
401	=item $uint = $device->max_work_item_dimensions	767	=item $uint = $device->max_work_item_dimensions
402		768
403	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s).	769	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
404		770
405	=item $int = $device->max_work_group_size	771	=item $int = $device->max_work_group_size
406		772
407	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s).	773	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
408		774
409	=item @ints = $device->max_work_item_sizes	775	=item @ints = $device->max_work_item_sizes
410		776
411	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s).	777	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
412		778
413	=item $uint = $device->preferred_vector_width_char	779	=item $uint = $device->preferred_vector_width_char
414		780
415	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s).	781	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
416		782
417	=item $uint = $device->preferred_vector_width_short	783	=item $uint = $device->preferred_vector_width_short
418		784
419	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s).	785	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
420		786
421	=item $uint = $device->preferred_vector_width_int	787	=item $uint = $device->preferred_vector_width_int
422		788
423	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s).	789	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
424		790
425	=item $uint = $device->preferred_vector_width_long	791	=item $uint = $device->preferred_vector_width_long
426		792
427	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s).	793	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
428		794
429	=item $uint = $device->preferred_vector_width_float	795	=item $uint = $device->preferred_vector_width_float
430		796
431	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s).	797	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
432		798
433	=item $uint = $device->preferred_vector_width_double	799	=item $uint = $device->preferred_vector_width_double
434		800
435	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s).	801	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
436		802
437	=item $uint = $device->max_clock_frequency	803	=item $uint = $device->max_clock_frequency
438		804
439	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s).	805	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
440		806
441	=item $bitfield = $device->address_bits	807	=item $bitfield = $device->address_bits
442		808
443	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s).	809	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
444		810
445	=item $uint = $device->max_read_image_args	811	=item $uint = $device->max_read_image_args
446		812
447	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s).	813	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
448		814
449	=item $uint = $device->max_write_image_args	815	=item $uint = $device->max_write_image_args
450		816
451	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s).	817	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
452		818
453	=item $ulong = $device->max_mem_alloc_size	819	=item $ulong = $device->max_mem_alloc_size
454		820
455	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s).	821	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
456		822
457	=item $int = $device->image2d_max_width	823	=item $int = $device->image2d_max_width
458		824
459	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s).	825	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
460		826
461	=item $int = $device->image2d_max_height	827	=item $int = $device->image2d_max_height
462		828
463	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s).	829	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
464		830
465	=item $int = $device->image3d_max_width	831	=item $int = $device->image3d_max_width
466		832
467	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s).	833	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
468		834
469	=item $int = $device->image3d_max_height	835	=item $int = $device->image3d_max_height
470		836
471	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s).	837	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
472		838
473	=item $int = $device->image3d_max_depth	839	=item $int = $device->image3d_max_depth
474		840
475	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s).	841	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
476		842
477	=item $uint = $device->image_support	843	=item $uint = $device->image_support
478		844
479	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s).	845	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
480		846
481	=item $int = $device->max_parameter_size	847	=item $int = $device->max_parameter_size
482		848
483	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s).	849	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
484		850
485	=item $uint = $device->max_samplers	851	=item $uint = $device->max_samplers
486		852
487	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s).	853	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
488		854
489	=item $uint = $device->mem_base_addr_align	855	=item $uint = $device->mem_base_addr_align
490		856
491	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s).	857	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
492		858
493	=item $uint = $device->min_data_type_align_size	859	=item $uint = $device->min_data_type_align_size
494		860
495	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s).	861	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
496		862
497	=item $device_fp_config = $device->single_fp_config	863	=item $device_fp_config = $device->single_fp_config
498		864
499	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s).	865	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
500		866
501	=item $device_mem_cache_type = $device->global_mem_cache_type	867	=item $device_mem_cache_type = $device->global_mem_cache_type
502		868
503	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s).	869	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
504		870
505	=item $uint = $device->global_mem_cacheline_size	871	=item $uint = $device->global_mem_cacheline_size
506		872
507	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s).	873	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
508		874
509	=item $ulong = $device->global_mem_cache_size	875	=item $ulong = $device->global_mem_cache_size
510		876
511	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s).	877	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
512		878
513	=item $ulong = $device->global_mem_size	879	=item $ulong = $device->global_mem_size
514		880
515	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s).	881	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
516		882
517	=item $ulong = $device->max_constant_buffer_size	883	=item $ulong = $device->max_constant_buffer_size
518		884
519	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s).	885	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
520		886
521	=item $uint = $device->max_constant_args	887	=item $uint = $device->max_constant_args
522		888
523	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s).	889	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
524		890
525	=item $device_local_mem_type = $device->local_mem_type	891	=item $device_local_mem_type = $device->local_mem_type
526		892
527	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s).	893	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
528		894
529	=item $ulong = $device->local_mem_size	895	=item $ulong = $device->local_mem_size
530		896
531	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s).	897	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
532		898
533	=item $boolean = $device->error_correction_support	899	=item $boolean = $device->error_correction_support
534		900
535	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s).	901	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
536		902
537	=item $int = $device->profiling_timer_resolution	903	=item $int = $device->profiling_timer_resolution
538		904
539	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s).	905	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
540		906
541	=item $boolean = $device->endian_little	907	=item $boolean = $device->endian_little
542		908
543	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s).	909	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
544		910
545	=item $boolean = $device->available	911	=item $boolean = $device->available
546		912
547	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s).	913	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
548		914
549	=item $boolean = $device->compiler_available	915	=item $boolean = $device->compiler_available
550		916
551	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s).	917	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
552		918
553	=item $device_exec_capabilities = $device->execution_capabilities	919	=item $device_exec_capabilities = $device->execution_capabilities
554		920
555	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s).	921	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
556		922
557	=item $command_queue_properties = $device->properties	923	=item $command_queue_properties = $device->properties
558		924
559	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s).	925	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
560		926
561	=item $ = $device->platform	927	=item $ = $device->platform
562		928
563	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s).	929	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
564		930
565	=item $string = $device->name	931	=item $string = $device->name
566		932
567	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s).	933	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
568		934
569	=item $string = $device->vendor	935	=item $string = $device->vendor
570		936
571	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s).	937	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
572		938
573	=item $string = $device->driver_version	939	=item $string = $device->driver_version
574		940
575	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s).	941	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
576		942
577	=item $string = $device->profile	943	=item $string = $device->profile
578		944
579	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s).	945	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
580		946
581	=item $string = $device->version	947	=item $string = $device->version
582		948
583	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s).	949	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
584		950
585	=item $string = $device->extensions	951	=item $string = $device->extensions
586		952
587	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s).	953	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
588		954
589	=item $uint = $device->preferred_vector_width_half	955	=item $uint = $device->preferred_vector_width_half
590		956
591	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s).	957	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
592		958
593	=item $uint = $device->native_vector_width_char	959	=item $uint = $device->native_vector_width_char
594		960
595	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s).	961	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
596		962
597	=item $uint = $device->native_vector_width_short	963	=item $uint = $device->native_vector_width_short
598		964
599	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s).	965	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
600		966
601	=item $uint = $device->native_vector_width_int	967	=item $uint = $device->native_vector_width_int
602		968
603	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s).	969	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
604		970
605	=item $uint = $device->native_vector_width_long	971	=item $uint = $device->native_vector_width_long
606		972
607	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s).	973	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
608		974
609	=item $uint = $device->native_vector_width_float	975	=item $uint = $device->native_vector_width_float
610		976
611	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s).	977	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
612		978
613	=item $uint = $device->native_vector_width_double	979	=item $uint = $device->native_vector_width_double
614		980
615	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s).	981	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
616		982
617	=item $uint = $device->native_vector_width_half	983	=item $uint = $device->native_vector_width_half
618		984
619	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s).	985	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
620		986
621	=item $device_fp_config = $device->double_fp_config	987	=item $device_fp_config = $device->double_fp_config
622		988
623	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s).	989	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
624		990
625	=item $device_fp_config = $device->half_fp_config	991	=item $device_fp_config = $device->half_fp_config
626		992
627	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s).	993	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
628		994
629	=item $boolean = $device->host_unified_memory	995	=item $boolean = $device->host_unified_memory
630		996
631	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s).	997	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
632		998
633	=item $device = $device->parent_device_ext	999	=item $device = $device->parent_device_ext
634		1000
635	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s).	1001	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
636		1002
637	=item @device_partition_property_exts = $device->partition_types_ext	1003	=item @device_partition_property_exts = $device->partition_types_ext
638		1004
639	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s).	1005	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
640		1006
641	=item @device_partition_property_exts = $device->affinity_domains_ext	1007	=item @device_partition_property_exts = $device->affinity_domains_ext
642		1008
643	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s).	1009	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
644		1010
645	=item $uint = $device->reference_count_ext	1011	=item $uint = $device->reference_count_ext
646		1012
647	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s).	1013	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
648		1014
649	=item @device_partition_property_exts = $device->partition_style_ext	1015	=item @device_partition_property_exts = $device->partition_style_ext
650		1016
651	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s).	1017	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
652		1018
653	=for gengetinfo end device	1019	=for gengetinfo end device
654		1020
655	=back	1021	=back
656		1022
657	=head2 THE OpenCL::Context CLASS	1023	=head2 THE OpenCL::Context CLASS
658		1024
659	=over 4	1025	=over 4
660		1026
		1027	=item $prog = $ctx->build_program ($program, $options = "")
		1028
		1029	This convenience function tries to build the program on all devices in
		1030	the context. If the build fails, then the function will C<croak> with the
		1031	build log. Otherwise ti returns the program object.
		1032
		1033	The C<$program> can either be a C<OpenCL::Program> object or a string
		1034	containing the program. In the latter case, a program objetc will be
		1035	created automatically.
		1036
		1037	=cut
		1038
		1039	sub OpenCL::Context::build_program {
		1040	my ($self, $prog, $options) = @_;
		1041
		1042	$prog = $self->program_with_source ($prog)
		1043	unless ref $prog;
		1044
		1045	eval { $prog->build (undef, $options); 1 }
		1046	or errno == BUILD_PROGRAM_FAILURE
		1047	or errno == INVALID_BINARY # workaround nvidia bug
		1048	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1049
		1050	# we check status for all devices
		1051	for my $dev ($self->devices) {
		1052	$prog->build_status ($dev) == BUILD_SUCCESS
		1053	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1054	. $prog->build_log ($dev);
		1055	}
		1056
		1057	$prog
		1058	}
		1059
661	=item $queue = $ctx->queue ($device, $properties)	1060	=item $queue = $ctx->queue ($device, $properties)
662		1061
663	Create a new OpenCL::Queue object from the context and the given device.	1062	Create a new OpenCL::Queue object from the context and the given device.
664		1063
665	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	1064	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
666		1065
		1066	Example: create an out-of-order queue.
		1067
		1068	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		1069
667	=item $ev = $ctx->user_event	1070	=item $ev = $ctx->user_event
668		1071
669	Creates a new OpenCL::UserEvent object.	1072	Creates a new OpenCL::UserEvent object.
670		1073
671	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	1074	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
672		1075
673	=item $buf = $ctx->buffer ($flags, $len)	1076	=item $buf = $ctx->buffer ($flags, $len)
674		1077
675	Creates a new OpenCL::Buffer object with the given flags and octet-size.	1078	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		1079	given flags and octet-size.
676		1080
677	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1081	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
678		1082
679	=item $buf = $ctx->buffer_sv ($flags, $data)	1083	=item $buf = $ctx->buffer_sv ($flags, $data)
680		1084
681	Creates a new OpenCL::Buffer object and initialise it with the given data values.	1085	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		1086	initialise it with the given data values.
		1087
		1088	=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)
		1089
		1090	Creates a new OpenCL::Image object and optionally initialises it with
		1091	the given data values.
		1092
		1093	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
682		1094
683	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1095	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
684		1096
685	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	1097	Creates a new OpenCL::Image2D object and optionally initialises it with
		1098	the given data values.
686		1099
687	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	1100	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
688		1101
689	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)	1102	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
690		1103
691	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	1104	Creates a new OpenCL::Image3D object and optionally initialises it with
		1105	the given data values.
692		1106
693	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	1107	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		1108
		1109	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		1110
		1111	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		1112	OpenGL buffer object.
		1113
		1114	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		1115
		1116	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		1117
		1118	Creates a new OpenCL::Image object that refers to the given OpenGL
		1119	texture object or buffer.
		1120
		1121	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		1122
		1123	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		1124
		1125	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1126	2D texture object.
		1127
		1128	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		1129
		1130	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		1131
		1132	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		1133	3D texture object.
		1134
		1135	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		1136
		1137	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		1138
		1139	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1140	render buffer.
		1141
		1142	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
694		1143
695	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	1144	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
696		1145
697	Returns a list of matching image formats - each format is an arrayref with	1146	Returns a list of matching image formats - each format is an arrayref with
698	two values, $channel_order and $channel_type, in it.	1147	two values, $channel_order and $channel_type, in it.
…		…
709		1158
710	Creates a new OpenCL::Program object from the given source code.	1159	Creates a new OpenCL::Program object from the given source code.
711		1160
712	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1161	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
713		1162
		1163	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1164
		1165	Creates a new OpenCL::Program object from the given binaries.
		1166
		1167	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1168
		1169	Example: clone an existing program object that contains a successfully
		1170	compiled program, no matter how useless this is.
		1171
		1172	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1173
714	=item $packed_value = $ctx->info ($name)	1174	=item $packed_value = $ctx->info ($name)
715		1175
716	See C<< $platform->info >> for details.	1176	See C<< $platform->info >> for details.
717		1177
718	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1178	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
719		1179
720	=for gengetinfo begin context	1180	=for gengetinfo begin context
721		1181
722
723	=item $uint = $context->reference_count	1182	=item $uint = $context->reference_count
724		1183
725	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s).	1184	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
726		1185
727	=item @devices = $context->devices	1186	=item @devices = $context->devices
728		1187
729	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s).	1188	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
730		1189
731	=item @property_ints = $context->properties	1190	=item @property_ints = $context->properties
732		1191
733	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s).	1192	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
734		1193
735	=item $uint = $context->num_devices	1194	=item $uint = $context->num_devices
736		1195
737	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s).	1196	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
738		1197
739	=for gengetinfo end context	1198	=for gengetinfo end context
740		1199
741	=back	1200	=back
742		1201
743	=head2 THE OpenCL::Queue CLASS	1202	=head2 THE OpenCL::Queue CLASS
744		1203
745	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1204	An OpenCL::Queue represents an execution queue for OpenCL. You execute
746	requests by calling their respective C<enqueue_xxx> method and waitinf for	1205	requests by calling their respective method and waiting for it to complete
747	it to complete in some way.	1206	in some way.
748		1207
749	All the enqueue methods return an event object that can be used to wait	1208	Most methods that enqueue some request return an event object that can
750	for completion, unless the method is called in void context, in which case	1209	be used to wait for completion (optionally using a callback), unless
751	no event object is created.	1210	the method is called in void context, in which case no event object is
		1211	created.
752		1212
753	They also allow you to specify any number of other event objects that this	1213	They also allow you to specify any number of other event objects that this
754	request has to wait for before it starts executing, by simply passing the	1214	request has to wait for before it starts executing, by simply passing the
755	event objects as extra parameters to the enqueue methods.	1215	event objects as extra parameters to the enqueue methods. To simplify
		1216	program design, this module ignores any C<undef> values in the list of
		1217	events. This makes it possible to code operations such as this, without
		1218	having to put a valid event object into C<$event> first:
		1219
		1220	$event = $queue->xxx (..., $event);
756		1221
757	Queues execute in-order by default, without any parallelism, so in most	1222	Queues execute in-order by default, without any parallelism, so in most
758	cases (i.e. you use only one queue) it's not necessary to wait for or	1223	cases (i.e. you use only one queue) it's not necessary to wait for or
759	create event objects.	1224	create event objects, althoguh an our of order queue is often a bit
		1225	faster.
760		1226
761	=over 4	1227	=over 4
762		1228
763	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1229	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
764		1230
765	Reads data from buffer into the given string.	1231	Reads data from buffer into the given string.
766		1232
767	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1233	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
768		1234
769	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1235	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
770		1236
771	Writes data to buffer from the given string.	1237	Writes data to buffer from the given string.
772		1238
773	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1239	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
774		1240
775	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1241	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
776		1242
777	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1243	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
778		1244
		1245	=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...)
		1246
		1247	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		1248
		1249	=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...)
		1250
		1251	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		1252
		1253	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1254
		1255	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1256
779	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1257	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1258
		1259	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1260	module uses the image width (and height) to supply default values.
780		1261
781	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
782		1263
783	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1264	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
784		1265
		1266	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1267	module uses the image width (and height) to supply default values.
785	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1268	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
786		1269
		1270	=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...)
		1271
		1272	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		1273
		1274	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
		1275
		1276	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		1277
787	=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...)	1278	=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...)
788		1279
789	Yeah.	1280	Yeah.
790		1281
791	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
792
793	=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...)
794
795	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1282	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
796		1283
797	=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...)	1284	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
798		1285
		1286	Fills the given buffer object with repeated applications of C<$pattern>,
		1287	starting at C<$offset> for C<$size> octets.
		1288
		1289	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1290
		1291	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1292
		1293	Fills the given image area with the given rgba colour components. The
		1294	components are normally floating point values between C<0> and C<1>,
		1295	except when the image channel data type is a signe dor unsigned
		1296	unnormalised format, in which case the range is determined by the format.
		1297
799	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1298	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
800		1299
801	=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...)
802
803	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
804
805	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1300	=item $ev = $queue->task ($kernel, $wait_events...)
806		1301
807	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1302	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
808		1303
809	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1304	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
810		1305
811	Enqueues a kernel execution.	1306	Enqueues a kernel execution.
812		1307
813	@$global_work_size must be specified as a reference to an array of	1308	\@global_work_size must be specified as a reference to an array of
814	integers specifying the work sizes (element counts).	1309	integers specifying the work sizes (element counts).
815		1310
816	@$global_work_offset must be either C<undef> (in which case all offsets	1311	\@global_work_offset must be either C<undef> (in which case all offsets
817	are C<0>), or a reference to an array of work offsets, with the same number	1312	are C<0>), or a reference to an array of work offsets, with the same number
818	of elements as @$global_work_size.	1313	of elements as \@global_work_size.
819		1314
820	@$local_work_size must be either C<undef> (in which case the	1315	\@local_work_size must be either C<undef> (in which case the
821	implementation is supposed to choose good local work sizes), or a	1316	implementation is supposed to choose good local work sizes), or a
822	reference to an array of local work sizes, with the same number of	1317	reference to an array of local work sizes, with the same number of
823	elements as @$global_work_size.	1318	elements as \@global_work_size.
824		1319
825	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1320	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
826		1321
827	=item $ev = $queue->enqueue_marker	1322	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
828		1323
		1324	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1325	for subsequent OpenCL usage.
		1326
829	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1327	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
830		1328
		1329	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
		1330
		1331	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1332	for subsequent OpenGL usage.
		1333
		1334	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
		1335
831	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1336	=item $ev = $queue->wait_for_events ($wait_events...)
832		1337
833	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1338	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
834		1339
835	=item $queue->enqueue_barrier	1340	=item $ev = $queue->marker ($wait_events...)
836		1341
		1342	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1343
		1344	=item $ev = $queue->barrier ($wait_events...)
		1345
837	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1346	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
838		1347
839	=item $queue->flush	1348	=item $queue->flush
840		1349
841	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1350	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
842		1351
…		…
850		1359
851	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>	1360	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
852		1361
853	=for gengetinfo begin command_queue	1362	=for gengetinfo begin command_queue
854		1363
855
856	=item $ctx = $command_queue->context	1364	=item $ctx = $command_queue->context
857		1365
858	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s).	1366	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
859		1367
860	=item $device = $command_queue->device	1368	=item $device = $command_queue->device
861		1369
862	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s).	1370	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
863		1371
864	=item $uint = $command_queue->reference_count	1372	=item $uint = $command_queue->reference_count
865		1373
866	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s).	1374	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
867		1375
868	=item $command_queue_properties = $command_queue->properties	1376	=item $command_queue_properties = $command_queue->properties
869		1377
870	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s).	1378	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
871		1379
872	=for gengetinfo end command_queue	1380	=for gengetinfo end command_queue
		1381
		1382	=back
		1383
		1384	=head3 MEMORY MAPPED BUFFERS
		1385
		1386	OpenCL allows you to map buffers and images to host memory (read: perl
		1387	scalars). This is done much like reading or copying a buffer, by enqueuing
		1388	a map or unmap operation on the command queue.
		1389
		1390	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1391	OpenCL::Mapped CLASS> section for details on what to do with these
		1392	objects.
		1393
		1394	The object will be unmapped automatically when the mapped object is
		1395	destroyed (you can use a barrier to make sure the unmap has finished,
		1396	before using the buffer in a kernel), but you can also enqueue an unmap
		1397	operation manually.
		1398
		1399	=over 4
		1400
		1401	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1402
		1403	Maps the given buffer into host memory and returns an
		1404	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1405	the map will extend to the end of the buffer.
		1406
		1407	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1408
		1409	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1410
		1411	{
		1412	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1413	substr $$mapped, 0, 4, "abcd";
		1414	} # asynchronously unmap because $mapped is destroyed
		1415
		1416	=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...)
		1417
		1418	Maps the given image area into host memory and return an
		1419	C<OpenCL::MappedImage> object.
		1420
		1421	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1422	will be replaced by the maximum possible value.
		1423
		1424	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1425
		1426	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1427	the first channel of the leftmost column to 5, then explicitly unmap
		1428	it. You are not necessarily meant to do it this way, this example just
		1429	shows you the accessors to use :)
		1430
		1431	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1432
		1433	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1434	for 0..$image->height;
		1435
		1436	$mapped->unmap;.
		1437	$mapped->wait; # only needed for out of order queues normally
		1438
		1439	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1440
		1441	Unmaps the data from host memory. You must not call any methods that
		1442	modify the data, or modify the data scalar directly, after calling this
		1443	method.
		1444
		1445	The mapped event object will always be passed as part of the
		1446	$wait_events. The mapped event object will be replaced by the new event
		1447	object that this request creates.
873		1448
874	=back	1449	=back
875		1450
876	=head2 THE OpenCL::Memory CLASS	1451	=head2 THE OpenCL::Memory CLASS
877		1452
…		…
886		1461
887	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1462	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
888		1463
889	=for gengetinfo begin mem	1464	=for gengetinfo begin mem
890		1465
891
892	=item $mem_object_type = $mem->type	1466	=item $mem_object_type = $mem->type
893		1467
894	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s).	1468	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
895		1469
896	=item $mem_flags = $mem->flags	1470	=item $mem_flags = $mem->flags
897		1471
898	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s).	1472	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
899		1473
900	=item $int = $mem->size	1474	=item $int = $mem->size
901		1475
902	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s).	1476	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
903		1477
904	=item $ptr_value = $mem->host_ptr	1478	=item $ptr_value = $mem->host_ptr
905		1479
906	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s).	1480	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
907		1481
908	=item $uint = $mem->map_count	1482	=item $uint = $mem->map_count
909		1483
910	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s).	1484	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
911		1485
912	=item $uint = $mem->reference_count	1486	=item $uint = $mem->reference_count
913		1487
914	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s).	1488	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
915		1489
916	=item $ctx = $mem->context	1490	=item $ctx = $mem->context
917		1491
918	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s).	1492	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
919		1493
920	=item $mem = $mem->associated_memobject	1494	=item $mem = $mem->associated_memobject
921		1495
922	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s).	1496	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
923		1497
924	=item $int = $mem->offset	1498	=item $int = $mem->offset
925		1499
926	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s).	1500	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
927		1501
928	=for gengetinfo end mem	1502	=for gengetinfo end mem
929		1503
		1504	=item ($type, $name) = $mem->gl_object_info
		1505
		1506	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1507	object "name" (e.g. the texture name) used to create this memory object.
		1508
		1509	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1510
930	=back	1511	=back
931		1512
		1513	=head2 THE OpenCL::Buffer CLASS
		1514
		1515	This is a subclass of OpenCL::Memory, and the superclass of
		1516	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1517	and sub-buffers.
		1518
		1519	=head2 THE OpenCL::BufferObj CLASS
		1520
		1521	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1522	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1523	sub buffers from these sub buffers.
		1524
		1525	=over 4
		1526
		1527	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1528
		1529	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1530	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1531
		1532	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1533
		1534	=back
		1535
932	=head2 THE OpenCL::Image CLASS	1536	=head2 THE OpenCL::Image CLASS
933		1537
934	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.	1538	This is the superclass of all image objects - OpenCL::Image1D,
		1539	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1540	OpenCL::Image2DArray and OpenCL::Image3D.
935		1541
936	=over 4	1542	=over 4
937		1543
938	=item $packed_value = $ev->image_info ($name)	1544	=item $packed_value = $image->image_info ($name)
939		1545
940	See C<< $platform->info >> for details.	1546	See C<< $platform->info >> for details.
941		1547
942	The reason this method is not called C<info> is that there already is an	1548	The reason this method is not called C<info> is that there already is an
943	C<< ->info >> method inherited from C<OpenCL::Memory>.	1549	C<< ->info >> method inherited from C<OpenCL::Memory>.
944		1550
945	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1551	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
946		1552
		1553	=item ($channel_order, $channel_data_type) = $image->format
		1554
		1555	Returns the channel order and type used to create the image by calling
		1556	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1557
947	=for gengetinfo begin image	1558	=for gengetinfo begin image
948		1559
949
950	=item $int = $image->element_size	1560	=item $int = $image->element_size
951		1561
952	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s).	1562	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
953		1563
954	=item $int = $image->row_pitch	1564	=item $int = $image->row_pitch
955		1565
956	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s).	1566	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
957		1567
958	=item $int = $image->slice_pitch	1568	=item $int = $image->slice_pitch
959		1569
960	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s).	1570	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
961		1571
962	=item $int = $image->width	1572	=item $int = $image->width
963		1573
964	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s).	1574	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
965		1575
966	=item $int = $image->height	1576	=item $int = $image->height
967		1577
968	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s).	1578	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
969		1579
970	=item $int = $image->depth	1580	=item $int = $image->depth
971		1581
972	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s).	1582	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
973		1583
974	=for gengetinfo end image	1584	=for gengetinfo end image
975		1585
		1586	=for gengetinfo begin gl_texture
		1587
		1588	=item $GLenum = $gl_texture->target
		1589
		1590	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1591
		1592	=item $GLint = $gl_texture->gl_mipmap_level
		1593
		1594	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1595
		1596	=for gengetinfo end gl_texture
		1597
976	=back	1598	=back
977		1599
978	=head2 THE OpenCL::Sampler CLASS	1600	=head2 THE OpenCL::Sampler CLASS
979		1601
980	=over 4	1602	=over 4
…		…
985		1607
986	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1608	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
987		1609
988	=for gengetinfo begin sampler	1610	=for gengetinfo begin sampler
989		1611
990
991	=item $uint = $sampler->reference_count	1612	=item $uint = $sampler->reference_count
992		1613
993	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s).	1614	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
994		1615
995	=item $ctx = $sampler->context	1616	=item $ctx = $sampler->context
996		1617
997	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s).	1618	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
998		1619
999	=item $addressing_mode = $sampler->normalized_coords	1620	=item $addressing_mode = $sampler->normalized_coords
1000		1621
1001	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s).	1622	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1002		1623
1003	=item $filter_mode = $sampler->addressing_mode	1624	=item $filter_mode = $sampler->addressing_mode
1004		1625
1005	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s).	1626	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1006		1627
1007	=item $boolean = $sampler->filter_mode	1628	=item $boolean = $sampler->filter_mode
1008		1629
1009	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s).	1630	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1010		1631
1011	=for gengetinfo end sampler	1632	=for gengetinfo end sampler
1012		1633
1013	=back	1634	=back
1014		1635
1015	=head2 THE OpenCL::Program CLASS	1636	=head2 THE OpenCL::Program CLASS
1016		1637
1017	=over 4	1638	=over 4
1018		1639
1019	=item $program->build ($device, $options = "")	1640	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1020		1641
1021	Tries to build the program with the givne options.	1642	Tries to build the program with the given options. See also the
		1643	C<$ctx->build> convenience function.
		1644
		1645	If a callback is specified, then it will be called when compilation is
		1646	finished. Note that many OpenCL implementations block your program while
		1647	compiling whether you use a callback or not. See C<build_async> if you
		1648	want to make sure the build is done in the background.
		1649
		1650	Note that some OpenCL implementations act up badly, and don't call the
		1651	callback in some error cases (but call it in others). This implementation
		1652	assumes the callback will always be called, and leaks memory if this is
		1653	not so. So best make sure you don't pass in invalid values.
		1654
		1655	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1656	compilation state is successful but some later stage fails.
1022		1657
1023	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1658	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1659
		1660	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1661
		1662	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1663	need to check the compilation status form the callback, or by polling).
1024		1664
1025	=item $packed_value = $program->build_info ($device, $name)	1665	=item $packed_value = $program->build_info ($device, $name)
1026		1666
1027	Similar to C<< $platform->info >>, but returns build info for a previous	1667	Similar to C<< $platform->info >>, but returns build info for a previous
1028	build attempt for the given device.	1668	build attempt for the given device.
…		…
1034	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1674	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1035	the program.	1675	the program.
1036		1676
1037	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1677	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1038		1678
		1679	=item @kernels = $program->kernels_in_program
		1680
		1681	Returns all kernels successfully compiled for all devices in program.
		1682
		1683	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
		1684
1039	=for gengetinfo begin program_build	1685	=for gengetinfo begin program_build
1040		1686
1041
1042	=item $build_status = $program->build_status ($device)	1687	=item $build_status = $program->build_status ($device)
1043		1688
1044	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s).	1689	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1045		1690
1046	=item $string = $program->build_options ($device)	1691	=item $string = $program->build_options ($device)
1047		1692
1048	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s).	1693	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1049		1694
1050	=item $string = $program->build_log ($device)	1695	=item $string = $program->build_log ($device)
1051		1696
1052	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s).	1697	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1053		1698
1054	=for gengetinfo end program_build	1699	=for gengetinfo end program_build
1055		1700
1056	=item $packed_value = $program->info ($name)	1701	=item $packed_value = $program->info ($name)
1057		1702
…		…
1059		1704
1060	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>	1705	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1061		1706
1062	=for gengetinfo begin program	1707	=for gengetinfo begin program
1063		1708
1064
1065	=item $uint = $program->reference_count	1709	=item $uint = $program->reference_count
1066		1710
1067	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s).	1711	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1068		1712
1069	=item $ctx = $program->context	1713	=item $ctx = $program->context
1070		1714
1071	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s).	1715	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1072		1716
1073	=item $uint = $program->num_devices	1717	=item $uint = $program->num_devices
1074		1718
1075	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s).	1719	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1076		1720
1077	=item @devices = $program->devices	1721	=item @devices = $program->devices
1078		1722
1079	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s).	1723	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1080		1724
1081	=item $string = $program->source	1725	=item $string = $program->source
1082		1726
1083	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s).	1727	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1084		1728
1085	=item @ints = $program->binary_sizes	1729	=item @ints = $program->binary_sizes
1086		1730
1087	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s).	1731	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1088		1732
1089	=for gengetinfo end program	1733	=for gengetinfo end program
1090		1734
		1735	=item @blobs = $program->binaries
		1736
		1737	Returns a string for the compiled binary for every device associated with
		1738	the program, empty strings indicate missing programs, and an empty result
		1739	means no program binaries are available.
		1740
		1741	These "binaries" are often, in fact, informative low-level assembly
		1742	sources.
		1743
		1744	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1745
1091	=back	1746	=back
1092		1747
1093	=head2 THE OpenCL::Kernel CLASS	1748	=head2 THE OpenCL::Kernel CLASS
1094		1749
1095	=over 4	1750	=over 4
…		…
1100		1755
1101	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1756	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1102		1757
1103	=for gengetinfo begin kernel	1758	=for gengetinfo begin kernel
1104		1759
1105
1106	=item $string = $kernel->function_name	1760	=item $string = $kernel->function_name
1107		1761
1108	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s).	1762	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1109		1763
1110	=item $uint = $kernel->num_args	1764	=item $uint = $kernel->num_args
1111		1765
1112	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s).	1766	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1113		1767
1114	=item $uint = $kernel->reference_count	1768	=item $uint = $kernel->reference_count
1115		1769
1116	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s).	1770	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1117		1771
1118	=item $ctx = $kernel->context	1772	=item $ctx = $kernel->context
1119		1773
1120	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s).	1774	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1121		1775
1122	=item $program = $kernel->program	1776	=item $program = $kernel->program
1123		1777
1124	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s).	1778	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1125		1779
1126	=for gengetinfo end kernel	1780	=for gengetinfo end kernel
1127		1781
1128	=item $packed_value = $kernel->work_group_info ($device, $name)	1782	=item $packed_value = $kernel->work_group_info ($device, $name)
1129		1783
…		…
1134		1788
1135	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1789	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1136		1790
1137	=for gengetinfo begin kernel_work_group	1791	=for gengetinfo begin kernel_work_group
1138		1792
1139
1140	=item $int = $kernel->work_group_size ($device)	1793	=item $int = $kernel->work_group_size ($device)
1141		1794
1142	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s).	1795	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1143		1796
1144	=item @ints = $kernel->compile_work_group_size ($device)	1797	=item @ints = $kernel->compile_work_group_size ($device)
1145		1798
1146	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s).	1799	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1147		1800
1148	=item $ulong = $kernel->local_mem_size ($device)	1801	=item $ulong = $kernel->local_mem_size ($device)
1149		1802
1150	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s).	1803	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1151		1804
1152	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1805	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1153		1806
1154	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s).	1807	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1155		1808
1156	=item $ulong = $kernel->private_mem_size ($device)	1809	=item $ulong = $kernel->private_mem_size ($device)
1157		1810
1158	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s).	1811	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1159		1812
1160	=for gengetinfo end kernel_work_group	1813	=for gengetinfo end kernel_work_group
1161		1814
		1815	=item $kernel->setf ($format, ...)
		1816
		1817	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1818	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1819	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1820	what type of argument it is.
		1821
		1822	The format arguments are single letters:
		1823
		1824	c char
		1825	C unsigned char
		1826	s short
		1827	S unsigned short
		1828	i int
		1829	I unsigned int
		1830	l long
		1831	L unsigned long
		1832
		1833	h half float (0..65535)
		1834	f float
		1835	d double
		1836
		1837	z local (octet size)
		1838
		1839	m memory object (buffer or image)
		1840	a sampler
		1841	e event
		1842
		1843	Space characters in the format string are ignored.
		1844
		1845	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1846
		1847	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1848
1162	=item $kernel->set_TYPE ($index, $value)	1849	=item $kernel->set_TYPE ($index, $value)
1163		1850
		1851	=item $kernel->set_char ($index, $value)
		1852
		1853	=item $kernel->set_uchar ($index, $value)
		1854
		1855	=item $kernel->set_short ($index, $value)
		1856
		1857	=item $kernel->set_ushort ($index, $value)
		1858
		1859	=item $kernel->set_int ($index, $value)
		1860
		1861	=item $kernel->set_uint ($index, $value)
		1862
		1863	=item $kernel->set_long ($index, $value)
		1864
		1865	=item $kernel->set_ulong ($index, $value)
		1866
		1867	=item $kernel->set_half ($index, $value)
		1868
		1869	=item $kernel->set_float ($index, $value)
		1870
		1871	=item $kernel->set_double ($index, $value)
		1872
		1873	=item $kernel->set_memory ($index, $value)
		1874
		1875	=item $kernel->set_buffer ($index, $value)
		1876
		1877	=item $kernel->set_image ($index, $value)
		1878
		1879	=item $kernel->set_sampler ($index, $value)
		1880
		1881	=item $kernel->set_local ($index, $value)
		1882
		1883	=item $kernel->set_event ($index, $value)
		1884
1164	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1885	This is a family of methods to set the kernel argument with the number
1165		1886	C<$index> to the give C<$value>.
1166	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1167	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1168	C<image2d>, C<image3d>, C<sampler> or C<event>.
1169		1887
1170	Chars and integers (including the half type) are specified as integers,	1888	Chars and integers (including the half type) are specified as integers,
1171	float and double as floating point values, memory/buffer/image2d/image3d	1889	float and double as floating point values, memory/buffer/image must be
1172	must be an object of that type or C<undef>, and sampler and event must be	1890	an object of that type or C<undef>, local-memory arguments are set by
1173	objects of that type.	1891	specifying the size, and sampler and event must be objects of that type.
		1892
		1893	Note that C<set_memory> works for all memory objects (all types of buffers
		1894	and images) - the main purpose of the more specific C<set_TYPE> functions
		1895	is type checking.
		1896
		1897	Setting an argument for a kernel does NOT keep a reference to the object -
		1898	for example, if you set an argument to some image object, free the image,
		1899	and call the kernel, you will run into undefined behaviour.
1174		1900
1175	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1901	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1176		1902
1177	=back	1903	=back
1178		1904
…		…
1187		1913
1188	Waits for the event to complete.	1914	Waits for the event to complete.
1189		1915
1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1916	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1191		1917
		1918	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1919
		1920	Adds a callback to the callback stack for the given event type. There is
		1921	no way to remove a callback again.
		1922
		1923	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1924
1192	=item $packed_value = $ev->info ($name)	1925	=item $packed_value = $ev->info ($name)
1193		1926
1194	See C<< $platform->info >> for details.	1927	See C<< $platform->info >> for details.
1195		1928
1196	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1929	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
1197		1930
1198	=for gengetinfo begin event	1931	=for gengetinfo begin event
1199		1932
1200
1201	=item $queue = $event->command_queue	1933	=item $queue = $event->command_queue
1202		1934
1203	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s).	1935	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1204		1936
1205	=item $command_type = $event->command_type	1937	=item $command_type = $event->command_type
1206		1938
1207	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s).	1939	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1208		1940
1209	=item $uint = $event->reference_count	1941	=item $uint = $event->reference_count
1210		1942
1211	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s).	1943	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1212		1944
1213	=item $uint = $event->command_execution_status	1945	=item $uint = $event->command_execution_status
1214		1946
1215	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s).	1947	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1216		1948
1217	=item $ctx = $event->context	1949	=item $ctx = $event->context
1218		1950
1219	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s).	1951	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1220		1952
1221	=for gengetinfo end event	1953	=for gengetinfo end event
1222		1954
1223	=item $packed_value = $ev->profiling_info ($name)	1955	=item $packed_value = $ev->profiling_info ($name)
1224		1956
…		…
1229		1961
1230	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>	1962	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1231		1963
1232	=for gengetinfo begin profiling	1964	=for gengetinfo begin profiling
1233		1965
1234
1235	=item $ulong = $event->profiling_command_queued	1966	=item $ulong = $event->profiling_command_queued
1236		1967
1237	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s).	1968	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1238		1969
1239	=item $ulong = $event->profiling_command_submit	1970	=item $ulong = $event->profiling_command_submit
1240		1971
1241	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s).	1972	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1242		1973
1243	=item $ulong = $event->profiling_command_start	1974	=item $ulong = $event->profiling_command_start
1244		1975
1245	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s).	1976	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1246		1977
1247	=item $ulong = $event->profiling_command_end	1978	=item $ulong = $event->profiling_command_end
1248		1979
1249	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s).	1980	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1250		1981
1251	=for gengetinfo end profiling	1982	=for gengetinfo end profiling
1252		1983
1253	=back	1984	=back
1254		1985
…		…
1258		1989
1259	=over 4	1990	=over 4
1260		1991
1261	=item $ev->set_status ($execution_status)	1992	=item $ev->set_status ($execution_status)
1262		1993
		1994	Sets the execution status of the user event. Can only be called once,
		1995	either with OpenCL::COMPLETE or a negative number as status.
		1996
1263	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1997	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1264		1998
1265	=back	1999	=back
1266		2000
		2001	=head2 THE OpenCL::Mapped CLASS
		2002
		2003	This class represents objects mapped into host memory. They are
		2004	represented by a blessed string scalar. The string data is the mapped
		2005	memory area, that is, if you read or write it, then the mapped object is
		2006	accessed directly.
		2007
		2008	You must only ever use operations that modify the string in-place - for
		2009	example, a C<substr> that doesn't change the length, or maybe a regex that
		2010	doesn't change the length. Any other operation might cause the data to be
		2011	copied.
		2012
		2013	When the object is destroyed it will enqueue an implicit unmap operation
		2014	on the queue that was used to create it.
		2015
		2016	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2017	OpenCL sees the changes, even if some implementations don't need this
		2018	sometimes.
		2019
		2020	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2021
		2022	my $mapped = $queue->map_buffer ($buf, ...
		2023	$mapped->event->wait; # make sure it's there
		2024
		2025	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2026	# we blindly assume device endianness to equal host endianness
		2027	# (and of course, we assume iee 754 single precision floats :)
		2028	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2029
		2030	=over 4
		2031
		2032	=item $ev = $mapped->unmap ($wait_events...)
		2033
		2034	Unmaps the mapped memory object, using the queue originally used to create
		2035	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2036
		2037	=item $bool = $mapped->mapped
		2038
		2039	Returns whether the object is still mapped - true before an C<unmap> is
		2040	enqueued, false afterwards.
		2041
		2042	=item $ev = $mapped->event
		2043
		2044	Return the event object associated with the mapped object. Initially, this
		2045	will be the event object created when mapping the object, and after an
		2046	unmap, this will be the event object that the unmap operation created.
		2047
		2048	=item $mapped->wait
		2049
		2050	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2051	mapped object are outstanding.
		2052
		2053	=item $bytes = $mapped->size
		2054
		2055	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2056
		2057	=item $ptr = $mapped->ptr
		2058
		2059	Returns the raw memory address of the mapped area.
		2060
		2061	=item $mapped->set ($offset, $data)
		2062
		2063	Replaces the data at the given C<$offset> in the memory area by the new
		2064	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2065	because it does bounds-checking, but also slower.
		2066
		2067	=item $data = $mapped->get ($offset, $length)
		2068
		2069	Returns (without copying) a scalar representing the data at the given
		2070	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2071	the following substr, except much slower;
		2072
		2073	$data = substr $$mapped, $offset, $length
		2074
1267	=cut	2075	=cut
1268		2076
1269	package OpenCL;	2077	sub OpenCL::Mapped::get {
1270		2078	substr ${$_[0]}, $_[1], $_[2]
1271	use common::sense;
1272
1273	BEGIN {
1274	our $VERSION = '0.55';
1275
1276	require XSLoader;
1277	XSLoader::load (__PACKAGE__, $VERSION);
1278
1279	@OpenCL::Buffer::ISA =
1280	@OpenCL::Image::ISA = OpenCL::Memory::;
1281
1282	@OpenCL::Image2D::ISA =
1283	@OpenCL::Image3D::ISA = OpenCL::Image::;
1284
1285	@OpenCL::UserEvent::ISA = OpenCL::Event::;
1286	}	2079	}
		2080
		2081	=back
		2082
		2083	=head2 THE OpenCL::MappedBuffer CLASS
		2084
		2085	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2086
		2087	=head2 THE OpenCL::MappedImage CLASS
		2088
		2089	This is a subclass of OpenCL::Mapped, representing mapped images.
		2090
		2091	=over 4
		2092
		2093	=item $bytes = $mapped->row_pitch
		2094
		2095	=item $bytes = $mapped->slice_pitch
		2096
		2097	Return the row or slice pitch of the image that has been mapped.
		2098
		2099	=back
		2100
		2101
		2102	=cut
1287		2103
1288	1;	2104	1;
1289		2105
1290	=head1 AUTHOR	2106	=head1 AUTHOR
1291		2107

Diff Legend

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