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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.30 by root, Thu Apr 5 10:08:59 2012 UTC vs.
Revision 1.61 by root, Sat Apr 28 13:31:40 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.
152		155
153	my $src = '	156	my $src = '
154	__kernel void	157	kernel void
155	squareit (__global float input, __global float output)	158	squareit (global float input, global float output)
156	{	159	{
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); 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;
		213
		214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
		215	set tunnel effect.
		216
		217	This is quite a long example to get you going.
		218
		219	use OpenGL ":all";
		220	use OpenCL;
		221
		222	# open a window and create a gl texture
		223	OpenGL::glpOpenWindow width => 256, height => 256;
		224	my $texid = glGenTextures_p 1;
		225	glBindTexture GL_TEXTURE_2D, $texid;
		226	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
		227
		228	# find and use the first opencl device that let's us get a shared opengl context
		229	my $platform;
		230	my $dev;
		231	my $ctx;
		232
		233	for (OpenCL::platforms) {
		234	$platform = $_;
		235	for ($platform->devices) {
		236	$dev = $_;
		237	$ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
		238	and last;
		239	}
		240	}
		241
		242	$ctx
		243	or die "cannot find suitable OpenCL device\n";
		244
		245	my $queue = $ctx->queue ($dev);
		246
		247	# now attach an opencl image2d object to the opengl texture
		248	my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
		249
		250	# now the boring opencl code
		251	my $src = <<EOF;
		252	kernel void
		253	juliatunnel (write_only image2d_t img, float time)
		254	{
		255	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
		256
		257	float2 m = (float2)(1.f, p.y) / fabs (p.x);
		258	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
		259
		260	float2 z = m;
		261	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
		262
		263	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
		264	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		265
		266	float3 colour = (float3)(z.x, z.y, z.x * z.y);
		267	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
		268	}
		269	EOF
		270
		271	my $prog = $ctx->build_program ($src);
		272	my $kernel = $prog->kernel ("juliatunnel");
		273
		274	# program compiled, kernel ready, now draw and loop
		275
		276	for (my $time; ; ++$time) {
		277	# acquire objects from opengl
		278	$queue->acquire_gl_objects ([$tex]);
		279
		280	# configure and run our kernel
		281	$kernel->set_image2d (0, $tex);
		282	$kernel->set_float (1, $time);
		283	$queue->nd_range_kernel ($kernel, undef, [256, 256], undef);
		284
		285	# release objects to opengl again
		286	$queue->release_gl_objects ([$tex]);
		287
		288	# wait
		289	$queue->finish;
		290
		291	# now draw the texture, the defaults should be all right
		292	glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
		293
		294	glEnable GL_TEXTURE_2D;
		295	glBegin GL_QUADS;
		296	glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
		297	glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
		298	glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
		299	glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
		300	glEnd;
		301
		302	glXSwapBuffers;
		303
		304	select undef, undef, undef, 1/60;
		305	}
215		306
216	=head1 DOCUMENTATION	307	=head1 DOCUMENTATION
217		308
218	=head2 BASIC CONVENTIONS	309	=head2 BASIC CONVENTIONS
219		310
…		…
241	=item * Structures are often specified by flattening out their components	332	=item * Structures are often specified by flattening out their components
242	as with short vectors, and returned as arrayrefs.	333	as with short vectors, and returned as arrayrefs.
243		334
244	=item * When enqueuing commands, the wait list is specified by adding	335	=item * When enqueuing commands, the wait list is specified by adding
245	extra arguments to the function - anywhere a C<$wait_events...> argument	336	extra arguments to the function - anywhere a C<$wait_events...> argument
246	is documented this can be any number of event objects.	337	is documented this can be any number of event objects. As an extsnion
		338	implemented by this module, C<undef> values will be ignored in the event
		339	list.
247		340
248	=item * When enqueuing commands, if the enqueue method is called in void	341	=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	342	context, no event is created. In all other contexts an event is returned
250	by the method.	343	by the method.
251		344
…		…
271	ulong IV - Q	364	ulong IV - Q
272	float NV float f	365	float NV float f
273	half IV ushort S	366	half IV ushort S
274	double NV double d	367	double NV double d
275		368
		369	=head2 GLX SUPPORT
		370
		371	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		372	module, which has little to no documentation and has little to no support
		373	for glX), this module, as a special extension, treats context creation
		374	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		375	specially: If either or both of these are C<undef>, then the OpenCL
		376	module tries to dynamically resolve C<glXGetCurrentDisplay> and
		377	C<glXGetCurrentContext>, call these functions and use their return values
		378	instead.
		379
		380	For this to work, the OpenGL library must be loaded, a GLX context must
		381	have been created and be made current, and C<dlsym> must be available and
		382	capable of finding the function via C<RTLD_DEFAULT>.
		383
		384	=head2 EVENT SYSTEM
		385
		386	OpenCL can generate a number of (potentially) asynchronous events, for
		387	example, after compiling a program, to signal a context-related error or,
		388	perhaps most important, to signal completion of queued jobs (by setting
		389	callbacks on OpenCL::Event objects).
		390
		391	To facilitate this, this module maintains an event queue - each
		392	time an asynchronous event happens, it is queued, and perl will be
		393	interrupted. This is implemented via the L<Async::Interrupt> module. In
		394	addition, this module has L<AnyEvent> support, so it can seamlessly
		395	integrate itself into many event loops.
		396
		397	Since this module is a bit hard to understand, here are some case examples:
		398
		399	=head3 Don't use callbacks.
		400
		401	When your program never uses any callbacks, then there will never be any
		402	notifications you need to take care of, and therefore no need to worry
		403	about all this.
		404
		405	You can achieve a great deal by explicitly waiting for events, or using
		406	barriers and flush calls. In many programs, there is no need at all to
		407	tinker with asynchronous events.
		408
		409	=head3 Use AnyEvent
		410
		411	This module automatically registers a watcher that invokes all outstanding
		412	event callbacks when AnyEvent is initialised (and block asynchronous
		413	interruptions). Using this mode of operations is the safest and most
		414	recommended one.
		415
		416	To use this, simply use AnyEvent and this module normally, make sure you
		417	have an event loop running:
		418
		419	use Gtk2 -init;
		420	use AnyEvent;
		421
		422	# initialise AnyEvent, by creating a watcher, or:
		423	AnyEvent::detect;
		424
		425	my $e = $queue->marker;
		426	$e->cb (sub {
		427	warn "opencl is finished\n";
		428	})
		429
		430	main Gtk2;
		431
		432	Note that this module will not initialise AnyEvent for you. Before
		433	AnyEvent is initialised, the module will asynchronously interrupt perl
		434	instead. To avoid any surprises, it's best to explicitly initialise
		435	AnyEvent.
		436
		437	You can temporarily enable asynchronous interruptions (see next paragraph)
		438	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		439	calling C<$OpenCL::INTERRUPT->block>.
		440
		441	=head3 Let yourself be interrupted at any time
		442
		443	This mode is the default unless AnyEvent is loaded and initialised. In
		444	this mode, OpenCL asynchronously interrupts a running perl program. The
		445	emphasis is on both I<asynchronously> and I<running> here.
		446
		447	Asynchronously means that perl might execute your callbacks at any
		448	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		449	the C<until> loop following the marker call will be interrupted by the
		450	callback:
		451
		452	my $e = $queue->marker;
		453	my $flag;
		454	$e->cb (sub { $flag = 1 });
		455	1 until $flag;
		456	# $flag is now 1
		457
		458	The reason why you shouldn't blindly copy the above code is that
		459	busy waiting is a really really bad thing, and really really bad for
		460	performance.
		461
		462	While at first this asynchronous business might look exciting, it can be
		463	really hard, because you need to be prepared for the callback code to be
		464	executed at any time, which limits the amount of things the callback code
		465	can do safely.
		466
		467	This can be mitigated somewhat by using C<<
		468	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		469	documentation for details).
		470
		471	The other problem is that your program must be actively I<running> to be
		472	interrupted. When you calculate stuff, your program is running. When you
		473	hang in some C functions or other block execution (by calling C<sleep>,
		474	C<select>, running an event loop and so on), your program is waiting, not
		475	running.
		476
		477	One way around that would be to attach a read watcher to your event loop,
		478	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		479	dummy callback (C<sub { }>) to temporarily execute some perl code.
		480
		481	That is then awfully close to using the built-in AnyEvent support above,
		482	though, so consider that one instead.
		483
		484	=head3 Be creative
		485
		486	OpenCL exports the L<Async::Interrupt> object it uses in the global
		487	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		488
		489	So if you want to feel like a real pro, err, wait, if you feel no risk
		490	menas no fun, you can experiment by implementing your own mode of
		491	operations.
		492
		493	=cut
		494
		495	package OpenCL;
		496
		497	use common::sense;
		498	use Async::Interrupt ();
		499
		500	our $POLL_FUNC; # set by XS
		501
		502	BEGIN {
		503	our $VERSION = '0.97';
		504
		505	require XSLoader;
		506	XSLoader::load (__PACKAGE__, $VERSION);
		507
		508	@OpenCL::Platform::ISA =
		509	@OpenCL::Device::ISA =
		510	@OpenCL::Context::ISA =
		511	@OpenCL::Queue::ISA =
		512	@OpenCL::Memory::ISA =
		513	@OpenCL::Sampler::ISA =
		514	@OpenCL::Program::ISA =
		515	@OpenCL::Kernel::ISA =
		516	@OpenCL::Event::ISA = OpenCL::Object::;
		517
		518	@OpenCL::Buffer::ISA =
		519	@OpenCL::Image::ISA = OpenCL::Memory::;
		520
		521	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		522
		523	@OpenCL::Image2D::ISA =
		524	@OpenCL::Image3D::ISA =
		525	@OpenCL::Image2DArray::ISA =
		526	@OpenCL::Image1D::ISA =
		527	@OpenCL::Image1DArray::ISA =
		528	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		529
		530	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		531	}
		532
276	=head2 THE OpenCL PACKAGE	533	=head2 THE OpenCL PACKAGE
277		534
278	=over 4	535	=over 4
279		536
280	=item $int = OpenCL::errno	537	=item $int = OpenCL::errno
281		538
282	The last error returned by a function - it's only valid after an error occured	539	The last error returned by a function - it's only valid after an error occured
283	and before calling another OpenCL function.	540	and before calling another OpenCL function.
284		541
285	=item $str = OpenCL::err2str $errval	542	=item $str = OpenCL::err2str [$errval]
286		543
287	Comverts an error value into a human readable string.	544	Converts an error value into a human readable string. IF no error value is
		545	given, then the last error will be used (as returned by OpenCL::errno).
288		546
289	=item $str = OpenCL::enum2str $enum	547	=item $str = OpenCL::enum2str $enum
290		548
291	Converts most enum values (of parameter names, image format constants,	549	Converts most enum values (of parameter names, image format constants,
292	object types, addressing and filter modes, command types etc.) into a	550	object types, addressing and filter modes, command types etc.) into a
…		…
298		556
299	Returns all available OpenCL::Platform objects.	557	Returns all available OpenCL::Platform objects.
300		558
301	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	559	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
302		560
303	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	561	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
304		562
305	Tries to create a context from a default device and platform - never worked for me.	563	Tries to create a context from a default device and platform type - never worked for me.
306		564
307	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	565	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
308		566
		567	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		568
		569	Create a new OpenCL::Context object using the given device object(s). This
		570	function isn't implemented yet, use C<< $platform->context >> instead.
		571
		572	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		573
309	=item OpenCL::wait_for_events $wait_events...	574	=item OpenCL::wait_for_events $wait_events...
310		575
311	Waits for all events to complete.	576	Waits for all events to complete.
312		577
313	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	578	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314		579
		580	=item OpenCL::poll
		581
		582	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		583	invokes their callbacks.
		584
		585	=item $OpenCL::INTERRUPT
		586
		587	The L<Async::Interrupt> object used to signal asynchronous events (see
		588	L<EVENT SYSTEM>).
		589
		590	=cut
		591
		592	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		593
		594	&_eq_initialise ($INTERRUPT->signal_func);
		595
		596	=item $OpenCL::WATCHER
		597
		598	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		599	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		600	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		601
		602	=cut
		603
		604	our $WATCHER;
		605
		606	sub _init_anyevent {
		607	$INTERRUPT->block;
		608	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		609	}
		610
		611	if (defined $AnyEvent::MODEL) {
		612	_init_anyevent;
		613	} else {
		614	push @AnyEvent::post_detect, \&_init_anyevent;
		615	}
		616
315	=back	617	=back
316		618
		619	=head2 THE OpenCL::Object CLASS
		620
		621	This is the base class for all objects in the OpenCL module. The only
		622	method it implements is the C<id> method, which is only useful if you want
		623	to interface to OpenCL on the C level.
		624
		625	=over 4
		626
		627	=item $iv = $obj->id
		628
		629	OpenCL objects are represented by pointers or integers on the C level. If
		630	you want to interface to an OpenCL object directly on the C level, then
		631	you need this value, which is returned by this method. You should use an
		632	C<IV> type in your code and cast that to the correct type.
		633
		634	=cut
		635
		636	sub OpenCL::Object::id {
		637	ref $_[0] eq "SCALAR"
		638	? ${ $_[0] }
		639	: $_[0][0]
		640	}
		641
		642	=back
		643
317	=head2 THE OpenCL::Platform CLASS	644	=head2 THE OpenCL::Platform CLASS
318		645
319	=over 4	646	=over 4
320		647
321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	648	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
322		649
323	Returns a list of matching OpenCL::Device objects.	650	Returns a list of matching OpenCL::Device objects.
324		651
325	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	652	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
326		653
327	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	654	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328		655
329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	656	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330		657
331	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)	658	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
332		659
333	Create a new OpenCL::Context object using the given device object(s)- a	660	Create a new OpenCL::Context object using the given device object(s)- a
334	CL_CONTEXT_PLATFORM property is supplied automatically.	661	CL_CONTEXT_PLATFORM property is supplied automatically.
335		662
336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	663	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	671	It's best to avoid this method and use one of the following convenience
345	wrappers.	672	wrappers.
346		673
347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	674	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348		675
		676	=item $platform->unload_compiler
		677
		678	Attempts to unload the compiler for this platform, for endless
		679	profit. Does nothing on OpenCL 1.1.
		680
		681	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		682
349	=for gengetinfo begin platform	683	=for gengetinfo begin platform
350		684
351	=item $string = $platform->profile	685	=item $string = $platform->profile
352		686
353	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	687	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
…		…
638		972
639	=item @device_partition_property_exts = $device->affinity_domains_ext	973	=item @device_partition_property_exts = $device->affinity_domains_ext
640		974
641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	975	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
642		976
643	=item $uint = $device->reference_count_ext	977	=item $uint = $device->reference_count_ext
644		978
645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.	979	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
646		980
647	=item @device_partition_property_exts = $device->partition_style_ext	981	=item @device_partition_property_exts = $device->partition_style_ext
648		982
649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	983	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
650		984
…		…
654		988
655	=head2 THE OpenCL::Context CLASS	989	=head2 THE OpenCL::Context CLASS
656		990
657	=over 4	991	=over 4
658		992
		993	=item $prog = $ctx->build_program ($program, $options = "")
		994
		995	This convenience function tries to build the program on all devices in
		996	the context. If the build fails, then the function will C<croak> with the
		997	build log. Otherwise ti returns the program object.
		998
		999	The C<$program> can either be a C<OpenCL::Program> object or a string
		1000	containing the program. In the latter case, a program objetc will be
		1001	created automatically.
		1002
		1003	=cut
		1004
		1005	sub OpenCL::Context::build_program {
		1006	my ($self, $prog, $options) = @_;
		1007
		1008	require Carp;
		1009
		1010	$prog = $self->program_with_source ($prog)
		1011	unless ref $prog;
		1012
		1013	eval { $prog->build (undef, $options); 1 }
		1014	or errno == BUILD_PROGRAM_FAILURE
		1015	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1016
		1017	# we check status for all devices
		1018	for my $dev ($self->devices) {
		1019	$prog->build_status ($dev) == BUILD_SUCCESS
		1020	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1021	. $prog->build_log ($dev));
		1022	}
		1023
		1024	$prog
		1025	}
		1026
659	=item $queue = $ctx->queue ($device, $properties)	1027	=item $queue = $ctx->queue ($device, $properties)
660		1028
661	Create a new OpenCL::Queue object from the context and the given device.	1029	Create a new OpenCL::Queue object from the context and the given device.
662		1030
663	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	1031	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
		1032
		1033	Example: create an out-of-order queue.
		1034
		1035	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
664		1036
665	=item $ev = $ctx->user_event	1037	=item $ev = $ctx->user_event
666		1038
667	Creates a new OpenCL::UserEvent object.	1039	Creates a new OpenCL::UserEvent object.
668		1040
…		…
678	=item $buf = $ctx->buffer_sv ($flags, $data)	1050	=item $buf = $ctx->buffer_sv ($flags, $data)
679		1051
680	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1052	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
681	initialise it with the given data values.	1053	initialise it with the given data values.
682		1054
		1055	=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)
		1056
		1057	Creates a new OpenCL::Image object and optionally initialises it with
		1058	the given data values.
		1059
		1060	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
		1061
683	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1062	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
684		1063
685	Creates a new OpenCL::Image2D object and optionally initialises it with	1064	Creates a new OpenCL::Image2D object and optionally initialises it with
686	the given data values.	1065	the given data values.
687		1066
…		…
692	Creates a new OpenCL::Image3D object and optionally initialises it with	1071	Creates a new OpenCL::Image3D object and optionally initialises it with
693	the given data values.	1072	the given data values.
694		1073
695	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	1074	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
696		1075
		1076	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		1077
		1078	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		1079	OpenGL buffer object.
		1080
		1081	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		1082
		1083	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		1084
		1085	Creates a new OpenCL::Image object that refers to the given OpenGL
		1086	texture object or buffer.
		1087
		1088	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		1089
		1090	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		1091
		1092	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1093	2D texture object.
		1094
		1095	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		1096
		1097	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		1098
		1099	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		1100	3D texture object.
		1101
		1102	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		1103
		1104	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		1105
		1106	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1107	render buffer.
		1108
		1109	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
		1110
697	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	1111	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
698		1112
699	Returns a list of matching image formats - each format is an arrayref with	1113	Returns a list of matching image formats - each format is an arrayref with
700	two values, $channel_order and $channel_type, in it.	1114	two values, $channel_order and $channel_type, in it.
701		1115
…		…
742	=back	1156	=back
743		1157
744	=head2 THE OpenCL::Queue CLASS	1158	=head2 THE OpenCL::Queue CLASS
745		1159
746	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1160	An OpenCL::Queue represents an execution queue for OpenCL. You execute
747	requests by calling their respective C<enqueue_xxx> method and waitinf for	1161	requests by calling their respective method and waiting for it to complete
748	it to complete in some way.	1162	in some way.
749		1163
750	All the enqueue methods return an event object that can be used to wait	1164	Most methods that enqueue some request return an event object that can
751	for completion, unless the method is called in void context, in which case	1165	be used to wait for completion (optionally using a callback), unless
752	no event object is created.	1166	the method is called in void context, in which case no event object is
		1167	created.
753		1168
754	They also allow you to specify any number of other event objects that this	1169	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	1170	request has to wait for before it starts executing, by simply passing the
756	event objects as extra parameters to the enqueue methods.	1171	event objects as extra parameters to the enqueue methods. To simplify
		1172	program design, this module ignores any C<undef> values in the list of
		1173	events. This makes it possible to code operations such as this, without
		1174	having to put a valid event object into C<$event> first:
		1175
		1176	$event = $queue->xxx (..., $event);
757		1177
758	Queues execute in-order by default, without any parallelism, so in most	1178	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	1179	cases (i.e. you use only one queue) it's not necessary to wait for or
760	create event objects.	1180	create event objects, althoguh an our of order queue is often a bit
		1181	faster.
761		1182
762	=over 4	1183	=over 4
763		1184
764	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1185	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
765		1186
766	Reads data from buffer into the given string.	1187	Reads data from buffer into the given string.
767		1188
768	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1189	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
769		1190
770	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1191	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
771		1192
772	Writes data to buffer from the given string.	1193	Writes data to buffer from the given string.
773		1194
774	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1195	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
775		1196
776	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1197	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
777		1198
778	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1199	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
779		1200
780	=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...)	1201	=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...)
781		1202
782	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1203	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
783		1204
784	=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...)	1205	=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...)
785		1206
786	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1207	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
787		1208
788	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1209	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
789		1210
790	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1211	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
791		1212
792	=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...)	1213	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
793		1214
794	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1215	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
795		1216
796	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1217	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
797		1218
798	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1219	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
799		1220
800	=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...)	1221	=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...)
801		1222
802	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1223	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
803		1224
804	=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...)	1225	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
805		1226
806	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1227	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
807		1228
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...)	1229	=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...)
809		1230
810	Yeah.	1231	Yeah.
811		1232
812	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1233	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
813		1234
		1235	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
		1236
		1237	Fills the given buffer object with repeated applications of C<$pattern>,
		1238	starting at C<$offset> for C<$size> octets.
		1239
		1240	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1241
		1242	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1243
		1244	Fills the given image area with the given rgba colour components. The
		1245	components are normally floating point values between C<0> and C<1>,
		1246	except when the image channel data type is a signe dor unsigned
		1247	unnormalised format, in which case the range is determined by the format.
		1248
		1249	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
		1250
814	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1251	=item $ev = $queue->task ($kernel, $wait_events...)
815		1252
816	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1253	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
817		1254
818	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1255	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
819		1256
820	Enqueues a kernel execution.	1257	Enqueues a kernel execution.
821		1258
822	@$global_work_size must be specified as a reference to an array of	1259	\@global_work_size must be specified as a reference to an array of
823	integers specifying the work sizes (element counts).	1260	integers specifying the work sizes (element counts).
824		1261
825	@$global_work_offset must be either C<undef> (in which case all offsets	1262	\@global_work_offset must be either C<undef> (in which case all offsets
826	are C<0>), or a reference to an array of work offsets, with the same number	1263	are C<0>), or a reference to an array of work offsets, with the same number
827	of elements as @$global_work_size.	1264	of elements as \@global_work_size.
828		1265
829	@$local_work_size must be either C<undef> (in which case the	1266	\@local_work_size must be either C<undef> (in which case the
830	implementation is supposed to choose good local work sizes), or a	1267	implementation is supposed to choose good local work sizes), or a
831	reference to an array of local work sizes, with the same number of	1268	reference to an array of local work sizes, with the same number of
832	elements as @$global_work_size.	1269	elements as \@global_work_size.
833		1270
834	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1271	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
835		1272
836	=item $ev = $queue->enqueue_marker	1273	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
837		1274
		1275	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1276	for subsequent OpenCL usage.
		1277
838	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1278	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
839		1279
		1280	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
		1281
		1282	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1283	for subsequent OpenGL usage.
		1284
		1285	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
		1286
840	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1287	=item $ev = $queue->wait_for_events ($wait_events...)
841		1288
842	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1289	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
843		1290
844	=item $queue->enqueue_barrier	1291	=item $ev = $queue->marker ($wait_events...)
845		1292
		1293	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1294
		1295	=item $ev = $queue->barrier ($wait_events...)
		1296
846	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1297	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
847		1298
848	=item $queue->flush	1299	=item $queue->flush
849		1300
850	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1301	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
851		1302
…		…
931	=item $int = $mem->offset	1382	=item $int = $mem->offset
932		1383
933	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1384	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
934		1385
935	=for gengetinfo end mem	1386	=for gengetinfo end mem
		1387
		1388	=item ($type, $name) = $mem->gl_object_info
		1389
		1390	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1391	object "name" (e.g. the texture name) used to create this memory object.
		1392
		1393	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
936		1394
937	=back	1395	=back
938		1396
939	=head2 THE OpenCL::Buffer CLASS	1397	=head2 THE OpenCL::Buffer CLASS
940		1398
…		…
959		1417
960	=back	1418	=back
961		1419
962	=head2 THE OpenCL::Image CLASS	1420	=head2 THE OpenCL::Image CLASS
963		1421
964	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.	1422	This is the superclass of all image objects - OpenCL::Image1D,
		1423	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1424	OpenCL::Image2DArray and OpenCL::Image3D.
965		1425
966	=over 4	1426	=over 4
967		1427
968	=item $packed_value = $ev->image_info ($name)	1428	=item $packed_value = $image->image_info ($name)
969		1429
970	See C<< $platform->info >> for details.	1430	See C<< $platform->info >> for details.
971		1431
972	The reason this method is not called C<info> is that there already is an	1432	The reason this method is not called C<info> is that there already is an
973	C<< ->info >> method inherited from C<OpenCL::Memory>.	1433	C<< ->info >> method inherited from C<OpenCL::Memory>.
974		1434
975	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1435	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
976		1436
		1437	=item ($channel_order, $channel_data_type) = $image->format
		1438
		1439	Returns the channel order and type used to create the image by calling
		1440	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1441
977	=for gengetinfo begin image	1442	=for gengetinfo begin image
978		1443
979	=item $int = $image->element_size	1444	=item $int = $image->element_size
980		1445
981	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1446	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
…		…
1000		1465
1001	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1466	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1002		1467
1003	=for gengetinfo end image	1468	=for gengetinfo end image
1004		1469
		1470	=for gengetinfo begin gl_texture
		1471
		1472	=item $GLenum = $gl_texture->target
		1473
		1474	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1475
		1476	=item $GLint = $gl_texture->gl_mipmap_level
		1477
		1478	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1479
		1480	=for gengetinfo end gl_texture
		1481
1005	=back	1482	=back
1006		1483
1007	=head2 THE OpenCL::Sampler CLASS	1484	=head2 THE OpenCL::Sampler CLASS
1008		1485
1009	=over 4	1486	=over 4
…		…
1042		1519
1043	=head2 THE OpenCL::Program CLASS	1520	=head2 THE OpenCL::Program CLASS
1044		1521
1045	=over 4	1522	=over 4
1046		1523
1047	=item $program->build ($device, $options = "")	1524	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1048		1525
1049	Tries to build the program with the givne options.	1526	Tries to build the program with the given options. See also the
		1527	C<$ctx->build> convenience function.
		1528
		1529	If a callback is specified, then it will be called when compilation is
		1530	finished. Note that many OpenCL implementations block your program while
		1531	compiling whether you use a callback or not. See C<build_async> if you
		1532	want to make sure the build is done in the background.
		1533
		1534	Note that some OpenCL implementations atc up badly, and don't call the
		1535	callback in some error cases (but call it in others). This implementation
		1536	assumes the callback will always be called, and leaks memory if this is
		1537	not so. So best make sure you don't pass in invalid values.
1050		1538
1051	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1539	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1540
		1541	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1542
		1543	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1544	need to check the compilation status form the callback, or by polling).
1052		1545
1053	=item $packed_value = $program->build_info ($device, $name)	1546	=item $packed_value = $program->build_info ($device, $name)
1054		1547
1055	Similar to C<< $platform->info >>, but returns build info for a previous	1548	Similar to C<< $platform->info >>, but returns build info for a previous
1056	build attempt for the given device.	1549	build attempt for the given device.
…		…
1061		1554
1062	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1555	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1063	the program.	1556	the program.
1064		1557
1065	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
		1559
		1560	=item @kernels = $program->kernels_in_program
		1561
		1562	Returns all kernels successfully compiled for all devices in program.
		1563
		1564	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1066		1565
1067	=for gengetinfo begin program_build	1566	=for gengetinfo begin program_build
1068		1567
1069	=item $build_status = $program->build_status ($device)	1568	=item $build_status = $program->build_status ($device)
1070		1569
…		…
1192		1691
1193	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1692	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1194		1693
1195	=for gengetinfo end kernel_work_group	1694	=for gengetinfo end kernel_work_group
1196		1695
		1696	=item $kernel->setf ($format, ...)
		1697
		1698	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1699	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1700	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1701	what type of argument it is.
		1702
		1703	The format arguments are single letters:
		1704
		1705	c char
		1706	C unsigned char
		1707	s short
		1708	S unsigned short
		1709	i int
		1710	I unsigned int
		1711	l long
		1712	L unsigned long
		1713
		1714	h half float (0..65535)
		1715	f float
		1716	d double
		1717
		1718	z local (octet size)
		1719
		1720	m memory object (buffer or image)
		1721	a sampler
		1722	e event
		1723
		1724	Space characters in the format string are ignored.
		1725
		1726	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1727
		1728	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1729
1197	=item $kernel->set_TYPE ($index, $value)	1730	=item $kernel->set_TYPE ($index, $value)
1198		1731
		1732	=item $kernel->set_char ($index, $value)
		1733
		1734	=item $kernel->set_uchar ($index, $value)
		1735
		1736	=item $kernel->set_short ($index, $value)
		1737
		1738	=item $kernel->set_ushort ($index, $value)
		1739
		1740	=item $kernel->set_int ($index, $value)
		1741
		1742	=item $kernel->set_uint ($index, $value)
		1743
		1744	=item $kernel->set_long ($index, $value)
		1745
		1746	=item $kernel->set_ulong ($index, $value)
		1747
		1748	=item $kernel->set_half ($index, $value)
		1749
		1750	=item $kernel->set_float ($index, $value)
		1751
		1752	=item $kernel->set_double ($index, $value)
		1753
		1754	=item $kernel->set_memory ($index, $value)
		1755
		1756	=item $kernel->set_buffer ($index, $value)
		1757
		1758	=item $kernel->set_image ($index, $value)
		1759
		1760	=item $kernel->set_sampler ($index, $value)
		1761
		1762	=item $kernel->set_local ($index, $value)
		1763
		1764	=item $kernel->set_event ($index, $value)
		1765
1199	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1766	This is a family of methods to set the kernel argument with the number
1200		1767	C<$index> to the give C<$value>.
1201	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>,
1203	C<image2d>, C<image3d>, C<sampler> or C<event>.
1204		1768
1205	Chars and integers (including the half type) are specified as integers,	1769	Chars and integers (including the half type) are specified as integers,
1206	float and double as floating point values, memory/buffer/image2d/image3d	1770	float and double as floating point values, memory/buffer/image must be
1207	must be an object of that type or C<undef>, and sampler and event must be	1771	an object of that type or C<undef>, local-memory arguments are set by
1208	objects of that type.	1772	specifying the size, and sampler and event must be objects of that type.
		1773
		1774	Note that C<set_memory> works for all memory objects (all types of buffers
		1775	and images) - the main purpose of the more specific C<set_TYPE> functions
		1776	is type checking.
		1777
		1778	Setting an argument for a kernel does NOT keep a reference to the object -
		1779	for example, if you set an argument to some image object, free the image,
		1780	and call the kernel, you will run into undefined behaviour.
1209		1781
1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1782	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1211		1783
1212	=back	1784	=back
1213		1785
…		…
1222		1794
1223	Waits for the event to complete.	1795	Waits for the event to complete.
1224		1796
1225	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1797	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1226		1798
		1799	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1800
		1801	Adds a callback to the callback stack for the given event type. There is
		1802	no way to remove a callback again.
		1803
		1804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1805
1227	=item $packed_value = $ev->info ($name)	1806	=item $packed_value = $ev->info ($name)
1228		1807
1229	See C<< $platform->info >> for details.	1808	See C<< $platform->info >> for details.
1230		1809
1231	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1810	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
…		…
1291		1870
1292	=over 4	1871	=over 4
1293		1872
1294	=item $ev->set_status ($execution_status)	1873	=item $ev->set_status ($execution_status)
1295		1874
		1875	Sets the execution status of the user event. Can only be called once,
		1876	either with OpenCL::COMPLETE or a negative number as status.
		1877
1296	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1878	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1297		1879
1298	=back	1880	=back
1299		1881
1300	=cut	1882	=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		1883
1323	1;	1884	1;
1324		1885
1325	=head1 AUTHOR	1886	=head1 AUTHOR
1326		1887

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.30 by root, Thu Apr 5 10:08:59 2012 UTC vs. Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.30 by root, Thu Apr 5 10:08:59 2012 UTC vs.
Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC