ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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