ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.4 by root, Tue Nov 15 21:16:19 2011 UTC vs.
Revision 1.32 by root, Thu Apr 19 12:12:03 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
80	eval { $prog->build ($dev); 1 }	165	eval { $prog->build ($dev); 1 }
81	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);	166	or die $prog->build_log;
82		167
83	my $kernel = $prog->kernel ("squareit");	168	my $kernel = $prog->kernel ("squareit");
84		169
85	Create some input and output float buffers, then call squareit on them:	170	=head2 Create some input and output float buffers, then call the
		171	'squareit' kernel on them.
86		172
87	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);	173	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);
88	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);	174	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
89		175
90	# set buffer	176	# set buffer
…		…
92	$kernel->set_buffer (1, $output);	178	$kernel->set_buffer (1, $output);
93		179
94	# execute it for all 4 numbers	180	# execute it for all 4 numbers
95	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	181	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);
96		182
97	# enqueue a barrier ot ensure in-order execution (not really needed in this case)	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
98	$queue->enqueue_barrier;	196	$queue->enqueue_barrier;
99		197
100	# enqueue an async read (could easily be blocking here though), then wait for it:	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
101	my $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	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
102	$ev->wait;	214	$ev->wait;
103		215
104	# print the results:	216	=head1 DOCUMENTATION
105	say join ", ", unpack "f*", $data;	217
		218	=head2 BASIC CONVENTIONS
		219
		220	This is not a one-to-one C-style translation of OpenCL to Perl - instead
		221	I attempted to make the interface as type-safe as possible by introducing
		222	object syntax where it makes sense. There are a number of important
		223	differences between the OpenCL C API and this module:
106		224
107	=over 4	225	=over 4
108		226
		227	=item * Object lifetime managament is automatic - there is no need
		228	to free objects explicitly (C<clReleaseXXX>), the release function
		229	is called automatically once all Perl references to it go away.
		230
		231	=item * OpenCL uses CamelCase for function names
		232	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
		233	uses underscores as word separator and often leaves out prefixes
		234	(C<OpenCL::platforms>, C<< $platform->info >>).
		235
		236	=item * OpenCL often specifies fixed vector function arguments as short
		237	arrays (C<size_t origin[3]>), while this module explicitly expects the
		238	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		239	function calls.
		240
		241	=item * Structures are often specified by flattening out their components
		242	as with short vectors, and returned as arrayrefs.
		243
		244	=item * When enqueuing commands, the wait list is specified by adding
		245	extra arguments to the function - anywhere a C<$wait_events...> argument
		246	is documented this can be any number of event objects.
		247
		248	=item * When enqueuing commands, if the enqueue method is called in void
		249	context, no event is created. In all other contexts an event is returned
		250	by the method.
		251
		252	=item * This module expects all functions to return C<CL_SUCCESS>. If any
		253	other status is returned the function will throw an exception, so you
		254	don't normally have to to any error checking.
		255
		256	=back
		257
		258	=head2 PERL AND OPENCL TYPES
		259
		260	This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
		261	format equivalents:
		262
		263	OpenCL perl PDL pack/unpack
		264	char IV - c
		265	uchar IV byte C
		266	short IV short s
		267	ushort IV ushort S
		268	int IV long? l
		269	uint IV - L
		270	long IV longlong q
		271	ulong IV - Q
		272	float NV float f
		273	half IV ushort S
		274	double NV double d
		275
		276	=head2 OpenGL sharing
		277
		278	This module can be optionally compiled with support for
		279	OpenGL sharing. The sharing functions are only available when
		280	C<OpenCL::HAVE_OPENGL> returns true, otherwise they are absent and cannot
		281	be called.
		282
		283	=head2 THE OpenCL PACKAGE
		284
		285	=over 4
		286
		287	=item $int = OpenCL::errno
		288
		289	The last error returned by a function - it's only valid after an error occured
		290	and before calling another OpenCL function.
		291
		292	=item $str = OpenCL::err2str $errval
		293
		294	Comverts an error value into a human readable string.
		295
		296	=item $str = OpenCL::enum2str $enum
		297
		298	Converts most enum values (of parameter names, image format constants,
		299	object types, addressing and filter modes, command types etc.) into a
		300	human readable string. When confronted with some random integer it can be
		301	very helpful to pass it through this function to maybe get some readable
		302	string out of it.
		303
		304	=item @platforms = OpenCL::platforms
		305
		306	Returns all available OpenCL::Platform objects.
		307
		308	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
		309
		310	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef
		311
		312	Tries to create a context from a default device and platform - never worked for me.
		313
		314	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		315
		316	=item OpenCL::wait_for_events $wait_events...
		317
		318	Waits for all events to complete.
		319
		320	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		321
		322	=back
		323
		324	=head2 THE OpenCL::Platform CLASS
		325
		326	=over 4
		327
		328	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
		329
		330	Returns a list of matching OpenCL::Device objects.
		331
		332	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
		333
		334	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
		335
		336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		337
		338	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
		339
		340	Create a new OpenCL::Context object using the given device object(s)- a
		341	CL_CONTEXT_PLATFORM property is supplied automatically.
		342
		343	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		344
		345	=item $packed_value = $platform->info ($name)
		346
		347	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
		348	strings, this will be the string (possibly including terminating \0), for
		349	other values you probably need to use the correct C<unpack>.
		350
		351	It's best to avoid this method and use one of the following convenience
		352	wrappers.
		353
		354	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
		355
		356	=for gengetinfo begin platform
		357
		358	=item $string = $platform->profile
		359
		360	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
		361
		362	=item $string = $platform->version
		363
		364	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
		365
		366	=item $string = $platform->name
		367
		368	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
		369
		370	=item $string = $platform->vendor
		371
		372	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
		373
		374	=item $string = $platform->extensions
		375
		376	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		377
		378	=for gengetinfo end platform
		379
		380	=back
		381
		382	=head2 THE OpenCL::Device CLASS
		383
		384	=over 4
		385
		386	=item $packed_value = $device->info ($name)
		387
		388	See C<< $platform->info >> for details.
		389
		390	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
		391
		392	=for gengetinfo begin device
		393
		394	=item $device_type = $device->type
		395
		396	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		397
		398	=item $uint = $device->vendor_id
		399
		400	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		401
		402	=item $uint = $device->max_compute_units
		403
		404	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		405
		406	=item $uint = $device->max_work_item_dimensions
		407
		408	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		409
		410	=item $int = $device->max_work_group_size
		411
		412	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		413
		414	=item @ints = $device->max_work_item_sizes
		415
		416	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		417
		418	=item $uint = $device->preferred_vector_width_char
		419
		420	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		421
		422	=item $uint = $device->preferred_vector_width_short
		423
		424	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		425
		426	=item $uint = $device->preferred_vector_width_int
		427
		428	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		429
		430	=item $uint = $device->preferred_vector_width_long
		431
		432	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		433
		434	=item $uint = $device->preferred_vector_width_float
		435
		436	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		437
		438	=item $uint = $device->preferred_vector_width_double
		439
		440	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		441
		442	=item $uint = $device->max_clock_frequency
		443
		444	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		445
		446	=item $bitfield = $device->address_bits
		447
		448	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		449
		450	=item $uint = $device->max_read_image_args
		451
		452	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		453
		454	=item $uint = $device->max_write_image_args
		455
		456	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		457
		458	=item $ulong = $device->max_mem_alloc_size
		459
		460	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		461
		462	=item $int = $device->image2d_max_width
		463
		464	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		465
		466	=item $int = $device->image2d_max_height
		467
		468	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		469
		470	=item $int = $device->image3d_max_width
		471
		472	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		473
		474	=item $int = $device->image3d_max_height
		475
		476	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		477
		478	=item $int = $device->image3d_max_depth
		479
		480	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		481
		482	=item $uint = $device->image_support
		483
		484	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		485
		486	=item $int = $device->max_parameter_size
		487
		488	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		489
		490	=item $uint = $device->max_samplers
		491
		492	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		493
		494	=item $uint = $device->mem_base_addr_align
		495
		496	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		497
		498	=item $uint = $device->min_data_type_align_size
		499
		500	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		501
		502	=item $device_fp_config = $device->single_fp_config
		503
		504	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		505
		506	=item $device_mem_cache_type = $device->global_mem_cache_type
		507
		508	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		509
		510	=item $uint = $device->global_mem_cacheline_size
		511
		512	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		513
		514	=item $ulong = $device->global_mem_cache_size
		515
		516	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		517
		518	=item $ulong = $device->global_mem_size
		519
		520	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		521
		522	=item $ulong = $device->max_constant_buffer_size
		523
		524	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		525
		526	=item $uint = $device->max_constant_args
		527
		528	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		529
		530	=item $device_local_mem_type = $device->local_mem_type
		531
		532	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		533
		534	=item $ulong = $device->local_mem_size
		535
		536	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		537
		538	=item $boolean = $device->error_correction_support
		539
		540	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		541
		542	=item $int = $device->profiling_timer_resolution
		543
		544	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		545
		546	=item $boolean = $device->endian_little
		547
		548	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		549
		550	=item $boolean = $device->available
		551
		552	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		553
		554	=item $boolean = $device->compiler_available
		555
		556	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		557
		558	=item $device_exec_capabilities = $device->execution_capabilities
		559
		560	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		561
		562	=item $command_queue_properties = $device->properties
		563
		564	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		565
		566	=item $ = $device->platform
		567
		568	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		569
		570	=item $string = $device->name
		571
		572	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		573
		574	=item $string = $device->vendor
		575
		576	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		577
		578	=item $string = $device->driver_version
		579
		580	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		581
		582	=item $string = $device->profile
		583
		584	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		585
		586	=item $string = $device->version
		587
		588	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		589
		590	=item $string = $device->extensions
		591
		592	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		593
		594	=item $uint = $device->preferred_vector_width_half
		595
		596	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		597
		598	=item $uint = $device->native_vector_width_char
		599
		600	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		601
		602	=item $uint = $device->native_vector_width_short
		603
		604	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		605
		606	=item $uint = $device->native_vector_width_int
		607
		608	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		609
		610	=item $uint = $device->native_vector_width_long
		611
		612	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		613
		614	=item $uint = $device->native_vector_width_float
		615
		616	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		617
		618	=item $uint = $device->native_vector_width_double
		619
		620	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		621
		622	=item $uint = $device->native_vector_width_half
		623
		624	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		625
		626	=item $device_fp_config = $device->double_fp_config
		627
		628	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		629
		630	=item $device_fp_config = $device->half_fp_config
		631
		632	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		633
		634	=item $boolean = $device->host_unified_memory
		635
		636	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		637
		638	=item $device = $device->parent_device_ext
		639
		640	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		641
		642	=item @device_partition_property_exts = $device->partition_types_ext
		643
		644	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		645
		646	=item @device_partition_property_exts = $device->affinity_domains_ext
		647
		648	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		649
		650	=item $uint = $device->reference_count_ext
		651
		652	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
		653
		654	=item @device_partition_property_exts = $device->partition_style_ext
		655
		656	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		657
		658	=for gengetinfo end device
		659
		660	=back
		661
		662	=head2 THE OpenCL::Context CLASS
		663
		664	=over 4
		665
		666	=item $queue = $ctx->queue ($device, $properties)
		667
		668	Create a new OpenCL::Queue object from the context and the given device.
		669
		670	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
		671
		672	=item $ev = $ctx->user_event
		673
		674	Creates a new OpenCL::UserEvent object.
		675
		676	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
		677
		678	=item $buf = $ctx->buffer ($flags, $len)
		679
		680	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		681	given flags and octet-size.
		682
		683	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
		684
		685	=item $buf = $ctx->buffer_sv ($flags, $data)
		686
		687	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		688	initialise it with the given data values.
		689
		690	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
		691
		692	Creates a new OpenCL::Image2D object and optionally initialises it with
		693	the given data values.
		694
		695	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
		696
		697	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
		698
		699	Creates a new OpenCL::Image3D object and optionally initialises it with
		700	the given data values.
		701
		702	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		703
		704	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
		705
		706	Returns a list of matching image formats - each format is an arrayref with
		707	two values, $channel_order and $channel_type, in it.
		708
		709	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSupportedImageFormats.html>
		710
		711	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
		712
		713	Creates a new OpenCL::Sampler object.
		714
		715	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
		716
		717	=item $program = $ctx->program_with_source ($string)
		718
		719	Creates a new OpenCL::Program object from the given source code.
		720
		721	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		722
		723	=item $packed_value = $ctx->info ($name)
		724
		725	See C<< $platform->info >> for details.
		726
		727	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		728
		729	=for gengetinfo begin context
		730
		731	=item $uint = $context->reference_count
		732
		733	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		734
		735	=item @devices = $context->devices
		736
		737	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		738
		739	=item @property_ints = $context->properties
		740
		741	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		742
		743	=item $uint = $context->num_devices
		744
		745	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		746
		747	=for gengetinfo end context
		748
		749	=back
		750
		751	=head2 THE OpenCL::Queue CLASS
		752
		753	An OpenCL::Queue represents an execution queue for OpenCL. You execute
		754	requests by calling their respective C<enqueue_xxx> method and waitinf for
		755	it to complete in some way.
		756
		757	All the enqueue methods return an event object that can be used to wait
		758	for completion, unless the method is called in void context, in which case
		759	no event object is created.
		760
		761	They also allow you to specify any number of other event objects that this
		762	request has to wait for before it starts executing, by simply passing the
		763	event objects as extra parameters to the enqueue methods.
		764
		765	Queues execute in-order by default, without any parallelism, so in most
		766	cases (i.e. you use only one queue) it's not necessary to wait for or
		767	create event objects.
		768
		769	=over 4
		770
		771	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
		772
		773	Reads data from buffer into the given string.
		774
		775	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
		776
		777	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
		778
		779	Writes data to buffer from the given string.
		780
		781	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
		782
		783	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
		784
		785	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
		786
		787	=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...)
		788
		789	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		790
		791	=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...)
		792
		793	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		794
		795	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		796
		797	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		798
		799	=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...)
		800
		801	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
		802
		803	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		804
		805	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
		806
		807	=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...)
		808
		809	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		810
		811	=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...)
		812
		813	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		814
		815	=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...)
		816
		817	Yeah.
		818
		819	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
		820
		821	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
		822
		823	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
		824
		825	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)
		826
		827	Enqueues a kernel execution.
		828
		829	@$global_work_size must be specified as a reference to an array of
		830	integers specifying the work sizes (element counts).
		831
		832	@$global_work_offset must be either C<undef> (in which case all offsets
		833	are C<0>), or a reference to an array of work offsets, with the same number
		834	of elements as @$global_work_size.
		835
		836	@$local_work_size must be either C<undef> (in which case the
		837	implementation is supposed to choose good local work sizes), or a
		838	reference to an array of local work sizes, with the same number of
		839	elements as @$global_work_size.
		840
		841	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
		842
		843	=item $ev = $queue->enqueue_marker
		844
		845	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
		846
		847	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
		848
		849	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
		850
		851	=item $queue->enqueue_barrier
		852
		853	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>
		854
		855	=item $queue->flush
		856
		857	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
		858
		859	=item $queue->finish
		860
		861	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
		862
		863	=item $packed_value = $queue->info ($name)
		864
		865	See C<< $platform->info >> for details.
		866
		867	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		868
		869	=for gengetinfo begin command_queue
		870
		871	=item $ctx = $command_queue->context
		872
		873	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		874
		875	=item $device = $command_queue->device
		876
		877	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		878
		879	=item $uint = $command_queue->reference_count
		880
		881	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		882
		883	=item $command_queue_properties = $command_queue->properties
		884
		885	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		886
		887	=for gengetinfo end command_queue
		888
		889	=back
		890
		891	=head2 THE OpenCL::Memory CLASS
		892
		893	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
		894	OpenCL::Image2D and OpenCL::Image3D.
		895
		896	=over 4
		897
		898	=item $packed_value = $memory->info ($name)
		899
		900	See C<< $platform->info >> for details.
		901
		902	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
		903
		904	=for gengetinfo begin mem
		905
		906	=item $mem_object_type = $mem->type
		907
		908	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		909
		910	=item $mem_flags = $mem->flags
		911
		912	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		913
		914	=item $int = $mem->size
		915
		916	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		917
		918	=item $ptr_value = $mem->host_ptr
		919
		920	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		921
		922	=item $uint = $mem->map_count
		923
		924	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		925
		926	=item $uint = $mem->reference_count
		927
		928	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		929
		930	=item $ctx = $mem->context
		931
		932	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		933
		934	=item $mem = $mem->associated_memobject
		935
		936	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		937
		938	=item $int = $mem->offset
		939
		940	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		941
		942	=for gengetinfo end mem
		943
		944	=back
		945
		946	=head2 THE OpenCL::Buffer CLASS
		947
		948	This is a subclass of OpenCL::Memory, and the superclass of
		949	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		950	and sub-buffers.
		951
		952	=head2 THE OpenCL::BufferObj CLASS
		953
		954	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		955	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		956	sub buffers from these sub buffers.
		957
		958	=over 4
		959
		960	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		961
		962	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		963	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		964
		965	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		966
		967	=back
		968
		969	=head2 THE OpenCL::Image CLASS
		970
		971	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		972
		973	=over 4
		974
		975	=item $packed_value = $ev->image_info ($name)
		976
		977	See C<< $platform->info >> for details.
		978
		979	The reason this method is not called C<info> is that there already is an
		980	C<< ->info >> method inherited from C<OpenCL::Memory>.
		981
		982	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		983
		984	=for gengetinfo begin image
		985
		986	=item $int = $image->element_size
		987
		988	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		989
		990	=item $int = $image->row_pitch
		991
		992	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		993
		994	=item $int = $image->slice_pitch
		995
		996	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		997
		998	=item $int = $image->width
		999
		1000	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1001
		1002	=item $int = $image->height
		1003
		1004	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1005
		1006	=item $int = $image->depth
		1007
		1008	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1009
		1010	=for gengetinfo end image
		1011
		1012	=back
		1013
		1014	=head2 THE OpenCL::Sampler CLASS
		1015
		1016	=over 4
		1017
		1018	=item $packed_value = $sampler->info ($name)
		1019
		1020	See C<< $platform->info >> for details.
		1021
		1022	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
		1023
		1024	=for gengetinfo begin sampler
		1025
		1026	=item $uint = $sampler->reference_count
		1027
		1028	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1029
		1030	=item $ctx = $sampler->context
		1031
		1032	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1033
		1034	=item $addressing_mode = $sampler->normalized_coords
		1035
		1036	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1037
		1038	=item $filter_mode = $sampler->addressing_mode
		1039
		1040	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1041
		1042	=item $boolean = $sampler->filter_mode
		1043
		1044	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1045
		1046	=for gengetinfo end sampler
		1047
		1048	=back
		1049
		1050	=head2 THE OpenCL::Program CLASS
		1051
		1052	=over 4
		1053
		1054	=item $program->build ($device, $options = "")
		1055
		1056	Tries to build the program with the givne options.
		1057
		1058	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1059
		1060	=item $packed_value = $program->build_info ($device, $name)
		1061
		1062	Similar to C<< $platform->info >>, but returns build info for a previous
		1063	build attempt for the given device.
		1064
		1065	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
		1066
		1067	=item $kernel = $program->kernel ($function_name)
		1068
		1069	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
		1070	the program.
		1071
		1072	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
		1073
		1074	=for gengetinfo begin program_build
		1075
		1076	=item $build_status = $program->build_status ($device)
		1077
		1078	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1079
		1080	=item $string = $program->build_options ($device)
		1081
		1082	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1083
		1084	=item $string = $program->build_log ($device)
		1085
		1086	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1087
		1088	=for gengetinfo end program_build
		1089
		1090	=item $packed_value = $program->info ($name)
		1091
		1092	See C<< $platform->info >> for details.
		1093
		1094	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1095
		1096	=for gengetinfo begin program
		1097
		1098	=item $uint = $program->reference_count
		1099
		1100	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1101
		1102	=item $ctx = $program->context
		1103
		1104	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1105
		1106	=item $uint = $program->num_devices
		1107
		1108	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1109
		1110	=item @devices = $program->devices
		1111
		1112	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1113
		1114	=item $string = $program->source
		1115
		1116	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1117
		1118	=item @ints = $program->binary_sizes
		1119
		1120	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1121
		1122	=for gengetinfo end program
		1123
		1124	=item @blobs = $program->binaries
		1125
		1126	Returns a string for the compiled binary for every device associated with
		1127	the program, empty strings indicate missing programs, and an empty result
		1128	means no program binaries are available.
		1129
		1130	These "binaries" are often, in fact, informative low-level assembly
		1131	sources.
		1132
		1133	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1134
		1135	=back
		1136
		1137	=head2 THE OpenCL::Kernel CLASS
		1138
		1139	=over 4
		1140
		1141	=item $packed_value = $kernel->info ($name)
		1142
		1143	See C<< $platform->info >> for details.
		1144
		1145	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1146
		1147	=for gengetinfo begin kernel
		1148
		1149	=item $string = $kernel->function_name
		1150
		1151	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1152
		1153	=item $uint = $kernel->num_args
		1154
		1155	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1156
		1157	=item $uint = $kernel->reference_count
		1158
		1159	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1160
		1161	=item $ctx = $kernel->context
		1162
		1163	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1164
		1165	=item $program = $kernel->program
		1166
		1167	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1168
		1169	=for gengetinfo end kernel
		1170
		1171	=item $packed_value = $kernel->work_group_info ($device, $name)
		1172
		1173	See C<< $platform->info >> for details.
		1174
		1175	The reason this method is not called C<info> is that there already is an
		1176	C<< ->info >> method.
		1177
		1178	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1179
		1180	=for gengetinfo begin kernel_work_group
		1181
		1182	=item $int = $kernel->work_group_size ($device)
		1183
		1184	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1185
		1186	=item @ints = $kernel->compile_work_group_size ($device)
		1187
		1188	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1189
		1190	=item $ulong = $kernel->local_mem_size ($device)
		1191
		1192	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1193
		1194	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1195
		1196	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1197
		1198	=item $ulong = $kernel->private_mem_size ($device)
		1199
		1200	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1201
		1202	=for gengetinfo end kernel_work_group
		1203
		1204	=item $kernel->set_TYPE ($index, $value)
		1205
		1206	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
		1207
		1208	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
		1209	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
		1210	C<image2d>, C<image3d>, C<sampler> or C<event>.
		1211
		1212	Chars and integers (including the half type) are specified as integers,
		1213	float and double as floating point values, memory/buffer/image2d/image3d
		1214	must be an object of that type or C<undef>, and sampler and event must be
		1215	objects of that type.
		1216
		1217	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
		1218
		1219	=back
		1220
		1221	=head2 THE OpenCL::Event CLASS
		1222
		1223	This is the superclass for all event objects (including OpenCL::UserEvent
		1224	objects).
		1225
		1226	=over 4
		1227
		1228	=item $ev->wait
		1229
		1230	Waits for the event to complete.
		1231
		1232	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1233
		1234	=item $packed_value = $ev->info ($name)
		1235
		1236	See C<< $platform->info >> for details.
		1237
		1238	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
		1239
		1240	=for gengetinfo begin event
		1241
		1242	=item $queue = $event->command_queue
		1243
		1244	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1245
		1246	=item $command_type = $event->command_type
		1247
		1248	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1249
		1250	=item $uint = $event->reference_count
		1251
		1252	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1253
		1254	=item $uint = $event->command_execution_status
		1255
		1256	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1257
		1258	=item $ctx = $event->context
		1259
		1260	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1261
		1262	=for gengetinfo end event
		1263
		1264	=item $packed_value = $ev->profiling_info ($name)
		1265
		1266	See C<< $platform->info >> for details.
		1267
		1268	The reason this method is not called C<info> is that there already is an
		1269	C<< ->info >> method.
		1270
		1271	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1272
		1273	=for gengetinfo begin profiling
		1274
		1275	=item $ulong = $event->profiling_command_queued
		1276
		1277	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1278
		1279	=item $ulong = $event->profiling_command_submit
		1280
		1281	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1282
		1283	=item $ulong = $event->profiling_command_start
		1284
		1285	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1286
		1287	=item $ulong = $event->profiling_command_end
		1288
		1289	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1290
		1291	=for gengetinfo end profiling
		1292
		1293	=back
		1294
		1295	=head2 THE OpenCL::UserEvent CLASS
		1296
		1297	This is a subclass of OpenCL::Event.
		1298
		1299	=over 4
		1300
		1301	=item $ev->set_status ($execution_status)
		1302
		1303	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
		1304
		1305	=back
		1306
109	=cut	1307	=cut
110		1308
111	package OpenCL;	1309	package OpenCL;
112		1310
113	use common::sense;	1311	use common::sense;
114		1312
115	BEGIN {	1313	BEGIN {
116	our $VERSION = '0.02';	1314	our $VERSION = '0.92';
117		1315
118	require XSLoader;	1316	require XSLoader;
119	XSLoader::load (__PACKAGE__, $VERSION);	1317	XSLoader::load (__PACKAGE__, $VERSION);
120		1318
121	@OpenCL::Buffer::ISA =	1319	@OpenCL::Buffer::ISA =
122	@OpenCL::Image::ISA = OpenCL::Memory::;	1320	@OpenCL::Image::ISA = OpenCL::Memory::;
123		1321
		1322	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1323
124	@OpenCL::Image2D::ISA =	1324	@OpenCL::Image2D::ISA =
125	@OpenCL::Image3D::ISA = OpenCL::Image::;	1325	@OpenCL::Image3D::ISA = OpenCL::Image::;
		1326
		1327	@OpenCL::UserEvent::ISA = OpenCL::Event::;
126	}	1328	}
127		1329
128	1;	1330	1;
129
130	=back
131		1331
132	=head1 AUTHOR	1332	=head1 AUTHOR
133		1333
134	Marc Lehmann <schmorp@schmorp.de>	1334	Marc Lehmann <schmorp@schmorp.de>
135	http://home.schmorp.de/	1335	http://home.schmorp.de/

Diff Legend

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