[ViewVC] Diff of: cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.24 by root, Sun Nov 20 22:31:48 2011 UTC vs.
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC

…		…
105	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
106	printf "platform: %s\n", $platform->name;	106	printf "platform: %s\n", $platform->name;
107	printf "extensions: %s\n", $platform->extensions;	107	printf "extensions: %s\n", $platform->extensions;
108	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
109	printf "+ device: %s\n", $device->name;	109	printf "+ device: %s\n", $device->name;
110	my $ctx = $device->context;	110	my $ctx = $platform->context (undef, [$device]);
111	# do stuff	111	# do stuff
112	}	112	}
113	}	113	}
114		114
115	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
…		…
149		149
150	=head2 Create and build a program, then create a kernel out of one of its	150	=head2 Create and build a program, then create a kernel out of one of its
151	functions.	151	functions.
152		152
153	my $src = '	153	my $src = '
154	__kernel void	154	kernel void
155	squareit (__global float input, __global float output)	155	squareit (global float input, global float output)
156	{	156	{
157	$id = get_global_id (0);	157	$id = get_global_id (0);
158	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
159	}	159	}
160	';	160	';
161		161
162	my $prog = $ctx->program_with_source ($src);	162	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_log;
167
168	my $kernel = $prog->kernel ("squareit");	163	my $kernel = $prog->kernel ("squareit");
169		164
170	=head2 Create some input and output float buffers, then call the	165	=head2 Create some input and output float buffers, then call the
171	'squareit' kernel on them.	166	'squareit' kernel on them.
172		167
…		…
210	# enqueue an async read	205	# enqueue an async read
211	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	206	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212		207
213	# wait for the last event to complete	208	# wait for the last event to complete
214	$ev->wait;	209	$ev->wait;
		210
		211	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
		212	set tunnel effect.
		213
		214	This is quite a long example to get you going.
		215
		216	use OpenGL ":all";
		217	use OpenCL;
		218
		219	# open a window and create a gl texture
		220	OpenGL::glpOpenWindow width => 256, height => 256;
		221	my $texid = glGenTextures_p 1;
		222	glBindTexture GL_TEXTURE_2D, $texid;
		223	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
		224
		225	# find and use the first opencl device that let's us get a shared opengl context
		226	my $platform;
		227	my $dev;
		228	my $ctx;
		229
		230	for (OpenCL::platforms) {
		231	$platform = $_;
		232	for ($platform->devices) {
		233	$dev = $_;
		234	$ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
		235	and last;
		236	}
		237	}
		238
		239	$ctx
		240	or die "cannot find suitable OpenCL device\n";
		241
		242	my $queue = $ctx->queue ($dev);
		243
		244	# now attach an opencl image2d object to the opengl texture
		245	my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
		246
		247	# now the boring opencl code
		248	my $src = <<EOF;
		249	kernel void
		250	juliatunnel (write_only image2d_t img, float time)
		251	{
		252	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
		253
		254	float2 m = (float2)(1.f, p.y) / fabs (p.x);
		255	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
		256
		257	float2 z = m;
		258	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
		259
		260	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
		261	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		262
		263	float3 colour = (float3)(z.x, z.y, z.x * z.y);
		264	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
		265	}
		266	EOF
		267
		268	my $prog = $ctx->build_program ($src);
		269	my $kernel = $prog->kernel ("juliatunnel");
		270
		271	# program compiled, kernel ready, now draw and loop
		272
		273	for (my $time; ; ++$time) {
		274	# acquire objects from opengl
		275	$queue->enqueue_acquire_gl_objects ([$tex]);
		276
		277	# configure and run our kernel
		278	$kernel->set_image2d (0, $tex);
		279	$kernel->set_float (1, $time);
		280	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
		281
		282	# release objects to opengl again
		283	$queue->enqueue_release_gl_objects ([$tex]);
		284
		285	# wait
		286	$queue->finish;
		287
		288	# now draw the texture, the defaults should be all right
		289	glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
		290
		291	glEnable GL_TEXTURE_2D;
		292	glBegin GL_QUADS;
		293	glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
		294	glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
		295	glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
		296	glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
		297	glEnd;
		298
		299	glXSwapBuffers;
		300
		301	select undef, undef, undef, 1/60;
		302	}
215		303
216	=head1 DOCUMENTATION	304	=head1 DOCUMENTATION
217		305
218	=head2 BASIC CONVENTIONS	306	=head2 BASIC CONVENTIONS
219		307
…		…
241	=item * Structures are often specified by flattening out their components	329	=item * Structures are often specified by flattening out their components
242	as with short vectors, and returned as arrayrefs.	330	as with short vectors, and returned as arrayrefs.
243		331
244	=item * When enqueuing commands, the wait list is specified by adding	332	=item * When enqueuing commands, the wait list is specified by adding
245	extra arguments to the function - anywhere a C<$wait_events...> argument	333	extra arguments to the function - anywhere a C<$wait_events...> argument
246	is documented this can be any number of event objects.	334	is documented this can be any number of event objects. As an extsnion
		335	implemented by this module, C<undef> values will be ignored in the event
		336	list.
247		337
248	=item * When enqueuing commands, if the enqueue method is called in void	338	=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	339	context, no event is created. In all other contexts an event is returned
250	by the method.	340	by the method.
251		341
…		…
271	ulong IV - Q	361	ulong IV - Q
272	float NV float f	362	float NV float f
273	half IV ushort S	363	half IV ushort S
274	double NV double d	364	double NV double d
275		365
		366	=head2 GLX SUPPORT
		367
		368	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		369	module, which has little to no documentation and has little to no support
		370	for glX), this module, as a special extension, treats context creation
		371	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		372	specially: If either or both of these are C<undef>, then the OpenCL
		373	module tries to dynamically resolve C<glXGetCurrentDisplay> and
		374	C<glXGetCurrentContext>, call these functions and use their return values
		375	instead.
		376
		377	For this to work, the OpenGL library must be loaded, a GLX context must
		378	have been created and be made current, and C<dlsym> must be available and
		379	capable of finding the function via C<RTLD_DEFAULT>.
		380
		381	=head2 EVENT SYSTEM
		382
		383	OpenCL can generate a number of (potentially) asynchronous events, for
		384	example, after compiling a program, to signal a context-related error or,
		385	perhaps most important, to signal completion of queued jobs (by setting
		386	callbacks on OpenCL::Event objects).
		387
		388	To facilitate this, this module maintains an event queue - each
		389	time an asynchronous event happens, it is queued, and perl will be
		390	interrupted. This is implemented via the L<Async::Interrupt> module. In
		391	addition, this module has L<AnyEvent> support, so it can seamlessly
		392	integrate itself into many event loops.
		393
		394	Since this module is a bit hard to understand, here are some case examples:
		395
		396	=head3 Don't use callbacks.
		397
		398	When your program never uses any callbacks, then there will never be any
		399	notifications you need to take care of, and therefore no need to worry
		400	about all this.
		401
		402	You can achieve a great deal by explicitly waiting for events, or using
		403	barriers and flush calls. In many programs, there is no need at all to
		404	tinker with asynchronous events.
		405
		406	=head3 Use AnyEvent
		407
		408	This module automatically registers a watcher that invokes all outstanding
		409	event callbacks when AnyEvent is initialised (and block asynchronous
		410	interruptions). Using this mode of operations is the safest and most
		411	recommended one.
		412
		413	To use this, simply use AnyEvent and this module normally, make sure you
		414	have an event loop running:
		415
		416	use Gtk2 -init;
		417	use AnyEvent;
		418
		419	# initialise AnyEvent, by creating a watcher, or:
		420	AnyEvent::detect;
		421
		422	my $e = $queue->enqueue_marker;
		423	$e->cb (sub {
		424	warn "opencl is finished\n";
		425	})
		426
		427	main Gtk2;
		428
		429	Note that this module will not initialise AnyEvent for you. Before
		430	AnyEvent is initialised, the module will asynchronously interrupt perl
		431	instead. To avoid any surprises, it's best to explicitly initialise
		432	AnyEvent.
		433
		434	You can temporarily enable asynchronous interruptions (see next paragraph)
		435	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		436	calling C<$OpenCL::INTERRUPT->block>.
		437
		438	=head3 Let yourself be interrupted at any time
		439
		440	This mode is the default unless AnyEvent is loaded and initialised. In
		441	this mode, OpenCL asynchronously interrupts a running perl program. The
		442	emphasis is on both I<asynchronously> and I<running> here.
		443
		444	Asynchronously means that perl might execute your callbacks at any
		445	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		446	the C<until> loop following the marker call will be interrupted by the
		447	callback:
		448
		449	my $e = $queue->enqueue_marker;
		450	my $flag;
		451	$e->cb (sub { $flag = 1 });
		452	1 until $flag;
		453	# $flag is now 1
		454
		455	The reason why you shouldn't blindly copy the above code is that
		456	busy waiting is a really really bad thing, and really really bad for
		457	performance.
		458
		459	While at first this asynchronous business might look exciting, it can be
		460	really hard, because you need to be prepared for the callback code to be
		461	executed at any time, which limits the amount of things the callback code
		462	can do safely.
		463
		464	This can be mitigated somewhat by using C<<
		465	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		466	documentation for details).
		467
		468	The other problem is that your program must be actively I<running> to be
		469	interrupted. When you calculate stuff, your program is running. When you
		470	hang in some C functions or other block execution (by calling C<sleep>,
		471	C<select>, running an event loop and so on), your program is waiting, not
		472	running.
		473
		474	One way around that would be to attach a read watcher to your event loop,
		475	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		476	dummy callback (C<sub { }>) to temporarily execute some perl code.
		477
		478	That is then awfully close to using the built-in AnyEvent support above,
		479	though, so consider that one instead.
		480
		481	=head3 Be creative
		482
		483	OpenCL exports the L<Async::Interrupt> object it uses in the global
		484	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		485
		486	So if you want to feel like a real pro, err, wait, if you feel no risk
		487	menas no fun, you can experiment by implementing your own mode of
		488	operations.
		489
		490	=cut
		491
		492	package OpenCL;
		493
		494	use common::sense;
		495	use Async::Interrupt ();
		496
		497	our $POLL_FUNC; # set by XS
		498
		499	BEGIN {
		500	our $VERSION = '0.97';
		501
		502	require XSLoader;
		503	XSLoader::load (__PACKAGE__, $VERSION);
		504
		505	@OpenCL::Platform::ISA =
		506	@OpenCL::Device::ISA =
		507	@OpenCL::Context::ISA =
		508	@OpenCL::Queue::ISA =
		509	@OpenCL::Memory::ISA =
		510	@OpenCL::Sampler::ISA =
		511	@OpenCL::Program::ISA =
		512	@OpenCL::Kernel::ISA =
		513	@OpenCL::Event::ISA = OpenCL::Object::;
		514
		515	@OpenCL::Buffer::ISA =
		516	@OpenCL::Image::ISA = OpenCL::Memory::;
		517
		518	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		519
		520	@OpenCL::Image2D::ISA =
		521	@OpenCL::Image3D::ISA =
		522	@OpenCL::Image2DArray::ISA =
		523	@OpenCL::Image1D::ISA =
		524	@OpenCL::Image1DArray::ISA =
		525	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		526
		527	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		528	}
		529
276	=head2 THE OpenCL PACKAGE	530	=head2 THE OpenCL PACKAGE
277		531
278	=over 4	532	=over 4
279		533
280	=item $int = OpenCL::errno	534	=item $int = OpenCL::errno
…		…
286		540
287	Comverts an error value into a human readable string.	541	Comverts an error value into a human readable string.
288		542
289	=item $str = OpenCL::enum2str $enum	543	=item $str = OpenCL::enum2str $enum
290		544
291	Converts most enum values (inof parameter names, image format constants,	545	Converts most enum values (of parameter names, image format constants,
292	object types, addressing and filter modes, command types etc.) into a	546	object types, addressing and filter modes, command types etc.) into a
293	human readbale string. When confronted with some random integer it can be	547	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	548	very helpful to pass it through this function to maybe get some readable
295	string out of it.	549	string out of it.
296		550
297	=item @platforms = OpenCL::platforms	551	=item @platforms = OpenCL::platforms
298		552
299	Returns all available OpenCL::Platform objects.	553	Returns all available OpenCL::Platform objects.
300		554
301	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	555	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
302		556
303	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	557	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
304		558
305	Tries to create a context from a default device and platform - never worked for me.	559	Tries to create a context from a default device and platform type - never worked for me.
306		560
307	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	561	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
308		562
		563	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		564
		565	Create a new OpenCL::Context object using the given device object(s). This
		566	function isn't implemented yet, use C<< $platform->context >> instead.
		567
		568	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		569
309	=item OpenCL::wait_for_events $wait_events...	570	=item OpenCL::wait_for_events $wait_events...
310		571
311	Waits for all events to complete.	572	Waits for all events to complete.
312		573
313	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	574	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314		575
		576	=item OpenCL::poll
		577
		578	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		579	invokes their callbacks.
		580
		581	=item $OpenCL::INTERRUPT
		582
		583	The L<Async::Interrupt> object used to signal asynchronous events (see
		584	L<EVENT SYSTEM>).
		585
		586	=cut
		587
		588	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		589
		590	&_eq_initialise ($INTERRUPT->signal_func);
		591
		592	=item $OpenCL::WATCHER
		593
		594	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		595	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		596	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		597
		598	=cut
		599
		600	our $WATCHER;
		601
		602	sub _init_anyevent {
		603	$INTERRUPT->block;
		604	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		605	}
		606
		607	if (defined $AnyEvent::MODEL) {
		608	_init_anyevent;
		609	} else {
		610	push @AnyEvent::post_detect, \&_init_anyevent;
		611	}
		612
315	=back	613	=back
316		614
		615	=head2 THE OpenCL::Object CLASS
		616
		617	This is the base class for all objects in the OpenCL module. The only
		618	method it implements is the C<id> method, which is only useful if you want
		619	to interface to OpenCL on the C level.
		620
		621	=over 4
		622
		623	=item $iv = $obj->id
		624
		625	OpenCL objects are represented by pointers or integers on the C level. If
		626	you want to interface to an OpenCL object directly on the C level, then
		627	you need this value, which is returned by this method. You should use an
		628	C<IV> type in your code and cast that to the correct type.
		629
		630	=cut
		631
		632	sub OpenCL::Object::id {
		633	ref $_[0] eq "SCALAR"
		634	? ${ $_[0] }
		635	: $_[0][0]
		636	}
		637
		638	=back
		639
317	=head2 THE OpenCL::Platform CLASS	640	=head2 THE OpenCL::Platform CLASS
318		641
319	=over 4	642	=over 4
320		643
321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	644	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322		645
323	Returns a list of matching OpenCL::Device objects.	646	Returns a list of matching OpenCL::Device objects.
324		647
325	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	648	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
326		649
327	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	650	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328		651
329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	652	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330		653
331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	654	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
332		655
333	Create a new OpenCL::Context object using the given device object(s)- a	656	Create a new OpenCL::Context object using the given device object(s)- a
334	CL_CONTEXT_PLATFORM property is supplied automatically.	657	CL_CONTEXT_PLATFORM property is supplied automatically.
335		658
336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	659	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
344	It's best to avoid this method and use one of the following convenience	667	It's best to avoid this method and use one of the following convenience
345	wrappers.	668	wrappers.
346		669
347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	670	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348		671
		672	=item $platform->unload_compiler
		673
		674	Attempts to unload the compiler for this platform, for endless
		675	profit. Does nothing on OpenCL 1.1.
		676
		677	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		678
349	=for gengetinfo begin platform	679	=for gengetinfo begin platform
350		680
351	=item $string = $platform->profile	681	=item $string = $platform->profile
352		682
353	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	683	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
…		…
638		968
639	=item @device_partition_property_exts = $device->affinity_domains_ext	969	=item @device_partition_property_exts = $device->affinity_domains_ext
640		970
641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	971	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
642		972
643	=item $uint = $device->reference_count_ext	973	=item $uint = $device->reference_count_ext
644		974
645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.	975	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
646		976
647	=item @device_partition_property_exts = $device->partition_style_ext	977	=item @device_partition_property_exts = $device->partition_style_ext
648		978
649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	979	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
650		980
…		…
654		984
655	=head2 THE OpenCL::Context CLASS	985	=head2 THE OpenCL::Context CLASS
656		986
657	=over 4	987	=over 4
658		988
		989	=item $prog = $ctx->build_program ($program, $options = "")
		990
		991	This convenience function tries to build the program on all devices in
		992	the context. If the build fails, then the function will C<croak> with the
		993	build log. Otherwise ti returns the program object.
		994
		995	The C<$program> can either be a C<OpenCL::Program> object or a string
		996	containing the program. In the latter case, a program objetc will be
		997	created automatically.
		998
		999	=cut
		1000
		1001	sub OpenCL::Context::build_program {
		1002	my ($self, $prog, $options) = @_;
		1003
		1004	require Carp;
		1005
		1006	$prog = $self->program_with_source ($prog)
		1007	unless ref $prog;
		1008
		1009	# we build separately per device so we instantly know which one failed
		1010	for my $dev ($self->devices) {
		1011	eval { $prog->build ([$dev], $options); 1 }
		1012	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1013	. $prog->build_log ($dev));
		1014	}
		1015
		1016	$prog
		1017	}
		1018
659	=item $queue = $ctx->queue ($device, $properties)	1019	=item $queue = $ctx->queue ($device, $properties)
660		1020
661	Create a new OpenCL::Queue object from the context and the given device.	1021	Create a new OpenCL::Queue object from the context and the given device.
662		1022
663	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	1023	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
664		1024
		1025	Example: create an out-of-order queue.
		1026
		1027	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		1028
665	=item $ev = $ctx->user_event	1029	=item $ev = $ctx->user_event
666		1030
667	Creates a new OpenCL::UserEvent object.	1031	Creates a new OpenCL::UserEvent object.
668		1032
669	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	1033	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
670		1034
671	=item $buf = $ctx->buffer ($flags, $len)	1035	=item $buf = $ctx->buffer ($flags, $len)
672		1036
673	Creates a new OpenCL::Buffer object with the given flags and octet-size.	1037	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		1038	given flags and octet-size.
674		1039
675	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1040	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
676		1041
677	=item $buf = $ctx->buffer_sv ($flags, $data)	1042	=item $buf = $ctx->buffer_sv ($flags, $data)
678		1043
679	Creates a new OpenCL::Buffer object and initialise it with the given data values.	1044	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		1045	initialise it with the given data values.
		1046
		1047	=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)
		1048
		1049	Creates a new OpenCL::Image object and optionally initialises it with
		1050	the given data values.
		1051
		1052	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
680		1053
681	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1054	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
682		1055
683	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	1056	Creates a new OpenCL::Image2D object and optionally initialises it with
		1057	the given data values.
684		1058
685	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	1059	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
686		1060
687	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)	1061	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
688		1062
689	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	1063	Creates a new OpenCL::Image3D object and optionally initialises it with
		1064	the given data values.
690		1065
691	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	1066	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		1067
		1068	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		1069
		1070	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		1071	OpenGL buffer object.
		1072
		1073	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		1074
		1075	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		1076
		1077	Creates a new OpenCL::Image object that refers to the given OpenGL
		1078	texture object or buffer.
		1079
		1080	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		1081
		1082	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		1083
		1084	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1085	2D texture object.
		1086
		1087	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		1088
		1089	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		1090
		1091	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		1092	3D texture object.
		1093
		1094	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		1095
		1096	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		1097
		1098	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1099	render buffer.
		1100
		1101	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
692		1102
693	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	1103	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
694		1104
695	Returns a list of matching image formats - each format is an arrayref with	1105	Returns a list of matching image formats - each format is an arrayref with
696	two values, $channel_order and $channel_type, in it.	1106	two values, $channel_order and $channel_type, in it.
…		…
747	for completion, unless the method is called in void context, in which case	1157	for completion, unless the method is called in void context, in which case
748	no event object is created.	1158	no event object is created.
749		1159
750	They also allow you to specify any number of other event objects that this	1160	They also allow you to specify any number of other event objects that this
751	request has to wait for before it starts executing, by simply passing the	1161	request has to wait for before it starts executing, by simply passing the
752	event objects as extra parameters to the enqueue methods.	1162	event objects as extra parameters to the enqueue methods. To simplify
		1163	program design, this module ignores any C<undef> values in the list of
		1164	events. This makes it possible to code operations such as this, without
		1165	having to put a valid event object into C<$event> first:
		1166
		1167	$event = $queue->enqueue_xxx (..., $event);
753		1168
754	Queues execute in-order by default, without any parallelism, so in most	1169	Queues execute in-order by default, without any parallelism, so in most
755	cases (i.e. you use only one queue) it's not necessary to wait for or	1170	cases (i.e. you use only one queue) it's not necessary to wait for or
756	create event objects.	1171	create event objects, althoguh an our of order queue is often a bit
		1172	faster.
757		1173
758	=over 4	1174	=over 4
759		1175
760	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1176	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
761		1177
…		…
771		1187
772	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1188	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
773		1189
774	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
775		1191
		1192	=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...)
		1193
		1194	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		1195
		1196	=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...)
		1197
		1198	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		1199
776	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1200	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
777		1201
		1202	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		1203
		1204	=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...)
		1205
778	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1206	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
779		1207
780	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1208	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
781		1209
782	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
783		1211
		1212	=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...)
		1213
		1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		1215
		1216	=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...)
		1217
		1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		1219
784	=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...)	1220	=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...)
785		1221
786	Yeah.	1222	Yeah.
787		1223
788	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
789
790	=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...)
791
792	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1224	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
793		1225
794	=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...)	1226	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
795		1227
		1228	Fills the given buffer object with repeated applications of C<$pattern>,
		1229	starting at C<$offset> for C<$size> octets.
		1230
		1231	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1232
		1233	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1234
		1235	Fills the given image area with the given rgba colour components. The
		1236	components are normally floating point values between C<0> and C<1>,
		1237	except when the image channel data type is a signe dor unsigned
		1238	unnormalised format, in which case the range is determined by the format.
		1239
796	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1240	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
797
798	=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...)
799
800	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
801		1241
802	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1242	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
803		1243
804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1244	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
805		1245
…		…
819	reference to an array of local work sizes, with the same number of	1259	reference to an array of local work sizes, with the same number of
820	elements as @$global_work_size.	1260	elements as @$global_work_size.
821		1261
822	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
823		1263
824	=item $ev = $queue->enqueue_marker	1264	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
825		1265
		1266	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1267	for subsequent OpenCL usage.
		1268
826	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1269	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		1270
		1271	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		1272
		1273	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1274	for subsequent OpenGL usage.
		1275
		1276	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
827		1277
828	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1278	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
829		1279
830	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1280	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
831		1281
832	=item $queue->enqueue_barrier	1282	=item $ev = $queue->enqueue_marker ($wait_events...)
833		1283
		1284	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1285
		1286	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1287
834	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
835		1289
836	=item $queue->flush	1290	=item $queue->flush
837		1291
838	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1292	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
839		1293
…		…
920		1374
921	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1375	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
922		1376
923	=for gengetinfo end mem	1377	=for gengetinfo end mem
924		1378
		1379	=item ($type, $name) = $mem->gl_object_info
		1380
		1381	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1382	object "name" (e.g. the texture name) used to create this memory object.
		1383
		1384	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1385
925	=back	1386	=back
926		1387
		1388	=head2 THE OpenCL::Buffer CLASS
		1389
		1390	This is a subclass of OpenCL::Memory, and the superclass of
		1391	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1392	and sub-buffers.
		1393
		1394	=head2 THE OpenCL::BufferObj CLASS
		1395
		1396	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1397	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1398	sub buffers from these sub buffers.
		1399
		1400	=over 4
		1401
		1402	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1403
		1404	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1405	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1406
		1407	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1408
		1409	=back
		1410
927	=head2 THE OpenCL::Image CLASS	1411	=head2 THE OpenCL::Image CLASS
928		1412
929	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.	1413	This is the superclass of all image objects - OpenCL::Image1D,
		1414	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1415	OpenCL::Image2DArray and OpenCL::Image3D.
930		1416
931	=over 4	1417	=over 4
932		1418
933	=item $packed_value = $ev->image_info ($name)	1419	=item $packed_value = $image->image_info ($name)
934		1420
935	See C<< $platform->info >> for details.	1421	See C<< $platform->info >> for details.
936		1422
937	The reason this method is not called C<info> is that there already is an	1423	The reason this method is not called C<info> is that there already is an
938	C<< ->info >> method inherited from C<OpenCL::Memory>.	1424	C<< ->info >> method inherited from C<OpenCL::Memory>.
939		1425
940	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1426	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
941		1427
		1428	=item ($channel_order, $channel_data_type) = $image->format
		1429
		1430	Returns the channel order and type used to create the image by calling
		1431	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1432
942	=for gengetinfo begin image	1433	=for gengetinfo begin image
943		1434
944	=item $int = $image->element_size	1435	=item $int = $image->element_size
945		1436
946	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1437	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
…		…
965		1456
966	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1457	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
967		1458
968	=for gengetinfo end image	1459	=for gengetinfo end image
969		1460
		1461	=for gengetinfo begin gl_texture
		1462
		1463	=item $GLenum = $gl_texture->target
		1464
		1465	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1466
		1467	=item $GLint = $gl_texture->gl_mipmap_level
		1468
		1469	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1470
		1471	=for gengetinfo end gl_texture
		1472
970	=back	1473	=back
971		1474
972	=head2 THE OpenCL::Sampler CLASS	1475	=head2 THE OpenCL::Sampler CLASS
973		1476
974	=over 4	1477	=over 4
…		…
1007		1510
1008	=head2 THE OpenCL::Program CLASS	1511	=head2 THE OpenCL::Program CLASS
1009		1512
1010	=over 4	1513	=over 4
1011		1514
1012	=item $program->build ($device, $options = "")	1515	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1013		1516
1014	Tries to build the program with the givne options.	1517	Tries to build the program with the given options. See also the
		1518	C<$ctx->build> convenience function.
		1519
		1520	If a callback is specified, then it will be called when compilation is
		1521	finished. Note that many OpenCL implementations block your program while
		1522	compiling whether you use a callback or not. See C<build_async> if you
		1523	want to make sure the build is done in the background.
		1524
		1525	Note that some OpenCL implementations atc up badly, and don't call the
		1526	callback in some error cases (but call it in others). This implementation
		1527	assumes the callback will always be called, and leaks memory if this is
		1528	not so. So best make sure you don't pass in invalid values.
1015		1529
1016	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1531
		1532	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1533
		1534	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1535	need to check the compilation status form the callback, or by polling).
1017		1536
1018	=item $packed_value = $program->build_info ($device, $name)	1537	=item $packed_value = $program->build_info ($device, $name)
1019		1538
1020	Similar to C<< $platform->info >>, but returns build info for a previous	1539	Similar to C<< $platform->info >>, but returns build info for a previous
1021	build attempt for the given device.	1540	build attempt for the given device.
…		…
1026		1545
1027	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1546	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1028	the program.	1547	the program.
1029		1548
1030	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1549	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
		1550
		1551	=item @kernels = $program->kernels_in_program
		1552
		1553	Returns all kernels successfully compiled for all devices in program.
		1554
		1555	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1031		1556
1032	=for gengetinfo begin program_build	1557	=for gengetinfo begin program_build
1033		1558
1034	=item $build_status = $program->build_status ($device)	1559	=item $build_status = $program->build_status ($device)
1035		1560
…		…
1163		1688
1164	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1689	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1165		1690
1166	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,	1691	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>,	1692	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1168	C<image2d>, C<image3d>, C<sampler> or C<event>.	1693	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1169		1694
1170	Chars and integers (including the half type) are specified as integers,	1695	Chars and integers (including the half type) are specified as integers,
1171	float and double as floating point values, memory/buffer/image2d/image3d	1696	float and double as floating point values, memory/buffer/image2d/image3d
1172	must be an object of that type or C<undef>, and sampler and event must be	1697	must be an object of that type or C<undef>, local-memory arguments are
1173	objects of that type.	1698	set by specifying the size, and sampler and event must be objects of that
		1699	type.
		1700
		1701	Setting an argument for a kernel does NOT keep a reference to the object -
		1702	for example, if you set an argument to some image object, free the image,
		1703	and call the kernel, you will run into undefined behaviour.
1174		1704
1175	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1705	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1176		1706
1177	=back	1707	=back
1178		1708
…		…
1187		1717
1188	Waits for the event to complete.	1718	Waits for the event to complete.
1189		1719
1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1720	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1191		1721
		1722	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1723
		1724	Adds a callback to the callback stack for the given event type. There is
		1725	no way to remove a callback again.
		1726
		1727	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1728
1192	=item $packed_value = $ev->info ($name)	1729	=item $packed_value = $ev->info ($name)
1193		1730
1194	See C<< $platform->info >> for details.	1731	See C<< $platform->info >> for details.
1195		1732
1196	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1733	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
…		…
1256		1793
1257	=over 4	1794	=over 4
1258		1795
1259	=item $ev->set_status ($execution_status)	1796	=item $ev->set_status ($execution_status)
1260		1797
		1798	Sets the execution status of the user event. Can only be called once,
		1799	either with OpenCL::COMPLETE or a negative number as status.
		1800
1261	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1801	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1262		1802
1263	=back	1803	=back
1264		1804
1265	=cut	1805	=cut
1266
1267	package OpenCL;
1268
1269	use common::sense;
1270
1271	BEGIN {
1272	our $VERSION = '0.55';
1273
1274	require XSLoader;
1275	XSLoader::load (__PACKAGE__, $VERSION);
1276
1277	@OpenCL::Buffer::ISA =
1278	@OpenCL::Image::ISA = OpenCL::Memory::;
1279
1280	@OpenCL::Image2D::ISA =
1281	@OpenCL::Image3D::ISA = OpenCL::Image::;
1282
1283	@OpenCL::UserEvent::ISA = OpenCL::Event::;
1284	}
1285		1806
1286	1;	1807	1;
1287		1808
1288	=head1 AUTHOR	1809	=head1 AUTHOR
1289		1810

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.24 by root, Sun Nov 20 22:31:48 2011 UTC vs. Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.24 by root, Sun Nov 20 22:31:48 2011 UTC vs.
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC