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

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

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.11 by root, Thu Nov 17 02:54:14 2011 UTC vs. Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.11 by root, Thu Nov 17 02:54:14 2011 UTC vs.
Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC