ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.3 by root, Tue Nov 15 20:38:07 2011 UTC vs.
Revision 1.47 by root, Sat Apr 21 19:48:58 2012 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	OpenCL - bindings to, well, OpenCL	3	OpenCL - Open Computing Language Bindings
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use OpenCL;	7	use OpenCL;
8		8
9	=head1 DESCRIPTION	9	=head1 DESCRIPTION
10		10
11	This is an early release which is not useful yet.	11	This is an early release which might be useful, but hasn't seen much testing.
12		12
		13	=head2 OpenCL FROM 10000 FEET HEIGHT
		14
		15	Here is a high level overview of OpenCL:
		16
		17	First you need to find one or more OpenCL::Platforms (kind of like
		18	vendors) - usually there is only one.
		19
		20	Each platform gives you access to a number of OpenCL::Device objects, e.g.
		21	your graphics card.
		22
		23	From a platform and some device(s), you create an OpenCL::Context, which is
		24	a very central object in OpenCL: Once you have a context you can create
		25	most other objects:
		26
		27	OpenCL::Program objects, which store source code and, after building for a
		28	specific device ("compiling and linking"), also binary programs. For each
		29	kernel function in a program you can then create an OpenCL::Kernel object
		30	which represents basically a function call with argument values.
		31
		32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
		33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
		34	or 3d array) for bulk data and input and output for kernels.
		35
		36	OpenCL::Sampler objects, which are kind of like texture filter modes in
		37	OpenGL.
		38
		39	OpenCL::Queue objects - command queues, which allow you to submit memory
		40	reads, writes and copies, as well as kernel calls to your devices. They
		41	also offer a variety of methods to synchronise request execution, for
		42	example with barriers or OpenCL::Event objects.
		43
		44	OpenCL::Event objects are used to signal when something is complete.
		45
13	=head1 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
14		47
15	The OpenCL spec used to dveelop this module (1.2 spec was available, but	48	The OpenCL spec used to develop this module (1.2 spec was available, but
16	no implementation was available to me :).	49	no implementation was available to me :).
17		50
18	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
19		52
20	OpenCL manpages:	53	OpenCL manpages:
21		54
22	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
23		56
		57	If you are into UML class diagrams, the following diagram might help - if
		58	not, it will be mildly cobfusing:
		59
		60	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html
		61
		62	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
		63	is, but at least it's free of charge:
		64
		65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
		66
		67	And here's NVIDIA's OpenCL Best Practises Guide:
		68
		69	http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
		70
		71	=head1 BASIC WORKFLOW
		72
		73	To get something done, you basically have to do this once (refer to the
		74	examples below for actual code, this is just a high-level description):
		75
		76	Find some platform (e.g. the first one) and some device(s) (e.g. the first
		77	device of the platform), and create a context from those.
		78
		79	Create program objects from your OpenCL source code, then build (compile)
		80	the programs for each device you want to run them on.
		81
		82	Create kernel objects for all kernels you want to use (surprisingly, these
		83	are not device-specific).
		84
		85	Then, to execute stuff, you repeat these steps, possibly resuing or
		86	sharing some buffers:
		87
		88	Create some input and output buffers from your context. Set these as
		89	arguments to your kernel.
		90
		91	Enqueue buffer writes to initialise your input buffers (when not
		92	initialised at creation time).
		93
		94	Enqueue the kernel execution.
		95
		96	Enqueue buffer reads for your output buffer to read results.
		97
24	=head1 EXAMPLES	98	=head1 EXAMPLES
25		99
26	Enumerate all devices and get contexts for them;	100	=head2 Enumerate all devices and get contexts for them.
		101
		102	Best run this once to get a feel for the platforms and devices in your
		103	system.
27		104
28	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
29	warn $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
30	warn $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
31	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
32	warn $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
33	my $ctx = $device->context_simple;	110	my $ctx = $platform->context (undef, [$device]);
34	# do stuff	111	# do stuff
35	}	112	}
36	}	113	}
37		114
38	Get a useful context and a command queue:	115	=head2 Get a useful context and a command queue.
39		116
40	my $dev = ((OpenCL::platforms)[0]->devices)[0];	117	This is a useful boilerplate for any OpenCL program that only wants to use
41	my $ctx = $dev->context_simple;	118	one device,
42	my $queue = $ctx->command_queue_simple ($dev);
43		119
44	Create a buffer with some predefined data, read it back synchronously,	120	my ($platform) = OpenCL::platforms; # find first platform
45	then asynchronously:	121	my ($dev) = $platform->devices; # find first device of platform
		122	my $ctx = $platform->context (undef, [$dev]); # create context out of those
		123	my $queue = $ctx->queue ($dev); # create a command queue for the device
46		124
47	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
48
49	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);
50	warn $data;
51
52	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);
53	$ev->wait;
54	warn $data;
55
56	Print all supported image formats:	125	=head2 Print all supported image formats of a context.
		126
		127	Best run this once for your context, to see whats available and how to
		128	gather information.
57		129
58	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {	130	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
59	say "supported image formats for ", OpenCL::enum2str $type;	131	print "supported image formats for ", OpenCL::enum2str $type, "\n";
60		132
61	for my $f ($ctx->supported_image_formats (0, $type)) {	133	for my $f ($ctx->supported_image_formats (0, $type)) {
62	printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];	134	printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];
63	}	135	}
64	}	136	}
65		137
		138	=head2 Create a buffer with some predefined data, read it back synchronously,
		139	then asynchronously.
		140
		141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
		142
		143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);
		144	print "$data\n";
		145
		146	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);
		147	$ev->wait;
		148	print "$data\n"; # prints "elm"
		149
66	Create and build a program, then create a kernel out of one of its	150	=head2 Create and build a program, then create a kernel out of one of its
67	functions:	151	functions.
68		152
69	my $src = '	153	my $src = '
70	__kernel void	154	kernel void
71	squareit (__global float *input, __global float *output)	155	squareit (global float *input, global float *output)
72	{	156	{
73	size_t id = get_global_id (0);	157	$id = get_global_id (0);
74	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
75	}	159	}
76	';	160	';
77		161
78	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->program_with_source ($src);
79		163
		164	# build croaks on compile errors, so catch it and print the compile errors
		165	eval { $prog->build ($dev, "-cl-fast-relaxed-math"); 1 }
		166	or die $prog->build_log;
		167
		168	my $kernel = $prog->kernel ("squareit");
		169
		170	=head2 Create some input and output float buffers, then call the
		171	'squareit' kernel on them.
		172
		173	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);
		174	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
		175
		176	# set buffer
		177	$kernel->set_buffer (0, $input);
		178	$kernel->set_buffer (1, $output);
		179
		180	# execute it for all 4 numbers
		181	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);
		182
		183	# enqueue a synchronous read
		184	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
		185
		186	# print the results:
		187	printf "%s\n", join ", ", unpack "f*", $data;
		188
		189	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
		190	showing off barriers.
		191
		192	# execute it for all 4 numbers
		193	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);
		194
		195	# enqueue a barrier to ensure in-order execution
		196	$queue->enqueue_barrier;
		197
		198	# enqueue an async read
		199	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
		200
		201	# wait for all requests to finish
		202	$queue->finish;
		203
		204	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
		205	showing off event objects and wait lists.
		206
		207	# execute it for all 4 numbers
		208	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);
		209
		210	# enqueue an async read
		211	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
		212
		213	# wait for the last event to complete
		214	$ev->wait;
		215
		216	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
		217	set tunnel effect.
		218
		219	This is quite a long example to get you going.
		220
		221	use OpenGL ":all";
		222	use OpenCL;
		223
		224	# open a window and create a gl texture
		225	OpenGL::glpOpenWindow width => 256, height => 256;
		226	my $texid = glGenTextures_p 1;
		227	glBindTexture GL_TEXTURE_2D, $texid;
		228	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
		229
		230	# find and use the first opencl device that let's us get a shared opengl context
		231	my $platform;
		232	my $dev;
		233	my $ctx;
		234
		235	for (OpenCL::platforms) {
		236	$platform = $_;
		237	for ($platform->devices) {
		238	$dev = $_;
		239	$ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
		240	and last;
		241	}
		242	}
		243
		244	$ctx
		245	or die "cannot find suitable OpenCL device\n";
		246
		247	my $queue = $ctx->queue ($dev);
		248
		249	# now attach an opencl image2d object to the opengl texture
		250	my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
		251
		252	# now the boring opencl code
		253	my $src = <<EOF;
		254	kernel void
		255	juliatunnel (write_only image2d_t img, float time)
		256	{
		257	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
		258
		259	float2 m = (float2)(1.f, p.y) / fabs (p.x);
		260	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
		261
		262	float2 z = m;
		263	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
		264
		265	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
		266	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		267
		268	float3 colour = (float3)(z.x, z.y, z.x * z.y);
		269	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
		270	}
		271	EOF
		272	my $prog = $ctx->program_with_source ($src);
80	eval { $prog->build ($dev); 1 }	273	eval { $prog->build ($dev); 1 }
81	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);	274	or die $prog->build_log ($dev);
82		275
83	my $kernel = $prog->kernel ("squareit");	276	my $kernel = $prog->kernel ("juliatunnel");
		277
		278	# program compiled, kernel ready, now draw and loop
		279
		280	for (my $time; ; ++$time) {
		281	# acquire objects from opengl
		282	$queue->enqueue_acquire_gl_objects ([$tex]);
		283
		284	# configure and run our kernel
		285	$kernel->set_image2d (0, $tex);
		286	$kernel->set_float (1, $time);
		287	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
		288
		289	# release objects to opengl again
		290	$queue->enqueue_release_gl_objects ([$tex]);
		291
		292	# wait
		293	$queue->finish;
		294
		295	# now draw the texture, the defaults should be all right
		296	glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
		297
		298	glEnable GL_TEXTURE_2D;
		299	glBegin GL_QUADS;
		300	glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
		301	glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
		302	glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
		303	glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
		304	glEnd;
		305
		306	glXSwapBuffers;
		307
		308	select undef, undef, undef, 1/60;
		309	}
		310
		311	=head1 DOCUMENTATION
		312
		313	=head2 BASIC CONVENTIONS
		314
		315	This is not a one-to-one C-style translation of OpenCL to Perl - instead
		316	I attempted to make the interface as type-safe as possible by introducing
		317	object syntax where it makes sense. There are a number of important
		318	differences between the OpenCL C API and this module:
84		319
85	=over 4	320	=over 4
86		321
		322	=item * Object lifetime managament is automatic - there is no need
		323	to free objects explicitly (C<clReleaseXXX>), the release function
		324	is called automatically once all Perl references to it go away.
		325
		326	=item * OpenCL uses CamelCase for function names
		327	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
		328	uses underscores as word separator and often leaves out prefixes
		329	(C<OpenCL::platforms>, C<< $platform->info >>).
		330
		331	=item * OpenCL often specifies fixed vector function arguments as short
		332	arrays (C<size_t origin[3]>), while this module explicitly expects the
		333	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		334	function calls.
		335
		336	=item * Structures are often specified by flattening out their components
		337	as with short vectors, and returned as arrayrefs.
		338
		339	=item * When enqueuing commands, the wait list is specified by adding
		340	extra arguments to the function - anywhere a C<$wait_events...> argument
		341	is documented this can be any number of event objects. As an extsnion
		342	implemented by this module, C<undef> values will be ignored in the event
		343	list.
		344
		345	=item * When enqueuing commands, if the enqueue method is called in void
		346	context, no event is created. In all other contexts an event is returned
		347	by the method.
		348
		349	=item * This module expects all functions to return C<CL_SUCCESS>. If any
		350	other status is returned the function will throw an exception, so you
		351	don't normally have to to any error checking.
		352
		353	=back
		354
		355	=head2 PERL AND OPENCL TYPES
		356
		357	This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
		358	format equivalents:
		359
		360	OpenCL perl PDL pack/unpack
		361	char IV - c
		362	uchar IV byte C
		363	short IV short s
		364	ushort IV ushort S
		365	int IV long? l
		366	uint IV - L
		367	long IV longlong q
		368	ulong IV - Q
		369	float NV float f
		370	half IV ushort S
		371	double NV double d
		372
		373	=head2 GLX SUPPORT
		374
		375	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		376	module, which has little to no documentation and has little to no support
		377	for glX), this module, as a special extension, treats context creation
		378	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		379	specially: If either or both of these are C<undef>, then the OpenCL
		380	module tries to dynamically resolve C<glXGetCurrentDisplay> and
		381	C<glXGetCurrentContext>, call these functions and use their return values
		382	instead.
		383
		384	For this to work, the OpenGL library must be loaded, a GLX context must
		385	have been created and be made current, and C<dlsym> must be available and
		386	capable of finding the function via C<RTLD_DEFAULT>.
		387
		388	=head2 THE OpenCL PACKAGE
		389
		390	=over 4
		391
		392	=item $int = OpenCL::errno
		393
		394	The last error returned by a function - it's only valid after an error occured
		395	and before calling another OpenCL function.
		396
		397	=item $str = OpenCL::err2str $errval
		398
		399	Comverts an error value into a human readable string.
		400
		401	=item $str = OpenCL::enum2str $enum
		402
		403	Converts most enum values (of parameter names, image format constants,
		404	object types, addressing and filter modes, command types etc.) into a
		405	human readable string. When confronted with some random integer it can be
		406	very helpful to pass it through this function to maybe get some readable
		407	string out of it.
		408
		409	=item @platforms = OpenCL::platforms
		410
		411	Returns all available OpenCL::Platform objects.
		412
		413	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
		414
		415	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef
		416
		417	Tries to create a context from a default device and platform - never worked for me.
		418
		419	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		420
		421	=item OpenCL::wait_for_events $wait_events...
		422
		423	Waits for all events to complete.
		424
		425	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		426
		427	=back
		428
		429	=head2 THE OpenCL::Platform CLASS
		430
		431	=over 4
		432
		433	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
		434
		435	Returns a list of matching OpenCL::Device objects.
		436
		437	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
		438
		439	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
		440
		441	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		442
		443	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
		444
		445	Create a new OpenCL::Context object using the given device object(s)- a
		446	CL_CONTEXT_PLATFORM property is supplied automatically.
		447
		448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		449
		450	=item $packed_value = $platform->info ($name)
		451
		452	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
		453	strings, this will be the string (possibly including terminating \0), for
		454	other values you probably need to use the correct C<unpack>.
		455
		456	It's best to avoid this method and use one of the following convenience
		457	wrappers.
		458
		459	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
		460
		461	=for gengetinfo begin platform
		462
		463	=item $string = $platform->profile
		464
		465	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
		466
		467	=item $string = $platform->version
		468
		469	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
		470
		471	=item $string = $platform->name
		472
		473	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
		474
		475	=item $string = $platform->vendor
		476
		477	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
		478
		479	=item $string = $platform->extensions
		480
		481	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		482
		483	=for gengetinfo end platform
		484
		485	=back
		486
		487	=head2 THE OpenCL::Device CLASS
		488
		489	=over 4
		490
		491	=item $packed_value = $device->info ($name)
		492
		493	See C<< $platform->info >> for details.
		494
		495	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
		496
		497	=for gengetinfo begin device
		498
		499	=item $device_type = $device->type
		500
		501	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		502
		503	=item $uint = $device->vendor_id
		504
		505	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		506
		507	=item $uint = $device->max_compute_units
		508
		509	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		510
		511	=item $uint = $device->max_work_item_dimensions
		512
		513	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		514
		515	=item $int = $device->max_work_group_size
		516
		517	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		518
		519	=item @ints = $device->max_work_item_sizes
		520
		521	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		522
		523	=item $uint = $device->preferred_vector_width_char
		524
		525	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		526
		527	=item $uint = $device->preferred_vector_width_short
		528
		529	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		530
		531	=item $uint = $device->preferred_vector_width_int
		532
		533	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		534
		535	=item $uint = $device->preferred_vector_width_long
		536
		537	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		538
		539	=item $uint = $device->preferred_vector_width_float
		540
		541	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		542
		543	=item $uint = $device->preferred_vector_width_double
		544
		545	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		546
		547	=item $uint = $device->max_clock_frequency
		548
		549	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		550
		551	=item $bitfield = $device->address_bits
		552
		553	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		554
		555	=item $uint = $device->max_read_image_args
		556
		557	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		558
		559	=item $uint = $device->max_write_image_args
		560
		561	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		562
		563	=item $ulong = $device->max_mem_alloc_size
		564
		565	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		566
		567	=item $int = $device->image2d_max_width
		568
		569	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		570
		571	=item $int = $device->image2d_max_height
		572
		573	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		574
		575	=item $int = $device->image3d_max_width
		576
		577	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		578
		579	=item $int = $device->image3d_max_height
		580
		581	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		582
		583	=item $int = $device->image3d_max_depth
		584
		585	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		586
		587	=item $uint = $device->image_support
		588
		589	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		590
		591	=item $int = $device->max_parameter_size
		592
		593	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		594
		595	=item $uint = $device->max_samplers
		596
		597	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		598
		599	=item $uint = $device->mem_base_addr_align
		600
		601	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		602
		603	=item $uint = $device->min_data_type_align_size
		604
		605	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		606
		607	=item $device_fp_config = $device->single_fp_config
		608
		609	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		610
		611	=item $device_mem_cache_type = $device->global_mem_cache_type
		612
		613	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		614
		615	=item $uint = $device->global_mem_cacheline_size
		616
		617	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		618
		619	=item $ulong = $device->global_mem_cache_size
		620
		621	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		622
		623	=item $ulong = $device->global_mem_size
		624
		625	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		626
		627	=item $ulong = $device->max_constant_buffer_size
		628
		629	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		630
		631	=item $uint = $device->max_constant_args
		632
		633	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		634
		635	=item $device_local_mem_type = $device->local_mem_type
		636
		637	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		638
		639	=item $ulong = $device->local_mem_size
		640
		641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		642
		643	=item $boolean = $device->error_correction_support
		644
		645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		646
		647	=item $int = $device->profiling_timer_resolution
		648
		649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		650
		651	=item $boolean = $device->endian_little
		652
		653	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		654
		655	=item $boolean = $device->available
		656
		657	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		658
		659	=item $boolean = $device->compiler_available
		660
		661	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		662
		663	=item $device_exec_capabilities = $device->execution_capabilities
		664
		665	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		666
		667	=item $command_queue_properties = $device->properties
		668
		669	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		670
		671	=item $ = $device->platform
		672
		673	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		674
		675	=item $string = $device->name
		676
		677	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		678
		679	=item $string = $device->vendor
		680
		681	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		682
		683	=item $string = $device->driver_version
		684
		685	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		686
		687	=item $string = $device->profile
		688
		689	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		690
		691	=item $string = $device->version
		692
		693	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		694
		695	=item $string = $device->extensions
		696
		697	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		698
		699	=item $uint = $device->preferred_vector_width_half
		700
		701	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		702
		703	=item $uint = $device->native_vector_width_char
		704
		705	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		706
		707	=item $uint = $device->native_vector_width_short
		708
		709	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		710
		711	=item $uint = $device->native_vector_width_int
		712
		713	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		714
		715	=item $uint = $device->native_vector_width_long
		716
		717	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		718
		719	=item $uint = $device->native_vector_width_float
		720
		721	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		722
		723	=item $uint = $device->native_vector_width_double
		724
		725	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		726
		727	=item $uint = $device->native_vector_width_half
		728
		729	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		730
		731	=item $device_fp_config = $device->double_fp_config
		732
		733	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		734
		735	=item $device_fp_config = $device->half_fp_config
		736
		737	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		738
		739	=item $boolean = $device->host_unified_memory
		740
		741	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		742
		743	=item $device = $device->parent_device_ext
		744
		745	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		746
		747	=item @device_partition_property_exts = $device->partition_types_ext
		748
		749	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		750
		751	=item @device_partition_property_exts = $device->affinity_domains_ext
		752
		753	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		754
		755	=item $uint = $device->reference_count_ext
		756
		757	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
		758
		759	=item @device_partition_property_exts = $device->partition_style_ext
		760
		761	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		762
		763	=for gengetinfo end device
		764
		765	=back
		766
		767	=head2 THE OpenCL::Context CLASS
		768
		769	=over 4
		770
		771	=item $queue = $ctx->queue ($device, $properties)
		772
		773	Create a new OpenCL::Queue object from the context and the given device.
		774
		775	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
		776
		777	Example: create an out-of-order queue.
		778
		779	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		780
		781	=item $ev = $ctx->user_event
		782
		783	Creates a new OpenCL::UserEvent object.
		784
		785	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
		786
		787	=item $buf = $ctx->buffer ($flags, $len)
		788
		789	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		790	given flags and octet-size.
		791
		792	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
		793
		794	=item $buf = $ctx->buffer_sv ($flags, $data)
		795
		796	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		797	initialise it with the given data values.
		798
		799	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
		800
		801	Creates a new OpenCL::Image2D object and optionally initialises it with
		802	the given data values.
		803
		804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
		805
		806	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
		807
		808	Creates a new OpenCL::Image3D object and optionally initialises it with
		809	the given data values.
		810
		811	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		812
		813	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		814
		815	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		816	OpenGL buffer object.
		817
		818	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		819
		820	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		821
		822	Creates a new OpenCL::Image object that refers to the given OpenGL
		823	texture object or buffer.
		824
		825	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		826
		827	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		828
		829	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		830	2D texture object.
		831
		832	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		833
		834	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		835
		836	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		837	3D texture object.
		838
		839	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		840
		841	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		842
		843	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		844	render buffer.
		845
		846	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
		847
		848	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
		849
		850	Returns a list of matching image formats - each format is an arrayref with
		851	two values, $channel_order and $channel_type, in it.
		852
		853	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSupportedImageFormats.html>
		854
		855	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
		856
		857	Creates a new OpenCL::Sampler object.
		858
		859	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
		860
		861	=item $program = $ctx->program_with_source ($string)
		862
		863	Creates a new OpenCL::Program object from the given source code.
		864
		865	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		866
		867	=item $packed_value = $ctx->info ($name)
		868
		869	See C<< $platform->info >> for details.
		870
		871	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		872
		873	=for gengetinfo begin context
		874
		875	=item $uint = $context->reference_count
		876
		877	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		878
		879	=item @devices = $context->devices
		880
		881	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		882
		883	=item @property_ints = $context->properties
		884
		885	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		886
		887	=item $uint = $context->num_devices
		888
		889	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		890
		891	=for gengetinfo end context
		892
		893	=back
		894
		895	=head2 THE OpenCL::Queue CLASS
		896
		897	An OpenCL::Queue represents an execution queue for OpenCL. You execute
		898	requests by calling their respective C<enqueue_xxx> method and waitinf for
		899	it to complete in some way.
		900
		901	All the enqueue methods return an event object that can be used to wait
		902	for completion, unless the method is called in void context, in which case
		903	no event object is created.
		904
		905	They also allow you to specify any number of other event objects that this
		906	request has to wait for before it starts executing, by simply passing the
		907	event objects as extra parameters to the enqueue methods. To simplify
		908	program design, this module ignores any C<undef> values in the list of
		909	events. This makes it possible to code operations such as this, without
		910	having to put a valid event object into C<$event> first:
		911
		912	$event = $queue->enqueue_xxx (..., $event);
		913
		914	Queues execute in-order by default, without any parallelism, so in most
		915	cases (i.e. you use only one queue) it's not necessary to wait for or
		916	create event objects, althoguh an our of order queue is often a bit
		917	faster.
		918
		919	=over 4
		920
		921	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
		922
		923	Reads data from buffer into the given string.
		924
		925	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
		926
		927	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
		928
		929	Writes data to buffer from the given string.
		930
		931	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
		932
		933	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
		934
		935	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
		936
		937	=item $ev = $queue->enqueue_read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
		938
		939	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		940
		941	=item $ev = $queue->enqueue_write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
		942
		943	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		944
		945	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		946
		947	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		948
		949	=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...)
		950
		951	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
		952
		953	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		954
		955	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
		956
		957	=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...)
		958
		959	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		960
		961	=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...)
		962
		963	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		964
		965	=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...)
		966
		967	Yeah.
		968
		969	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
		970
		971	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
		972
		973	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
		974
		975	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)
		976
		977	Enqueues a kernel execution.
		978
		979	@$global_work_size must be specified as a reference to an array of
		980	integers specifying the work sizes (element counts).
		981
		982	@$global_work_offset must be either C<undef> (in which case all offsets
		983	are C<0>), or a reference to an array of work offsets, with the same number
		984	of elements as @$global_work_size.
		985
		986	@$local_work_size must be either C<undef> (in which case the
		987	implementation is supposed to choose good local work sizes), or a
		988	reference to an array of local work sizes, with the same number of
		989	elements as @$global_work_size.
		990
		991	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
		992
		993	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
		994
		995	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		996	for subsequent OpenCL usage.
		997
		998	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		999
		1000	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		1001
		1002	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1003	for subsequent OpenGL usage.
		1004
		1005	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
		1006
		1007	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
		1008
		1009	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
		1010
		1011	=item $ev = $queue->enqueue_marker ($wait_events...)
		1012
		1013	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1014
		1015	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1016
		1017	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
		1018
		1019	=item $queue->flush
		1020
		1021	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
		1022
		1023	=item $queue->finish
		1024
		1025	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
		1026
		1027	=item $packed_value = $queue->info ($name)
		1028
		1029	See C<< $platform->info >> for details.
		1030
		1031	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1032
		1033	=for gengetinfo begin command_queue
		1034
		1035	=item $ctx = $command_queue->context
		1036
		1037	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1038
		1039	=item $device = $command_queue->device
		1040
		1041	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1042
		1043	=item $uint = $command_queue->reference_count
		1044
		1045	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1046
		1047	=item $command_queue_properties = $command_queue->properties
		1048
		1049	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1050
		1051	=for gengetinfo end command_queue
		1052
		1053	=back
		1054
		1055	=head2 THE OpenCL::Memory CLASS
		1056
		1057	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
		1058	OpenCL::Image2D and OpenCL::Image3D.
		1059
		1060	=over 4
		1061
		1062	=item $packed_value = $memory->info ($name)
		1063
		1064	See C<< $platform->info >> for details.
		1065
		1066	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
		1067
		1068	=for gengetinfo begin mem
		1069
		1070	=item $mem_object_type = $mem->type
		1071
		1072	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1073
		1074	=item $mem_flags = $mem->flags
		1075
		1076	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1077
		1078	=item $int = $mem->size
		1079
		1080	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1081
		1082	=item $ptr_value = $mem->host_ptr
		1083
		1084	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1085
		1086	=item $uint = $mem->map_count
		1087
		1088	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1089
		1090	=item $uint = $mem->reference_count
		1091
		1092	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1093
		1094	=item $ctx = $mem->context
		1095
		1096	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1097
		1098	=item $mem = $mem->associated_memobject
		1099
		1100	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1101
		1102	=item $int = $mem->offset
		1103
		1104	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1105
		1106	=for gengetinfo end mem
		1107
		1108	=item ($type, $name) = $mem->gl_object_info
		1109
		1110	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1111	object "name" (e.g. the texture name) used to create this memory object.
		1112
		1113	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1114
		1115	=back
		1116
		1117	=head2 THE OpenCL::Buffer CLASS
		1118
		1119	This is a subclass of OpenCL::Memory, and the superclass of
		1120	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1121	and sub-buffers.
		1122
		1123	=head2 THE OpenCL::BufferObj CLASS
		1124
		1125	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1126	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1127	sub buffers from these sub buffers.
		1128
		1129	=over 4
		1130
		1131	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1132
		1133	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1134	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1135
		1136	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1137
		1138	=back
		1139
		1140	=head2 THE OpenCL::Image CLASS
		1141
		1142	This is the superclass of all image objects - OpenCL::Image1D,
		1143	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1144	OpenCL::Image2DArray and OpenCL::Image3D.
		1145
		1146	=over 4
		1147
		1148	=item $packed_value = $ev->image_info ($name)
		1149
		1150	See C<< $platform->info >> for details.
		1151
		1152	The reason this method is not called C<info> is that there already is an
		1153	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1154
		1155	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1156
		1157	=for gengetinfo begin image
		1158
		1159	=item $int = $image->element_size
		1160
		1161	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1162
		1163	=item $int = $image->row_pitch
		1164
		1165	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1166
		1167	=item $int = $image->slice_pitch
		1168
		1169	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1170
		1171	=item $int = $image->width
		1172
		1173	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1174
		1175	=item $int = $image->height
		1176
		1177	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1178
		1179	=item $int = $image->depth
		1180
		1181	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1182
		1183	=for gengetinfo end image
		1184
		1185	=for gengetinfo begin gl_texture
		1186
		1187	=item $GLenum = $gl_texture->target
		1188
		1189	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1190
		1191	=item $GLint = $gl_texture->gl_mipmap_level
		1192
		1193	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1194
		1195	=for gengetinfo end gl_texture
		1196
		1197	=back
		1198
		1199	=head2 THE OpenCL::Sampler CLASS
		1200
		1201	=over 4
		1202
		1203	=item $packed_value = $sampler->info ($name)
		1204
		1205	See C<< $platform->info >> for details.
		1206
		1207	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
		1208
		1209	=for gengetinfo begin sampler
		1210
		1211	=item $uint = $sampler->reference_count
		1212
		1213	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1214
		1215	=item $ctx = $sampler->context
		1216
		1217	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1218
		1219	=item $addressing_mode = $sampler->normalized_coords
		1220
		1221	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1222
		1223	=item $filter_mode = $sampler->addressing_mode
		1224
		1225	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1226
		1227	=item $boolean = $sampler->filter_mode
		1228
		1229	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1230
		1231	=for gengetinfo end sampler
		1232
		1233	=back
		1234
		1235	=head2 THE OpenCL::Program CLASS
		1236
		1237	=over 4
		1238
		1239	=item $program->build ($device, $options = "")
		1240
		1241	Tries to build the program with the givne options.
		1242
		1243	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1244
		1245	=item $packed_value = $program->build_info ($device, $name)
		1246
		1247	Similar to C<< $platform->info >>, but returns build info for a previous
		1248	build attempt for the given device.
		1249
		1250	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
		1251
		1252	=item $kernel = $program->kernel ($function_name)
		1253
		1254	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
		1255	the program.
		1256
		1257	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
		1258
		1259	=for gengetinfo begin program_build
		1260
		1261	=item $build_status = $program->build_status ($device)
		1262
		1263	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1264
		1265	=item $string = $program->build_options ($device)
		1266
		1267	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1268
		1269	=item $string = $program->build_log ($device)
		1270
		1271	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1272
		1273	=for gengetinfo end program_build
		1274
		1275	=item $packed_value = $program->info ($name)
		1276
		1277	See C<< $platform->info >> for details.
		1278
		1279	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1280
		1281	=for gengetinfo begin program
		1282
		1283	=item $uint = $program->reference_count
		1284
		1285	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1286
		1287	=item $ctx = $program->context
		1288
		1289	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1290
		1291	=item $uint = $program->num_devices
		1292
		1293	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1294
		1295	=item @devices = $program->devices
		1296
		1297	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1298
		1299	=item $string = $program->source
		1300
		1301	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1302
		1303	=item @ints = $program->binary_sizes
		1304
		1305	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1306
		1307	=for gengetinfo end program
		1308
		1309	=item @blobs = $program->binaries
		1310
		1311	Returns a string for the compiled binary for every device associated with
		1312	the program, empty strings indicate missing programs, and an empty result
		1313	means no program binaries are available.
		1314
		1315	These "binaries" are often, in fact, informative low-level assembly
		1316	sources.
		1317
		1318	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1319
		1320	=back
		1321
		1322	=head2 THE OpenCL::Kernel CLASS
		1323
		1324	=over 4
		1325
		1326	=item $packed_value = $kernel->info ($name)
		1327
		1328	See C<< $platform->info >> for details.
		1329
		1330	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1331
		1332	=for gengetinfo begin kernel
		1333
		1334	=item $string = $kernel->function_name
		1335
		1336	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1337
		1338	=item $uint = $kernel->num_args
		1339
		1340	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1341
		1342	=item $uint = $kernel->reference_count
		1343
		1344	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1345
		1346	=item $ctx = $kernel->context
		1347
		1348	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1349
		1350	=item $program = $kernel->program
		1351
		1352	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1353
		1354	=for gengetinfo end kernel
		1355
		1356	=item $packed_value = $kernel->work_group_info ($device, $name)
		1357
		1358	See C<< $platform->info >> for details.
		1359
		1360	The reason this method is not called C<info> is that there already is an
		1361	C<< ->info >> method.
		1362
		1363	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1364
		1365	=for gengetinfo begin kernel_work_group
		1366
		1367	=item $int = $kernel->work_group_size ($device)
		1368
		1369	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1370
		1371	=item @ints = $kernel->compile_work_group_size ($device)
		1372
		1373	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1374
		1375	=item $ulong = $kernel->local_mem_size ($device)
		1376
		1377	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1378
		1379	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1380
		1381	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1382
		1383	=item $ulong = $kernel->private_mem_size ($device)
		1384
		1385	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1386
		1387	=for gengetinfo end kernel_work_group
		1388
		1389	=item $kernel->set_TYPE ($index, $value)
		1390
		1391	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
		1392
		1393	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
		1394	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
		1395	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
		1396
		1397	Chars and integers (including the half type) are specified as integers,
		1398	float and double as floating point values, memory/buffer/image2d/image3d
		1399	must be an object of that type or C<undef>, local-memory arguments are
		1400	set by specifying the size, and sampler and event must be objects of that
		1401	type.
		1402
		1403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
		1404
		1405	=back
		1406
		1407	=head2 THE OpenCL::Event CLASS
		1408
		1409	This is the superclass for all event objects (including OpenCL::UserEvent
		1410	objects).
		1411
		1412	=over 4
		1413
		1414	=item $ev->wait
		1415
		1416	Waits for the event to complete.
		1417
		1418	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1419
		1420	=item $packed_value = $ev->info ($name)
		1421
		1422	See C<< $platform->info >> for details.
		1423
		1424	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
		1425
		1426	=for gengetinfo begin event
		1427
		1428	=item $queue = $event->command_queue
		1429
		1430	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1431
		1432	=item $command_type = $event->command_type
		1433
		1434	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1435
		1436	=item $uint = $event->reference_count
		1437
		1438	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1439
		1440	=item $uint = $event->command_execution_status
		1441
		1442	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1443
		1444	=item $ctx = $event->context
		1445
		1446	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1447
		1448	=for gengetinfo end event
		1449
		1450	=item $packed_value = $ev->profiling_info ($name)
		1451
		1452	See C<< $platform->info >> for details.
		1453
		1454	The reason this method is not called C<info> is that there already is an
		1455	C<< ->info >> method.
		1456
		1457	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1458
		1459	=for gengetinfo begin profiling
		1460
		1461	=item $ulong = $event->profiling_command_queued
		1462
		1463	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1464
		1465	=item $ulong = $event->profiling_command_submit
		1466
		1467	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1468
		1469	=item $ulong = $event->profiling_command_start
		1470
		1471	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1472
		1473	=item $ulong = $event->profiling_command_end
		1474
		1475	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1476
		1477	=for gengetinfo end profiling
		1478
		1479	=back
		1480
		1481	=head2 THE OpenCL::UserEvent CLASS
		1482
		1483	This is a subclass of OpenCL::Event.
		1484
		1485	=over 4
		1486
		1487	=item $ev->set_status ($execution_status)
		1488
		1489	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
		1490
		1491	=back
		1492
87	=cut	1493	=cut
88		1494
89	package OpenCL;	1495	package OpenCL;
90		1496
91	use common::sense;	1497	use common::sense;
92		1498
93	BEGIN {	1499	BEGIN {
94	our $VERSION = '0.01';	1500	our $VERSION = '0.96';
95		1501
96	require XSLoader;	1502	require XSLoader;
97	XSLoader::load (__PACKAGE__, $VERSION);	1503	XSLoader::load (__PACKAGE__, $VERSION);
98		1504
99	@OpenCL::Buffer::ISA =	1505	@OpenCL::Buffer::ISA =
100	@OpenCL::Image::ISA = OpenCL::Memory::;	1506	@OpenCL::Image::ISA = OpenCL::Memory::;
101		1507
		1508	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1509
102	@OpenCL::Image2D::ISA =	1510	@OpenCL::Image2D::ISA =
		1511	@OpenCL::Image3D::ISA =
		1512	@OpenCL::Image2DArray::ISA =
		1513	@OpenCL::Image1D::ISA =
		1514	@OpenCL::Image1DArray::ISA =
103	@OpenCL::Image3D::ISA = OpenCL::Image::;	1515	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		1516
		1517	@OpenCL::UserEvent::ISA = OpenCL::Event::;
104	}	1518	}
105		1519
106	1;	1520	1;
107
108	=back
109		1521
110	=head1 AUTHOR	1522	=head1 AUTHOR
111		1523
112	Marc Lehmann <schmorp@schmorp.de>	1524	Marc Lehmann <schmorp@schmorp.de>
113	http://home.schmorp.de/	1525	http://home.schmorp.de/

Diff Legend

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