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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs.
Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC

…		…
27	OpenCL::Program objects, which store source code and, after building for a	27	OpenCL::Program objects, which store source code and, after building for a
28	specific device ("compiling and linking"), also binary programs. For each	28	specific device ("compiling and linking"), also binary programs. For each
29	kernel function in a program you can then create an OpenCL::Kernel object	29	kernel function in a program you can then create an OpenCL::Kernel object
30	which represents basically a function call with argument values.	30	which represents basically a function call with argument values.
31		31
32	OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat	32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34	or 3d array) for bulk data and input and output for kernels.	34	or 3d array) for bulk data and input and output for kernels.
35		35
36	OpenCL::Sampler objects, which are kind of like texture filter modes in	36	OpenCL::Sampler objects, which are kind of like texture filter modes in
37	OpenGL.	37	OpenGL.
…		…
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
…		…
101		104
102	Best run this once to get a feel for the platforms and devices in your	105	Best run this once to get a feel for the platforms and devices in your
103	system.	106	system.
104		107
105	for my $platform (OpenCL::platforms) {	108	for my $platform (OpenCL::platforms) {
106	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	109	printf "platform: %s\n", $platform->name;
107	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	110	printf "extensions: %s\n", $platform->extensions;
108	for my $device ($platform->devices) {	111	for my $device ($platform->devices) {
109	printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME);	112	printf "+ device: %s\n", $device->name;
110	my $ctx = $device->context;	113	my $ctx = $platform->context (undef, [$device]);
111	# do stuff	114	# do stuff
112	}	115	}
113	}	116	}
114		117
115	=head2 Get a useful context and a command queue.	118	=head2 Get a useful context and a command queue.
…		…
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_info ($dev, OpenCL::PROGRAM_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
…		…
226		317
227	=item * Object lifetime managament is automatic - there is no need	318	=item * Object lifetime managament is automatic - there is no need
228	to free objects explicitly (C<clReleaseXXX>), the release function	319	to free objects explicitly (C<clReleaseXXX>), the release function
229	is called automatically once all Perl references to it go away.	320	is called automatically once all Perl references to it go away.
230		321
231	=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>),	322	=item * OpenCL uses CamelCase for function names
		323	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
232	while this module uses underscores as word separator and often leaves out	324	uses underscores as word separator and often leaves out prefixes
233	prefixes (C<< $platform->info >>).	325	(C<OpenCL::platforms>, C<< $platform->info >>).
234		326
235	=item * OpenCL often specifies fixed vector function arguments as short	327	=item * OpenCL often specifies fixed vector function arguments as short
236	arrays (C<$origin[3]>), while this module explicitly expects the	328	arrays (C<size_t origin[3]>), while this module explicitly expects the
237	components as separate arguments-	329	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		330	function calls.
238		331
239	=item * Structures are often specified with their components, and returned	332	=item * Structures are often specified by flattening out their components
240	as arrayrefs.	333	as with short vectors, and returned as arrayrefs.
241
242	=item * Where possible, one of the pitch values is calculated from the
243	perl scalar length and need not be specified.
244		334
245	=item * When enqueuing commands, the wait list is specified by adding	335	=item * When enqueuing commands, the wait list is specified by adding
246	extra arguments to the function - anywhere a C<$wait_events...> argument	336	extra arguments to the function - anywhere a C<$wait_events...> argument
247	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.
248		340
249	=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
250	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
251	by the method.	343	by the method.
252		344
…		…
272	ulong IV - Q	364	ulong IV - Q
273	float NV float f	365	float NV float f
274	half IV ushort S	366	half IV ushort S
275	double NV double d	367	double NV double d
276		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 Carp ();
		499	use Async::Interrupt ();
		500
		501	our $POLL_FUNC; # set by XS
		502
		503	BEGIN {
		504	our $VERSION = '0.98';
		505
		506	require XSLoader;
		507	XSLoader::load (__PACKAGE__, $VERSION);
		508
		509	@OpenCL::Platform::ISA =
		510	@OpenCL::Device::ISA =
		511	@OpenCL::Context::ISA =
		512	@OpenCL::Queue::ISA =
		513	@OpenCL::Memory::ISA =
		514	@OpenCL::Sampler::ISA =
		515	@OpenCL::Program::ISA =
		516	@OpenCL::Kernel::ISA =
		517	@OpenCL::Event::ISA = OpenCL::Object::;
		518
		519	@OpenCL::Buffer::ISA =
		520	@OpenCL::Image::ISA = OpenCL::Memory::;
		521
		522	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		523
		524	@OpenCL::Image2D::ISA =
		525	@OpenCL::Image3D::ISA =
		526	@OpenCL::Image2DArray::ISA =
		527	@OpenCL::Image1D::ISA =
		528	@OpenCL::Image1DArray::ISA =
		529	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		530
		531	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		532	}
		533
277	=head2 THE OpenCL PACKAGE	534	=head2 THE OpenCL PACKAGE
278		535
279	=over 4	536	=over 4
280		537
281	=item $int = OpenCL::errno	538	=item $int = OpenCL::errno
282		539
283	The last error returned by a function - it's only valid after an error occured	540	The last error returned by a function - it's only valid after an error occured
284	and before calling another OpenCL function.	541	and before calling another OpenCL function.
285		542
286	=item $str = OpenCL::err2str $errval	543	=item $str = OpenCL::err2str [$errval]
287		544
288	Comverts an error value into a human readable string.	545	Converts an error value into a human readable string. IF no error value is
		546	given, then the last error will be used (as returned by OpenCL::errno).
289		547
290	=item $str = OpenCL::enum2str $enum	548	=item $str = OpenCL::enum2str $enum
291		549
292	Converts most enum values (inof parameter names, image format constants,	550	Converts most enum values (of parameter names, image format constants,
293	object types, addressing and filter modes, command types etc.) into a	551	object types, addressing and filter modes, command types etc.) into a
294	human readbale string. When confronted with some random integer it can be	552	human readable string. When confronted with some random integer it can be
295	very helpful to pass it through this function to maybe get some readable	553	very helpful to pass it through this function to maybe get some readable
296	string out of it.	554	string out of it.
297		555
298	=item @platforms = OpenCL::platforms	556	=item @platforms = OpenCL::platforms
299		557
300	Returns all available OpenCL::Platform objects.	558	Returns all available OpenCL::Platform objects.
301		559
302	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	560	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
303		561
304	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	562	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
305		563
306	Tries to create a context from a default device and platform - never worked for me.	564	Tries to create a context from a default device and platform type - never worked for me.
307		565
308	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	566	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
309		567
		568	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		569
		570	Create a new OpenCL::Context object using the given device object(s). This
		571	function isn't implemented yet, use C<< $platform->context >> instead.
		572
		573	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		574
310	=item OpenCL::wait_for_events $wait_events...	575	=item OpenCL::wait_for_events $wait_events...
311		576
312	Waits for all events to complete.	577	Waits for all events to complete.
313		578
314	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	579	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
315		580
		581	=item OpenCL::poll
		582
		583	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		584	invokes their callbacks.
		585
		586	=item $OpenCL::INTERRUPT
		587
		588	The L<Async::Interrupt> object used to signal asynchronous events (see
		589	L<EVENT SYSTEM>).
		590
		591	=cut
		592
		593	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		594
		595	&_eq_initialise ($INTERRUPT->signal_func);
		596
		597	=item $OpenCL::WATCHER
		598
		599	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		600	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		601	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		602
		603	=cut
		604
		605	our $WATCHER;
		606
		607	sub _init_anyevent {
		608	$INTERRUPT->block;
		609	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		610	}
		611
		612	if (defined $AnyEvent::MODEL) {
		613	_init_anyevent;
		614	} else {
		615	push @AnyEvent::post_detect, \&_init_anyevent;
		616	}
		617
316	=back	618	=back
317		619
		620	=head2 THE OpenCL::Object CLASS
		621
		622	This is the base class for all objects in the OpenCL module. The only
		623	method it implements is the C<id> method, which is only useful if you want
		624	to interface to OpenCL on the C level.
		625
		626	=over 4
		627
		628	=item $iv = $obj->id
		629
		630	OpenCL objects are represented by pointers or integers on the C level. If
		631	you want to interface to an OpenCL object directly on the C level, then
		632	you need this value, which is returned by this method. You should use an
		633	C<IV> type in your code and cast that to the correct type.
		634
		635	=cut
		636
		637	sub OpenCL::Object::id {
		638	ref $_[0] eq "SCALAR"
		639	? ${ $_[0] }
		640	: $_[0][0]
		641	}
		642
		643	=back
		644
318	=head2 THE OpenCL::Platform CLASS	645	=head2 THE OpenCL::Platform CLASS
319		646
320	=over 4	647	=over 4
321		648
322	=item $packed_value = $platform->info ($name)
323
324	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
325	strings, this will be the string, for other values you probably need to
326	use the correct C<unpack>. This might get improved in the future. Hopefully.
327
328	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
329
330	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	649	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
331		650
332	Returns a list of matching OpenCL::Device objects.	651	Returns a list of matching OpenCL::Device objects.
333		652
334	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	653	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
335		654
336	Tries to create a context. Never worked for me, and you need devices explitly anyway.	655	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
337		656
338	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	657	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
339		658
340	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	659	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
341		660
342	Create a new OpenCL::Context object using the given device object(s)- a	661	Create a new OpenCL::Context object using the given device object(s)- a
343	CL_CONTEXT_PLATFORM property is supplied automatically.	662	CL_CONTEXT_PLATFORM property is supplied automatically.
344		663
345	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	664	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
346		665
		666	=item $packed_value = $platform->info ($name)
		667
		668	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
		669	strings, this will be the string (possibly including terminating \0), for
		670	other values you probably need to use the correct C<unpack>.
		671
		672	It's best to avoid this method and use one of the following convenience
		673	wrappers.
		674
		675	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
		676
		677	=item $platform->unload_compiler
		678
		679	Attempts to unload the compiler for this platform, for endless
		680	profit. Does nothing on OpenCL 1.1.
		681
		682	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		683
		684	=for gengetinfo begin platform
		685
		686	=item $string = $platform->profile
		687
		688	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
		689
		690	=item $string = $platform->version
		691
		692	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
		693
		694	=item $string = $platform->name
		695
		696	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
		697
		698	=item $string = $platform->vendor
		699
		700	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
		701
		702	=item $string = $platform->extensions
		703
		704	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		705
		706	=for gengetinfo end platform
		707
347	=back	708	=back
348		709
349	=head2 THE OpenCL::Device CLASS	710	=head2 THE OpenCL::Device CLASS
350		711
351	=over 4	712	=over 4
…		…
354		715
355	See C<< $platform->info >> for details.	716	See C<< $platform->info >> for details.
356		717
357	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	718	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
358		719
		720	=for gengetinfo begin device
		721
		722	=item $device_type = $device->type
		723
		724	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		725
		726	=item $uint = $device->vendor_id
		727
		728	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		729
		730	=item $uint = $device->max_compute_units
		731
		732	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		733
		734	=item $uint = $device->max_work_item_dimensions
		735
		736	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		737
		738	=item $int = $device->max_work_group_size
		739
		740	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		741
		742	=item @ints = $device->max_work_item_sizes
		743
		744	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		745
		746	=item $uint = $device->preferred_vector_width_char
		747
		748	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		749
		750	=item $uint = $device->preferred_vector_width_short
		751
		752	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		753
		754	=item $uint = $device->preferred_vector_width_int
		755
		756	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		757
		758	=item $uint = $device->preferred_vector_width_long
		759
		760	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		761
		762	=item $uint = $device->preferred_vector_width_float
		763
		764	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		765
		766	=item $uint = $device->preferred_vector_width_double
		767
		768	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		769
		770	=item $uint = $device->max_clock_frequency
		771
		772	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		773
		774	=item $bitfield = $device->address_bits
		775
		776	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		777
		778	=item $uint = $device->max_read_image_args
		779
		780	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		781
		782	=item $uint = $device->max_write_image_args
		783
		784	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		785
		786	=item $ulong = $device->max_mem_alloc_size
		787
		788	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		789
		790	=item $int = $device->image2d_max_width
		791
		792	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		793
		794	=item $int = $device->image2d_max_height
		795
		796	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		797
		798	=item $int = $device->image3d_max_width
		799
		800	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		801
		802	=item $int = $device->image3d_max_height
		803
		804	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		805
		806	=item $int = $device->image3d_max_depth
		807
		808	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		809
		810	=item $uint = $device->image_support
		811
		812	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		813
		814	=item $int = $device->max_parameter_size
		815
		816	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		817
		818	=item $uint = $device->max_samplers
		819
		820	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		821
		822	=item $uint = $device->mem_base_addr_align
		823
		824	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		825
		826	=item $uint = $device->min_data_type_align_size
		827
		828	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		829
		830	=item $device_fp_config = $device->single_fp_config
		831
		832	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		833
		834	=item $device_mem_cache_type = $device->global_mem_cache_type
		835
		836	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		837
		838	=item $uint = $device->global_mem_cacheline_size
		839
		840	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		841
		842	=item $ulong = $device->global_mem_cache_size
		843
		844	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		845
		846	=item $ulong = $device->global_mem_size
		847
		848	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		849
		850	=item $ulong = $device->max_constant_buffer_size
		851
		852	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		853
		854	=item $uint = $device->max_constant_args
		855
		856	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		857
		858	=item $device_local_mem_type = $device->local_mem_type
		859
		860	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		861
		862	=item $ulong = $device->local_mem_size
		863
		864	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		865
		866	=item $boolean = $device->error_correction_support
		867
		868	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		869
		870	=item $int = $device->profiling_timer_resolution
		871
		872	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		873
		874	=item $boolean = $device->endian_little
		875
		876	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		877
		878	=item $boolean = $device->available
		879
		880	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		881
		882	=item $boolean = $device->compiler_available
		883
		884	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		885
		886	=item $device_exec_capabilities = $device->execution_capabilities
		887
		888	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		889
		890	=item $command_queue_properties = $device->properties
		891
		892	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		893
		894	=item $ = $device->platform
		895
		896	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		897
		898	=item $string = $device->name
		899
		900	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		901
		902	=item $string = $device->vendor
		903
		904	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		905
		906	=item $string = $device->driver_version
		907
		908	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		909
		910	=item $string = $device->profile
		911
		912	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		913
		914	=item $string = $device->version
		915
		916	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		917
		918	=item $string = $device->extensions
		919
		920	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		921
		922	=item $uint = $device->preferred_vector_width_half
		923
		924	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		925
		926	=item $uint = $device->native_vector_width_char
		927
		928	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		929
		930	=item $uint = $device->native_vector_width_short
		931
		932	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		933
		934	=item $uint = $device->native_vector_width_int
		935
		936	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		937
		938	=item $uint = $device->native_vector_width_long
		939
		940	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		941
		942	=item $uint = $device->native_vector_width_float
		943
		944	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		945
		946	=item $uint = $device->native_vector_width_double
		947
		948	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		949
		950	=item $uint = $device->native_vector_width_half
		951
		952	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		953
		954	=item $device_fp_config = $device->double_fp_config
		955
		956	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		957
		958	=item $device_fp_config = $device->half_fp_config
		959
		960	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		961
		962	=item $boolean = $device->host_unified_memory
		963
		964	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		965
		966	=item $device = $device->parent_device_ext
		967
		968	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		969
		970	=item @device_partition_property_exts = $device->partition_types_ext
		971
		972	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		973
		974	=item @device_partition_property_exts = $device->affinity_domains_ext
		975
		976	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		977
		978	=item $uint = $device->reference_count_ext
		979
		980	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
		981
		982	=item @device_partition_property_exts = $device->partition_style_ext
		983
		984	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		985
		986	=for gengetinfo end device
		987
359	=back	988	=back
360		989
361	=head2 THE OpenCL::Context CLASS	990	=head2 THE OpenCL::Context CLASS
362		991
363	=over 4	992	=over 4
364		993
365	=item $packed_value = $ctx->info ($name)	994	=item $prog = $ctx->build_program ($program, $options = "")
366		995
367	See C<< $platform->info >> for details.	996	This convenience function tries to build the program on all devices in
		997	the context. If the build fails, then the function will C<croak> with the
		998	build log. Otherwise ti returns the program object.
368		999
369	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1000	The C<$program> can either be a C<OpenCL::Program> object or a string
		1001	containing the program. In the latter case, a program objetc will be
		1002	created automatically.
		1003
		1004	=cut
		1005
		1006	sub OpenCL::Context::build_program {
		1007	my ($self, $prog, $options) = @_;
		1008
		1009	$prog = $self->program_with_source ($prog)
		1010	unless ref $prog;
		1011
		1012	eval { $prog->build (undef, $options); 1 }
		1013	or errno == BUILD_PROGRAM_FAILURE
		1014	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1015
		1016	# we check status for all devices
		1017	for my $dev ($self->devices) {
		1018	$prog->build_status ($dev) == BUILD_SUCCESS
		1019	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1020	. $prog->build_log ($dev);
		1021	}
		1022
		1023	$prog
		1024	}
370		1025
371	=item $queue = $ctx->queue ($device, $properties)	1026	=item $queue = $ctx->queue ($device, $properties)
372		1027
373	Create a new OpenCL::Queue object from the context and the given device.	1028	Create a new OpenCL::Queue object from the context and the given device.
374		1029
375	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	1030	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
376		1031
		1032	Example: create an out-of-order queue.
		1033
		1034	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		1035
377	=item $ev = $ctx->user_event	1036	=item $ev = $ctx->user_event
378		1037
379	Creates a new OpenCL::UserEvent object.	1038	Creates a new OpenCL::UserEvent object.
380		1039
381	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	1040	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
382		1041
383	=item $buf = $ctx->buffer ($flags, $len)	1042	=item $buf = $ctx->buffer ($flags, $len)
384		1043
385	Creates a new OpenCL::Buffer object with the given flags and octet-size.	1044	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		1045	given flags and octet-size.
386		1046
387	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1047	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
388		1048
389	=item $buf = $ctx->buffer_sv ($flags, $data)	1049	=item $buf = $ctx->buffer_sv ($flags, $data)
390		1050
391	Creates a new OpenCL::Buffer object and initialise it with the given data values.	1051	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		1052	initialise it with the given data values.
		1053
		1054	=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)
		1055
		1056	Creates a new OpenCL::Image object and optionally initialises it with
		1057	the given data values.
		1058
		1059	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
392		1060
393	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1061	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
394		1062
395	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	1063	Creates a new OpenCL::Image2D object and optionally initialises it with
		1064	the given data values.
396		1065
397	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	1066	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
398		1067
399	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)	1068	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
400		1069
401	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	1070	Creates a new OpenCL::Image3D object and optionally initialises it with
		1071	the given data values.
402		1072
403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	1073	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		1074
		1075	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		1076
		1077	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		1078	OpenGL buffer object.
		1079
		1080	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		1081
		1082	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		1083
		1084	Creates a new OpenCL::Image object that refers to the given OpenGL
		1085	texture object or buffer.
		1086
		1087	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		1088
		1089	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		1090
		1091	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1092	2D texture object.
		1093
		1094	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		1095
		1096	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		1097
		1098	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		1099	3D texture object.
		1100
		1101	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		1102
		1103	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		1104
		1105	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1106	render buffer.
		1107
		1108	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
404		1109
405	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	1110	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
406		1111
407	Returns a list of matching image formats - each format is an arrayref with	1112	Returns a list of matching image formats - each format is an arrayref with
408	two values, $channel_order and $channel_type, in it.	1113	two values, $channel_order and $channel_type, in it.
…		…
419		1124
420	Creates a new OpenCL::Program object from the given source code.	1125	Creates a new OpenCL::Program object from the given source code.
421		1126
422	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1127	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
423		1128
		1129	=item $packed_value = $ctx->info ($name)
		1130
		1131	See C<< $platform->info >> for details.
		1132
		1133	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		1134
		1135	=for gengetinfo begin context
		1136
		1137	=item $uint = $context->reference_count
		1138
		1139	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		1140
		1141	=item @devices = $context->devices
		1142
		1143	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		1144
		1145	=item @property_ints = $context->properties
		1146
		1147	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		1148
		1149	=item $uint = $context->num_devices
		1150
		1151	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		1152
		1153	=for gengetinfo end context
		1154
424	=back	1155	=back
425		1156
426	=head2 THE OpenCL::Queue CLASS	1157	=head2 THE OpenCL::Queue CLASS
427		1158
428	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1159	An OpenCL::Queue represents an execution queue for OpenCL. You execute
429	requests by calling their respective C<enqueue_xxx> method and waitinf for	1160	requests by calling their respective method and waiting for it to complete
430	it to complete in some way.	1161	in some way.
431		1162
432	All the enqueue methods return an event object that can be used to wait	1163	Most methods that enqueue some request return an event object that can
433	for completion, unless the method is called in void context, in which case	1164	be used to wait for completion (optionally using a callback), unless
434	no event object is created.	1165	the method is called in void context, in which case no event object is
		1166	created.
435		1167
436	They also allow you to specify any number of other event objects that this	1168	They also allow you to specify any number of other event objects that this
437	request has to wait for before it starts executing, by simply passing the	1169	request has to wait for before it starts executing, by simply passing the
438	event objects as extra parameters to the enqueue methods.	1170	event objects as extra parameters to the enqueue methods. To simplify
		1171	program design, this module ignores any C<undef> values in the list of
		1172	events. This makes it possible to code operations such as this, without
		1173	having to put a valid event object into C<$event> first:
		1174
		1175	$event = $queue->xxx (..., $event);
439		1176
440	Queues execute in-order by default, without any parallelism, so in most	1177	Queues execute in-order by default, without any parallelism, so in most
441	cases (i.e. you use only one queue) it's not necessary to wait for or	1178	cases (i.e. you use only one queue) it's not necessary to wait for or
442	create event objects.	1179	create event objects, althoguh an our of order queue is often a bit
		1180	faster.
443		1181
444	=over 4	1182	=over 4
445		1183
446	=item $packed_value = $ctx->info ($name)
447
448	See C<< $platform->info >> for details.
449
450	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
451
452	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1184	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
453		1185
454	Reads data from buffer into the given string.	1186	Reads data from buffer into the given string.
455		1187
456	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1188	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
457		1189
458	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1190	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
459		1191
460	Writes data to buffer from the given string.	1192	Writes data to buffer from the given string.
461		1193
462	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1194	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
463		1195
464	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1196	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
465		1197
466	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1198	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
467		1199
		1200	=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...)
		1201
		1202	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		1203
		1204	=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...)
		1205
		1206	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		1207
468	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1208	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1209
		1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		1211
		1212	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
469		1213
470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
471		1215
472	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1216	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
473		1217
474	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
475		1219
		1220	=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...)
		1221
		1222	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		1223
		1224	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
		1225
		1226	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		1227
476	=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...)	1228	=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...)
477		1229
478	Yeah.	1230	Yeah.
479		1231
480	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
481
482	=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...)
483
484	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1232	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
485		1233
486	=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...)	1234	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
487		1235
		1236	Fills the given buffer object with repeated applications of C<$pattern>,
		1237	starting at C<$offset> for C<$size> octets.
		1238
		1239	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1240
		1241	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1242
		1243	Fills the given image area with the given rgba colour components. The
		1244	components are normally floating point values between C<0> and C<1>,
		1245	except when the image channel data type is a signe dor unsigned
		1246	unnormalised format, in which case the range is determined by the format.
		1247
488	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1248	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
489		1249
490	=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...)
491
492	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
493
494	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1250	=item $ev = $queue->task ($kernel, $wait_events...)
495		1251
496	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1252	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
497		1253
498	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1254	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
499		1255
500	Enqueues a kernel execution.	1256	Enqueues a kernel execution.
501		1257
502	@$global_work_size must be specified as a reference to an array of	1258	\@global_work_size must be specified as a reference to an array of
503	integers specifying the work sizes (element counts).	1259	integers specifying the work sizes (element counts).
504		1260
505	@$global_work_offset must be either C<undef> (in which case all offsets	1261	\@global_work_offset must be either C<undef> (in which case all offsets
506	are C<0>), or a reference to an array of work offsets, with the same number	1262	are C<0>), or a reference to an array of work offsets, with the same number
507	of elements as @$global_work_size.	1263	of elements as \@global_work_size.
508		1264
509	@$local_work_size must be either C<undef> (in which case the	1265	\@local_work_size must be either C<undef> (in which case the
510	implementation is supposed to choose good local work sizes), or a	1266	implementation is supposed to choose good local work sizes), or a
511	reference to an array of local work sizes, with the same number of	1267	reference to an array of local work sizes, with the same number of
512	elements as @$global_work_size.	1268	elements as \@global_work_size.
513		1269
514	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1270	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
515		1271
516	=item $ev = $queue->enqueue_marker	1272	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
517		1273
		1274	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1275	for subsequent OpenCL usage.
		1276
518	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1277	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
519		1278
		1279	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
		1280
		1281	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1282	for subsequent OpenGL usage.
		1283
		1284	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
		1285
520	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1286	=item $ev = $queue->wait_for_events ($wait_events...)
521		1287
522	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
523		1289
524	=item $queue->enqueue_barrier	1290	=item $ev = $queue->marker ($wait_events...)
525		1291
		1292	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1293
		1294	=item $ev = $queue->barrier ($wait_events...)
		1295
526	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1296	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
527		1297
528	=item $queue->flush	1298	=item $queue->flush
529		1299
530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1300	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
531		1301
532	=item $queue->finish	1302	=item $queue->finish
533		1303
534	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	1304	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
535		1305
		1306	=item $packed_value = $queue->info ($name)
		1307
		1308	See C<< $platform->info >> for details.
		1309
		1310	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1311
		1312	=for gengetinfo begin command_queue
		1313
		1314	=item $ctx = $command_queue->context
		1315
		1316	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1317
		1318	=item $device = $command_queue->device
		1319
		1320	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1321
		1322	=item $uint = $command_queue->reference_count
		1323
		1324	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1325
		1326	=item $command_queue_properties = $command_queue->properties
		1327
		1328	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1329
		1330	=for gengetinfo end command_queue
		1331
536	=back	1332	=back
537		1333
538	=head2 THE OpenCL::Memory CLASS	1334	=head2 THE OpenCL::Memory CLASS
539		1335
540	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	1336	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
541	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	1337	OpenCL::Image2D and OpenCL::Image3D.
542	currently only exist to allow type-checking.
543		1338
544	=over 4	1339	=over 4
545		1340
546	=item $packed_value = $memory->info ($name)	1341	=item $packed_value = $memory->info ($name)
547		1342
548	See C<< $platform->info >> for details.	1343	See C<< $platform->info >> for details.
549		1344
550	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1345	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
551		1346
		1347	=for gengetinfo begin mem
		1348
		1349	=item $mem_object_type = $mem->type
		1350
		1351	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1352
		1353	=item $mem_flags = $mem->flags
		1354
		1355	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1356
		1357	=item $int = $mem->size
		1358
		1359	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1360
		1361	=item $ptr_value = $mem->host_ptr
		1362
		1363	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1364
		1365	=item $uint = $mem->map_count
		1366
		1367	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1368
		1369	=item $uint = $mem->reference_count
		1370
		1371	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1372
		1373	=item $ctx = $mem->context
		1374
		1375	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1376
		1377	=item $mem = $mem->associated_memobject
		1378
		1379	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1380
		1381	=item $int = $mem->offset
		1382
		1383	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1384
		1385	=for gengetinfo end mem
		1386
		1387	=item ($type, $name) = $mem->gl_object_info
		1388
		1389	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1390	object "name" (e.g. the texture name) used to create this memory object.
		1391
		1392	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1393
552	=back	1394	=back
553		1395
		1396	=head2 THE OpenCL::Buffer CLASS
		1397
		1398	This is a subclass of OpenCL::Memory, and the superclass of
		1399	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1400	and sub-buffers.
		1401
		1402	=head2 THE OpenCL::BufferObj CLASS
		1403
		1404	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1405	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1406	sub buffers from these sub buffers.
		1407
		1408	=over 4
		1409
		1410	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1411
		1412	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1413	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1414
		1415	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1416
		1417	=back
		1418
		1419	=head2 THE OpenCL::Image CLASS
		1420
		1421	This is the superclass of all image objects - OpenCL::Image1D,
		1422	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1423	OpenCL::Image2DArray and OpenCL::Image3D.
		1424
		1425	=over 4
		1426
		1427	=item $packed_value = $image->image_info ($name)
		1428
		1429	See C<< $platform->info >> for details.
		1430
		1431	The reason this method is not called C<info> is that there already is an
		1432	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1433
		1434	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1435
		1436	=item ($channel_order, $channel_data_type) = $image->format
		1437
		1438	Returns the channel order and type used to create the image by calling
		1439	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1440
		1441	=for gengetinfo begin image
		1442
		1443	=item $int = $image->element_size
		1444
		1445	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1446
		1447	=item $int = $image->row_pitch
		1448
		1449	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1450
		1451	=item $int = $image->slice_pitch
		1452
		1453	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1454
		1455	=item $int = $image->width
		1456
		1457	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1458
		1459	=item $int = $image->height
		1460
		1461	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1462
		1463	=item $int = $image->depth
		1464
		1465	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1466
		1467	=for gengetinfo end image
		1468
		1469	=for gengetinfo begin gl_texture
		1470
		1471	=item $GLenum = $gl_texture->target
		1472
		1473	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1474
		1475	=item $GLint = $gl_texture->gl_mipmap_level
		1476
		1477	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1478
		1479	=for gengetinfo end gl_texture
		1480
		1481	=back
		1482
554	=head2 THE OpenCL::Sampler CLASS	1483	=head2 THE OpenCL::Sampler CLASS
555		1484
556	=over 4	1485	=over 4
557		1486
558	=item $packed_value = $sampler->info ($name)	1487	=item $packed_value = $sampler->info ($name)
559		1488
560	See C<< $platform->info >> for details.	1489	See C<< $platform->info >> for details.
561		1490
562	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1491	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
563		1492
		1493	=for gengetinfo begin sampler
		1494
		1495	=item $uint = $sampler->reference_count
		1496
		1497	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1498
		1499	=item $ctx = $sampler->context
		1500
		1501	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1502
		1503	=item $addressing_mode = $sampler->normalized_coords
		1504
		1505	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1506
		1507	=item $filter_mode = $sampler->addressing_mode
		1508
		1509	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1510
		1511	=item $boolean = $sampler->filter_mode
		1512
		1513	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1514
		1515	=for gengetinfo end sampler
		1516
564	=back	1517	=back
565		1518
566	=head2 THE OpenCL::Program CLASS	1519	=head2 THE OpenCL::Program CLASS
567		1520
568	=over 4	1521	=over 4
569		1522
570	=item $packed_value = $program->info ($name)	1523	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
571		1524
572	See C<< $platform->info >> for details.
573
574	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
575
576	=item $program->build ($device, $options = "")
577
578	Tries to build the program with the givne options.	1525	Tries to build the program with the given options. See also the
		1526	C<$ctx->build> convenience function.
		1527
		1528	If a callback is specified, then it will be called when compilation is
		1529	finished. Note that many OpenCL implementations block your program while
		1530	compiling whether you use a callback or not. See C<build_async> if you
		1531	want to make sure the build is done in the background.
		1532
		1533	Note that some OpenCL implementations atc up badly, and don't call the
		1534	callback in some error cases (but call it in others). This implementation
		1535	assumes the callback will always be called, and leaks memory if this is
		1536	not so. So best make sure you don't pass in invalid values.
579		1537
580	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1538	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1539
		1540	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1541
		1542	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1543	need to check the compilation status form the callback, or by polling).
581		1544
582	=item $packed_value = $program->build_info ($device, $name)	1545	=item $packed_value = $program->build_info ($device, $name)
583		1546
584	Similar to C<< $platform->info >>, but returns build info for a previous	1547	Similar to C<< $platform->info >>, but returns build info for a previous
585	build attempt for the given device.	1548	build attempt for the given device.
…		…
591	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1554	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
592	the program.	1555	the program.
593		1556
594	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1557	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
595		1558
		1559	=item @kernels = $program->kernels_in_program
		1560
		1561	Returns all kernels successfully compiled for all devices in program.
		1562
		1563	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
		1564
		1565	=for gengetinfo begin program_build
		1566
		1567	=item $build_status = $program->build_status ($device)
		1568
		1569	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1570
		1571	=item $string = $program->build_options ($device)
		1572
		1573	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1574
		1575	=item $string = $program->build_log ($device)
		1576
		1577	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1578
		1579	=for gengetinfo end program_build
		1580
		1581	=item $packed_value = $program->info ($name)
		1582
		1583	See C<< $platform->info >> for details.
		1584
		1585	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1586
		1587	=for gengetinfo begin program
		1588
		1589	=item $uint = $program->reference_count
		1590
		1591	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1592
		1593	=item $ctx = $program->context
		1594
		1595	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1596
		1597	=item $uint = $program->num_devices
		1598
		1599	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1600
		1601	=item @devices = $program->devices
		1602
		1603	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1604
		1605	=item $string = $program->source
		1606
		1607	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1608
		1609	=item @ints = $program->binary_sizes
		1610
		1611	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1612
		1613	=for gengetinfo end program
		1614
		1615	=item @blobs = $program->binaries
		1616
		1617	Returns a string for the compiled binary for every device associated with
		1618	the program, empty strings indicate missing programs, and an empty result
		1619	means no program binaries are available.
		1620
		1621	These "binaries" are often, in fact, informative low-level assembly
		1622	sources.
		1623
		1624	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1625
596	=back	1626	=back
597		1627
598	=head2 THE OpenCL::Kernel CLASS	1628	=head2 THE OpenCL::Kernel CLASS
599		1629
600	=over 4	1630	=over 4
…		…
603		1633
604	See C<< $platform->info >> for details.	1634	See C<< $platform->info >> for details.
605		1635
606	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1636	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
607		1637
		1638	=for gengetinfo begin kernel
		1639
		1640	=item $string = $kernel->function_name
		1641
		1642	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1643
		1644	=item $uint = $kernel->num_args
		1645
		1646	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1647
		1648	=item $uint = $kernel->reference_count
		1649
		1650	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1651
		1652	=item $ctx = $kernel->context
		1653
		1654	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1655
		1656	=item $program = $kernel->program
		1657
		1658	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1659
		1660	=for gengetinfo end kernel
		1661
		1662	=item $packed_value = $kernel->work_group_info ($device, $name)
		1663
		1664	See C<< $platform->info >> for details.
		1665
		1666	The reason this method is not called C<info> is that there already is an
		1667	C<< ->info >> method.
		1668
		1669	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1670
		1671	=for gengetinfo begin kernel_work_group
		1672
		1673	=item $int = $kernel->work_group_size ($device)
		1674
		1675	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1676
		1677	=item @ints = $kernel->compile_work_group_size ($device)
		1678
		1679	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1680
		1681	=item $ulong = $kernel->local_mem_size ($device)
		1682
		1683	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1684
		1685	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1686
		1687	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1688
		1689	=item $ulong = $kernel->private_mem_size ($device)
		1690
		1691	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1692
		1693	=for gengetinfo end kernel_work_group
		1694
		1695	=item $kernel->setf ($format, ...)
		1696
		1697	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1698	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1699	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1700	what type of argument it is.
		1701
		1702	The format arguments are single letters:
		1703
		1704	c char
		1705	C unsigned char
		1706	s short
		1707	S unsigned short
		1708	i int
		1709	I unsigned int
		1710	l long
		1711	L unsigned long
		1712
		1713	h half float (0..65535)
		1714	f float
		1715	d double
		1716
		1717	z local (octet size)
		1718
		1719	m memory object (buffer or image)
		1720	a sampler
		1721	e event
		1722
		1723	Space characters in the format string are ignored.
		1724
		1725	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1726
		1727	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1728
608	=item $kernel->set_TYPE ($index, $value)	1729	=item $kernel->set_TYPE ($index, $value)
609		1730
		1731	=item $kernel->set_char ($index, $value)
		1732
		1733	=item $kernel->set_uchar ($index, $value)
		1734
		1735	=item $kernel->set_short ($index, $value)
		1736
		1737	=item $kernel->set_ushort ($index, $value)
		1738
		1739	=item $kernel->set_int ($index, $value)
		1740
		1741	=item $kernel->set_uint ($index, $value)
		1742
		1743	=item $kernel->set_long ($index, $value)
		1744
		1745	=item $kernel->set_ulong ($index, $value)
		1746
		1747	=item $kernel->set_half ($index, $value)
		1748
		1749	=item $kernel->set_float ($index, $value)
		1750
		1751	=item $kernel->set_double ($index, $value)
		1752
		1753	=item $kernel->set_memory ($index, $value)
		1754
		1755	=item $kernel->set_buffer ($index, $value)
		1756
		1757	=item $kernel->set_image ($index, $value)
		1758
		1759	=item $kernel->set_sampler ($index, $value)
		1760
		1761	=item $kernel->set_local ($index, $value)
		1762
		1763	=item $kernel->set_event ($index, $value)
		1764
610	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1765	This is a family of methods to set the kernel argument with the number
611		1766	C<$index> to the give C<$value>.
612	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
613	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
614	C<image2d>, C<image3d>, C<sampler> or C<event>.
615		1767
616	Chars and integers (including the half type) are specified as integers,	1768	Chars and integers (including the half type) are specified as integers,
617	float and double as floating point values, memory/buffer/image2d/image3d	1769	float and double as floating point values, memory/buffer/image must be
618	must be an object of that type or C<undef>, and sampler and event must be	1770	an object of that type or C<undef>, local-memory arguments are set by
619	objects of that type.	1771	specifying the size, and sampler and event must be objects of that type.
		1772
		1773	Note that C<set_memory> works for all memory objects (all types of buffers
		1774	and images) - the main purpose of the more specific C<set_TYPE> functions
		1775	is type checking.
		1776
		1777	Setting an argument for a kernel does NOT keep a reference to the object -
		1778	for example, if you set an argument to some image object, free the image,
		1779	and call the kernel, you will run into undefined behaviour.
620		1780
621	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1781	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
622		1782
623	=back	1783	=back
624		1784
…		…
627	This is the superclass for all event objects (including OpenCL::UserEvent	1787	This is the superclass for all event objects (including OpenCL::UserEvent
628	objects).	1788	objects).
629		1789
630	=over 4	1790	=over 4
631		1791
		1792	=item $ev->wait
		1793
		1794	Waits for the event to complete.
		1795
		1796	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1797
		1798	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1799
		1800	Adds a callback to the callback stack for the given event type. There is
		1801	no way to remove a callback again.
		1802
		1803	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1804
632	=item $packed_value = $ev->info ($name)	1805	=item $packed_value = $ev->info ($name)
633		1806
634	See C<< $platform->info >> for details.	1807	See C<< $platform->info >> for details.
635		1808
636	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1809	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
637		1810
638	=item $ev->wait	1811	=for gengetinfo begin event
639		1812
640	Waits for the event to complete.	1813	=item $queue = $event->command_queue
641		1814
		1815	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1816
		1817	=item $command_type = $event->command_type
		1818
		1819	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1820
		1821	=item $uint = $event->reference_count
		1822
		1823	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1824
		1825	=item $uint = $event->command_execution_status
		1826
		1827	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1828
		1829	=item $ctx = $event->context
		1830
		1831	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1832
		1833	=for gengetinfo end event
		1834
		1835	=item $packed_value = $ev->profiling_info ($name)
		1836
		1837	See C<< $platform->info >> for details.
		1838
		1839	The reason this method is not called C<info> is that there already is an
		1840	C<< ->info >> method.
		1841
642	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1842	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1843
		1844	=for gengetinfo begin profiling
		1845
		1846	=item $ulong = $event->profiling_command_queued
		1847
		1848	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1849
		1850	=item $ulong = $event->profiling_command_submit
		1851
		1852	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1853
		1854	=item $ulong = $event->profiling_command_start
		1855
		1856	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1857
		1858	=item $ulong = $event->profiling_command_end
		1859
		1860	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1861
		1862	=for gengetinfo end profiling
643		1863
644	=back	1864	=back
645		1865
646	=head2 THE OpenCL::UserEvent CLASS	1866	=head2 THE OpenCL::UserEvent CLASS
647		1867
…		…
649		1869
650	=over 4	1870	=over 4
651		1871
652	=item $ev->set_status ($execution_status)	1872	=item $ev->set_status ($execution_status)
653		1873
		1874	Sets the execution status of the user event. Can only be called once,
		1875	either with OpenCL::COMPLETE or a negative number as status.
		1876
654	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1877	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
655		1878
656	=back	1879	=back
657		1880
658	=cut	1881	=cut
659
660	package OpenCL;
661
662	use common::sense;
663
664	BEGIN {
665	our $VERSION = '0.15';
666
667	require XSLoader;
668	XSLoader::load (__PACKAGE__, $VERSION);
669
670	@OpenCL::Buffer::ISA =
671	@OpenCL::Image::ISA = OpenCL::Memory::;
672
673	@OpenCL::Image2D::ISA =
674	@OpenCL::Image3D::ISA = OpenCL::Image::;
675
676	@OpenCL::UserEvent::ISA = OpenCL::Event::;
677	}
678		1882
679	1;	1883	1;
680		1884
681	=head1 AUTHOR	1885	=head1 AUTHOR
682		1886

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs. Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs.
Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC