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.71 by root, Fri May 4 14:29:35 2012 UTC

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

Diff Legend

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