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.58 by root, Wed Apr 25 20:29:03 2012 UTC

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

Diff Legend

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