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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.42 by root, Fri Apr 20 11:05:46 2012 UTC vs.
Revision 1.64 by root, Mon Apr 30 23:12:43 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.
…		…
157	$id = get_global_id (0);	160	$id = get_global_id (0);
158	output [id] = input [id] * input [id];	161	output [id] = input [id] * input [id];
159	}	162	}
160	';	163	';
161		164
162	my $prog = $ctx->program_with_source ($src);	165	my $prog = $ctx->build_program ($src);
163
164	# build croaks on compile errors, so catch it and print the compile errors
165	eval { $prog->build ($dev, "-cl-fast-relaxed-math"); 1 }
166	or die $prog->build_log;
167
168	my $kernel = $prog->kernel ("squareit");	166	my $kernel = $prog->kernel ("squareit");
169		167
170	=head2 Create some input and output float buffers, then call the	168	=head2 Create some input and output float buffers, then call the
171	'squareit' kernel on them.	169	'squareit' kernel on them.
172		170
…		…
176	# set buffer	174	# set buffer
177	$kernel->set_buffer (0, $input);	175	$kernel->set_buffer (0, $input);
178	$kernel->set_buffer (1, $output);	176	$kernel->set_buffer (1, $output);
179		177
180	# execute it for all 4 numbers	178	# execute it for all 4 numbers
181	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	179	$queue->nd_range_kernel ($kernel, undef, [4], undef);
182		180
183	# enqueue a synchronous read	181	# enqueue a synchronous read
184	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	182	$queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
185		183
186	# print the results:	184	# print the results:
187	printf "%s\n", join ", ", unpack "f*", $data;	185	printf "%s\n", join ", ", unpack "f*", $data;
188		186
189	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	187	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
190	showing off barriers.	188	showing off barriers.
191		189
192	# execute it for all 4 numbers	190	# execute it for all 4 numbers
193	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	191	$queue->nd_range_kernel ($kernel, undef, [4], undef);
194		192
195	# enqueue a barrier to ensure in-order execution	193	# enqueue a barrier to ensure in-order execution
196	$queue->enqueue_barrier;	194	$queue->barrier;
197		195
198	# enqueue an async read	196	# enqueue an async read
199	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	197	$queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
200		198
201	# wait for all requests to finish	199	# wait for all requests to finish
202	$queue->finish;	200	$queue->finish;
203		201
204	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	202	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
205	showing off event objects and wait lists.	203	showing off event objects and wait lists.
206		204
207	# execute it for all 4 numbers	205	# execute it for all 4 numbers
208	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	206	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
209		207
210	# enqueue an async read	208	# enqueue an async read
211	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	209	$ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212		210
213	# wait for the last event to complete	211	# wait for the last event to complete
214	$ev->wait;	212	$ev->wait;
215		213
216	=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
217	set tunnel effect.	215	set tunnel effect.
218		216
219	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>.
220		219
221	use OpenGL ":all";	220	use OpenGL ":all";
222	use OpenCL;	221	use OpenCL;
223		222
		223	my $S = $ARGV[0] \|\| 256; # window/texture size, smaller is faster
		224
224	# open a window and create a gl texture	225	# open a window and create a gl texture
225	OpenGL::glpOpenWindow width => 256, height => 256;	226	OpenGL::glpOpenWindow width => $S, height => $S;
226	my $texid = glGenTextures_p 1;	227	my $texid = glGenTextures_p 1;
227	glBindTexture GL_TEXTURE_2D, $texid;	228	glBindTexture GL_TEXTURE_2D, $texid;
228	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;
229		230
230	# 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
231	my $platform;	232	my $platform;
232	my $dev;	233	my $dev;
233	my $ctx;	234	my $ctx;
…		…
252	# now the boring opencl code	253	# now the boring opencl code
253	my $src = <<EOF;	254	my $src = <<EOF;
254	kernel void	255	kernel void
255	juliatunnel (write_only image2d_t img, float time)	256	juliatunnel (write_only image2d_t img, float time)
256	{	257	{
257	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;
258		260
259	float2 m = (float2)(1.f, p.y) / fabs (p.x);	261	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
260	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);
261		263
262	float2 z = m;	264	float2 z = m;
263	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	265	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
264		266
265	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
266	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;
267		269
268	float3 colour = (float3)(z.x, z.y, z.x * z.y);	270	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
269	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.));
270	}	272	}
271	EOF	273	EOF
		274
272	my $prog = $ctx->program_with_source ($src);	275	my $prog = $ctx->build_program ($src);
273	eval { $prog->build ($dev); 1 }
274	or die $prog->build_log ($dev);
275
276	my $kernel = $prog->kernel ("juliatunnel");	276	my $kernel = $prog->kernel ("juliatunnel");
277		277
278	# program compiled, kernel ready, now draw and loop	278	# program compiled, kernel ready, now draw and loop
279		279
280	for (my $time; ; ++$time) {	280	for (my $time; ; ++$time) {
281	# acquire objects from opengl	281	# acquire objects from opengl
282	$queue->enqueue_acquire_gl_objects ([$tex]);	282	$queue->acquire_gl_objects ([$tex]);
283		283
284	# configure and run our kernel	284	# configure and run our kernel
285	$kernel->set_image2d (0, $tex);	285	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
286	$kernel->set_float (1, $time);
287	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);	286	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
288		287
289	# release objects to opengl again	288	# release objects to opengl again
290	$queue->enqueue_release_gl_objects ([$tex]);	289	$queue->release_gl_objects ([$tex]);
291		290
292	# wait	291	# wait
293	$queue->finish;	292	$queue->finish;
294		293
295	# now draw the texture, the defaults should be all right	294	# now draw the texture, the defaults should be all right
…		…
336	=item * Structures are often specified by flattening out their components	335	=item * Structures are often specified by flattening out their components
337	as with short vectors, and returned as arrayrefs.	336	as with short vectors, and returned as arrayrefs.
338		337
339	=item * When enqueuing commands, the wait list is specified by adding	338	=item * When enqueuing commands, the wait list is specified by adding
340	extra arguments to the function - anywhere a C<$wait_events...> argument	339	extra arguments to the function - anywhere a C<$wait_events...> argument
341	is documented this can be any number of event objects.	340	is documented this can be any number of event objects. As an extsnion
		341	implemented by this module, C<undef> values will be ignored in the event
		342	list.
342		343
343	=item * When enqueuing commands, if the enqueue method is called in void	344	=item * When enqueuing commands, if the enqueue method is called in void
344	context, no event is created. In all other contexts an event is returned	345	context, no event is created. In all other contexts an event is returned
345	by the method.	346	by the method.
346		347
…		…
381		382
382	For this to work, the OpenGL library must be loaded, a GLX context must	383	For this to work, the OpenGL library must be loaded, a GLX context must
383	have been created and be made current, and C<dlsym> must be available and	384	have been created and be made current, and C<dlsym> must be available and
384	capable of finding the function via C<RTLD_DEFAULT>.	385	capable of finding the function via C<RTLD_DEFAULT>.
385		386
		387	=head2 EVENT SYSTEM
		388
		389	OpenCL can generate a number of (potentially) asynchronous events, for
		390	example, after compiling a program, to signal a context-related error or,
		391	perhaps most important, to signal completion of queued jobs (by setting
		392	callbacks on OpenCL::Event objects).
		393
		394	To facilitate this, this module maintains an event queue - each
		395	time an asynchronous event happens, it is queued, and perl will be
		396	interrupted. This is implemented via the L<Async::Interrupt> module. In
		397	addition, this module has L<AnyEvent> support, so it can seamlessly
		398	integrate itself into many event loops.
		399
		400	Since this module is a bit hard to understand, here are some case examples:
		401
		402	=head3 Don't use callbacks.
		403
		404	When your program never uses any callbacks, then there will never be any
		405	notifications you need to take care of, and therefore no need to worry
		406	about all this.
		407
		408	You can achieve a great deal by explicitly waiting for events, or using
		409	barriers and flush calls. In many programs, there is no need at all to
		410	tinker with asynchronous events.
		411
		412	=head3 Use AnyEvent
		413
		414	This module automatically registers a watcher that invokes all outstanding
		415	event callbacks when AnyEvent is initialised (and block asynchronous
		416	interruptions). Using this mode of operations is the safest and most
		417	recommended one.
		418
		419	To use this, simply use AnyEvent and this module normally, make sure you
		420	have an event loop running:
		421
		422	use Gtk2 -init;
		423	use AnyEvent;
		424
		425	# initialise AnyEvent, by creating a watcher, or:
		426	AnyEvent::detect;
		427
		428	my $e = $queue->marker;
		429	$e->cb (sub {
		430	warn "opencl is finished\n";
		431	})
		432
		433	main Gtk2;
		434
		435	Note that this module will not initialise AnyEvent for you. Before
		436	AnyEvent is initialised, the module will asynchronously interrupt perl
		437	instead. To avoid any surprises, it's best to explicitly initialise
		438	AnyEvent.
		439
		440	You can temporarily enable asynchronous interruptions (see next paragraph)
		441	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		442	calling C<$OpenCL::INTERRUPT->block>.
		443
		444	=head3 Let yourself be interrupted at any time
		445
		446	This mode is the default unless AnyEvent is loaded and initialised. In
		447	this mode, OpenCL asynchronously interrupts a running perl program. The
		448	emphasis is on both I<asynchronously> and I<running> here.
		449
		450	Asynchronously means that perl might execute your callbacks at any
		451	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		452	the C<until> loop following the marker call will be interrupted by the
		453	callback:
		454
		455	my $e = $queue->marker;
		456	my $flag;
		457	$e->cb (sub { $flag = 1 });
		458	1 until $flag;
		459	# $flag is now 1
		460
		461	The reason why you shouldn't blindly copy the above code is that
		462	busy waiting is a really really bad thing, and really really bad for
		463	performance.
		464
		465	While at first this asynchronous business might look exciting, it can be
		466	really hard, because you need to be prepared for the callback code to be
		467	executed at any time, which limits the amount of things the callback code
		468	can do safely.
		469
		470	This can be mitigated somewhat by using C<<
		471	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		472	documentation for details).
		473
		474	The other problem is that your program must be actively I<running> to be
		475	interrupted. When you calculate stuff, your program is running. When you
		476	hang in some C functions or other block execution (by calling C<sleep>,
		477	C<select>, running an event loop and so on), your program is waiting, not
		478	running.
		479
		480	One way around that would be to attach a read watcher to your event loop,
		481	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		482	dummy callback (C<sub { }>) to temporarily execute some perl code.
		483
		484	That is then awfully close to using the built-in AnyEvent support above,
		485	though, so consider that one instead.
		486
		487	=head3 Be creative
		488
		489	OpenCL exports the L<Async::Interrupt> object it uses in the global
		490	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		491
		492	So if you want to feel like a real pro, err, wait, if you feel no risk
		493	menas no fun, you can experiment by implementing your own mode of
		494	operations.
		495
		496	=cut
		497
		498	package OpenCL;
		499
		500	use common::sense;
		501	use Carp ();
		502	use Async::Interrupt ();
		503
		504	our $POLL_FUNC; # set by XS
		505
		506	BEGIN {
		507	our $VERSION = '0.98';
		508
		509	require XSLoader;
		510	XSLoader::load (__PACKAGE__, $VERSION);
		511
		512	@OpenCL::Platform::ISA =
		513	@OpenCL::Device::ISA =
		514	@OpenCL::Context::ISA =
		515	@OpenCL::Queue::ISA =
		516	@OpenCL::Memory::ISA =
		517	@OpenCL::Sampler::ISA =
		518	@OpenCL::Program::ISA =
		519	@OpenCL::Kernel::ISA =
		520	@OpenCL::Event::ISA = OpenCL::Object::;
		521
		522	@OpenCL::Buffer::ISA =
		523	@OpenCL::Image::ISA = OpenCL::Memory::;
		524
		525	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		526
		527	@OpenCL::Image2D::ISA =
		528	@OpenCL::Image3D::ISA =
		529	@OpenCL::Image2DArray::ISA =
		530	@OpenCL::Image1D::ISA =
		531	@OpenCL::Image1DArray::ISA =
		532	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		533
		534	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		535	}
		536
386	=head2 THE OpenCL PACKAGE	537	=head2 THE OpenCL PACKAGE
387		538
388	=over 4	539	=over 4
389		540
390	=item $int = OpenCL::errno	541	=item $int = OpenCL::errno
391		542
392	The last error returned by a function - it's only valid after an error occured	543	The last error returned by a function - it's only valid after an error occured
393	and before calling another OpenCL function.	544	and before calling another OpenCL function.
394		545
395	=item $str = OpenCL::err2str $errval	546	=item $str = OpenCL::err2str [$errval]
396		547
397	Comverts an error value into a human readable string.	548	Converts an error value into a human readable string. IF no error value is
		549	given, then the last error will be used (as returned by OpenCL::errno).
398		550
399	=item $str = OpenCL::enum2str $enum	551	=item $str = OpenCL::enum2str $enum
400		552
401	Converts most enum values (of parameter names, image format constants,	553	Converts most enum values (of parameter names, image format constants,
402	object types, addressing and filter modes, command types etc.) into a	554	object types, addressing and filter modes, command types etc.) into a
…		…
408		560
409	Returns all available OpenCL::Platform objects.	561	Returns all available OpenCL::Platform objects.
410		562
411	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	563	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
412		564
413	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	565	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
414		566
415	Tries to create a context from a default device and platform - never worked for me.	567	Tries to create a context from a default device and platform type - never worked for me.
416		568
417	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	569	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
418		570
		571	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		572
		573	Create a new OpenCL::Context object using the given device object(s). This
		574	function isn't implemented yet, use C<< $platform->context >> instead.
		575
		576	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		577
419	=item OpenCL::wait_for_events $wait_events...	578	=item OpenCL::wait_for_events $wait_events...
420		579
421	Waits for all events to complete.	580	Waits for all events to complete.
422		581
423	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	582	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
424		583
		584	=item OpenCL::poll
		585
		586	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		587	invokes their callbacks.
		588
		589	=item $OpenCL::INTERRUPT
		590
		591	The L<Async::Interrupt> object used to signal asynchronous events (see
		592	L<EVENT SYSTEM>).
		593
		594	=cut
		595
		596	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		597
		598	&_eq_initialise ($INTERRUPT->signal_func);
		599
		600	=item $OpenCL::WATCHER
		601
		602	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		603	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		604	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		605
		606	=cut
		607
		608	our $WATCHER;
		609
		610	sub _init_anyevent {
		611	$INTERRUPT->block;
		612	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		613	}
		614
		615	if (defined $AnyEvent::MODEL) {
		616	_init_anyevent;
		617	} else {
		618	push @AnyEvent::post_detect, \&_init_anyevent;
		619	}
		620
425	=back	621	=back
426		622
		623	=head2 THE OpenCL::Object CLASS
		624
		625	This is the base class for all objects in the OpenCL module. The only
		626	method it implements is the C<id> method, which is only useful if you want
		627	to interface to OpenCL on the C level.
		628
		629	=over 4
		630
		631	=item $iv = $obj->id
		632
		633	OpenCL objects are represented by pointers or integers on the C level. If
		634	you want to interface to an OpenCL object directly on the C level, then
		635	you need this value, which is returned by this method. You should use an
		636	C<IV> type in your code and cast that to the correct type.
		637
		638	=cut
		639
		640	sub OpenCL::Object::id {
		641	ref $_[0] eq "SCALAR"
		642	? ${ $_[0] }
		643	: $_[0][0]
		644	}
		645
		646	=back
		647
427	=head2 THE OpenCL::Platform CLASS	648	=head2 THE OpenCL::Platform CLASS
428		649
429	=over 4	650	=over 4
430		651
431	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	652	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
432		653
433	Returns a list of matching OpenCL::Device objects.	654	Returns a list of matching OpenCL::Device objects.
434		655
435	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	656	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
436		657
437	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	658	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
438		659
439	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	660	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
440		661
441	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)	662	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
442		663
443	Create a new OpenCL::Context object using the given device object(s)- a	664	Create a new OpenCL::Context object using the given device object(s)- a
444	CL_CONTEXT_PLATFORM property is supplied automatically.	665	CL_CONTEXT_PLATFORM property is supplied automatically.
445		666
446	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	667	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
454	It's best to avoid this method and use one of the following convenience	675	It's best to avoid this method and use one of the following convenience
455	wrappers.	676	wrappers.
456		677
457	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	678	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
458		679
		680	=item $platform->unload_compiler
		681
		682	Attempts to unload the compiler for this platform, for endless
		683	profit. Does nothing on OpenCL 1.1.
		684
		685	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		686
459	=for gengetinfo begin platform	687	=for gengetinfo begin platform
460		688
461	=item $string = $platform->profile	689	=item $string = $platform->profile
462		690
463	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	691	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
…		…
748		976
749	=item @device_partition_property_exts = $device->affinity_domains_ext	977	=item @device_partition_property_exts = $device->affinity_domains_ext
750		978
751	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	979	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
752		980
753	=item $uint = $device->reference_count_ext	981	=item $uint = $device->reference_count_ext
754		982
755	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.	983	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
756		984
757	=item @device_partition_property_exts = $device->partition_style_ext	985	=item @device_partition_property_exts = $device->partition_style_ext
758		986
759	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	987	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
760		988
…		…
764		992
765	=head2 THE OpenCL::Context CLASS	993	=head2 THE OpenCL::Context CLASS
766		994
767	=over 4	995	=over 4
768		996
		997	=item $prog = $ctx->build_program ($program, $options = "")
		998
		999	This convenience function tries to build the program on all devices in
		1000	the context. If the build fails, then the function will C<croak> with the
		1001	build log. Otherwise ti returns the program object.
		1002
		1003	The C<$program> can either be a C<OpenCL::Program> object or a string
		1004	containing the program. In the latter case, a program objetc will be
		1005	created automatically.
		1006
		1007	=cut
		1008
		1009	sub OpenCL::Context::build_program {
		1010	my ($self, $prog, $options) = @_;
		1011
		1012	$prog = $self->program_with_source ($prog)
		1013	unless ref $prog;
		1014
		1015	eval { $prog->build (undef, $options); 1 }
		1016	or errno == BUILD_PROGRAM_FAILURE
		1017	or errno == INVALID_BINARY # workaround nvidia bug
		1018	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1019
		1020	# we check status for all devices
		1021	for my $dev ($self->devices) {
		1022	$prog->build_status ($dev) == BUILD_SUCCESS
		1023	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1024	. $prog->build_log ($dev);
		1025	}
		1026
		1027	$prog
		1028	}
		1029
769	=item $queue = $ctx->queue ($device, $properties)	1030	=item $queue = $ctx->queue ($device, $properties)
770		1031
771	Create a new OpenCL::Queue object from the context and the given device.	1032	Create a new OpenCL::Queue object from the context and the given device.
772		1033
773	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	1034	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
		1035
		1036	Example: create an out-of-order queue.
		1037
		1038	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
774		1039
775	=item $ev = $ctx->user_event	1040	=item $ev = $ctx->user_event
776		1041
777	Creates a new OpenCL::UserEvent object.	1042	Creates a new OpenCL::UserEvent object.
778		1043
…		…
788	=item $buf = $ctx->buffer_sv ($flags, $data)	1053	=item $buf = $ctx->buffer_sv ($flags, $data)
789		1054
790	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1055	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
791	initialise it with the given data values.	1056	initialise it with the given data values.
792		1057
		1058	=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)
		1059
		1060	Creates a new OpenCL::Image object and optionally initialises it with
		1061	the given data values.
		1062
		1063	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
		1064
793	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1065	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
794		1066
795	Creates a new OpenCL::Image2D object and optionally initialises it with	1067	Creates a new OpenCL::Image2D object and optionally initialises it with
796	the given data values.	1068	the given data values.
797		1069
…		…
809	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1081	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
810	OpenGL buffer object.	1082	OpenGL buffer object.
811		1083
812	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1084	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
813		1085
		1086	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		1087
		1088	Creates a new OpenCL::Image object that refers to the given OpenGL
		1089	texture object or buffer.
		1090
		1091	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		1092
814	=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1093	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
815		1094
816	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1095	Creates a new OpenCL::Image2D object that refers to the given OpenGL
817	2D texture object.	1096	2D texture object.
818		1097
819	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html	1098	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
820		1099
821	=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)	1100	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
822		1101
823	Creates a new OpenCL::Image3D object that refers to the given OpenGL	1102	Creates a new OpenCL::Image3D object that refers to the given OpenGL
824	3D texture object.	1103	3D texture object.
825		1104
826	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html	1105	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
…		…
880	=back	1159	=back
881		1160
882	=head2 THE OpenCL::Queue CLASS	1161	=head2 THE OpenCL::Queue CLASS
883		1162
884	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1163	An OpenCL::Queue represents an execution queue for OpenCL. You execute
885	requests by calling their respective C<enqueue_xxx> method and waitinf for	1164	requests by calling their respective method and waiting for it to complete
886	it to complete in some way.	1165	in some way.
887		1166
888	All the enqueue methods return an event object that can be used to wait	1167	Most methods that enqueue some request return an event object that can
889	for completion, unless the method is called in void context, in which case	1168	be used to wait for completion (optionally using a callback), unless
890	no event object is created.	1169	the method is called in void context, in which case no event object is
		1170	created.
891		1171
892	They also allow you to specify any number of other event objects that this	1172	They also allow you to specify any number of other event objects that this
893	request has to wait for before it starts executing, by simply passing the	1173	request has to wait for before it starts executing, by simply passing the
894	event objects as extra parameters to the enqueue methods.	1174	event objects as extra parameters to the enqueue methods. To simplify
		1175	program design, this module ignores any C<undef> values in the list of
		1176	events. This makes it possible to code operations such as this, without
		1177	having to put a valid event object into C<$event> first:
		1178
		1179	$event = $queue->xxx (..., $event);
895		1180
896	Queues execute in-order by default, without any parallelism, so in most	1181	Queues execute in-order by default, without any parallelism, so in most
897	cases (i.e. you use only one queue) it's not necessary to wait for or	1182	cases (i.e. you use only one queue) it's not necessary to wait for or
898	create event objects.	1183	create event objects, althoguh an our of order queue is often a bit
		1184	faster.
899		1185
900	=over 4	1186	=over 4
901		1187
902	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1188	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
903		1189
904	Reads data from buffer into the given string.	1190	Reads data from buffer into the given string.
905		1191
906	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1192	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
907		1193
908	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1194	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
909		1195
910	Writes data to buffer from the given string.	1196	Writes data to buffer from the given string.
911		1197
912	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1198	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
913		1199
914	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1200	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
915		1201
916	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1202	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
917		1203
918	=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...)	1204	=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...)
919		1205
920	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1206	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
921		1207
922	=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...)	1208	=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...)
923		1209
924	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1210	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
925		1211
926	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1212	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
927		1213
928	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
929		1215
930	=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...)	1216	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
931		1217
932	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
933		1219
934	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1220	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
935		1221
936	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1222	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
937		1223
938	=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...)	1224	=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...)
939		1225
940	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1226	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
941		1227
942	=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...)	1228	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
943		1229
944	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1230	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
945		1231
946	=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...)	1232	=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...)
947		1233
948	Yeah.	1234	Yeah.
949		1235
950	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1236	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
951		1237
		1238	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
		1239
		1240	Fills the given buffer object with repeated applications of C<$pattern>,
		1241	starting at C<$offset> for C<$size> octets.
		1242
		1243	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1244
		1245	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1246
		1247	Fills the given image area with the given rgba colour components. The
		1248	components are normally floating point values between C<0> and C<1>,
		1249	except when the image channel data type is a signe dor unsigned
		1250	unnormalised format, in which case the range is determined by the format.
		1251
		1252	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
		1253
952	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1254	=item $ev = $queue->task ($kernel, $wait_events...)
953		1255
954	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1256	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
955		1257
956	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1258	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
957		1259
958	Enqueues a kernel execution.	1260	Enqueues a kernel execution.
959		1261
960	@$global_work_size must be specified as a reference to an array of	1262	\@global_work_size must be specified as a reference to an array of
961	integers specifying the work sizes (element counts).	1263	integers specifying the work sizes (element counts).
962		1264
963	@$global_work_offset must be either C<undef> (in which case all offsets	1265	\@global_work_offset must be either C<undef> (in which case all offsets
964	are C<0>), or a reference to an array of work offsets, with the same number	1266	are C<0>), or a reference to an array of work offsets, with the same number
965	of elements as @$global_work_size.	1267	of elements as \@global_work_size.
966		1268
967	@$local_work_size must be either C<undef> (in which case the	1269	\@local_work_size must be either C<undef> (in which case the
968	implementation is supposed to choose good local work sizes), or a	1270	implementation is supposed to choose good local work sizes), or a
969	reference to an array of local work sizes, with the same number of	1271	reference to an array of local work sizes, with the same number of
970	elements as @$global_work_size.	1272	elements as \@global_work_size.
971		1273
972	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1274	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
973		1275
974	=item $ev = $queue->enqueue_marker ($wait_events...)
975
976	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
977
978	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1276	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
979		1277
980	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1278	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
981	for subsequent OpenCL usage.	1279	for subsequent OpenCL usage.
982		1280
983	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1281	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
984		1282
985	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1283	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
986		1284
987	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1285	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
988	for subsequent OpenGL usage.	1286	for subsequent OpenGL usage.
989		1287
990	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
991		1289
992	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1290	=item $ev = $queue->wait_for_events ($wait_events...)
993		1291
994	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1292	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
995		1293
996	=item $queue->enqueue_barrier	1294	=item $ev = $queue->marker ($wait_events...)
997		1295
		1296	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1297
		1298	=item $ev = $queue->barrier ($wait_events...)
		1299
998	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1300	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
999		1301
1000	=item $queue->flush	1302	=item $queue->flush
1001		1303
1002	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1304	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
1003		1305
…		…
1118		1420
1119	=back	1421	=back
1120		1422
1121	=head2 THE OpenCL::Image CLASS	1423	=head2 THE OpenCL::Image CLASS
1122		1424
1123	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.	1425	This is the superclass of all image objects - OpenCL::Image1D,
		1426	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1427	OpenCL::Image2DArray and OpenCL::Image3D.
1124		1428
1125	=over 4	1429	=over 4
1126		1430
1127	=item $packed_value = $ev->image_info ($name)	1431	=item $packed_value = $image->image_info ($name)
1128		1432
1129	See C<< $platform->info >> for details.	1433	See C<< $platform->info >> for details.
1130		1434
1131	The reason this method is not called C<info> is that there already is an	1435	The reason this method is not called C<info> is that there already is an
1132	C<< ->info >> method inherited from C<OpenCL::Memory>.	1436	C<< ->info >> method inherited from C<OpenCL::Memory>.
1133		1437
1134	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1438	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1135		1439
		1440	=item ($channel_order, $channel_data_type) = $image->format
		1441
		1442	Returns the channel order and type used to create the image by calling
		1443	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1444
1136	=for gengetinfo begin image	1445	=for gengetinfo begin image
1137		1446
1138	=item $int = $image->element_size	1447	=item $int = $image->element_size
1139		1448
1140	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1449	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
…		…
1213		1522
1214	=head2 THE OpenCL::Program CLASS	1523	=head2 THE OpenCL::Program CLASS
1215		1524
1216	=over 4	1525	=over 4
1217		1526
1218	=item $program->build ($device, $options = "")	1527	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1219		1528
1220	Tries to build the program with the givne options.	1529	Tries to build the program with the given options. See also the
		1530	C<$ctx->build> convenience function.
		1531
		1532	If a callback is specified, then it will be called when compilation is
		1533	finished. Note that many OpenCL implementations block your program while
		1534	compiling whether you use a callback or not. See C<build_async> if you
		1535	want to make sure the build is done in the background.
		1536
		1537	Note that some OpenCL implementations act up badly, and don't call the
		1538	callback in some error cases (but call it in others). This implementation
		1539	assumes the callback will always be called, and leaks memory if this is
		1540	not so. So best make sure you don't pass in invalid values.
		1541
		1542	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1543	compilation state is successful but some later stage fails.
1221		1544
1222	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1545	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1546
		1547	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1548
		1549	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1550	need to check the compilation status form the callback, or by polling).
1223		1551
1224	=item $packed_value = $program->build_info ($device, $name)	1552	=item $packed_value = $program->build_info ($device, $name)
1225		1553
1226	Similar to C<< $platform->info >>, but returns build info for a previous	1554	Similar to C<< $platform->info >>, but returns build info for a previous
1227	build attempt for the given device.	1555	build attempt for the given device.
…		…
1232		1560
1233	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1561	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1234	the program.	1562	the program.
1235		1563
1236	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1564	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
		1565
		1566	=item @kernels = $program->kernels_in_program
		1567
		1568	Returns all kernels successfully compiled for all devices in program.
		1569
		1570	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1237		1571
1238	=for gengetinfo begin program_build	1572	=for gengetinfo begin program_build
1239		1573
1240	=item $build_status = $program->build_status ($device)	1574	=item $build_status = $program->build_status ($device)
1241		1575
…		…
1363		1697
1364	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1698	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1365		1699
1366	=for gengetinfo end kernel_work_group	1700	=for gengetinfo end kernel_work_group
1367		1701
		1702	=item $kernel->setf ($format, ...)
		1703
		1704	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1705	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1706	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1707	what type of argument it is.
		1708
		1709	The format arguments are single letters:
		1710
		1711	c char
		1712	C unsigned char
		1713	s short
		1714	S unsigned short
		1715	i int
		1716	I unsigned int
		1717	l long
		1718	L unsigned long
		1719
		1720	h half float (0..65535)
		1721	f float
		1722	d double
		1723
		1724	z local (octet size)
		1725
		1726	m memory object (buffer or image)
		1727	a sampler
		1728	e event
		1729
		1730	Space characters in the format string are ignored.
		1731
		1732	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1733
		1734	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1735
1368	=item $kernel->set_TYPE ($index, $value)	1736	=item $kernel->set_TYPE ($index, $value)
1369		1737
		1738	=item $kernel->set_char ($index, $value)
		1739
		1740	=item $kernel->set_uchar ($index, $value)
		1741
		1742	=item $kernel->set_short ($index, $value)
		1743
		1744	=item $kernel->set_ushort ($index, $value)
		1745
		1746	=item $kernel->set_int ($index, $value)
		1747
		1748	=item $kernel->set_uint ($index, $value)
		1749
		1750	=item $kernel->set_long ($index, $value)
		1751
		1752	=item $kernel->set_ulong ($index, $value)
		1753
		1754	=item $kernel->set_half ($index, $value)
		1755
		1756	=item $kernel->set_float ($index, $value)
		1757
		1758	=item $kernel->set_double ($index, $value)
		1759
		1760	=item $kernel->set_memory ($index, $value)
		1761
		1762	=item $kernel->set_buffer ($index, $value)
		1763
		1764	=item $kernel->set_image ($index, $value)
		1765
		1766	=item $kernel->set_sampler ($index, $value)
		1767
		1768	=item $kernel->set_local ($index, $value)
		1769
		1770	=item $kernel->set_event ($index, $value)
		1771
1370	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1772	This is a family of methods to set the kernel argument with the number
1371		1773	C<$index> to the give C<$value>.
1372	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1373	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1374	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1375		1774
1376	Chars and integers (including the half type) are specified as integers,	1775	Chars and integers (including the half type) are specified as integers,
1377	float and double as floating point values, memory/buffer/image2d/image3d	1776	float and double as floating point values, memory/buffer/image must be
1378	must be an object of that type or C<undef>, local-memory arguments are	1777	an object of that type or C<undef>, local-memory arguments are set by
1379	set by specifying the size, and sampler and event must be objects of that	1778	specifying the size, and sampler and event must be objects of that type.
1380	type.	1779
		1780	Note that C<set_memory> works for all memory objects (all types of buffers
		1781	and images) - the main purpose of the more specific C<set_TYPE> functions
		1782	is type checking.
		1783
		1784	Setting an argument for a kernel does NOT keep a reference to the object -
		1785	for example, if you set an argument to some image object, free the image,
		1786	and call the kernel, you will run into undefined behaviour.
1381		1787
1382	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1788	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1383		1789
1384	=back	1790	=back
1385		1791
…		…
1394		1800
1395	Waits for the event to complete.	1801	Waits for the event to complete.
1396		1802
1397	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1803	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1398		1804
		1805	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1806
		1807	Adds a callback to the callback stack for the given event type. There is
		1808	no way to remove a callback again.
		1809
		1810	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1811
1399	=item $packed_value = $ev->info ($name)	1812	=item $packed_value = $ev->info ($name)
1400		1813
1401	See C<< $platform->info >> for details.	1814	See C<< $platform->info >> for details.
1402		1815
1403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1816	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
…		…
1463		1876
1464	=over 4	1877	=over 4
1465		1878
1466	=item $ev->set_status ($execution_status)	1879	=item $ev->set_status ($execution_status)
1467		1880
		1881	Sets the execution status of the user event. Can only be called once,
		1882	either with OpenCL::COMPLETE or a negative number as status.
		1883
1468	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1884	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1469		1885
1470	=back	1886	=back
1471		1887
1472	=cut	1888	=cut
1473
1474	package OpenCL;
1475
1476	use common::sense;
1477
1478	BEGIN {
1479	our $VERSION = '0.95';
1480
1481	require XSLoader;
1482	XSLoader::load (__PACKAGE__, $VERSION);
1483
1484	@OpenCL::Buffer::ISA =
1485	@OpenCL::Image::ISA = OpenCL::Memory::;
1486
1487	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1488
1489	@OpenCL::Image2D::ISA =
1490	@OpenCL::Image3D::ISA = OpenCL::Image::;
1491
1492	@OpenCL::UserEvent::ISA = OpenCL::Event::;
1493	}
1494		1889
1495	1;	1890	1;
1496		1891
1497	=head1 AUTHOR	1892	=head1 AUTHOR
1498		1893

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.42 by root, Fri Apr 20 11:05:46 2012 UTC vs. Revision 1.64 by root, Mon Apr 30 23:12:43 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.42 by root, Fri Apr 20 11:05:46 2012 UTC vs.
Revision 1.64 by root, Mon Apr 30 23:12:43 2012 UTC