ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.17 by root, Thu Nov 17 03:56:07 2011 UTC vs.
Revision 1.59 by root, Wed Apr 25 20:49:13 2012 UTC

…		…
27	OpenCL::Program objects, which store source code and, after building for a	27	OpenCL::Program objects, which store source code and, after building for a
28	specific device ("compiling and linking"), also binary programs. For each	28	specific device ("compiling and linking"), also binary programs. For each
29	kernel function in a program you can then create an OpenCL::Kernel object	29	kernel function in a program you can then create an OpenCL::Kernel object
30	which represents basically a function call with argument values.	30	which represents basically a function call with argument values.
31		31
32	OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat	32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34	or 3d array) for bulk data and input and output for kernels.	34	or 3d array) for bulk data and input and output for kernels.
35		35
36	OpenCL::Sampler objects, which are kind of like texture filter modes in	36	OpenCL::Sampler objects, which are kind of like texture filter modes in
37	OpenGL.	37	OpenGL.
…		…
43		43
44	OpenCL::Event objects are used to signal when something is complete.	44	OpenCL::Event objects are used to signal when something is complete.
45		45
46	=head2 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
47		47
48	The OpenCL spec used to develop this module (1.2 spec was available, but	48	The OpenCL specs used to develop this module:
49	no implementation was available to me :).
50		49
51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	50	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
		51	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
		52	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
52		53
53	OpenCL manpages:	54	OpenCL manpages:
54		55
55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	56	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
		57	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
		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
56		64
57	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it	65	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
58	is, but at least it's free of charge:	66	is, but at least it's free of charge:
59		67
60	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf	68	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
61		69
62	If you are into UML class diagrams, the following diagram might help - if	70	And here's NVIDIA's OpenCL Best Practises Guide:
63	not, it will be mildly cofusing:
64		71
65	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html	72	http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
66		73
67	=head1 BASIC WORKFLOW	74	=head1 BASIC WORKFLOW
68		75
69	To get something done, you basically have to do this once (refer to the	76	To get something done, you basically have to do this once (refer to the
70	examples below for actual code, this is just a high-level description):	77	examples below for actual code, this is just a high-level description):
…		…
97		104
98	Best run this once to get a feel for the platforms and devices in your	105	Best run this once to get a feel for the platforms and devices in your
99	system.	106	system.
100		107
101	for my $platform (OpenCL::platforms) {	108	for my $platform (OpenCL::platforms) {
102	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	109	printf "platform: %s\n", $platform->name;
103	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	110	printf "extensions: %s\n", $platform->extensions;
104	for my $device ($platform->devices) {	111	for my $device ($platform->devices) {
105	printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME);	112	printf "+ device: %s\n", $device->name;
106	my $ctx = $device->context;	113	my $ctx = $platform->context (undef, [$device]);
107	# do stuff	114	# do stuff
108	}	115	}
109	}	116	}
110		117
111	=head2 Get a useful context and a command queue.	118	=head2 Get a useful context and a command queue.
…		…
134	=head2 Create a buffer with some predefined data, read it back synchronously,	141	=head2 Create a buffer with some predefined data, read it back synchronously,
135	then asynchronously.	142	then asynchronously.
136		143
137	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	144	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
138		145
139	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	146	$queue->read_buffer ($buf, 1, 1, 3, my $data);
140	print "$data\n";	147	print "$data\n";
141		148
142	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	149	my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
143	$ev->wait;	150	$ev->wait;
144	print "$data\n"; # prints "elm"	151	print "$data\n"; # prints "elm"
145		152
146	=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
147	functions.	154	functions.
148		155
149	my $src = '	156	my $src = '
150	__kernel void	157	kernel void
151	squareit (__global float *input, __global float *output)	158	squareit (global float *input, global float *output)
152	{	159	{
153	$id = get_global_id (0);	160	$id = get_global_id (0);
154	output [id] = input [id] * input [id];	161	output [id] = input [id] * input [id];
155	}	162	}
156	';	163	';
157		164
158	my $prog = $ctx->program_with_source ($src);	165	my $prog = $ctx->build_program ($src);
159
160	# build croaks on compile errors, so catch it and print the compile errors
161	eval { $prog->build ($dev); 1 }
162	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
163
164	my $kernel = $prog->kernel ("squareit");	166	my $kernel = $prog->kernel ("squareit");
165		167
166	=head2 Create some input and output float buffers, then call the	168	=head2 Create some input and output float buffers, then call the
167	'squareit' kernel on them.	169	'squareit' kernel on them.
168		170
…		…
172	# set buffer	174	# set buffer
173	$kernel->set_buffer (0, $input);	175	$kernel->set_buffer (0, $input);
174	$kernel->set_buffer (1, $output);	176	$kernel->set_buffer (1, $output);
175		177
176	# execute it for all 4 numbers	178	# execute it for all 4 numbers
177	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	179	$queue->nd_range_kernel ($kernel, undef, [4], undef);
178		180
179	# enqueue a synchronous read	181	# enqueue a synchronous read
180	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	182	$queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
181		183
182	# print the results:	184	# print the results:
183	printf "%s\n", join ", ", unpack "f*", $data;	185	printf "%s\n", join ", ", unpack "f*", $data;
184		186
185	=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,
186	showing off barriers.	188	showing off barriers.
187		189
188	# execute it for all 4 numbers	190	# execute it for all 4 numbers
189	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	191	$queue->nd_range_kernel ($kernel, undef, [4], undef);
190		192
191	# enqueue a barrier to ensure in-order execution	193	# enqueue a barrier to ensure in-order execution
192	$queue->enqueue_barrier;	194	$queue->barrier;
193		195
194	# enqueue an async read	196	# enqueue an async read
195	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	197	$queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
196		198
197	# wait for all requests to finish	199	# wait for all requests to finish
198	$queue->finish;	200	$queue->finish;
199		201
200	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	202	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
201	showing off event objects and wait lists.	203	showing off event objects and wait lists.
202		204
203	# execute it for all 4 numbers	205	# execute it for all 4 numbers
204	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	206	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
205		207
206	# enqueue an async read	208	# enqueue an async read
207	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	209	$ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
208		210
209	# wait for the last event to complete	211	# wait for the last event to complete
210	$ev->wait;	212	$ev->wait;
		213
		214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
		215	set tunnel effect.
		216
		217	This is quite a long example to get you going.
		218
		219	use OpenGL ":all";
		220	use OpenCL;
		221
		222	# open a window and create a gl texture
		223	OpenGL::glpOpenWindow width => 256, height => 256;
		224	my $texid = glGenTextures_p 1;
		225	glBindTexture GL_TEXTURE_2D, $texid;
		226	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
		227
		228	# find and use the first opencl device that let's us get a shared opengl context
		229	my $platform;
		230	my $dev;
		231	my $ctx;
		232
		233	for (OpenCL::platforms) {
		234	$platform = $_;
		235	for ($platform->devices) {
		236	$dev = $_;
		237	$ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
		238	and last;
		239	}
		240	}
		241
		242	$ctx
		243	or die "cannot find suitable OpenCL device\n";
		244
		245	my $queue = $ctx->queue ($dev);
		246
		247	# now attach an opencl image2d object to the opengl texture
		248	my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
		249
		250	# now the boring opencl code
		251	my $src = <<EOF;
		252	kernel void
		253	juliatunnel (write_only image2d_t img, float time)
		254	{
		255	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
		256
		257	float2 m = (float2)(1.f, p.y) / fabs (p.x);
		258	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
		259
		260	float2 z = m;
		261	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
		262
		263	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
		264	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		265
		266	float3 colour = (float3)(z.x, z.y, z.x * z.y);
		267	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
		268	}
		269	EOF
		270
		271	my $prog = $ctx->build_program ($src);
		272	my $kernel = $prog->kernel ("juliatunnel");
		273
		274	# program compiled, kernel ready, now draw and loop
		275
		276	for (my $time; ; ++$time) {
		277	# acquire objects from opengl
		278	$queue->acquire_gl_objects ([$tex]);
		279
		280	# configure and run our kernel
		281	$kernel->set_image2d (0, $tex);
		282	$kernel->set_float (1, $time);
		283	$queue->nd_range_kernel ($kernel, undef, [256, 256], undef);
		284
		285	# release objects to opengl again
		286	$queue->release_gl_objects ([$tex]);
		287
		288	# wait
		289	$queue->finish;
		290
		291	# now draw the texture, the defaults should be all right
		292	glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
		293
		294	glEnable GL_TEXTURE_2D;
		295	glBegin GL_QUADS;
		296	glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
		297	glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
		298	glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
		299	glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
		300	glEnd;
		301
		302	glXSwapBuffers;
		303
		304	select undef, undef, undef, 1/60;
		305	}
211		306
212	=head1 DOCUMENTATION	307	=head1 DOCUMENTATION
213		308
214	=head2 BASIC CONVENTIONS	309	=head2 BASIC CONVENTIONS
215		310
…		…
222		317
223	=item * Object lifetime managament is automatic - there is no need	318	=item * Object lifetime managament is automatic - there is no need
224	to free objects explicitly (C<clReleaseXXX>), the release function	319	to free objects explicitly (C<clReleaseXXX>), the release function
225	is called automatically once all Perl references to it go away.	320	is called automatically once all Perl references to it go away.
226		321
227	=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
228	while this module uses underscores as word separator and often leaves out	324	uses underscores as word separator and often leaves out prefixes
229	prefixes (C<< $platform->info >>).	325	(C<OpenCL::platforms>, C<< $platform->info >>).
230		326
231	=item * OpenCL often specifies fixed vector function arguments as short	327	=item * OpenCL often specifies fixed vector function arguments as short
232	arrays (C<$origin[3]>), while this module explicitly expects the	328	arrays (C<size_t origin[3]>), while this module explicitly expects the
233	components as separate arguments-	329	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		330	function calls.
234		331
235	=item * Structures are often specified with their components, and returned	332	=item * Structures are often specified by flattening out their components
236	as arrayrefs.	333	as with short vectors, and returned as arrayrefs.
237
238	=item * Where possible, one of the pitch values is calculated from the
239	perl scalar length and need not be specified.
240		334
241	=item * When enqueuing commands, the wait list is specified by adding	335	=item * When enqueuing commands, the wait list is specified by adding
242	extra arguments to the function - anywhere a C<$wait_events...> argument	336	extra arguments to the function - anywhere a C<$wait_events...> argument
243	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.
244		340
245	=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
246	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
247	by the method.	343	by the method.
248		344
…		…
268	ulong IV - Q	364	ulong IV - Q
269	float NV float f	365	float NV float f
270	half IV ushort S	366	half IV ushort S
271	double NV double d	367	double NV double d
272		368
		369	=head2 GLX SUPPORT
		370
		371	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		372	module, which has little to no documentation and has little to no support
		373	for glX), this module, as a special extension, treats context creation
		374	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		375	specially: If either or both of these are C<undef>, then the OpenCL
		376	module tries to dynamically resolve C<glXGetCurrentDisplay> and
		377	C<glXGetCurrentContext>, call these functions and use their return values
		378	instead.
		379
		380	For this to work, the OpenGL library must be loaded, a GLX context must
		381	have been created and be made current, and C<dlsym> must be available and
		382	capable of finding the function via C<RTLD_DEFAULT>.
		383
		384	=head2 EVENT SYSTEM
		385
		386	OpenCL can generate a number of (potentially) asynchronous events, for
		387	example, after compiling a program, to signal a context-related error or,
		388	perhaps most important, to signal completion of queued jobs (by setting
		389	callbacks on OpenCL::Event objects).
		390
		391	To facilitate this, this module maintains an event queue - each
		392	time an asynchronous event happens, it is queued, and perl will be
		393	interrupted. This is implemented via the L<Async::Interrupt> module. In
		394	addition, this module has L<AnyEvent> support, so it can seamlessly
		395	integrate itself into many event loops.
		396
		397	Since this module is a bit hard to understand, here are some case examples:
		398
		399	=head3 Don't use callbacks.
		400
		401	When your program never uses any callbacks, then there will never be any
		402	notifications you need to take care of, and therefore no need to worry
		403	about all this.
		404
		405	You can achieve a great deal by explicitly waiting for events, or using
		406	barriers and flush calls. In many programs, there is no need at all to
		407	tinker with asynchronous events.
		408
		409	=head3 Use AnyEvent
		410
		411	This module automatically registers a watcher that invokes all outstanding
		412	event callbacks when AnyEvent is initialised (and block asynchronous
		413	interruptions). Using this mode of operations is the safest and most
		414	recommended one.
		415
		416	To use this, simply use AnyEvent and this module normally, make sure you
		417	have an event loop running:
		418
		419	use Gtk2 -init;
		420	use AnyEvent;
		421
		422	# initialise AnyEvent, by creating a watcher, or:
		423	AnyEvent::detect;
		424
		425	my $e = $queue->marker;
		426	$e->cb (sub {
		427	warn "opencl is finished\n";
		428	})
		429
		430	main Gtk2;
		431
		432	Note that this module will not initialise AnyEvent for you. Before
		433	AnyEvent is initialised, the module will asynchronously interrupt perl
		434	instead. To avoid any surprises, it's best to explicitly initialise
		435	AnyEvent.
		436
		437	You can temporarily enable asynchronous interruptions (see next paragraph)
		438	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		439	calling C<$OpenCL::INTERRUPT->block>.
		440
		441	=head3 Let yourself be interrupted at any time
		442
		443	This mode is the default unless AnyEvent is loaded and initialised. In
		444	this mode, OpenCL asynchronously interrupts a running perl program. The
		445	emphasis is on both I<asynchronously> and I<running> here.
		446
		447	Asynchronously means that perl might execute your callbacks at any
		448	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		449	the C<until> loop following the marker call will be interrupted by the
		450	callback:
		451
		452	my $e = $queue->marker;
		453	my $flag;
		454	$e->cb (sub { $flag = 1 });
		455	1 until $flag;
		456	# $flag is now 1
		457
		458	The reason why you shouldn't blindly copy the above code is that
		459	busy waiting is a really really bad thing, and really really bad for
		460	performance.
		461
		462	While at first this asynchronous business might look exciting, it can be
		463	really hard, because you need to be prepared for the callback code to be
		464	executed at any time, which limits the amount of things the callback code
		465	can do safely.
		466
		467	This can be mitigated somewhat by using C<<
		468	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		469	documentation for details).
		470
		471	The other problem is that your program must be actively I<running> to be
		472	interrupted. When you calculate stuff, your program is running. When you
		473	hang in some C functions or other block execution (by calling C<sleep>,
		474	C<select>, running an event loop and so on), your program is waiting, not
		475	running.
		476
		477	One way around that would be to attach a read watcher to your event loop,
		478	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		479	dummy callback (C<sub { }>) to temporarily execute some perl code.
		480
		481	That is then awfully close to using the built-in AnyEvent support above,
		482	though, so consider that one instead.
		483
		484	=head3 Be creative
		485
		486	OpenCL exports the L<Async::Interrupt> object it uses in the global
		487	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		488
		489	So if you want to feel like a real pro, err, wait, if you feel no risk
		490	menas no fun, you can experiment by implementing your own mode of
		491	operations.
		492
		493	=cut
		494
		495	package OpenCL;
		496
		497	use common::sense;
		498	use Async::Interrupt ();
		499
		500	our $POLL_FUNC; # set by XS
		501
		502	BEGIN {
		503	our $VERSION = '0.97';
		504
		505	require XSLoader;
		506	XSLoader::load (__PACKAGE__, $VERSION);
		507
		508	@OpenCL::Platform::ISA =
		509	@OpenCL::Device::ISA =
		510	@OpenCL::Context::ISA =
		511	@OpenCL::Queue::ISA =
		512	@OpenCL::Memory::ISA =
		513	@OpenCL::Sampler::ISA =
		514	@OpenCL::Program::ISA =
		515	@OpenCL::Kernel::ISA =
		516	@OpenCL::Event::ISA = OpenCL::Object::;
		517
		518	@OpenCL::Buffer::ISA =
		519	@OpenCL::Image::ISA = OpenCL::Memory::;
		520
		521	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		522
		523	@OpenCL::Image2D::ISA =
		524	@OpenCL::Image3D::ISA =
		525	@OpenCL::Image2DArray::ISA =
		526	@OpenCL::Image1D::ISA =
		527	@OpenCL::Image1DArray::ISA =
		528	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		529
		530	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		531	}
		532
273	=head2 THE OpenCL PACKAGE	533	=head2 THE OpenCL PACKAGE
274		534
275	=over 4	535	=over 4
276		536
277	=item $int = OpenCL::errno	537	=item $int = OpenCL::errno
…		…
283		543
284	Comverts an error value into a human readable string.	544	Comverts an error value into a human readable string.
285		545
286	=item $str = OpenCL::enum2str $enum	546	=item $str = OpenCL::enum2str $enum
287		547
288	Converts most enum values (inof parameter names, image format constants,	548	Converts most enum values (of parameter names, image format constants,
289	object types, addressing and filter modes, command types etc.) into a	549	object types, addressing and filter modes, command types etc.) into a
290	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
291	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
292	string out of it.	552	string out of it.
293		553
294	=item @platforms = OpenCL::platforms	554	=item @platforms = OpenCL::platforms
295		555
296	Returns all available OpenCL::Platform objects.	556	Returns all available OpenCL::Platform objects.
297		557
298	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>
299		559
300	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	560	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
301		561
302	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.
303		563
304	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>
305		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
306	=item OpenCL::wait_for_events $wait_events...	573	=item OpenCL::wait_for_events $wait_events...
307		574
308	Waits for all events to complete.	575	Waits for all events to complete.
309		576
310	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>
311		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
312	=back	616	=back
313		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
314	=head2 THE OpenCL::Platform CLASS	643	=head2 THE OpenCL::Platform CLASS
315		644
316	=over 4	645	=over 4
317		646
318	=item $packed_value = $platform->info ($name)
319
320	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
321	strings, this will be the string, for other values you probably need to
322	use the correct C<unpack>. This might get improved in the future. Hopefully.
323
324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
325
326	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	647	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
327		648
328	Returns a list of matching OpenCL::Device objects.	649	Returns a list of matching OpenCL::Device objects.
329		650
330	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	651	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
331		652
332	Tries to create a context. Never worked for me, and you need devices explitly anyway.	653	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
333		654
334	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	655	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
335		656
336	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	657	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
337		658
338	Create a new OpenCL::Context object using the given device object(s)- a	659	Create a new OpenCL::Context object using the given device object(s)- a
339	CL_CONTEXT_PLATFORM property is supplied automatically.	660	CL_CONTEXT_PLATFORM property is supplied automatically.
340		661
341	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	662	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
342		663
		664	=item $packed_value = $platform->info ($name)
		665
		666	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
		667	strings, this will be the string (possibly including terminating \0), for
		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.
		672
		673	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
		674
		675	=item $platform->unload_compiler
		676
		677	Attempts to unload the compiler for this platform, for endless
		678	profit. Does nothing on OpenCL 1.1.
		679
		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
		705
343	=back	706	=back
344		707
345	=head2 THE OpenCL::Device CLASS	708	=head2 THE OpenCL::Device CLASS
346		709
347	=over 4	710	=over 4
…		…
350		713
351	See C<< $platform->info >> for details.	714	See C<< $platform->info >> for details.
352		715
353	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>
354		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
		816	=item $uint = $device->max_samplers
		817
		818	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		819
		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
		985
355	=back	986	=back
356		987
357	=head2 THE OpenCL::Context CLASS	988	=head2 THE OpenCL::Context CLASS
358		989
359	=over 4	990	=over 4
360		991
361	=item $packed_value = $ctx->info ($name)	992	=item $prog = $ctx->build_program ($program, $options = "")
362		993
363	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.
364		997
365	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.
		1001
		1002	=cut
		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	}
366		1021
367	=item $queue = $ctx->queue ($device, $properties)	1022	=item $queue = $ctx->queue ($device, $properties)
368		1023
369	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.
370		1025
371	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>
372		1027
		1028	Example: create an out-of-order queue.
		1029
		1030	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		1031
373	=item $ev = $ctx->user_event	1032	=item $ev = $ctx->user_event
374		1033
375	Creates a new OpenCL::UserEvent object.	1034	Creates a new OpenCL::UserEvent object.
376		1035
377	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>
378		1037
379	=item $buf = $ctx->buffer ($flags, $len)	1038	=item $buf = $ctx->buffer ($flags, $len)
380		1039
381	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.
382		1042
383	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>
384		1044
385	=item $buf = $ctx->buffer_sv ($flags, $data)	1045	=item $buf = $ctx->buffer_sv ($flags, $data)
386		1046
387	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.
388		1049
		1050	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
		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
389	=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)
390		1058
391	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.
392		1061
393	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>
394		1063
395	=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)
396		1065
397	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.
398		1068
399	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
400		1105
401	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	1106	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
402		1107
403	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
404	two values, $channel_order and $channel_type, in it.	1109	two values, $channel_order and $channel_type, in it.
…		…
415		1120
416	Creates a new OpenCL::Program object from the given source code.	1121	Creates a new OpenCL::Program object from the given source code.
417		1122
418	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>
419		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
		1150
420	=back	1151	=back
421		1152
422	=head2 THE OpenCL::Queue CLASS	1153	=head2 THE OpenCL::Queue CLASS
423		1154
424	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1155	An OpenCL::Queue represents an execution queue for OpenCL. You execute
425	requests by calling their respective C<enqueue_xxx> method and waitinf for	1156	requests by calling their respective method and waiting for it to complete
426	it to complete in some way.	1157	in some way.
427		1158
428	All the enqueue methods return an event object that can be used to wait	1159	Most methods that enqueue some request return an event object that can
429	for completion, unless the method is called in void context, in which case	1160	be used to wait for completion (optionally using a callback), unless
430	no event object is created.	1161	the method is called in void context, in which case no event object is
		1162	created.
431		1163
432	They also allow you to specify any number of other event objects that this	1164	They also allow you to specify any number of other event objects that this
433	request has to wait for before it starts executing, by simply passing the	1165	request has to wait for before it starts executing, by simply passing the
434	event objects as extra parameters to the enqueue methods.	1166	event objects as extra parameters to the enqueue methods. To simplify
		1167	program design, this module ignores any C<undef> values in the list of
		1168	events. This makes it possible to code operations such as this, without
		1169	having to put a valid event object into C<$event> first:
		1170
		1171	$event = $queue->xxx (..., $event);
435		1172
436	Queues execute in-order by default, without any parallelism, so in most	1173	Queues execute in-order by default, without any parallelism, so in most
437	cases (i.e. you use only one queue) it's not necessary to wait for or	1174	cases (i.e. you use only one queue) it's not necessary to wait for or
438	create event objects.	1175	create event objects, althoguh an our of order queue is often a bit
		1176	faster.
439		1177
440	=over 4	1178	=over 4
441		1179
442	=item $packed_value = $ctx->info ($name)
443
444	See C<< $platform->info >> for details.
445
446	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
447
448	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1180	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
449		1181
450	Reads data from buffer into the given string.	1182	Reads data from buffer into the given string.
451		1183
452	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1184	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
453		1185
454	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1186	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
455		1187
456	Writes data to buffer from the given string.	1188	Writes data to buffer from the given string.
457		1189
458	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
459		1191
460	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1192	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
461		1193
462	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1194	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
463		1195
		1196	=item $ev = $queue->read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
		1197
		1198	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		1199
		1200	=item $ev = $queue->write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
		1201
		1202	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		1203
464	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1204	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1205
		1206	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		1207
		1208	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
465		1209
466	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
467		1211
468	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1212	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
469		1213
470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
471		1215
		1216	=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1217
		1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		1219
		1220	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
		1221
		1222	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		1223
472	=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...)	1224	=item $ev = $queue->copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
473		1225
474	Yeah.	1226	Yeah.
475		1227
476	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
477
478	=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...)
479
480	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1228	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
481		1229
482	=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...)	1230	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
483		1231
		1232	Fills the given buffer object with repeated applications of C<$pattern>,
		1233	starting at C<$offset> for C<$size> octets.
		1234
		1235	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1236
		1237	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1238
		1239	Fills the given image area with the given rgba colour components. The
		1240	components are normally floating point values between C<0> and C<1>,
		1241	except when the image channel data type is a signe dor unsigned
		1242	unnormalised format, in which case the range is determined by the format.
		1243
484	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1244	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
485		1245
486	=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...)
487
488	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
489
490	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1246	=item $ev = $queue->task ($kernel, $wait_events...)
491		1247
492	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1248	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
493		1249
494	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1250	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
495		1251
496	Enqueues a kernel execution.	1252	Enqueues a kernel execution.
497		1253
498	@$global_work_size must be specified as a reference to an array of	1254	\@global_work_size must be specified as a reference to an array of
499	integers specifying the work sizes (element counts).	1255	integers specifying the work sizes (element counts).
500		1256
501	@$global_work_offset must be either C<undef> (in which case all offsets	1257	\@global_work_offset must be either C<undef> (in which case all offsets
502	are C<0>), or a reference to an array of work offsets, with the same number	1258	are C<0>), or a reference to an array of work offsets, with the same number
503	of elements as @$global_work_size.	1259	of elements as \@global_work_size.
504		1260
505	@$local_work_size must be either C<undef> (in which case the	1261	\@local_work_size must be either C<undef> (in which case the
506	implementation is supposed to choose good local work sizes), or a	1262	implementation is supposed to choose good local work sizes), or a
507	reference to an array of local work sizes, with the same number of	1263	reference to an array of local work sizes, with the same number of
508	elements as @$global_work_size.	1264	elements as \@global_work_size.
509		1265
510	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1266	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
511		1267
512	=item $ev = $queue->enqueue_marker	1268	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
513		1269
		1270	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1271	for subsequent OpenCL usage.
		1272
514	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1273	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
515		1274
		1275	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
		1276
		1277	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1278	for subsequent OpenGL usage.
		1279
		1280	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
		1281
516	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1282	=item $ev = $queue->wait_for_events ($wait_events...)
517		1283
518	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1284	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
519		1285
520	=item $queue->enqueue_barrier	1286	=item $ev = $queue->marker ($wait_events...)
521		1287
		1288	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1289
		1290	=item $ev = $queue->barrier ($wait_events...)
		1291
522	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1292	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
523		1293
524	=item $queue->flush	1294	=item $queue->flush
525		1295
526	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1296	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
527		1297
528	=item $queue->finish	1298	=item $queue->finish
529		1299
530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	1300	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
531		1301
		1302	=item $packed_value = $queue->info ($name)
		1303
		1304	See C<< $platform->info >> for details.
		1305
		1306	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1307
		1308	=for gengetinfo begin command_queue
		1309
		1310	=item $ctx = $command_queue->context
		1311
		1312	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1313
		1314	=item $device = $command_queue->device
		1315
		1316	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1317
		1318	=item $uint = $command_queue->reference_count
		1319
		1320	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1321
		1322	=item $command_queue_properties = $command_queue->properties
		1323
		1324	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1325
		1326	=for gengetinfo end command_queue
		1327
532	=back	1328	=back
533		1329
534	=head2 THE OpenCL::Memory CLASS	1330	=head2 THE OpenCL::Memory CLASS
535		1331
536	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	1332	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
537	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	1333	OpenCL::Image2D and OpenCL::Image3D.
538	currently only exist to allow type-checking.
539		1334
540	=over 4	1335	=over 4
541		1336
542	=item $packed_value = $memory->info ($name)	1337	=item $packed_value = $memory->info ($name)
543		1338
544	See C<< $platform->info >> for details.	1339	See C<< $platform->info >> for details.
545		1340
546	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1341	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
547		1342
		1343	=for gengetinfo begin mem
		1344
		1345	=item $mem_object_type = $mem->type
		1346
		1347	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1348
		1349	=item $mem_flags = $mem->flags
		1350
		1351	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1352
		1353	=item $int = $mem->size
		1354
		1355	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1356
		1357	=item $ptr_value = $mem->host_ptr
		1358
		1359	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1360
		1361	=item $uint = $mem->map_count
		1362
		1363	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1364
		1365	=item $uint = $mem->reference_count
		1366
		1367	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1368
		1369	=item $ctx = $mem->context
		1370
		1371	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1372
		1373	=item $mem = $mem->associated_memobject
		1374
		1375	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1376
		1377	=item $int = $mem->offset
		1378
		1379	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1380
		1381	=for gengetinfo end mem
		1382
		1383	=item ($type, $name) = $mem->gl_object_info
		1384
		1385	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1386	object "name" (e.g. the texture name) used to create this memory object.
		1387
		1388	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1389
548	=back	1390	=back
549		1391
		1392	=head2 THE OpenCL::Buffer CLASS
		1393
		1394	This is a subclass of OpenCL::Memory, and the superclass of
		1395	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1396	and sub-buffers.
		1397
		1398	=head2 THE OpenCL::BufferObj CLASS
		1399
		1400	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1401	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1402	sub buffers from these sub buffers.
		1403
		1404	=over 4
		1405
		1406	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1407
		1408	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1409	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1410
		1411	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1412
		1413	=back
		1414
		1415	=head2 THE OpenCL::Image CLASS
		1416
		1417	This is the superclass of all image objects - OpenCL::Image1D,
		1418	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1419	OpenCL::Image2DArray and OpenCL::Image3D.
		1420
		1421	=over 4
		1422
		1423	=item $packed_value = $image->image_info ($name)
		1424
		1425	See C<< $platform->info >> for details.
		1426
		1427	The reason this method is not called C<info> is that there already is an
		1428	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1429
		1430	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1431
		1432	=item ($channel_order, $channel_data_type) = $image->format
		1433
		1434	Returns the channel order and type used to create the image by calling
		1435	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1436
		1437	=for gengetinfo begin image
		1438
		1439	=item $int = $image->element_size
		1440
		1441	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1442
		1443	=item $int = $image->row_pitch
		1444
		1445	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1446
		1447	=item $int = $image->slice_pitch
		1448
		1449	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1450
		1451	=item $int = $image->width
		1452
		1453	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1454
		1455	=item $int = $image->height
		1456
		1457	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1458
		1459	=item $int = $image->depth
		1460
		1461	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1462
		1463	=for gengetinfo end image
		1464
		1465	=for gengetinfo begin gl_texture
		1466
		1467	=item $GLenum = $gl_texture->target
		1468
		1469	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1470
		1471	=item $GLint = $gl_texture->gl_mipmap_level
		1472
		1473	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1474
		1475	=for gengetinfo end gl_texture
		1476
		1477	=back
		1478
550	=head2 THE OpenCL::Sampler CLASS	1479	=head2 THE OpenCL::Sampler CLASS
551		1480
552	=over 4	1481	=over 4
553		1482
554	=item $packed_value = $sampler->info ($name)	1483	=item $packed_value = $sampler->info ($name)
555		1484
556	See C<< $platform->info >> for details.	1485	See C<< $platform->info >> for details.
557		1486
558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1487	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
559		1488
		1489	=for gengetinfo begin sampler
		1490
		1491	=item $uint = $sampler->reference_count
		1492
		1493	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1494
		1495	=item $ctx = $sampler->context
		1496
		1497	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1498
		1499	=item $addressing_mode = $sampler->normalized_coords
		1500
		1501	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1502
		1503	=item $filter_mode = $sampler->addressing_mode
		1504
		1505	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1506
		1507	=item $boolean = $sampler->filter_mode
		1508
		1509	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1510
		1511	=for gengetinfo end sampler
		1512
560	=back	1513	=back
561		1514
562	=head2 THE OpenCL::Program CLASS	1515	=head2 THE OpenCL::Program CLASS
563		1516
564	=over 4	1517	=over 4
565		1518
566	=item $packed_value = $program->info ($name)	1519	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
567		1520
568	See C<< $platform->info >> for details.
569
570	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
571
572	=item $program->build ($device, $options = "")
573
574	Tries to build the program with the givne options.	1521	Tries to build the program with the given options. See also the
		1522	C<$ctx->build> convenience function.
		1523
		1524	If a callback is specified, then it will be called when compilation is
		1525	finished. Note that many OpenCL implementations block your program while
		1526	compiling whether you use a callback or not. See C<build_async> if you
		1527	want to make sure the build is done in the background.
		1528
		1529	Note that some OpenCL implementations atc up badly, and don't call the
		1530	callback in some error cases (but call it in others). This implementation
		1531	assumes the callback will always be called, and leaks memory if this is
		1532	not so. So best make sure you don't pass in invalid values.
575		1533
576	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1534	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1535
		1536	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1537
		1538	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1539	need to check the compilation status form the callback, or by polling).
577		1540
578	=item $packed_value = $program->build_info ($device, $name)	1541	=item $packed_value = $program->build_info ($device, $name)
579		1542
580	Similar to C<< $platform->info >>, but returns build info for a previous	1543	Similar to C<< $platform->info >>, but returns build info for a previous
581	build attempt for the given device.	1544	build attempt for the given device.
…		…
587	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1550	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
588	the program.	1551	the program.
589		1552
590	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1553	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
591		1554
		1555	=item @kernels = $program->kernels_in_program
		1556
		1557	Returns all kernels successfully compiled for all devices in program.
		1558
		1559	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
		1560
		1561	=for gengetinfo begin program_build
		1562
		1563	=item $build_status = $program->build_status ($device)
		1564
		1565	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1566
		1567	=item $string = $program->build_options ($device)
		1568
		1569	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1570
		1571	=item $string = $program->build_log ($device)
		1572
		1573	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1574
		1575	=for gengetinfo end program_build
		1576
		1577	=item $packed_value = $program->info ($name)
		1578
		1579	See C<< $platform->info >> for details.
		1580
		1581	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1582
		1583	=for gengetinfo begin program
		1584
		1585	=item $uint = $program->reference_count
		1586
		1587	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1588
		1589	=item $ctx = $program->context
		1590
		1591	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1592
		1593	=item $uint = $program->num_devices
		1594
		1595	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1596
		1597	=item @devices = $program->devices
		1598
		1599	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1600
		1601	=item $string = $program->source
		1602
		1603	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1604
		1605	=item @ints = $program->binary_sizes
		1606
		1607	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1608
		1609	=for gengetinfo end program
		1610
		1611	=item @blobs = $program->binaries
		1612
		1613	Returns a string for the compiled binary for every device associated with
		1614	the program, empty strings indicate missing programs, and an empty result
		1615	means no program binaries are available.
		1616
		1617	These "binaries" are often, in fact, informative low-level assembly
		1618	sources.
		1619
		1620	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1621
592	=back	1622	=back
593		1623
594	=head2 THE OpenCL::Kernel CLASS	1624	=head2 THE OpenCL::Kernel CLASS
595		1625
596	=over 4	1626	=over 4
…		…
599		1629
600	See C<< $platform->info >> for details.	1630	See C<< $platform->info >> for details.
601		1631
602	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1632	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
603		1633
		1634	=for gengetinfo begin kernel
		1635
		1636	=item $string = $kernel->function_name
		1637
		1638	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1639
		1640	=item $uint = $kernel->num_args
		1641
		1642	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1643
		1644	=item $uint = $kernel->reference_count
		1645
		1646	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1647
		1648	=item $ctx = $kernel->context
		1649
		1650	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1651
		1652	=item $program = $kernel->program
		1653
		1654	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1655
		1656	=for gengetinfo end kernel
		1657
		1658	=item $packed_value = $kernel->work_group_info ($device, $name)
		1659
		1660	See C<< $platform->info >> for details.
		1661
		1662	The reason this method is not called C<info> is that there already is an
		1663	C<< ->info >> method.
		1664
		1665	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1666
		1667	=for gengetinfo begin kernel_work_group
		1668
		1669	=item $int = $kernel->work_group_size ($device)
		1670
		1671	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1672
		1673	=item @ints = $kernel->compile_work_group_size ($device)
		1674
		1675	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1676
		1677	=item $ulong = $kernel->local_mem_size ($device)
		1678
		1679	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1680
		1681	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1682
		1683	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1684
		1685	=item $ulong = $kernel->private_mem_size ($device)
		1686
		1687	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1688
		1689	=for gengetinfo end kernel_work_group
		1690
604	=item $kernel->set_TYPE ($index, $value)	1691	=item $kernel->set_TYPE ($index, $value)
605		1692
		1693	=item $kernel->set_char ($index, $value)
		1694
		1695	=item $kernel->set_uchar ($index, $value)
		1696
		1697	=item $kernel->set_short ($index, $value)
		1698
		1699	=item $kernel->set_ushort ($index, $value)
		1700
		1701	=item $kernel->set_int ($index, $value)
		1702
		1703	=item $kernel->set_uint ($index, $value)
		1704
		1705	=item $kernel->set_long ($index, $value)
		1706
		1707	=item $kernel->set_ulong ($index, $value)
		1708
		1709	=item $kernel->set_half ($index, $value)
		1710
		1711	=item $kernel->set_float ($index, $value)
		1712
		1713	=item $kernel->set_double ($index, $value)
		1714
		1715	=item $kernel->set_memory ($index, $value)
		1716
		1717	=item $kernel->set_buffer ($index, $value)
		1718
		1719	=item $kernel->set_image ($index, $value)
		1720
		1721	=item $kernel->set_sampler ($index, $value)
		1722
		1723	=item $kernel->set_local ($index, $value)
		1724
		1725	=item $kernel->set_event ($index, $value)
		1726
606	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1727	This is a family of methods to set the kernel argument with the number
607		1728	C<$index> to the give C<$value>.
608	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
609	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
610	C<image2d>, C<image3d>, C<sampler> or C<event>.
611		1729
612	Chars and integers (including the half type) are specified as integers,	1730	Chars and integers (including the half type) are specified as integers,
613	float and double as floating point values, memory/buffer/image2d/image3d	1731	float and double as floating point values, memory/buffer/image must be
614	must be an object of that type or C<undef>, and sampler and event must be	1732	an object of that type or C<undef>, local-memory arguments are set by
615	objects of that type.	1733	specifying the size, and sampler and event must be objects of that type.
		1734
		1735	Note that C<set_memory> works for all memory objects (all types of buffers
		1736	and images) - the main purpose of the more specific C<set_TYPE> functions
		1737	is type checking.
		1738
		1739	Setting an argument for a kernel does NOT keep a reference to the object -
		1740	for example, if you set an argument to some image object, free the image,
		1741	and call the kernel, you will run into undefined behaviour.
616		1742
617	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1743	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
618		1744
619	=back	1745	=back
620		1746
…		…
623	This is the superclass for all event objects (including OpenCL::UserEvent	1749	This is the superclass for all event objects (including OpenCL::UserEvent
624	objects).	1750	objects).
625		1751
626	=over 4	1752	=over 4
627		1753
		1754	=item $ev->wait
		1755
		1756	Waits for the event to complete.
		1757
		1758	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1759
		1760	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1761
		1762	Adds a callback to the callback stack for the given event type. There is
		1763	no way to remove a callback again.
		1764
		1765	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1766
628	=item $packed_value = $ev->info ($name)	1767	=item $packed_value = $ev->info ($name)
629		1768
630	See C<< $platform->info >> for details.	1769	See C<< $platform->info >> for details.
631		1770
632	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1771	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
633		1772
634	=item $ev->wait	1773	=for gengetinfo begin event
635		1774
636	Waits for the event to complete.	1775	=item $queue = $event->command_queue
637		1776
		1777	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1778
		1779	=item $command_type = $event->command_type
		1780
		1781	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1782
		1783	=item $uint = $event->reference_count
		1784
		1785	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1786
		1787	=item $uint = $event->command_execution_status
		1788
		1789	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1790
		1791	=item $ctx = $event->context
		1792
		1793	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1794
		1795	=for gengetinfo end event
		1796
		1797	=item $packed_value = $ev->profiling_info ($name)
		1798
		1799	See C<< $platform->info >> for details.
		1800
		1801	The reason this method is not called C<info> is that there already is an
		1802	C<< ->info >> method.
		1803
638	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1805
		1806	=for gengetinfo begin profiling
		1807
		1808	=item $ulong = $event->profiling_command_queued
		1809
		1810	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1811
		1812	=item $ulong = $event->profiling_command_submit
		1813
		1814	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1815
		1816	=item $ulong = $event->profiling_command_start
		1817
		1818	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1819
		1820	=item $ulong = $event->profiling_command_end
		1821
		1822	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1823
		1824	=for gengetinfo end profiling
639		1825
640	=back	1826	=back
641		1827
642	=head2 THE OpenCL::UserEvent CLASS	1828	=head2 THE OpenCL::UserEvent CLASS
643		1829
…		…
645		1831
646	=over 4	1832	=over 4
647		1833
648	=item $ev->set_status ($execution_status)	1834	=item $ev->set_status ($execution_status)
649		1835
		1836	Sets the execution status of the user event. Can only be called once,
		1837	either with OpenCL::COMPLETE or a negative number as status.
		1838
650	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1839	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
651		1840
652	=back	1841	=back
653		1842
654	=cut	1843	=cut
655
656	package OpenCL;
657
658	use common::sense;
659
660	BEGIN {
661	our $VERSION = '0.14';
662
663	require XSLoader;
664	XSLoader::load (__PACKAGE__, $VERSION);
665
666	@OpenCL::Buffer::ISA =
667	@OpenCL::Image::ISA = OpenCL::Memory::;
668
669	@OpenCL::Image2D::ISA =
670	@OpenCL::Image3D::ISA = OpenCL::Image::;
671
672	@OpenCL::UserEvent::ISA = OpenCL::Event::;
673	}
674		1844
675	1;	1845	1;
676		1846
677	=head1 AUTHOR	1847	=head1 AUTHOR
678		1848

Diff Legend

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