ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.5 by root, Wed Nov 16 00:35:30 2011 UTC vs.
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC

…		…
6		6
7	use OpenCL;	7	use OpenCL;
8		8
9	=head1 DESCRIPTION	9	=head1 DESCRIPTION
10		10
11	This is an early release which might be useful, but hasn't seen any testing.	11	This is an early release which might be useful, but hasn't seen much testing.
12		12
		13	=head2 OpenCL FROM 10000 FEET HEIGHT
		14
		15	Here is a high level overview of OpenCL:
		16
		17	First you need to find one or more OpenCL::Platforms (kind of like
		18	vendors) - usually there is only one.
		19
		20	Each platform gives you access to a number of OpenCL::Device objects, e.g.
		21	your graphics card.
		22
		23	From a platform and some device(s), you create an OpenCL::Context, which is
		24	a very central object in OpenCL: Once you have a context you can create
		25	most other objects:
		26
		27	OpenCL::Program objects, which store source code and, after building for a
		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
		30	which represents basically a function call with argument values.
		31
		32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
		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.
		35
		36	OpenCL::Sampler objects, which are kind of like texture filter modes in
		37	OpenGL.
		38
		39	OpenCL::Queue objects - command queues, which allow you to submit memory
		40	reads, writes and copies, as well as kernel calls to your devices. They
		41	also offer a variety of methods to synchronise request execution, for
		42	example with barriers or OpenCL::Event objects.
		43
		44	OpenCL::Event objects are used to signal when something is complete.
		45
13	=head1 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
14		47
15	The OpenCL spec used to develop this module (1.2 spec was available, but	48	The OpenCL spec used to develop this module (1.2 spec was available, but
16	no implementation was available to me :).	49	no implementation was available to me :).
17		50
18	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
19		52
20	OpenCL manpages:	53	OpenCL manpages:
21		54
22	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
23		56
		57	If you are into UML class diagrams, the following diagram might help - if
		58	not, it will be mildly cobfusing:
		59
		60	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html
		61
		62	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:
		64
		65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
		66
		67	And here's NVIDIA's OpenCL Best Practises Guide:
		68
		69	http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
		70
		71	=head1 BASIC WORKFLOW
		72
		73	To get something done, you basically have to do this once (refer to the
		74	examples below for actual code, this is just a high-level description):
		75
		76	Find some platform (e.g. the first one) and some device(s) (e.g. the first
		77	device of the platform), and create a context from those.
		78
		79	Create program objects from your OpenCL source code, then build (compile)
		80	the programs for each device you want to run them on.
		81
		82	Create kernel objects for all kernels you want to use (surprisingly, these
		83	are not device-specific).
		84
		85	Then, to execute stuff, you repeat these steps, possibly resuing or
		86	sharing some buffers:
		87
		88	Create some input and output buffers from your context. Set these as
		89	arguments to your kernel.
		90
		91	Enqueue buffer writes to initialise your input buffers (when not
		92	initialised at creation time).
		93
		94	Enqueue the kernel execution.
		95
		96	Enqueue buffer reads for your output buffer to read results.
		97
24	=head1 EXAMPLES	98	=head1 EXAMPLES
25		99
26	=head2 Enumerate all devices and get contexts for them.	100	=head2 Enumerate all devices and get contexts for them.
27		101
		102	Best run this once to get a feel for the platforms and devices in your
		103	system.
		104
28	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
29	warn $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
30	warn $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
31	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
32	warn $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
33	my $ctx = $device->context_simple;	110	my $ctx = $platform->context (undef, [$device]);
34	# do stuff	111	# do stuff
35	}	112	}
36	}	113	}
37		114
38	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
39		116
40	my $dev = ((OpenCL::platforms)[0]->devices)[0];	117	This is a useful boilerplate for any OpenCL program that only wants to use
41	my $ctx = $dev->context_simple;	118	one device,
42	my $queue = $ctx->command_queue_simple ($dev);	119
		120	my ($platform) = OpenCL::platforms; # find first platform
		121	my ($dev) = $platform->devices; # find first device of platform
		122	my $ctx = $platform->context (undef, [$dev]); # create context out of those
		123	my $queue = $ctx->queue ($dev); # create a command queue for the device
43		124
44	=head2 Print all supported image formats of a context.	125	=head2 Print all supported image formats of a context.
45		126
		127	Best run this once for your context, to see whats available and how to
		128	gather information.
		129
46	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {	130	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
47	say "supported image formats for ", OpenCL::enum2str $type;	131	print "supported image formats for ", OpenCL::enum2str $type, "\n";
48		132
49	for my $f ($ctx->supported_image_formats (0, $type)) {	133	for my $f ($ctx->supported_image_formats (0, $type)) {
50	printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];	134	printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];
51	}	135	}
52	}	136	}
…		…
55	then asynchronously.	139	then asynchronously.
56		140
57	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
58		142
59	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);
60	warn $data;	144	print "$data\n";
61		145
62	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	146	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);
63	$ev->wait;	147	$ev->wait;
64	warn $data;	148	print "$data\n"; # prints "elm"
65		149
66	=head2 Create and build a program, then create a kernel out of one of its	150	=head2 Create and build a program, then create a kernel out of one of its
67	functions.	151	functions.
68		152
69	my $src = '	153	my $src = '
70	__kernel void	154	kernel void
71	squareit (__global float *input, __global float *output)	155	squareit (global float *input, global float *output)
72	{	156	{
73	size_t id = get_global_id (0);	157	$id = get_global_id (0);
74	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
75	}	159	}
76	';	160	';
77		161
78	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->build_program ($src);
79
80	eval { $prog->build ($dev); 1 }
81	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
82
83	my $kernel = $prog->kernel ("squareit");	163	my $kernel = $prog->kernel ("squareit");
84		164
85	=head2 Create some input and output float buffers, then call squareit on them.	165	=head2 Create some input and output float buffers, then call the
		166	'squareit' kernel on them.
86		167
87	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);	168	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);
88	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);	169	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
89		170
90	# set buffer	171	# set buffer
…		…
96		177
97	# enqueue a synchronous read	178	# enqueue a synchronous read
98	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	179	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
99		180
100	# print the results:	181	# print the results:
101	say join ", ", unpack "f*", $data;	182	printf "%s\n", join ", ", unpack "f*", $data;
102		183
103	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	184	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
104	showing off barriers.	185	showing off barriers.
105		186
106	# execute it for all 4 numbers	187	# execute it for all 4 numbers
…		…
125	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	206	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
126		207
127	# wait for the last event to complete	208	# wait for the last event to complete
128	$ev->wait;	209	$ev->wait;
129		210
		211	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
		212	set tunnel effect.
		213
		214	This is quite a long example to get you going.
		215
		216	use OpenGL ":all";
		217	use OpenCL;
		218
		219	# open a window and create a gl texture
		220	OpenGL::glpOpenWindow width => 256, height => 256;
		221	my $texid = glGenTextures_p 1;
		222	glBindTexture GL_TEXTURE_2D, $texid;
		223	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
		224
		225	# find and use the first opencl device that let's us get a shared opengl context
		226	my $platform;
		227	my $dev;
		228	my $ctx;
		229
		230	for (OpenCL::platforms) {
		231	$platform = $_;
		232	for ($platform->devices) {
		233	$dev = $_;
		234	$ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
		235	and last;
		236	}
		237	}
		238
		239	$ctx
		240	or die "cannot find suitable OpenCL device\n";
		241
		242	my $queue = $ctx->queue ($dev);
		243
		244	# now attach an opencl image2d object to the opengl texture
		245	my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
		246
		247	# now the boring opencl code
		248	my $src = <<EOF;
		249	kernel void
		250	juliatunnel (write_only image2d_t img, float time)
		251	{
		252	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
		253
		254	float2 m = (float2)(1.f, p.y) / fabs (p.x);
		255	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
		256
		257	float2 z = m;
		258	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
		259
		260	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
		261	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		262
		263	float3 colour = (float3)(z.x, z.y, z.x * z.y);
		264	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
		265	}
		266	EOF
		267
		268	my $prog = $ctx->build_program ($src);
		269	my $kernel = $prog->kernel ("juliatunnel");
		270
		271	# program compiled, kernel ready, now draw and loop
		272
		273	for (my $time; ; ++$time) {
		274	# acquire objects from opengl
		275	$queue->enqueue_acquire_gl_objects ([$tex]);
		276
		277	# configure and run our kernel
		278	$kernel->set_image2d (0, $tex);
		279	$kernel->set_float (1, $time);
		280	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
		281
		282	# release objects to opengl again
		283	$queue->enqueue_release_gl_objects ([$tex]);
		284
		285	# wait
		286	$queue->finish;
		287
		288	# now draw the texture, the defaults should be all right
		289	glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
		290
		291	glEnable GL_TEXTURE_2D;
		292	glBegin GL_QUADS;
		293	glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
		294	glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
		295	glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
		296	glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
		297	glEnd;
		298
		299	glXSwapBuffers;
		300
		301	select undef, undef, undef, 1/60;
		302	}
		303
130	=head1 DOCUMENTATION	304	=head1 DOCUMENTATION
131		305
132	=head2 BASIC CONVENTIONS	306	=head2 BASIC CONVENTIONS
133		307
134	This is not a 1:1 C-style translation of OpenCL to Perl - instead I	308	This is not a one-to-one C-style translation of OpenCL to Perl - instead
135	attempted to make the interface as type-safe as possible and introducing	309	I attempted to make the interface as type-safe as possible by introducing
136	object syntax where it makes sense. There are a number of important	310	object syntax where it makes sense. There are a number of important
137	differences between the OpenCL C API and this module:	311	differences between the OpenCL C API and this module:
138		312
139	=over 4	313	=over 4
140		314
141	=item * Object lifetime managament is automatic - there is no need	315	=item * Object lifetime managament is automatic - there is no need
142	to free objects explicitly (C<clReleaseXXX>), the release function	316	to free objects explicitly (C<clReleaseXXX>), the release function
143	is called automatically once all Perl references to it go away.	317	is called automatically once all Perl references to it go away.
144		318
145	=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>),	319	=item * OpenCL uses CamelCase for function names
		320	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
146	while this module uses underscores as word separator and often leaves out	321	uses underscores as word separator and often leaves out prefixes
147	prefixes (C<< $platform->info >>).	322	(C<OpenCL::platforms>, C<< $platform->info >>).
148		323
149	=item * OpenCL often specifies fixed vector function arguments as short	324	=item * OpenCL often specifies fixed vector function arguments as short
150	arrays (C<size_t origin[3]>), while this module explicitly expects the	325	arrays (C<size_t origin[3]>), while this module explicitly expects the
151	components as separate arguments-	326	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		327	function calls.
152		328
153	=item * Where possible, the row_pitch value is calculated from the perl	329	=item * Structures are often specified by flattening out their components
154	scalar length and need not be specified.	330	as with short vectors, and returned as arrayrefs.
155		331
156	=item * When enqueuing commands, the wait list is specified by adding	332	=item * When enqueuing commands, the wait list is specified by adding
157	extra arguments to the function - everywhere a C<$wait_events...> argument	333	extra arguments to the function - anywhere a C<$wait_events...> argument
158	is documented this can be any number of event objects.	334	is documented this can be any number of event objects. As an extsnion
		335	implemented by this module, C<undef> values will be ignored in the event
		336	list.
159		337
160	=item * When enqueuing commands, if the enqueue method is called in void	338	=item * When enqueuing commands, if the enqueue method is called in void
161	context, no event is created. In all other contexts an event is returned	339	context, no event is created. In all other contexts an event is returned
162	by the method.	340	by the method.
163		341
…		…
165	other status is returned the function will throw an exception, so you	343	other status is returned the function will throw an exception, so you
166	don't normally have to to any error checking.	344	don't normally have to to any error checking.
167		345
168	=back	346	=back
169		347
		348	=head2 PERL AND OPENCL TYPES
		349
		350	This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
		351	format equivalents:
		352
		353	OpenCL perl PDL pack/unpack
		354	char IV - c
		355	uchar IV byte C
		356	short IV short s
		357	ushort IV ushort S
		358	int IV long? l
		359	uint IV - L
		360	long IV longlong q
		361	ulong IV - Q
		362	float NV float f
		363	half IV ushort S
		364	double NV double d
		365
		366	=head2 GLX SUPPORT
		367
		368	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		369	module, which has little to no documentation and has little to no support
		370	for glX), this module, as a special extension, treats context creation
		371	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		372	specially: If either or both of these are C<undef>, then the OpenCL
		373	module tries to dynamically resolve C<glXGetCurrentDisplay> and
		374	C<glXGetCurrentContext>, call these functions and use their return values
		375	instead.
		376
		377	For this to work, the OpenGL library must be loaded, a GLX context must
		378	have been created and be made current, and C<dlsym> must be available and
		379	capable of finding the function via C<RTLD_DEFAULT>.
		380
		381	=head2 EVENT SYSTEM
		382
		383	OpenCL can generate a number of (potentially) asynchronous events, for
		384	example, after compiling a program, to signal a context-related error or,
		385	perhaps most important, to signal completion of queued jobs (by setting
		386	callbacks on OpenCL::Event objects).
		387
		388	To facilitate this, this module maintains an event queue - each
		389	time an asynchronous event happens, it is queued, and perl will be
		390	interrupted. This is implemented via the L<Async::Interrupt> module. In
		391	addition, this module has L<AnyEvent> support, so it can seamlessly
		392	integrate itself into many event loops.
		393
		394	Since this module is a bit hard to understand, here are some case examples:
		395
		396	=head3 Don't use callbacks.
		397
		398	When your program never uses any callbacks, then there will never be any
		399	notifications you need to take care of, and therefore no need to worry
		400	about all this.
		401
		402	You can achieve a great deal by explicitly waiting for events, or using
		403	barriers and flush calls. In many programs, there is no need at all to
		404	tinker with asynchronous events.
		405
		406	=head3 Use AnyEvent
		407
		408	This module automatically registers a watcher that invokes all outstanding
		409	event callbacks when AnyEvent is initialised (and block asynchronous
		410	interruptions). Using this mode of operations is the safest and most
		411	recommended one.
		412
		413	To use this, simply use AnyEvent and this module normally, make sure you
		414	have an event loop running:
		415
		416	use Gtk2 -init;
		417	use AnyEvent;
		418
		419	# initialise AnyEvent, by creating a watcher, or:
		420	AnyEvent::detect;
		421
		422	my $e = $queue->enqueue_marker;
		423	$e->cb (sub {
		424	warn "opencl is finished\n";
		425	})
		426
		427	main Gtk2;
		428
		429	Note that this module will not initialise AnyEvent for you. Before
		430	AnyEvent is initialised, the module will asynchronously interrupt perl
		431	instead. To avoid any surprises, it's best to explicitly initialise
		432	AnyEvent.
		433
		434	You can temporarily enable asynchronous interruptions (see next paragraph)
		435	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		436	calling C<$OpenCL::INTERRUPT->block>.
		437
		438	=head3 Let yourself be interrupted at any time
		439
		440	This mode is the default unless AnyEvent is loaded and initialised. In
		441	this mode, OpenCL asynchronously interrupts a running perl program. The
		442	emphasis is on both I<asynchronously> and I<running> here.
		443
		444	Asynchronously means that perl might execute your callbacks at any
		445	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		446	the C<until> loop following the marker call will be interrupted by the
		447	callback:
		448
		449	my $e = $queue->enqueue_marker;
		450	my $flag;
		451	$e->cb (sub { $flag = 1 });
		452	1 until $flag;
		453	# $flag is now 1
		454
		455	The reason why you shouldn't blindly copy the above code is that
		456	busy waiting is a really really bad thing, and really really bad for
		457	performance.
		458
		459	While at first this asynchronous business might look exciting, it can be
		460	really hard, because you need to be prepared for the callback code to be
		461	executed at any time, which limits the amount of things the callback code
		462	can do safely.
		463
		464	This can be mitigated somewhat by using C<<
		465	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		466	documentation for details).
		467
		468	The other problem is that your program must be actively I<running> to be
		469	interrupted. When you calculate stuff, your program is running. When you
		470	hang in some C functions or other block execution (by calling C<sleep>,
		471	C<select>, running an event loop and so on), your program is waiting, not
		472	running.
		473
		474	One way around that would be to attach a read watcher to your event loop,
		475	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		476	dummy callback (C<sub { }>) to temporarily execute some perl code.
		477
		478	That is then awfully close to using the built-in AnyEvent support above,
		479	though, so consider that one instead.
		480
		481	=head3 Be creative
		482
		483	OpenCL exports the L<Async::Interrupt> object it uses in the global
		484	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		485
		486	So if you want to feel like a real pro, err, wait, if you feel no risk
		487	menas no fun, you can experiment by implementing your own mode of
		488	operations.
		489
		490	=cut
		491
		492	package OpenCL;
		493
		494	use common::sense;
		495	use Async::Interrupt ();
		496
		497	our $POLL_FUNC; # set by XS
		498
		499	BEGIN {
		500	our $VERSION = '0.97';
		501
		502	require XSLoader;
		503	XSLoader::load (__PACKAGE__, $VERSION);
		504
		505	@OpenCL::Platform::ISA =
		506	@OpenCL::Device::ISA =
		507	@OpenCL::Context::ISA =
		508	@OpenCL::Queue::ISA =
		509	@OpenCL::Memory::ISA =
		510	@OpenCL::Sampler::ISA =
		511	@OpenCL::Program::ISA =
		512	@OpenCL::Kernel::ISA =
		513	@OpenCL::Event::ISA = OpenCL::Object::;
		514
		515	@OpenCL::Buffer::ISA =
		516	@OpenCL::Image::ISA = OpenCL::Memory::;
		517
		518	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		519
		520	@OpenCL::Image2D::ISA =
		521	@OpenCL::Image3D::ISA =
		522	@OpenCL::Image2DArray::ISA =
		523	@OpenCL::Image1D::ISA =
		524	@OpenCL::Image1DArray::ISA =
		525	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		526
		527	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		528	}
		529
170	=head2 THE OpenCL PACKAGE	530	=head2 THE OpenCL PACKAGE
171		531
172	=over 4	532	=over 4
173		533
174	=item $int = OpenCL::errno	534	=item $int = OpenCL::errno
175		535
176	The last error returned by a function - it's only changed on errors.	536	The last error returned by a function - it's only valid after an error occured
		537	and before calling another OpenCL function.
177		538
178	=item $str = OpenCL::err2str $errval	539	=item $str = OpenCL::err2str $errval
179		540
180	Comverts an error value into a human readable string.	541	Comverts an error value into a human readable string.
181		542
182	=item $str = OpenCL::err2str $enum	543	=item $str = OpenCL::enum2str $enum
183		544
184	Converts most enum values (inof parameter names, image format constants,	545	Converts most enum values (of parameter names, image format constants,
185	object types, addressing and filter modes, command types etc.) into a	546	object types, addressing and filter modes, command types etc.) into a
186	human readbale string. When confronted with some random integer it can be	547	human readable string. When confronted with some random integer it can be
187	very helpful to pass it through this function to maybe get some readable	548	very helpful to pass it through this function to maybe get some readable
188	string out of it.	549	string out of it.
189		550
190	=item @platforms = OpenCL::platforms	551	=item @platforms = OpenCL::platforms
191		552
192	Returns all available OpenCL::Platform objects.	553	Returns all available OpenCL::Platform objects.
193		554
194	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	555	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
195		556
196	=item $ctx = OpenCL::context_from_type_simple $type = OpenCL::DEVICE_TYPE_DEFAULT	557	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
197		558
198	Tries to create a context from a default device and platform - never worked for me.	559	Tries to create a context from a default device and platform type - never worked for me.
199		560
200	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	561	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
201		562
		563	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		564
		565	Create a new OpenCL::Context object using the given device object(s). This
		566	function isn't implemented yet, use C<< $platform->context >> instead.
		567
		568	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		569
202	=item OpenCL::wait_for_events $wait_events...	570	=item OpenCL::wait_for_events $wait_events...
203		571
204	Waits for all events to complete.	572	Waits for all events to complete.
205		573
206	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	574	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
207		575
		576	=item OpenCL::poll
		577
		578	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		579	invokes their callbacks.
		580
		581	=item $OpenCL::INTERRUPT
		582
		583	The L<Async::Interrupt> object used to signal asynchronous events (see
		584	L<EVENT SYSTEM>).
		585
		586	=cut
		587
		588	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		589
		590	&_eq_initialise ($INTERRUPT->signal_func);
		591
		592	=item $OpenCL::WATCHER
		593
		594	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		595	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		596	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		597
		598	=cut
		599
		600	our $WATCHER;
		601
		602	sub _init_anyevent {
		603	$INTERRUPT->block;
		604	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		605	}
		606
		607	if (defined $AnyEvent::MODEL) {
		608	_init_anyevent;
		609	} else {
		610	push @AnyEvent::post_detect, \&_init_anyevent;
		611	}
		612
208	=back	613	=back
209		614
		615	=head2 THE OpenCL::Object CLASS
		616
		617	This is the base class for all objects in the OpenCL module. The only
		618	method it implements is the C<id> method, which is only useful if you want
		619	to interface to OpenCL on the C level.
		620
		621	=over 4
		622
		623	=item $iv = $obj->id
		624
		625	OpenCL objects are represented by pointers or integers on the C level. If
		626	you want to interface to an OpenCL object directly on the C level, then
		627	you need this value, which is returned by this method. You should use an
		628	C<IV> type in your code and cast that to the correct type.
		629
		630	=cut
		631
		632	sub OpenCL::Object::id {
		633	ref $_[0] eq "SCALAR"
		634	? ${ $_[0] }
		635	: $_[0][0]
		636	}
		637
		638	=back
		639
210	=head2 THE OpenCL::Platform CLASS	640	=head2 THE OpenCL::Platform CLASS
211		641
212	=over 4	642	=over 4
213		643
		644	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
		645
		646	Returns a list of matching OpenCL::Device objects.
		647
		648	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
		649
		650	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
		651
		652	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		653
		654	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		655
		656	Create a new OpenCL::Context object using the given device object(s)- a
		657	CL_CONTEXT_PLATFORM property is supplied automatically.
		658
		659	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		660
214	=item $packed_value = $platform->info ($name)	661	=item $packed_value = $platform->info ($name)
215		662
216	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	663	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
217	strings, this will be the string, for other values you probably need to	664	strings, this will be the string (possibly including terminating \0), for
218	use the correct C<unpack>. This might get improved in the future. Hopefully.	665	other values you probably need to use the correct C<unpack>.
		666
		667	It's best to avoid this method and use one of the following convenience
		668	wrappers.
219		669
220	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	670	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
221		671
222	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	672	=item $platform->unload_compiler
223		673
224	Returns a list of matching OpenCL::Device objects.	674	Attempts to unload the compiler for this platform, for endless
		675	profit. Does nothing on OpenCL 1.1.
225		676
226	=item $ctx = $platform->context_from_type_simple ($type = OpenCL::DEVICE_TYPE_DEFAULT)
227
228	Tries to create a context. Never worked for me.
229
230	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	677	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		678
		679	=for gengetinfo begin platform
		680
		681	=item $string = $platform->profile
		682
		683	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
		684
		685	=item $string = $platform->version
		686
		687	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
		688
		689	=item $string = $platform->name
		690
		691	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
		692
		693	=item $string = $platform->vendor
		694
		695	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
		696
		697	=item $string = $platform->extensions
		698
		699	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		700
		701	=for gengetinfo end platform
231		702
232	=back	703	=back
233		704
234	=head2 THE OpenCL::Device CLASS	705	=head2 THE OpenCL::Device CLASS
235		706
…		…
239		710
240	See C<< $platform->info >> for details.	711	See C<< $platform->info >> for details.
241		712
242	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	713	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
243		714
		715	=for gengetinfo begin device
		716
		717	=item $device_type = $device->type
		718
		719	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		720
		721	=item $uint = $device->vendor_id
		722
		723	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		724
		725	=item $uint = $device->max_compute_units
		726
		727	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		728
		729	=item $uint = $device->max_work_item_dimensions
		730
		731	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		732
		733	=item $int = $device->max_work_group_size
		734
		735	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		736
		737	=item @ints = $device->max_work_item_sizes
		738
		739	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		740
		741	=item $uint = $device->preferred_vector_width_char
		742
		743	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		744
		745	=item $uint = $device->preferred_vector_width_short
		746
		747	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		748
		749	=item $uint = $device->preferred_vector_width_int
		750
		751	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		752
		753	=item $uint = $device->preferred_vector_width_long
		754
		755	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		756
		757	=item $uint = $device->preferred_vector_width_float
		758
		759	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		760
		761	=item $uint = $device->preferred_vector_width_double
		762
		763	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		764
		765	=item $uint = $device->max_clock_frequency
		766
		767	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		768
		769	=item $bitfield = $device->address_bits
		770
		771	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		772
		773	=item $uint = $device->max_read_image_args
		774
		775	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		776
		777	=item $uint = $device->max_write_image_args
		778
		779	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		780
		781	=item $ulong = $device->max_mem_alloc_size
		782
		783	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		784
		785	=item $int = $device->image2d_max_width
		786
		787	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		788
		789	=item $int = $device->image2d_max_height
		790
		791	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		792
		793	=item $int = $device->image3d_max_width
		794
		795	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		796
		797	=item $int = $device->image3d_max_height
		798
		799	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		800
		801	=item $int = $device->image3d_max_depth
		802
		803	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		804
		805	=item $uint = $device->image_support
		806
		807	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		808
		809	=item $int = $device->max_parameter_size
		810
		811	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		812
244	=item $ctx = $device->context_simple	813	=item $uint = $device->max_samplers
245		814
246	Convenience function to create a new OpenCL::Context object.	815	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
247		816
248	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	817	=item $uint = $device->mem_base_addr_align
		818
		819	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		820
		821	=item $uint = $device->min_data_type_align_size
		822
		823	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		824
		825	=item $device_fp_config = $device->single_fp_config
		826
		827	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		828
		829	=item $device_mem_cache_type = $device->global_mem_cache_type
		830
		831	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		832
		833	=item $uint = $device->global_mem_cacheline_size
		834
		835	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		836
		837	=item $ulong = $device->global_mem_cache_size
		838
		839	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		840
		841	=item $ulong = $device->global_mem_size
		842
		843	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		844
		845	=item $ulong = $device->max_constant_buffer_size
		846
		847	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		848
		849	=item $uint = $device->max_constant_args
		850
		851	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		852
		853	=item $device_local_mem_type = $device->local_mem_type
		854
		855	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		856
		857	=item $ulong = $device->local_mem_size
		858
		859	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		860
		861	=item $boolean = $device->error_correction_support
		862
		863	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		864
		865	=item $int = $device->profiling_timer_resolution
		866
		867	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		868
		869	=item $boolean = $device->endian_little
		870
		871	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		872
		873	=item $boolean = $device->available
		874
		875	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		876
		877	=item $boolean = $device->compiler_available
		878
		879	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		880
		881	=item $device_exec_capabilities = $device->execution_capabilities
		882
		883	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		884
		885	=item $command_queue_properties = $device->properties
		886
		887	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		888
		889	=item $ = $device->platform
		890
		891	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		892
		893	=item $string = $device->name
		894
		895	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		896
		897	=item $string = $device->vendor
		898
		899	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		900
		901	=item $string = $device->driver_version
		902
		903	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		904
		905	=item $string = $device->profile
		906
		907	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		908
		909	=item $string = $device->version
		910
		911	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		912
		913	=item $string = $device->extensions
		914
		915	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		916
		917	=item $uint = $device->preferred_vector_width_half
		918
		919	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		920
		921	=item $uint = $device->native_vector_width_char
		922
		923	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		924
		925	=item $uint = $device->native_vector_width_short
		926
		927	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		928
		929	=item $uint = $device->native_vector_width_int
		930
		931	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		932
		933	=item $uint = $device->native_vector_width_long
		934
		935	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		936
		937	=item $uint = $device->native_vector_width_float
		938
		939	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		940
		941	=item $uint = $device->native_vector_width_double
		942
		943	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		944
		945	=item $uint = $device->native_vector_width_half
		946
		947	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		948
		949	=item $device_fp_config = $device->double_fp_config
		950
		951	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		952
		953	=item $device_fp_config = $device->half_fp_config
		954
		955	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		956
		957	=item $boolean = $device->host_unified_memory
		958
		959	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		960
		961	=item $device = $device->parent_device_ext
		962
		963	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		964
		965	=item @device_partition_property_exts = $device->partition_types_ext
		966
		967	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		968
		969	=item @device_partition_property_exts = $device->affinity_domains_ext
		970
		971	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		972
		973	=item $uint = $device->reference_count_ext
		974
		975	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
		976
		977	=item @device_partition_property_exts = $device->partition_style_ext
		978
		979	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		980
		981	=for gengetinfo end device
249		982
250	=back	983	=back
251		984
252	=head2 THE OpenCL::Context CLASS	985	=head2 THE OpenCL::Context CLASS
253		986
254	=over 4	987	=over 4
255		988
256	=item $packed_value = $ctx->info ($name)	989	=item $prog = $ctx->build_program ($program, $options = "")
257		990
258	See C<< $platform->info >> for details.	991	This convenience function tries to build the program on all devices in
		992	the context. If the build fails, then the function will C<croak> with the
		993	build log. Otherwise ti returns the program object.
259		994
260	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	995	The C<$program> can either be a C<OpenCL::Program> object or a string
		996	containing the program. In the latter case, a program objetc will be
		997	created automatically.
261		998
262	=item $queue = $ctx->command_queue_simple ($device)	999	=cut
263		1000
		1001	sub OpenCL::Context::build_program {
		1002	my ($self, $prog, $options) = @_;
		1003
		1004	require Carp;
		1005
		1006	$prog = $self->program_with_source ($prog)
		1007	unless ref $prog;
		1008
		1009	# we build separately per device so we instantly know which one failed
		1010	for my $dev ($self->devices) {
		1011	eval { $prog->build ([$dev], $options); 1 }
		1012	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1013	. $prog->build_log ($dev));
		1014	}
		1015
		1016	$prog
		1017	}
		1018
		1019	=item $queue = $ctx->queue ($device, $properties)
		1020
264	Convenience function to create a new OpenCL::Queue object from the context and the given device.	1021	Create a new OpenCL::Queue object from the context and the given device.
265		1022
266	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	1023	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
267		1024
		1025	Example: create an out-of-order queue.
		1026
		1027	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		1028
268	=item $ev = $ctx->user_event	1029	=item $ev = $ctx->user_event
269		1030
270	Creates a new OpenCL::UserEvent object.	1031	Creates a new OpenCL::UserEvent object.
271		1032
272	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	1033	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
273		1034
274	=item $buf = $ctx->buffer ($flags, $len)	1035	=item $buf = $ctx->buffer ($flags, $len)
275		1036
276	Creates a new OpenCL::Buffer object with the given flags and octet-size.	1037	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		1038	given flags and octet-size.
277		1039
278	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1040	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
279		1041
280	=item $buf = $ctx->buffer_sv ($flags, $data)	1042	=item $buf = $ctx->buffer_sv ($flags, $data)
281		1043
282	Creates a new OpenCL::Buffer object and initialise it with the given data values.	1044	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		1045	initialise it with the given data values.
283		1046
		1047	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
		1048
		1049	Creates a new OpenCL::Image object and optionally initialises it with
		1050	the given data values.
		1051
		1052	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
		1053
284	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	1054	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
285		1055
286	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	1056	Creates a new OpenCL::Image2D object and optionally initialises it with
		1057	the given data values.
287		1058
288	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	1059	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
289		1060
290	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	1061	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
291		1062
292	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	1063	Creates a new OpenCL::Image3D object and optionally initialises it with
		1064	the given data values.
293		1065
294	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	1066	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		1067
		1068	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		1069
		1070	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		1071	OpenGL buffer object.
		1072
		1073	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		1074
		1075	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		1076
		1077	Creates a new OpenCL::Image object that refers to the given OpenGL
		1078	texture object or buffer.
		1079
		1080	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		1081
		1082	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		1083
		1084	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1085	2D texture object.
		1086
		1087	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		1088
		1089	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		1090
		1091	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		1092	3D texture object.
		1093
		1094	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		1095
		1096	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		1097
		1098	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		1099	render buffer.
		1100
		1101	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
295		1102
296	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	1103	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
297		1104
298	Returns a list of matching image formats - each format is an arrayref with	1105	Returns a list of matching image formats - each format is an arrayref with
299	two values, $channel_order and $channel_type, in it.	1106	two values, $channel_order and $channel_type, in it.
…		…
309	=item $program = $ctx->program_with_source ($string)	1116	=item $program = $ctx->program_with_source ($string)
310		1117
311	Creates a new OpenCL::Program object from the given source code.	1118	Creates a new OpenCL::Program object from the given source code.
312		1119
313	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1120	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		1121
		1122	=item $packed_value = $ctx->info ($name)
		1123
		1124	See C<< $platform->info >> for details.
		1125
		1126	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		1127
		1128	=for gengetinfo begin context
		1129
		1130	=item $uint = $context->reference_count
		1131
		1132	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		1133
		1134	=item @devices = $context->devices
		1135
		1136	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		1137
		1138	=item @property_ints = $context->properties
		1139
		1140	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		1141
		1142	=item $uint = $context->num_devices
		1143
		1144	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		1145
		1146	=for gengetinfo end context
314		1147
315	=back	1148	=back
316		1149
317	=head2 THE OpenCL::Queue CLASS	1150	=head2 THE OpenCL::Queue CLASS
318		1151
…		…
324	for completion, unless the method is called in void context, in which case	1157	for completion, unless the method is called in void context, in which case
325	no event object is created.	1158	no event object is created.
326		1159
327	They also allow you to specify any number of other event objects that this	1160	They also allow you to specify any number of other event objects that this
328	request has to wait for before it starts executing, by simply passing the	1161	request has to wait for before it starts executing, by simply passing the
329	event objects as extra parameters to the enqueue methods.	1162	event objects as extra parameters to the enqueue methods. To simplify
		1163	program design, this module ignores any C<undef> values in the list of
		1164	events. This makes it possible to code operations such as this, without
		1165	having to put a valid event object into C<$event> first:
		1166
		1167	$event = $queue->enqueue_xxx (..., $event);
330		1168
331	Queues execute in-order by default, without any parallelism, so in most	1169	Queues execute in-order by default, without any parallelism, so in most
332	cases it's not necessary to wait for or create event objects.	1170	cases (i.e. you use only one queue) it's not necessary to wait for or
		1171	create event objects, althoguh an our of order queue is often a bit
		1172	faster.
333		1173
334	=over 4	1174	=over 4
335		1175
336	=item $packed_value = $ctx->info ($name)
337
338	See C<< $platform->info >> for details.
339
340	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
341
342	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1176	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
343		1177
344	Reads data from buffer into the given string.	1178	Reads data from buffer into the given string.
345		1179
346	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1180	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
353		1187
354	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1188	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
355		1189
356	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
357		1191
		1192	=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...)
		1193
		1194	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		1195
		1196	=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...)
		1197
		1198	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		1199
358	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1200	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
359		1201
		1202	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		1203
		1204	=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...)
		1205
360	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1206	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
361		1207
362	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	1208	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
363		1209
364	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
365		1211
		1212	=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...)
		1213
		1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		1215
		1216	=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...)
		1217
		1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		1219
366	=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, 4dst_row_pitch, $dst_slice_pitch, $ait_event...)	1220	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
367		1221
368	Yeah.	1222	Yeah.
369		1223
370	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
371
372	=item $ev = $queue->enqueue_copy_buffer_to_image (OpenCL::Buffer src, OpenCL::Image dst, size_t src_offset, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
373
374	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1224	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
375		1225
376	=item $ev = $queue->enqueue_copy_image (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)	1226	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
377		1227
		1228	Fills the given buffer object with repeated applications of C<$pattern>,
		1229	starting at C<$offset> for C<$size> octets.
		1230
		1231	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1232
		1233	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1234
		1235	Fills the given image area with the given rgba colour components. The
		1236	components are normally floating point values between C<0> and C<1>,
		1237	except when the image channel data type is a signe dor unsigned
		1238	unnormalised format, in which case the range is determined by the format.
		1239
378	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1240	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
379
380	=item $ev = $queue->enqueue_copy_image_to_buffer (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t width, size_t height, size_t depth, size_t dst_offset, ...)
381
382	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
383		1241
384	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1242	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
385		1243
386	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1244	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
387		1245
…		…
401	reference to an array of local work sizes, with the same number of	1259	reference to an array of local work sizes, with the same number of
402	elements as @$global_work_size.	1260	elements as @$global_work_size.
403		1261
404	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
405		1263
406	=item $ev = $queue->enqueue_marker	1264	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
407		1265
		1266	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1267	for subsequent OpenCL usage.
		1268
408	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1269	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		1270
		1271	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		1272
		1273	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1274	for subsequent OpenGL usage.
		1275
		1276	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
409		1277
410	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1278	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
411		1279
412	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1280	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
413		1281
414	=item $queue->enqueue_barrier	1282	=item $ev = $queue->enqueue_marker ($wait_events...)
415		1283
		1284	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1285
		1286	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1287
416	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
417		1289
418	=item $queue->flush	1290	=item $queue->flush
419		1291
420	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1292	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
421		1293
422	=item $queue->finish	1294	=item $queue->finish
423		1295
424	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	1296	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
425		1297
		1298	=item $packed_value = $queue->info ($name)
		1299
		1300	See C<< $platform->info >> for details.
		1301
		1302	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1303
		1304	=for gengetinfo begin command_queue
		1305
		1306	=item $ctx = $command_queue->context
		1307
		1308	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1309
		1310	=item $device = $command_queue->device
		1311
		1312	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1313
		1314	=item $uint = $command_queue->reference_count
		1315
		1316	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1317
		1318	=item $command_queue_properties = $command_queue->properties
		1319
		1320	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1321
		1322	=for gengetinfo end command_queue
		1323
426	=back	1324	=back
427		1325
428	=head2 THE OpenCL::Memory CLASS	1326	=head2 THE OpenCL::Memory CLASS
429		1327
430	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	1328	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
431	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	1329	OpenCL::Image2D and OpenCL::Image3D.
432	currently only exist to allow type-checking.
433		1330
434	=over 4	1331	=over 4
435		1332
436	=item $packed_value = $memory->info ($name)	1333	=item $packed_value = $memory->info ($name)
437		1334
438	See C<< $platform->info >> for details.	1335	See C<< $platform->info >> for details.
439		1336
440	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1337	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
441		1338
		1339	=for gengetinfo begin mem
		1340
		1341	=item $mem_object_type = $mem->type
		1342
		1343	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1344
		1345	=item $mem_flags = $mem->flags
		1346
		1347	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1348
		1349	=item $int = $mem->size
		1350
		1351	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1352
		1353	=item $ptr_value = $mem->host_ptr
		1354
		1355	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1356
		1357	=item $uint = $mem->map_count
		1358
		1359	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1360
		1361	=item $uint = $mem->reference_count
		1362
		1363	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1364
		1365	=item $ctx = $mem->context
		1366
		1367	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1368
		1369	=item $mem = $mem->associated_memobject
		1370
		1371	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1372
		1373	=item $int = $mem->offset
		1374
		1375	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1376
		1377	=for gengetinfo end mem
		1378
		1379	=item ($type, $name) = $mem->gl_object_info
		1380
		1381	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1382	object "name" (e.g. the texture name) used to create this memory object.
		1383
		1384	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1385
442	=back	1386	=back
443		1387
		1388	=head2 THE OpenCL::Buffer CLASS
		1389
		1390	This is a subclass of OpenCL::Memory, and the superclass of
		1391	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1392	and sub-buffers.
		1393
		1394	=head2 THE OpenCL::BufferObj CLASS
		1395
		1396	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1397	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1398	sub buffers from these sub buffers.
		1399
		1400	=over 4
		1401
		1402	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1403
		1404	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1405	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1406
		1407	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1408
		1409	=back
		1410
		1411	=head2 THE OpenCL::Image CLASS
		1412
		1413	This is the superclass of all image objects - OpenCL::Image1D,
		1414	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1415	OpenCL::Image2DArray and OpenCL::Image3D.
		1416
		1417	=over 4
		1418
		1419	=item $packed_value = $image->image_info ($name)
		1420
		1421	See C<< $platform->info >> for details.
		1422
		1423	The reason this method is not called C<info> is that there already is an
		1424	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1425
		1426	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1427
		1428	=item ($channel_order, $channel_data_type) = $image->format
		1429
		1430	Returns the channel order and type used to create the image by calling
		1431	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1432
		1433	=for gengetinfo begin image
		1434
		1435	=item $int = $image->element_size
		1436
		1437	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1438
		1439	=item $int = $image->row_pitch
		1440
		1441	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1442
		1443	=item $int = $image->slice_pitch
		1444
		1445	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1446
		1447	=item $int = $image->width
		1448
		1449	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1450
		1451	=item $int = $image->height
		1452
		1453	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1454
		1455	=item $int = $image->depth
		1456
		1457	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1458
		1459	=for gengetinfo end image
		1460
		1461	=for gengetinfo begin gl_texture
		1462
		1463	=item $GLenum = $gl_texture->target
		1464
		1465	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1466
		1467	=item $GLint = $gl_texture->gl_mipmap_level
		1468
		1469	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1470
		1471	=for gengetinfo end gl_texture
		1472
		1473	=back
		1474
444	=head2 THE OpenCL::Sampler CLASS	1475	=head2 THE OpenCL::Sampler CLASS
445		1476
446	=over 4	1477	=over 4
447		1478
448	=item $packed_value = $sampler->info ($name)	1479	=item $packed_value = $sampler->info ($name)
449		1480
450	See C<< $platform->info >> for details.	1481	See C<< $platform->info >> for details.
451		1482
452	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1483	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
453		1484
		1485	=for gengetinfo begin sampler
		1486
		1487	=item $uint = $sampler->reference_count
		1488
		1489	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1490
		1491	=item $ctx = $sampler->context
		1492
		1493	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1494
		1495	=item $addressing_mode = $sampler->normalized_coords
		1496
		1497	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1498
		1499	=item $filter_mode = $sampler->addressing_mode
		1500
		1501	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1502
		1503	=item $boolean = $sampler->filter_mode
		1504
		1505	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1506
		1507	=for gengetinfo end sampler
		1508
454	=back	1509	=back
455		1510
456	=head2 THE OpenCL::Program CLASS	1511	=head2 THE OpenCL::Program CLASS
457		1512
458	=over 4	1513	=over 4
459		1514
460	=item $packed_value = $program->info ($name)	1515	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
461		1516
462	See C<< $platform->info >> for details.
463
464	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
465
466	=item $program->build ($device, $options = "")
467
468	Tries to build the program with the givne options.	1517	Tries to build the program with the given options. See also the
		1518	C<$ctx->build> convenience function.
		1519
		1520	If a callback is specified, then it will be called when compilation is
		1521	finished. Note that many OpenCL implementations block your program while
		1522	compiling whether you use a callback or not. See C<build_async> if you
		1523	want to make sure the build is done in the background.
		1524
		1525	Note that some OpenCL implementations atc up badly, and don't call the
		1526	callback in some error cases (but call it in others). This implementation
		1527	assumes the callback will always be called, and leaks memory if this is
		1528	not so. So best make sure you don't pass in invalid values.
469		1529
470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1531
		1532	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1533
		1534	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1535	need to check the compilation status form the callback, or by polling).
471		1536
472	=item $packed_value = $program->build_info ($device, $name)	1537	=item $packed_value = $program->build_info ($device, $name)
473		1538
474	Similar to C<< $platform->info >>, but returns build info for a previous	1539	Similar to C<< $platform->info >>, but returns build info for a previous
475	build attempt for the given device.	1540	build attempt for the given device.
…		…
481	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1546	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
482	the program.	1547	the program.
483		1548
484	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1549	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
485		1550
		1551	=item @kernels = $program->kernels_in_program
		1552
		1553	Returns all kernels successfully compiled for all devices in program.
		1554
		1555	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
		1556
		1557	=for gengetinfo begin program_build
		1558
		1559	=item $build_status = $program->build_status ($device)
		1560
		1561	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1562
		1563	=item $string = $program->build_options ($device)
		1564
		1565	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1566
		1567	=item $string = $program->build_log ($device)
		1568
		1569	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1570
		1571	=for gengetinfo end program_build
		1572
		1573	=item $packed_value = $program->info ($name)
		1574
		1575	See C<< $platform->info >> for details.
		1576
		1577	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1578
		1579	=for gengetinfo begin program
		1580
		1581	=item $uint = $program->reference_count
		1582
		1583	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1584
		1585	=item $ctx = $program->context
		1586
		1587	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1588
		1589	=item $uint = $program->num_devices
		1590
		1591	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1592
		1593	=item @devices = $program->devices
		1594
		1595	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1596
		1597	=item $string = $program->source
		1598
		1599	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1600
		1601	=item @ints = $program->binary_sizes
		1602
		1603	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1604
		1605	=for gengetinfo end program
		1606
		1607	=item @blobs = $program->binaries
		1608
		1609	Returns a string for the compiled binary for every device associated with
		1610	the program, empty strings indicate missing programs, and an empty result
		1611	means no program binaries are available.
		1612
		1613	These "binaries" are often, in fact, informative low-level assembly
		1614	sources.
		1615
		1616	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1617
486	=back	1618	=back
487		1619
488	=head2 THE OpenCL::Kernel CLASS	1620	=head2 THE OpenCL::Kernel CLASS
489		1621
490	=over 4	1622	=over 4
…		…
492	=item $packed_value = $kernel->info ($name)	1624	=item $packed_value = $kernel->info ($name)
493		1625
494	See C<< $platform->info >> for details.	1626	See C<< $platform->info >> for details.
495		1627
496	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1628	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1629
		1630	=for gengetinfo begin kernel
		1631
		1632	=item $string = $kernel->function_name
		1633
		1634	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1635
		1636	=item $uint = $kernel->num_args
		1637
		1638	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1639
		1640	=item $uint = $kernel->reference_count
		1641
		1642	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1643
		1644	=item $ctx = $kernel->context
		1645
		1646	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1647
		1648	=item $program = $kernel->program
		1649
		1650	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1651
		1652	=for gengetinfo end kernel
		1653
		1654	=item $packed_value = $kernel->work_group_info ($device, $name)
		1655
		1656	See C<< $platform->info >> for details.
		1657
		1658	The reason this method is not called C<info> is that there already is an
		1659	C<< ->info >> method.
		1660
		1661	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1662
		1663	=for gengetinfo begin kernel_work_group
		1664
		1665	=item $int = $kernel->work_group_size ($device)
		1666
		1667	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1668
		1669	=item @ints = $kernel->compile_work_group_size ($device)
		1670
		1671	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1672
		1673	=item $ulong = $kernel->local_mem_size ($device)
		1674
		1675	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1676
		1677	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1678
		1679	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1680
		1681	=item $ulong = $kernel->private_mem_size ($device)
		1682
		1683	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1684
		1685	=for gengetinfo end kernel_work_group
497		1686
498	=item $kernel->set_TYPE ($index, $value)	1687	=item $kernel->set_TYPE ($index, $value)
499		1688
500	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1689	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
501		1690
502	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,	1691	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
503	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,	1692	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
504	C<image2d>, C<image3d>, C<sampler> or C<event>.	1693	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
505		1694
506	Chars and integers (including the half type) are specified as integers,	1695	Chars and integers (including the half type) are specified as integers,
507	float and double as floating point values, memory/buffer/image2d/image3d	1696	float and double as floating point values, memory/buffer/image2d/image3d
508	must be an object of that type or C<undef>, and sampler and event must be	1697	must be an object of that type or C<undef>, local-memory arguments are
509	objects of that type.	1698	set by specifying the size, and sampler and event must be objects of that
		1699	type.
		1700
		1701	Setting an argument for a kernel does NOT keep a reference to the object -
		1702	for example, if you set an argument to some image object, free the image,
		1703	and call the kernel, you will run into undefined behaviour.
510		1704
511	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1705	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
512		1706
513	=back	1707	=back
514		1708
…		…
517	This is the superclass for all event objects (including OpenCL::UserEvent	1711	This is the superclass for all event objects (including OpenCL::UserEvent
518	objects).	1712	objects).
519		1713
520	=over 4	1714	=over 4
521		1715
		1716	=item $ev->wait
		1717
		1718	Waits for the event to complete.
		1719
		1720	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1721
		1722	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1723
		1724	Adds a callback to the callback stack for the given event type. There is
		1725	no way to remove a callback again.
		1726
		1727	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1728
522	=item $packed_value = $ev->info ($name)	1729	=item $packed_value = $ev->info ($name)
523		1730
524	See C<< $platform->info >> for details.	1731	See C<< $platform->info >> for details.
525		1732
526	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1733	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
527		1734
528	=item $ev->wait	1735	=for gengetinfo begin event
529		1736
530	Waits for the event to complete.	1737	=item $queue = $event->command_queue
531		1738
		1739	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1740
		1741	=item $command_type = $event->command_type
		1742
		1743	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1744
		1745	=item $uint = $event->reference_count
		1746
		1747	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1748
		1749	=item $uint = $event->command_execution_status
		1750
		1751	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1752
		1753	=item $ctx = $event->context
		1754
		1755	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1756
		1757	=for gengetinfo end event
		1758
		1759	=item $packed_value = $ev->profiling_info ($name)
		1760
		1761	See C<< $platform->info >> for details.
		1762
		1763	The reason this method is not called C<info> is that there already is an
		1764	C<< ->info >> method.
		1765
532	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1766	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1767
		1768	=for gengetinfo begin profiling
		1769
		1770	=item $ulong = $event->profiling_command_queued
		1771
		1772	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1773
		1774	=item $ulong = $event->profiling_command_submit
		1775
		1776	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1777
		1778	=item $ulong = $event->profiling_command_start
		1779
		1780	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1781
		1782	=item $ulong = $event->profiling_command_end
		1783
		1784	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1785
		1786	=for gengetinfo end profiling
533		1787
534	=back	1788	=back
535		1789
536	=head2 THE OpenCL::UserEvent CLASS	1790	=head2 THE OpenCL::UserEvent CLASS
537		1791
…		…
539		1793
540	=over 4	1794	=over 4
541		1795
542	=item $ev->set_status ($execution_status)	1796	=item $ev->set_status ($execution_status)
543		1797
		1798	Sets the execution status of the user event. Can only be called once,
		1799	either with OpenCL::COMPLETE or a negative number as status.
		1800
544	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1801	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
545		1802
546	=back	1803	=back
547		1804
548	=cut	1805	=cut
549
550	package OpenCL;
551
552	use common::sense;
553
554	BEGIN {
555	our $VERSION = '0.03';
556
557	require XSLoader;
558	XSLoader::load (__PACKAGE__, $VERSION);
559
560	@OpenCL::Buffer::ISA =
561	@OpenCL::Image::ISA = OpenCL::Memory::;
562
563	@OpenCL::Image2D::ISA =
564	@OpenCL::Image3D::ISA = OpenCL::Image::;
565
566	@OpenCL::UserEvent::ISA = OpenCL::Event::;
567	}
568		1806
569	1;	1807	1;
570		1808
571	=head1 AUTHOR	1809	=head1 AUTHOR
572		1810

Diff Legend

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