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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.37 by root, Thu Apr 19 14:36:46 2012 UTC vs.
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC

…		…
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
…		…
275		365
276	=head2 GLX SUPPORT	366	=head2 GLX SUPPORT
277		367
278	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL	368	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
279	module, which has little to no documentation and has little to no support	369	module, which has little to no documentation and has little to no support
280	for glx), this module, as a special extension, treats context creation	370	for glX), this module, as a special extension, treats context creation
281	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>	371	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
282	specially: If either or both of these are C<undef>, then the OpenCL	372	specially: If either or both of these are C<undef>, then the OpenCL
283	module tries to dynamically resolve C<glxGetCurrentDisplay> and	373	module tries to dynamically resolve C<glXGetCurrentDisplay> and
284	C<glxGetCurrentContext>, call these functions and use their return values	374	C<glXGetCurrentContext>, call these functions and use their return values
285	instead.	375	instead.
286		376
287	For this to work, the OpenGL library must be loaded, a GLX context must	377	For this to work, the OpenGL library must be loaded, a GLX context must
288	have been created and be made current, and C<dlsym> must be available and	378	have been created and be made current, and C<dlsym> must be available and
289	capable of finding the function via C<RTLD_DEFAULT>.	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	}
290		529
291	=head2 THE OpenCL PACKAGE	530	=head2 THE OpenCL PACKAGE
292		531
293	=over 4	532	=over 4
294		533
…		…
313		552
314	Returns all available OpenCL::Platform objects.	553	Returns all available OpenCL::Platform objects.
315		554
316	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>
317		556
318	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	557	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
319		558
320	Tries to create a context from a default device and platform - never worked for me.	559	Tries to create a context from a default device and platform type - never worked for me.
321		560
322	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>
323		562
		563	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		564
		565	Create a new OpenCL::Context object using the given device object(s). This
		566	function isn't implemented yet, use C<< $platform->context >> instead.
		567
		568	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		569
324	=item OpenCL::wait_for_events $wait_events...	570	=item OpenCL::wait_for_events $wait_events...
325		571
326	Waits for all events to complete.	572	Waits for all events to complete.
327		573
328	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	574	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
329		575
		576	=item OpenCL::poll
		577
		578	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		579	invokes their callbacks.
		580
		581	=item $OpenCL::INTERRUPT
		582
		583	The L<Async::Interrupt> object used to signal asynchronous events (see
		584	L<EVENT SYSTEM>).
		585
		586	=cut
		587
		588	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		589
		590	&_eq_initialise ($INTERRUPT->signal_func);
		591
		592	=item $OpenCL::WATCHER
		593
		594	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		595	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		596	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		597
		598	=cut
		599
		600	our $WATCHER;
		601
		602	sub _init_anyevent {
		603	$INTERRUPT->block;
		604	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		605	}
		606
		607	if (defined $AnyEvent::MODEL) {
		608	_init_anyevent;
		609	} else {
		610	push @AnyEvent::post_detect, \&_init_anyevent;
		611	}
		612
330	=back	613	=back
331		614
		615	=head2 THE OpenCL::Object CLASS
		616
		617	This is the base class for all objects in the OpenCL module. The only
		618	method it implements is the C<id> method, which is only useful if you want
		619	to interface to OpenCL on the C level.
		620
		621	=over 4
		622
		623	=item $iv = $obj->id
		624
		625	OpenCL objects are represented by pointers or integers on the C level. If
		626	you want to interface to an OpenCL object directly on the C level, then
		627	you need this value, which is returned by this method. You should use an
		628	C<IV> type in your code and cast that to the correct type.
		629
		630	=cut
		631
		632	sub OpenCL::Object::id {
		633	ref $_[0] eq "SCALAR"
		634	? ${ $_[0] }
		635	: $_[0][0]
		636	}
		637
		638	=back
		639
332	=head2 THE OpenCL::Platform CLASS	640	=head2 THE OpenCL::Platform CLASS
333		641
334	=over 4	642	=over 4
335		643
336	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	644	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
337		645
338	Returns a list of matching OpenCL::Device objects.	646	Returns a list of matching OpenCL::Device objects.
339		647
340	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	648	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
341		649
342	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	650	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
343		651
344	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	652	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
345		653
346	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)	654	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
347		655
348	Create a new OpenCL::Context object using the given device object(s)- a	656	Create a new OpenCL::Context object using the given device object(s)- a
349	CL_CONTEXT_PLATFORM property is supplied automatically.	657	CL_CONTEXT_PLATFORM property is supplied automatically.
350		658
351	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	659	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
359	It's best to avoid this method and use one of the following convenience	667	It's best to avoid this method and use one of the following convenience
360	wrappers.	668	wrappers.
361		669
362	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	670	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
363		671
		672	=item $platform->unload_compiler
		673
		674	Attempts to unload the compiler for this platform, for endless
		675	profit. Does nothing on OpenCL 1.1.
		676
		677	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		678
364	=for gengetinfo begin platform	679	=for gengetinfo begin platform
365		680
366	=item $string = $platform->profile	681	=item $string = $platform->profile
367		682
368	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	683	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
…		…
653		968
654	=item @device_partition_property_exts = $device->affinity_domains_ext	969	=item @device_partition_property_exts = $device->affinity_domains_ext
655		970
656	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	971	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
657		972
658	=item $uint = $device->reference_count_ext	973	=item $uint = $device->reference_count_ext
659		974
660	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.	975	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
661		976
662	=item @device_partition_property_exts = $device->partition_style_ext	977	=item @device_partition_property_exts = $device->partition_style_ext
663		978
664	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	979	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
665		980
…		…
669		984
670	=head2 THE OpenCL::Context CLASS	985	=head2 THE OpenCL::Context CLASS
671		986
672	=over 4	987	=over 4
673		988
		989	=item $prog = $ctx->build_program ($program, $options = "")
		990
		991	This convenience function tries to build the program on all devices in
		992	the context. If the build fails, then the function will C<croak> with the
		993	build log. Otherwise ti returns the program object.
		994
		995	The C<$program> can either be a C<OpenCL::Program> object or a string
		996	containing the program. In the latter case, a program objetc will be
		997	created automatically.
		998
		999	=cut
		1000
		1001	sub OpenCL::Context::build_program {
		1002	my ($self, $prog, $options) = @_;
		1003
		1004	require Carp;
		1005
		1006	$prog = $self->program_with_source ($prog)
		1007	unless ref $prog;
		1008
		1009	# we build separately per device so we instantly know which one failed
		1010	for my $dev ($self->devices) {
		1011	eval { $prog->build ([$dev], $options); 1 }
		1012	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1013	. $prog->build_log ($dev));
		1014	}
		1015
		1016	$prog
		1017	}
		1018
674	=item $queue = $ctx->queue ($device, $properties)	1019	=item $queue = $ctx->queue ($device, $properties)
675		1020
676	Create a new OpenCL::Queue object from the context and the given device.	1021	Create a new OpenCL::Queue object from the context and the given device.
677		1022
678	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	1023	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
		1024
		1025	Example: create an out-of-order queue.
		1026
		1027	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
679		1028
680	=item $ev = $ctx->user_event	1029	=item $ev = $ctx->user_event
681		1030
682	Creates a new OpenCL::UserEvent object.	1031	Creates a new OpenCL::UserEvent object.
683		1032
…		…
693	=item $buf = $ctx->buffer_sv ($flags, $data)	1042	=item $buf = $ctx->buffer_sv ($flags, $data)
694		1043
695	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1044	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
696	initialise it with the given data values.	1045	initialise it with the given data values.
697		1046
		1047	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
		1048
		1049	Creates a new OpenCL::Image object and optionally initialises it with
		1050	the given data values.
		1051
		1052	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
		1053
698	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1054	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
699		1055
700	Creates a new OpenCL::Image2D object and optionally initialises it with	1056	Creates a new OpenCL::Image2D object and optionally initialises it with
701	the given data values.	1057	the given data values.
702		1058
…		…
714	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1070	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
715	OpenGL buffer object.	1071	OpenGL buffer object.
716		1072
717	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1073	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
718		1074
		1075	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		1076
		1077	Creates a new OpenCL::Image object that refers to the given OpenGL
		1078	texture object or buffer.
		1079
		1080	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		1081
719	=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1082	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
720		1083
721	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1084	Creates a new OpenCL::Image2D object that refers to the given OpenGL
722	2D texture object.	1085	2D texture object.
723		1086
724	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html	1087	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
725		1088
726	=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)	1089	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
727		1090
728	Creates a new OpenCL::Image3D object that refers to the given OpenGL	1091	Creates a new OpenCL::Image3D object that refers to the given OpenGL
729	3D texture object.	1092	3D texture object.
730		1093
731	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html	1094	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
…		…
794	for completion, unless the method is called in void context, in which case	1157	for completion, unless the method is called in void context, in which case
795	no event object is created.	1158	no event object is created.
796		1159
797	They also allow you to specify any number of other event objects that this	1160	They also allow you to specify any number of other event objects that this
798	request has to wait for before it starts executing, by simply passing the	1161	request has to wait for before it starts executing, by simply passing the
799	event objects as extra parameters to the enqueue methods.	1162	event objects as extra parameters to the enqueue methods. To simplify
		1163	program design, this module ignores any C<undef> values in the list of
		1164	events. This makes it possible to code operations such as this, without
		1165	having to put a valid event object into C<$event> first:
		1166
		1167	$event = $queue->enqueue_xxx (..., $event);
800		1168
801	Queues execute in-order by default, without any parallelism, so in most	1169	Queues execute in-order by default, without any parallelism, so in most
802	cases (i.e. you use only one queue) it's not necessary to wait for or	1170	cases (i.e. you use only one queue) it's not necessary to wait for or
803	create event objects.	1171	create event objects, althoguh an our of order queue is often a bit
		1172	faster.
804		1173
805	=over 4	1174	=over 4
806		1175
807	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1176	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
808		1177
…		…
851	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)	1220	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
852		1221
853	Yeah.	1222	Yeah.
854		1223
855	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1224	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
		1225
		1226	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
		1227
		1228	Fills the given buffer object with repeated applications of C<$pattern>,
		1229	starting at C<$offset> for C<$size> octets.
		1230
		1231	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1232
		1233	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1234
		1235	Fills the given image area with the given rgba colour components. The
		1236	components are normally floating point values between C<0> and C<1>,
		1237	except when the image channel data type is a signe dor unsigned
		1238	unnormalised format, in which case the range is determined by the format.
		1239
		1240	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
856		1241
857	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1242	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
858		1243
859	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1244	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
860		1245
…		…
874	reference to an array of local work sizes, with the same number of	1259	reference to an array of local work sizes, with the same number of
875	elements as @$global_work_size.	1260	elements as @$global_work_size.
876		1261
877	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
878		1263
879	=item $ev = $queue->enqueue_marker ($wait_events...)
880
881	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
882
883	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1264	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
884		1265
885	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1266	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
886	for subsequent OpenCL usage.	1267	for subsequent OpenCL usage.
887		1268
…		…
896		1277
897	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1278	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
898		1279
899	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1280	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
900		1281
901	=item $queue->enqueue_barrier	1282	=item $ev = $queue->enqueue_marker ($wait_events...)
902		1283
		1284	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1285
		1286	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1287
903	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
904		1289
905	=item $queue->flush	1290	=item $queue->flush
906		1291
907	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1292	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
908		1293
…		…
1023		1408
1024	=back	1409	=back
1025		1410
1026	=head2 THE OpenCL::Image CLASS	1411	=head2 THE OpenCL::Image CLASS
1027		1412
1028	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.	1413	This is the superclass of all image objects - OpenCL::Image1D,
		1414	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1415	OpenCL::Image2DArray and OpenCL::Image3D.
1029		1416
1030	=over 4	1417	=over 4
1031		1418
1032	=item $packed_value = $ev->image_info ($name)	1419	=item $packed_value = $image->image_info ($name)
1033		1420
1034	See C<< $platform->info >> for details.	1421	See C<< $platform->info >> for details.
1035		1422
1036	The reason this method is not called C<info> is that there already is an	1423	The reason this method is not called C<info> is that there already is an
1037	C<< ->info >> method inherited from C<OpenCL::Memory>.	1424	C<< ->info >> method inherited from C<OpenCL::Memory>.
1038		1425
1039	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1426	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1040		1427
		1428	=item ($channel_order, $channel_data_type) = $image->format
		1429
		1430	Returns the channel order and type used to create the image by calling
		1431	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1432
1041	=for gengetinfo begin image	1433	=for gengetinfo begin image
1042		1434
1043	=item $int = $image->element_size	1435	=item $int = $image->element_size
1044		1436
1045	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1437	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
…		…
1118		1510
1119	=head2 THE OpenCL::Program CLASS	1511	=head2 THE OpenCL::Program CLASS
1120		1512
1121	=over 4	1513	=over 4
1122		1514
1123	=item $program->build ($device, $options = "")	1515	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1124		1516
1125	Tries to build the program with the givne options.	1517	Tries to build the program with the given options. See also the
		1518	C<$ctx->build> convenience function.
		1519
		1520	If a callback is specified, then it will be called when compilation is
		1521	finished. Note that many OpenCL implementations block your program while
		1522	compiling whether you use a callback or not. See C<build_async> if you
		1523	want to make sure the build is done in the background.
		1524
		1525	Note that some OpenCL implementations atc up badly, and don't call the
		1526	callback in some error cases (but call it in others). This implementation
		1527	assumes the callback will always be called, and leaks memory if this is
		1528	not so. So best make sure you don't pass in invalid values.
1126		1529
1127	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1531
		1532	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1533
		1534	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1535	need to check the compilation status form the callback, or by polling).
1128		1536
1129	=item $packed_value = $program->build_info ($device, $name)	1537	=item $packed_value = $program->build_info ($device, $name)
1130		1538
1131	Similar to C<< $platform->info >>, but returns build info for a previous	1539	Similar to C<< $platform->info >>, but returns build info for a previous
1132	build attempt for the given device.	1540	build attempt for the given device.
…		…
1137		1545
1138	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1546	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1139	the program.	1547	the program.
1140		1548
1141	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1549	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
		1550
		1551	=item @kernels = $program->kernels_in_program
		1552
		1553	Returns all kernels successfully compiled for all devices in program.
		1554
		1555	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1142		1556
1143	=for gengetinfo begin program_build	1557	=for gengetinfo begin program_build
1144		1558
1145	=item $build_status = $program->build_status ($device)	1559	=item $build_status = $program->build_status ($device)
1146		1560
…		…
1274		1688
1275	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1689	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1276		1690
1277	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,	1691	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1278	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,	1692	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1279	C<image2d>, C<image3d>, C<sampler> or C<event>.	1693	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1280		1694
1281	Chars and integers (including the half type) are specified as integers,	1695	Chars and integers (including the half type) are specified as integers,
1282	float and double as floating point values, memory/buffer/image2d/image3d	1696	float and double as floating point values, memory/buffer/image2d/image3d
1283	must be an object of that type or C<undef>, and sampler and event must be	1697	must be an object of that type or C<undef>, local-memory arguments are
1284	objects of that type.	1698	set by specifying the size, and sampler and event must be objects of that
		1699	type.
		1700
		1701	Setting an argument for a kernel does NOT keep a reference to the object -
		1702	for example, if you set an argument to some image object, free the image,
		1703	and call the kernel, you will run into undefined behaviour.
1285		1704
1286	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1705	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1287		1706
1288	=back	1707	=back
1289		1708
…		…
1298		1717
1299	Waits for the event to complete.	1718	Waits for the event to complete.
1300		1719
1301	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1720	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1302		1721
		1722	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1723
		1724	Adds a callback to the callback stack for the given event type. There is
		1725	no way to remove a callback again.
		1726
		1727	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1728
1303	=item $packed_value = $ev->info ($name)	1729	=item $packed_value = $ev->info ($name)
1304		1730
1305	See C<< $platform->info >> for details.	1731	See C<< $platform->info >> for details.
1306		1732
1307	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1733	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
…		…
1367		1793
1368	=over 4	1794	=over 4
1369		1795
1370	=item $ev->set_status ($execution_status)	1796	=item $ev->set_status ($execution_status)
1371		1797
		1798	Sets the execution status of the user event. Can only be called once,
		1799	either with OpenCL::COMPLETE or a negative number as status.
		1800
1372	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1801	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1373		1802
1374	=back	1803	=back
1375		1804
1376	=cut	1805	=cut
1377
1378	package OpenCL;
1379
1380	use common::sense;
1381
1382	BEGIN {
1383	our $VERSION = '0.92';
1384
1385	require XSLoader;
1386	XSLoader::load (__PACKAGE__, $VERSION);
1387
1388	@OpenCL::Buffer::ISA =
1389	@OpenCL::Image::ISA = OpenCL::Memory::;
1390
1391	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1392
1393	@OpenCL::Image2D::ISA =
1394	@OpenCL::Image3D::ISA = OpenCL::Image::;
1395
1396	@OpenCL::UserEvent::ISA = OpenCL::Event::;
1397	}
1398		1806
1399	1;	1807	1;
1400		1808
1401	=head1 AUTHOR	1809	=head1 AUTHOR
1402		1810

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.37 by root, Thu Apr 19 14:36:46 2012 UTC vs. Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.37 by root, Thu Apr 19 14:36:46 2012 UTC vs.
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC