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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.54 by root, Tue Apr 24 14:57:06 2012 UTC vs.
Revision 1.65 by root, Mon Apr 30 23:35:16 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
…		…
138	=head2 Create a buffer with some predefined data, read it back synchronously,	141	=head2 Create a buffer with some predefined data, read it back synchronously,
139	then asynchronously.	142	then asynchronously.
140		143
141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	144	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
142		145
143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	146	$queue->read_buffer ($buf, 1, 1, 3, my $data);
144	print "$data\n";	147	print "$data\n";
145		148
146	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	149	my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
147	$ev->wait;	150	$ev->wait;
148	print "$data\n"; # prints "elm"	151	print "$data\n"; # prints "elm"
149		152
150	=head2 Create and build a program, then create a kernel out of one of its	153	=head2 Create and build a program, then create a kernel out of one of its
151	functions.	154	functions.
…		…
171	# set buffer	174	# set buffer
172	$kernel->set_buffer (0, $input);	175	$kernel->set_buffer (0, $input);
173	$kernel->set_buffer (1, $output);	176	$kernel->set_buffer (1, $output);
174		177
175	# execute it for all 4 numbers	178	# execute it for all 4 numbers
176	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	179	$queue->nd_range_kernel ($kernel, undef, [4], undef);
177		180
178	# enqueue a synchronous read	181	# enqueue a synchronous read
179	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	182	$queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
180		183
181	# print the results:	184	# print the results:
182	printf "%s\n", join ", ", unpack "f*", $data;	185	printf "%s\n", join ", ", unpack "f*", $data;
183		186
184	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	187	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
185	showing off barriers.	188	showing off barriers.
186		189
187	# execute it for all 4 numbers	190	# execute it for all 4 numbers
188	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	191	$queue->nd_range_kernel ($kernel, undef, [4], undef);
189		192
190	# enqueue a barrier to ensure in-order execution	193	# enqueue a barrier to ensure in-order execution
191	$queue->enqueue_barrier;	194	$queue->barrier;
192		195
193	# enqueue an async read	196	# enqueue an async read
194	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	197	$queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
195		198
196	# wait for all requests to finish	199	# wait for all requests to finish
197	$queue->finish;	200	$queue->finish;
198		201
199	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	202	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
200	showing off event objects and wait lists.	203	showing off event objects and wait lists.
201		204
202	# execute it for all 4 numbers	205	# execute it for all 4 numbers
203	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	206	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
204		207
205	# enqueue an async read	208	# enqueue an async read
206	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	209	$ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
207		210
208	# wait for the last event to complete	211	# wait for the last event to complete
209	$ev->wait;	212	$ev->wait;
210		213
211	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia	214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
212	set tunnel effect.	215	set tunnel effect.
213		216
214	This is quite a long example to get you going.	217	This is quite a long example to get you going - you can download it from
		218	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
215		219
216	use OpenGL ":all";	220	use OpenGL ":all";
217	use OpenCL;	221	use OpenCL;
218		222
		223	my $S = $ARGV[0] \|\| 256; # window/texture size, smaller is faster
		224
219	# open a window and create a gl texture	225	# open a window and create a gl texture
220	OpenGL::glpOpenWindow width => 256, height => 256;	226	OpenGL::glpOpenWindow width => $S, height => $S;
221	my $texid = glGenTextures_p 1;	227	my $texid = glGenTextures_p 1;
222	glBindTexture GL_TEXTURE_2D, $texid;	228	glBindTexture GL_TEXTURE_2D, $texid;
223	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;	229	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
224		230
225	# find and use the first opencl device that let's us get a shared opengl context	231	# find and use the first opencl device that let's us get a shared opengl context
226	my $platform;	232	my $platform;
227	my $dev;	233	my $dev;
228	my $ctx;	234	my $ctx;
…		…
247	# now the boring opencl code	253	# now the boring opencl code
248	my $src = <<EOF;	254	my $src = <<EOF;
249	kernel void	255	kernel void
250	juliatunnel (write_only image2d_t img, float time)	256	juliatunnel (write_only image2d_t img, float time)
251	{	257	{
252	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;	258	int2 xy = (int2)(get_global_id (0), get_global_id (1));
		259	float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
253		260
254	float2 m = (float2)(1.f, p.y) / fabs (p.x);	261	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
255	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;	262	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
256		263
257	float2 z = m;	264	float2 z = m;
258	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	265	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
259		266
260	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)	267	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
261	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;	268	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
262		269
263	float3 colour = (float3)(z.x, z.y, z.x * z.y);	270	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
264	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));	271	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
265	}	272	}
266	EOF	273	EOF
267		274
268	my $prog = $ctx->build_program ($src);	275	my $prog = $ctx->build_program ($src);
269	my $kernel = $prog->kernel ("juliatunnel");	276	my $kernel = $prog->kernel ("juliatunnel");
270		277
271	# program compiled, kernel ready, now draw and loop	278	# program compiled, kernel ready, now draw and loop
272		279
273	for (my $time; ; ++$time) {	280	for (my $time; ; ++$time) {
274	# acquire objects from opengl	281	# acquire objects from opengl
275	$queue->enqueue_acquire_gl_objects ([$tex]);	282	$queue->acquire_gl_objects ([$tex]);
276		283
277	# configure and run our kernel	284	# configure and run our kernel
278	$kernel->set_image2d (0, $tex);	285	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
279	$kernel->set_float (1, $time);
280	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);	286	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
281		287
282	# release objects to opengl again	288	# release objects to opengl again
283	$queue->enqueue_release_gl_objects ([$tex]);	289	$queue->release_gl_objects ([$tex]);
284		290
285	# wait	291	# wait
286	$queue->finish;	292	$queue->finish;
287		293
288	# now draw the texture, the defaults should be all right	294	# now draw the texture, the defaults should be all right
…		…
298		304
299	glXSwapBuffers;	305	glXSwapBuffers;
300		306
301	select undef, undef, undef, 1/60;	307	select undef, undef, undef, 1/60;
302	}	308	}
		309
		310	=item How to modify the previous example to not rely on GL sharing.
		311
		312	For those poor souls with only a sucky CPU OpenCL implementation, you
		313	currently have to read the image into some perl scalar, and then modify a
		314	texture or use glDrawPixels or so).
		315
		316	First, when you don't need gl sharing, you can create the context much simpler:
		317
		318	$ctx = $platform->context (undef, [$dev])
		319
		320	To use a texture, you would modify the above example by creating an
		321	OpenCL::Image manually instead of deriving it from a texture:
		322
		323	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
		324
		325	And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you
		326	would read the image2d after the kernel has written it:
		327
		328	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
		329
		330	And then you would upload the pixel data to the texture (or use glDrawPixels):
		331
		332	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
		333
		334	The fully modified example can be found at
		335	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
303		336
304	=head1 DOCUMENTATION	337	=head1 DOCUMENTATION
305		338
306	=head2 BASIC CONVENTIONS	339	=head2 BASIC CONVENTIONS
307		340
…		…
376		409
377	For this to work, the OpenGL library must be loaded, a GLX context must	410	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	411	have been created and be made current, and C<dlsym> must be available and
379	capable of finding the function via C<RTLD_DEFAULT>.	412	capable of finding the function via C<RTLD_DEFAULT>.
380		413
		414	=head2 EVENT SYSTEM
		415
		416	OpenCL can generate a number of (potentially) asynchronous events, for
		417	example, after compiling a program, to signal a context-related error or,
		418	perhaps most important, to signal completion of queued jobs (by setting
		419	callbacks on OpenCL::Event objects).
		420
		421	To facilitate this, this module maintains an event queue - each
		422	time an asynchronous event happens, it is queued, and perl will be
		423	interrupted. This is implemented via the L<Async::Interrupt> module. In
		424	addition, this module has L<AnyEvent> support, so it can seamlessly
		425	integrate itself into many event loops.
		426
		427	Since this module is a bit hard to understand, here are some case examples:
		428
		429	=head3 Don't use callbacks.
		430
		431	When your program never uses any callbacks, then there will never be any
		432	notifications you need to take care of, and therefore no need to worry
		433	about all this.
		434
		435	You can achieve a great deal by explicitly waiting for events, or using
		436	barriers and flush calls. In many programs, there is no need at all to
		437	tinker with asynchronous events.
		438
		439	=head3 Use AnyEvent
		440
		441	This module automatically registers a watcher that invokes all outstanding
		442	event callbacks when AnyEvent is initialised (and block asynchronous
		443	interruptions). Using this mode of operations is the safest and most
		444	recommended one.
		445
		446	To use this, simply use AnyEvent and this module normally, make sure you
		447	have an event loop running:
		448
		449	use Gtk2 -init;
		450	use AnyEvent;
		451
		452	# initialise AnyEvent, by creating a watcher, or:
		453	AnyEvent::detect;
		454
		455	my $e = $queue->marker;
		456	$e->cb (sub {
		457	warn "opencl is finished\n";
		458	})
		459
		460	main Gtk2;
		461
		462	Note that this module will not initialise AnyEvent for you. Before
		463	AnyEvent is initialised, the module will asynchronously interrupt perl
		464	instead. To avoid any surprises, it's best to explicitly initialise
		465	AnyEvent.
		466
		467	You can temporarily enable asynchronous interruptions (see next paragraph)
		468	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		469	calling C<$OpenCL::INTERRUPT->block>.
		470
		471	=head3 Let yourself be interrupted at any time
		472
		473	This mode is the default unless AnyEvent is loaded and initialised. In
		474	this mode, OpenCL asynchronously interrupts a running perl program. The
		475	emphasis is on both I<asynchronously> and I<running> here.
		476
		477	Asynchronously means that perl might execute your callbacks at any
		478	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		479	the C<until> loop following the marker call will be interrupted by the
		480	callback:
		481
		482	my $e = $queue->marker;
		483	my $flag;
		484	$e->cb (sub { $flag = 1 });
		485	1 until $flag;
		486	# $flag is now 1
		487
		488	The reason why you shouldn't blindly copy the above code is that
		489	busy waiting is a really really bad thing, and really really bad for
		490	performance.
		491
		492	While at first this asynchronous business might look exciting, it can be
		493	really hard, because you need to be prepared for the callback code to be
		494	executed at any time, which limits the amount of things the callback code
		495	can do safely.
		496
		497	This can be mitigated somewhat by using C<<
		498	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		499	documentation for details).
		500
		501	The other problem is that your program must be actively I<running> to be
		502	interrupted. When you calculate stuff, your program is running. When you
		503	hang in some C functions or other block execution (by calling C<sleep>,
		504	C<select>, running an event loop and so on), your program is waiting, not
		505	running.
		506
		507	One way around that would be to attach a read watcher to your event loop,
		508	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		509	dummy callback (C<sub { }>) to temporarily execute some perl code.
		510
		511	That is then awfully close to using the built-in AnyEvent support above,
		512	though, so consider that one instead.
		513
		514	=head3 Be creative
		515
		516	OpenCL exports the L<Async::Interrupt> object it uses in the global
		517	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		518
		519	So if you want to feel like a real pro, err, wait, if you feel no risk
		520	menas no fun, you can experiment by implementing your own mode of
		521	operations.
		522
381	=cut	523	=cut
382		524
383	package OpenCL;	525	package OpenCL;
384		526
385	use common::sense;	527	use common::sense;
		528	use Carp ();
		529	use Async::Interrupt ();
		530
		531	our $POLL_FUNC; # set by XS
386		532
387	BEGIN {	533	BEGIN {
388	our $VERSION = '0.97';	534	our $VERSION = '0.98';
389		535
390	require XSLoader;	536	require XSLoader;
391	XSLoader::load (__PACKAGE__, $VERSION);	537	XSLoader::load (__PACKAGE__, $VERSION);
392		538
393	@OpenCL::Platform::ISA =	539	@OpenCL::Platform::ISA =
…		…
422	=item $int = OpenCL::errno	568	=item $int = OpenCL::errno
423		569
424	The last error returned by a function - it's only valid after an error occured	570	The last error returned by a function - it's only valid after an error occured
425	and before calling another OpenCL function.	571	and before calling another OpenCL function.
426		572
427	=item $str = OpenCL::err2str $errval	573	=item $str = OpenCL::err2str [$errval]
428		574
429	Comverts an error value into a human readable string.	575	Converts an error value into a human readable string. IF no error value is
		576	given, then the last error will be used (as returned by OpenCL::errno).
430		577
431	=item $str = OpenCL::enum2str $enum	578	=item $str = OpenCL::enum2str $enum
432		579
433	Converts most enum values (of parameter names, image format constants,	580	Converts most enum values (of parameter names, image format constants,
434	object types, addressing and filter modes, command types etc.) into a	581	object types, addressing and filter modes, command types etc.) into a
…		…
440		587
441	Returns all available OpenCL::Platform objects.	588	Returns all available OpenCL::Platform objects.
442		589
443	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	590	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
444		591
445	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	592	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
446		593
447	Tries to create a context from a default device and platform - never worked for me.	594	Tries to create a context from a default device and platform type - never worked for me.
448		595
449	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	596	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
450		597
		598	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		599
		600	Create a new OpenCL::Context object using the given device object(s). This
		601	function isn't implemented yet, use C<< $platform->context >> instead.
		602
		603	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		604
451	=item OpenCL::wait_for_events $wait_events...	605	=item OpenCL::wait_for_events $wait_events...
452		606
453	Waits for all events to complete.	607	Waits for all events to complete.
454		608
455	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	609	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		610
		611	=item OpenCL::poll
		612
		613	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		614	invokes their callbacks.
		615
		616	=item $OpenCL::INTERRUPT
		617
		618	The L<Async::Interrupt> object used to signal asynchronous events (see
		619	L<EVENT SYSTEM>).
		620
		621	=cut
		622
		623	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		624
		625	&_eq_initialise ($INTERRUPT->signal_func);
		626
		627	=item $OpenCL::WATCHER
		628
		629	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		630	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		631	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		632
		633	=cut
		634
		635	our $WATCHER;
		636
		637	sub _init_anyevent {
		638	$INTERRUPT->block;
		639	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		640	}
		641
		642	if (defined $AnyEvent::MODEL) {
		643	_init_anyevent;
		644	} else {
		645	push @AnyEvent::post_detect, \&_init_anyevent;
		646	}
456		647
457	=back	648	=back
458		649
459	=head2 THE OpenCL::Object CLASS	650	=head2 THE OpenCL::Object CLASS
460		651
…		…
472	C<IV> type in your code and cast that to the correct type.	663	C<IV> type in your code and cast that to the correct type.
473		664
474	=cut	665	=cut
475		666
476	sub OpenCL::Object::id {	667	sub OpenCL::Object::id {
		668	ref $_[0] eq "SCALAR"
477	${$_[0]}	669	? ${ $_[0] }
		670	: $_[0][0]
478	}	671	}
479		672
480	=back	673	=back
481		674
482	=head2 THE OpenCL::Platform CLASS	675	=head2 THE OpenCL::Platform CLASS
…		…
485		678
486	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	679	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
487		680
488	Returns a list of matching OpenCL::Device objects.	681	Returns a list of matching OpenCL::Device objects.
489		682
490	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	683	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
491		684
492	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	685	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
493		686
494	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	687	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
495		688
496	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)	689	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
497		690
498	Create a new OpenCL::Context object using the given device object(s)- a	691	Create a new OpenCL::Context object using the given device object(s)- a
499	CL_CONTEXT_PLATFORM property is supplied automatically.	692	CL_CONTEXT_PLATFORM property is supplied automatically.
500		693
501	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	694	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
841	=cut	1034	=cut
842		1035
843	sub OpenCL::Context::build_program {	1036	sub OpenCL::Context::build_program {
844	my ($self, $prog, $options) = @_;	1037	my ($self, $prog, $options) = @_;
845		1038
846	require Carp;
847
848	$prog = $self->program_with_source ($prog)	1039	$prog = $self->program_with_source ($prog)
849	unless ref $prog;	1040	unless ref $prog;
850		1041
		1042	eval { $prog->build (undef, $options); 1 }
		1043	or errno == BUILD_PROGRAM_FAILURE
		1044	or errno == INVALID_BINARY # workaround nvidia bug
		1045	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1046
		1047	# we check status for all devices
851	for my $dev ($self->devices) {	1048	for my $dev ($self->devices) {
852	eval { $prog->build ($dev, $options); 1 }	1049	$prog->build_status ($dev) == BUILD_SUCCESS
853	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"	1050	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
854	. $prog->build_log ($dev));	1051	. $prog->build_log ($dev);
855	}	1052	}
856		1053
857	$prog	1054	$prog
858	}	1055	}
859		1056
…		…
883	=item $buf = $ctx->buffer_sv ($flags, $data)	1080	=item $buf = $ctx->buffer_sv ($flags, $data)
884		1081
885	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1082	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
886	initialise it with the given data values.	1083	initialise it with the given data values.
887		1084
888	=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)	1085	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
889		1086
890	Creates a new OpenCL::Image object and optionally initialises it with	1087	Creates a new OpenCL::Image object and optionally initialises it with
891	the given data values.	1088	the given data values.
892		1089
893	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1090	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
…		…
989	=back	1186	=back
990		1187
991	=head2 THE OpenCL::Queue CLASS	1188	=head2 THE OpenCL::Queue CLASS
992		1189
993	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1190	An OpenCL::Queue represents an execution queue for OpenCL. You execute
994	requests by calling their respective C<enqueue_xxx> method and waitinf for	1191	requests by calling their respective method and waiting for it to complete
995	it to complete in some way.	1192	in some way.
996		1193
997	All the enqueue methods return an event object that can be used to wait	1194	Most methods that enqueue some request return an event object that can
998	for completion, unless the method is called in void context, in which case	1195	be used to wait for completion (optionally using a callback), unless
999	no event object is created.	1196	the method is called in void context, in which case no event object is
		1197	created.
1000		1198
1001	They also allow you to specify any number of other event objects that this	1199	They also allow you to specify any number of other event objects that this
1002	request has to wait for before it starts executing, by simply passing the	1200	request has to wait for before it starts executing, by simply passing the
1003	event objects as extra parameters to the enqueue methods. To simplify	1201	event objects as extra parameters to the enqueue methods. To simplify
1004	program design, this module ignores any C<undef> values in the list of	1202	program design, this module ignores any C<undef> values in the list of
1005	events. This makes it possible to code operations such as this, without	1203	events. This makes it possible to code operations such as this, without
1006	having to put a valid event object into C<$event> first:	1204	having to put a valid event object into C<$event> first:
1007		1205
1008	$event = $queue->enqueue_xxx (..., $event);	1206	$event = $queue->xxx (..., $event);
1009		1207
1010	Queues execute in-order by default, without any parallelism, so in most	1208	Queues execute in-order by default, without any parallelism, so in most
1011	cases (i.e. you use only one queue) it's not necessary to wait for or	1209	cases (i.e. you use only one queue) it's not necessary to wait for or
1012	create event objects, althoguh an our of order queue is often a bit	1210	create event objects, althoguh an our of order queue is often a bit
1013	faster.	1211	faster.
1014		1212
1015	=over 4	1213	=over 4
1016		1214
1017	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1215	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
1018		1216
1019	Reads data from buffer into the given string.	1217	Reads data from buffer into the given string.
1020		1218
1021	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1219	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
1022		1220
1023	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1221	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1024		1222
1025	Writes data to buffer from the given string.	1223	Writes data to buffer from the given string.
1026		1224
1027	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1225	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
1028		1226
1029	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1227	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1030		1228
1031	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1229	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1032		1230
1033	=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...)	1231	=item $ev = $queue->read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
1034		1232
1035	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1233	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1036		1234
1037	=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...)	1235	=item $ev = $queue->write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
1038		1236
1039	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1237	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1040		1238
1041	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1042
1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1044
1045	=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...)	1239	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1240
		1241	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1242
		1243	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1244
		1245	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1246	module uses the image width (and height) to supply default values.
1046		1247
1047	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1248	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1048		1249
1049	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1250	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1050		1251
		1252	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1253	module uses the image width (and height) to supply default values.
1051	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1254	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1052		1255
1053	=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...)	1256	=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1054		1257
1055	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1258	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1056		1259
1057	=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...)	1260	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1058		1261
1059	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1060		1263
1061	=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...)	1264	=item $ev = $queue->copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
1062		1265
1063	Yeah.	1266	Yeah.
1064		1267
1065	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1268	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1066		1269
1067	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1270	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1068		1271
1069	Fills the given buffer object with repeated applications of C<$pattern>,	1272	Fills the given buffer object with repeated applications of C<$pattern>,
1070	starting at C<$offset> for C<$size> octets.	1273	starting at C<$offset> for C<$size> octets.
1071		1274
1072	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>	1275	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1073		1276
1074	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)	1277	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1075		1278
1076	Fills the given image area with the given rgba colour components. The	1279	Fills the given image area with the given rgba colour components. The
1077	components are normally floating point values between C<0> and C<1>,	1280	components are normally floating point values between C<0> and C<1>,
1078	except when the image channel data type is a signe dor unsigned	1281	except when the image channel data type is a signe dor unsigned
1079	unnormalised format, in which case the range is determined by the format.	1282	unnormalised format, in which case the range is determined by the format.
1080		1283
1081	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>	1284	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1082		1285
1083	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1286	=item $ev = $queue->task ($kernel, $wait_events...)
1084		1287
1085	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1086		1289
1087	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1290	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1088		1291
1089	Enqueues a kernel execution.	1292	Enqueues a kernel execution.
1090		1293
1091	@$global_work_size must be specified as a reference to an array of	1294	\@global_work_size must be specified as a reference to an array of
1092	integers specifying the work sizes (element counts).	1295	integers specifying the work sizes (element counts).
1093		1296
1094	@$global_work_offset must be either C<undef> (in which case all offsets	1297	\@global_work_offset must be either C<undef> (in which case all offsets
1095	are C<0>), or a reference to an array of work offsets, with the same number	1298	are C<0>), or a reference to an array of work offsets, with the same number
1096	of elements as @$global_work_size.	1299	of elements as \@global_work_size.
1097		1300
1098	@$local_work_size must be either C<undef> (in which case the	1301	\@local_work_size must be either C<undef> (in which case the
1099	implementation is supposed to choose good local work sizes), or a	1302	implementation is supposed to choose good local work sizes), or a
1100	reference to an array of local work sizes, with the same number of	1303	reference to an array of local work sizes, with the same number of
1101	elements as @$global_work_size.	1304	elements as \@global_work_size.
1102		1305
1103	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1306	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1104		1307
1105	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1308	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1106		1309
1107	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1310	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1108	for subsequent OpenCL usage.	1311	for subsequent OpenCL usage.
1109		1312
1110	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1313	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1111		1314
1112	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1315	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1113		1316
1114	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1317	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1115	for subsequent OpenGL usage.	1318	for subsequent OpenGL usage.
1116		1319
1117	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1320	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1118		1321
1119	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1322	=item $ev = $queue->wait_for_events ($wait_events...)
1120		1323
1121	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1122		1325
1123	=item $ev = $queue->enqueue_marker ($wait_events...)	1326	=item $ev = $queue->marker ($wait_events...)
1124		1327
1125	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1328	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1126		1329
1127	=item $ev = $queue->enqueue_barrier ($wait_events...)	1330	=item $ev = $queue->barrier ($wait_events...)
1128		1331
1129	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1332	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1130		1333
1131	=item $queue->flush	1334	=item $queue->flush
1132		1335
…		…
1351		1554
1352	=head2 THE OpenCL::Program CLASS	1555	=head2 THE OpenCL::Program CLASS
1353		1556
1354	=over 4	1557	=over 4
1355		1558
1356	=item $program->build ($device, $options = "")	1559	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1357		1560
1358	Tries to build the program with the given options. See also the	1561	Tries to build the program with the given options. See also the
1359	C<$ctx->build> convenience function.	1562	C<$ctx->build> convenience function.
1360		1563
		1564	If a callback is specified, then it will be called when compilation is
		1565	finished. Note that many OpenCL implementations block your program while
		1566	compiling whether you use a callback or not. See C<build_async> if you
		1567	want to make sure the build is done in the background.
		1568
		1569	Note that some OpenCL implementations act up badly, and don't call the
		1570	callback in some error cases (but call it in others). This implementation
		1571	assumes the callback will always be called, and leaks memory if this is
		1572	not so. So best make sure you don't pass in invalid values.
		1573
		1574	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1575	compilation state is successful but some later stage fails.
		1576
1361	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1577	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1578
		1579	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1580
		1581	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1582	need to check the compilation status form the callback, or by polling).
1362		1583
1363	=item $packed_value = $program->build_info ($device, $name)	1584	=item $packed_value = $program->build_info ($device, $name)
1364		1585
1365	Similar to C<< $platform->info >>, but returns build info for a previous	1586	Similar to C<< $platform->info >>, but returns build info for a previous
1366	build attempt for the given device.	1587	build attempt for the given device.
…		…
1508		1729
1509	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1730	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1510		1731
1511	=for gengetinfo end kernel_work_group	1732	=for gengetinfo end kernel_work_group
1512		1733
		1734	=item $kernel->setf ($format, ...)
		1735
		1736	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1737	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1738	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1739	what type of argument it is.
		1740
		1741	The format arguments are single letters:
		1742
		1743	c char
		1744	C unsigned char
		1745	s short
		1746	S unsigned short
		1747	i int
		1748	I unsigned int
		1749	l long
		1750	L unsigned long
		1751
		1752	h half float (0..65535)
		1753	f float
		1754	d double
		1755
		1756	z local (octet size)
		1757
		1758	m memory object (buffer or image)
		1759	a sampler
		1760	e event
		1761
		1762	Space characters in the format string are ignored.
		1763
		1764	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1765
		1766	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1767
1513	=item $kernel->set_TYPE ($index, $value)	1768	=item $kernel->set_TYPE ($index, $value)
1514		1769
		1770	=item $kernel->set_char ($index, $value)
		1771
		1772	=item $kernel->set_uchar ($index, $value)
		1773
		1774	=item $kernel->set_short ($index, $value)
		1775
		1776	=item $kernel->set_ushort ($index, $value)
		1777
		1778	=item $kernel->set_int ($index, $value)
		1779
		1780	=item $kernel->set_uint ($index, $value)
		1781
		1782	=item $kernel->set_long ($index, $value)
		1783
		1784	=item $kernel->set_ulong ($index, $value)
		1785
		1786	=item $kernel->set_half ($index, $value)
		1787
		1788	=item $kernel->set_float ($index, $value)
		1789
		1790	=item $kernel->set_double ($index, $value)
		1791
		1792	=item $kernel->set_memory ($index, $value)
		1793
		1794	=item $kernel->set_buffer ($index, $value)
		1795
		1796	=item $kernel->set_image ($index, $value)
		1797
		1798	=item $kernel->set_sampler ($index, $value)
		1799
		1800	=item $kernel->set_local ($index, $value)
		1801
		1802	=item $kernel->set_event ($index, $value)
		1803
1515	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1804	This is a family of methods to set the kernel argument with the number
1516		1805	C<$index> to the give C<$value>.
1517	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1518	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1519	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1520		1806
1521	Chars and integers (including the half type) are specified as integers,	1807	Chars and integers (including the half type) are specified as integers,
1522	float and double as floating point values, memory/buffer/image2d/image3d	1808	float and double as floating point values, memory/buffer/image must be
1523	must be an object of that type or C<undef>, local-memory arguments are	1809	an object of that type or C<undef>, local-memory arguments are set by
1524	set by specifying the size, and sampler and event must be objects of that	1810	specifying the size, and sampler and event must be objects of that type.
1525	type.	1811
		1812	Note that C<set_memory> works for all memory objects (all types of buffers
		1813	and images) - the main purpose of the more specific C<set_TYPE> functions
		1814	is type checking.
1526		1815
1527	Setting an argument for a kernel does NOT keep a reference to the object -	1816	Setting an argument for a kernel does NOT keep a reference to the object -
1528	for example, if you set an argument to some image object, free the image,	1817	for example, if you set an argument to some image object, free the image,
1529	and call the kernel, you will run into undefined behaviour.	1818	and call the kernel, you will run into undefined behaviour.
1530		1819
…		…
1543		1832
1544	Waits for the event to complete.	1833	Waits for the event to complete.
1545		1834
1546	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1835	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1547		1836
		1837	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1838
		1839	Adds a callback to the callback stack for the given event type. There is
		1840	no way to remove a callback again.
		1841
		1842	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1843
1548	=item $packed_value = $ev->info ($name)	1844	=item $packed_value = $ev->info ($name)
1549		1845
1550	See C<< $platform->info >> for details.	1846	See C<< $platform->info >> for details.
1551		1847
1552	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1848	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
…		…
1612		1908
1613	=over 4	1909	=over 4
1614		1910
1615	=item $ev->set_status ($execution_status)	1911	=item $ev->set_status ($execution_status)
1616		1912
		1913	Sets the execution status of the user event. Can only be called once,
		1914	either with OpenCL::COMPLETE or a negative number as status.
		1915
1617	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1916	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1618		1917
1619	=back	1918	=back
1620		1919
1621	=cut	1920	=cut

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.54 by root, Tue Apr 24 14:57:06 2012 UTC vs. Revision 1.65 by root, Mon Apr 30 23:35:16 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.54 by root, Tue Apr 24 14:57:06 2012 UTC vs.
Revision 1.65 by root, Mon Apr 30 23:35:16 2012 UTC