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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.28 by root, Sat Dec 10 23:07:38 2011 UTC vs.
Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC

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

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.28 by root, Sat Dec 10 23:07:38 2011 UTC vs. Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.28 by root, Sat Dec 10 23:07:38 2011 UTC vs.
Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC