ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.1 by root, Tue Nov 15 06:50:30 2011 UTC vs.
Revision 1.44 by root, Sat Apr 21 17:47:23 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
		46	=head2 HELPFUL RESOURCES
		47
		48	The OpenCL spec used to develop this module (1.2 spec was available, but
		49	no implementation was available to me :).
		50
		51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
		52
		53	OpenCL manpages:
		54
		55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
		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
		98	=head1 EXAMPLES
		99
13	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.
14		104
15	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
16	warn $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
17	warn $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
18	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
19	warn $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
20	my $ctx = $device->context_simple;	110	my $ctx = $platform->context (undef, [$device]);
21	# do stuff	111	# do stuff
22	}	112	}
23	}	113	}
24		114
25	Get a useful context and a command queue:	115	=head2 Get a useful context and a command queue.
26		116
27	my $dev = ((OpenCL::platforms)[0]->devices)[0];	117	This is a useful boilerplate for any OpenCL program that only wants to use
28	my $ctx = $dev->context_simple;	118	one device,
		119
		120	my ($platform) = OpenCL::platforms; # find first platform
		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
		124
		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.
		129
		130	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
		131	print "supported image formats for ", OpenCL::enum2str $type, "\n";
		132
		133	for my $f ($ctx->supported_image_formats (0, $type)) {
		134	printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];
		135	}
		136	}
		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
		150	=head2 Create and build a program, then create a kernel out of one of its
		151	functions.
		152
		153	my $src = '
		154	kernel void
		155	squareit (global float *input, global float *output)
		156	{
		157	$id = get_global_id (0);
		158	output [id] = input [id] * input [id];
		159	}
		160	';
		161
		162	my $prog = $ctx->program_with_source ($src);
		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
29	my $queue = $ctx->command_queue_simple ($dev);	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);
		273	eval { $prog->build ($dev); 1 }
		274	or die $prog->build_log ($dev);
		275
		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:
30		319
31	=over 4	320	=over 4
32		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	=item $ev = $ctx->user_event
		778
		779	Creates a new OpenCL::UserEvent object.
		780
		781	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
		782
		783	=item $buf = $ctx->buffer ($flags, $len)
		784
		785	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		786	given flags and octet-size.
		787
		788	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
		789
		790	=item $buf = $ctx->buffer_sv ($flags, $data)
		791
		792	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		793	initialise it with the given data values.
		794
		795	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
		796
		797	Creates a new OpenCL::Image2D object and optionally initialises it with
		798	the given data values.
		799
		800	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
		801
		802	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
		803
		804	Creates a new OpenCL::Image3D object and optionally initialises it with
		805	the given data values.
		806
		807	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		808
		809	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		810
		811	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		812	OpenGL buffer object.
		813
		814	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		815
		816	=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		817
		818	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		819	2D texture object.
		820
		821	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		822
		823	=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		824
		825	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		826	3D texture object.
		827
		828	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		829
		830	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		831
		832	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		833	render buffer.
		834
		835	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
		836
		837	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
		838
		839	Returns a list of matching image formats - each format is an arrayref with
		840	two values, $channel_order and $channel_type, in it.
		841
		842	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSupportedImageFormats.html>
		843
		844	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
		845
		846	Creates a new OpenCL::Sampler object.
		847
		848	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
		849
		850	=item $program = $ctx->program_with_source ($string)
		851
		852	Creates a new OpenCL::Program object from the given source code.
		853
		854	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		855
		856	=item $packed_value = $ctx->info ($name)
		857
		858	See C<< $platform->info >> for details.
		859
		860	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		861
		862	=for gengetinfo begin context
		863
		864	=item $uint = $context->reference_count
		865
		866	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		867
		868	=item @devices = $context->devices
		869
		870	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		871
		872	=item @property_ints = $context->properties
		873
		874	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		875
		876	=item $uint = $context->num_devices
		877
		878	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		879
		880	=for gengetinfo end context
		881
		882	=back
		883
		884	=head2 THE OpenCL::Queue CLASS
		885
		886	An OpenCL::Queue represents an execution queue for OpenCL. You execute
		887	requests by calling their respective C<enqueue_xxx> method and waitinf for
		888	it to complete in some way.
		889
		890	All the enqueue methods return an event object that can be used to wait
		891	for completion, unless the method is called in void context, in which case
		892	no event object is created.
		893
		894	They also allow you to specify any number of other event objects that this
		895	request has to wait for before it starts executing, by simply passing the
		896	event objects as extra parameters to the enqueue methods.
		897
		898	Queues execute in-order by default, without any parallelism, so in most
		899	cases (i.e. you use only one queue) it's not necessary to wait for or
		900	create event objects.
		901
		902	=over 4
		903
		904	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
		905
		906	Reads data from buffer into the given string.
		907
		908	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
		909
		910	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
		911
		912	Writes data to buffer from the given string.
		913
		914	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
		915
		916	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
		917
		918	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
		919
		920	=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...)
		921
		922	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		923
		924	=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...)
		925
		926	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		927
		928	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		929
		930	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		931
		932	=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...)
		933
		934	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
		935
		936	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		937
		938	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
		939
		940	=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...)
		941
		942	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		943
		944	=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...)
		945
		946	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		947
		948	=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...)
		949
		950	Yeah.
		951
		952	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
		953
		954	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
		955
		956	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
		957
		958	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)
		959
		960	Enqueues a kernel execution.
		961
		962	@$global_work_size must be specified as a reference to an array of
		963	integers specifying the work sizes (element counts).
		964
		965	@$global_work_offset must be either C<undef> (in which case all offsets
		966	are C<0>), or a reference to an array of work offsets, with the same number
		967	of elements as @$global_work_size.
		968
		969	@$local_work_size must be either C<undef> (in which case the
		970	implementation is supposed to choose good local work sizes), or a
		971	reference to an array of local work sizes, with the same number of
		972	elements as @$global_work_size.
		973
		974	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
		975
		976	=item $ev = $queue->enqueue_marker ($wait_events...)
		977
		978	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
		979
		980	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
		981
		982	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		983	for subsequent OpenCL usage.
		984
		985	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		986
		987	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		988
		989	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		990	for subsequent OpenGL usage.
		991
		992	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
		993
		994	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
		995
		996	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
		997
		998	=item $queue->enqueue_barrier
		999
		1000	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>
		1001
		1002	=item $queue->flush
		1003
		1004	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
		1005
		1006	=item $queue->finish
		1007
		1008	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
		1009
		1010	=item $packed_value = $queue->info ($name)
		1011
		1012	See C<< $platform->info >> for details.
		1013
		1014	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1015
		1016	=for gengetinfo begin command_queue
		1017
		1018	=item $ctx = $command_queue->context
		1019
		1020	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1021
		1022	=item $device = $command_queue->device
		1023
		1024	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1025
		1026	=item $uint = $command_queue->reference_count
		1027
		1028	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1029
		1030	=item $command_queue_properties = $command_queue->properties
		1031
		1032	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1033
		1034	=for gengetinfo end command_queue
		1035
		1036	=back
		1037
		1038	=head2 THE OpenCL::Memory CLASS
		1039
		1040	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
		1041	OpenCL::Image2D and OpenCL::Image3D.
		1042
		1043	=over 4
		1044
		1045	=item $packed_value = $memory->info ($name)
		1046
		1047	See C<< $platform->info >> for details.
		1048
		1049	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
		1050
		1051	=for gengetinfo begin mem
		1052
		1053	=item $mem_object_type = $mem->type
		1054
		1055	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1056
		1057	=item $mem_flags = $mem->flags
		1058
		1059	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1060
		1061	=item $int = $mem->size
		1062
		1063	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1064
		1065	=item $ptr_value = $mem->host_ptr
		1066
		1067	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1068
		1069	=item $uint = $mem->map_count
		1070
		1071	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1072
		1073	=item $uint = $mem->reference_count
		1074
		1075	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1076
		1077	=item $ctx = $mem->context
		1078
		1079	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1080
		1081	=item $mem = $mem->associated_memobject
		1082
		1083	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1084
		1085	=item $int = $mem->offset
		1086
		1087	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1088
		1089	=for gengetinfo end mem
		1090
		1091	=item ($type, $name) = $mem->gl_object_info
		1092
		1093	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1094	object "name" (e.g. the texture name) used to create this memory object.
		1095
		1096	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1097
		1098	=back
		1099
		1100	=head2 THE OpenCL::Buffer CLASS
		1101
		1102	This is a subclass of OpenCL::Memory, and the superclass of
		1103	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1104	and sub-buffers.
		1105
		1106	=head2 THE OpenCL::BufferObj CLASS
		1107
		1108	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1109	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1110	sub buffers from these sub buffers.
		1111
		1112	=over 4
		1113
		1114	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1115
		1116	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1117	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1118
		1119	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1120
		1121	=back
		1122
		1123	=head2 THE OpenCL::Image CLASS
		1124
		1125	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		1126
		1127	=over 4
		1128
		1129	=item $packed_value = $ev->image_info ($name)
		1130
		1131	See C<< $platform->info >> for details.
		1132
		1133	The reason this method is not called C<info> is that there already is an
		1134	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1135
		1136	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1137
		1138	=for gengetinfo begin image
		1139
		1140	=item $int = $image->element_size
		1141
		1142	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1143
		1144	=item $int = $image->row_pitch
		1145
		1146	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1147
		1148	=item $int = $image->slice_pitch
		1149
		1150	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1151
		1152	=item $int = $image->width
		1153
		1154	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1155
		1156	=item $int = $image->height
		1157
		1158	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1159
		1160	=item $int = $image->depth
		1161
		1162	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1163
		1164	=for gengetinfo end image
		1165
		1166	=for gengetinfo begin gl_texture
		1167
		1168	=item $GLenum = $gl_texture->target
		1169
		1170	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1171
		1172	=item $GLint = $gl_texture->gl_mipmap_level
		1173
		1174	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1175
		1176	=for gengetinfo end gl_texture
		1177
		1178	=back
		1179
		1180	=head2 THE OpenCL::Sampler CLASS
		1181
		1182	=over 4
		1183
		1184	=item $packed_value = $sampler->info ($name)
		1185
		1186	See C<< $platform->info >> for details.
		1187
		1188	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
		1189
		1190	=for gengetinfo begin sampler
		1191
		1192	=item $uint = $sampler->reference_count
		1193
		1194	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1195
		1196	=item $ctx = $sampler->context
		1197
		1198	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1199
		1200	=item $addressing_mode = $sampler->normalized_coords
		1201
		1202	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1203
		1204	=item $filter_mode = $sampler->addressing_mode
		1205
		1206	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1207
		1208	=item $boolean = $sampler->filter_mode
		1209
		1210	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1211
		1212	=for gengetinfo end sampler
		1213
		1214	=back
		1215
		1216	=head2 THE OpenCL::Program CLASS
		1217
		1218	=over 4
		1219
		1220	=item $program->build ($device, $options = "")
		1221
		1222	Tries to build the program with the givne options.
		1223
		1224	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1225
		1226	=item $packed_value = $program->build_info ($device, $name)
		1227
		1228	Similar to C<< $platform->info >>, but returns build info for a previous
		1229	build attempt for the given device.
		1230
		1231	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
		1232
		1233	=item $kernel = $program->kernel ($function_name)
		1234
		1235	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
		1236	the program.
		1237
		1238	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
		1239
		1240	=for gengetinfo begin program_build
		1241
		1242	=item $build_status = $program->build_status ($device)
		1243
		1244	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1245
		1246	=item $string = $program->build_options ($device)
		1247
		1248	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1249
		1250	=item $string = $program->build_log ($device)
		1251
		1252	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1253
		1254	=for gengetinfo end program_build
		1255
		1256	=item $packed_value = $program->info ($name)
		1257
		1258	See C<< $platform->info >> for details.
		1259
		1260	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1261
		1262	=for gengetinfo begin program
		1263
		1264	=item $uint = $program->reference_count
		1265
		1266	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1267
		1268	=item $ctx = $program->context
		1269
		1270	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1271
		1272	=item $uint = $program->num_devices
		1273
		1274	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1275
		1276	=item @devices = $program->devices
		1277
		1278	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1279
		1280	=item $string = $program->source
		1281
		1282	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1283
		1284	=item @ints = $program->binary_sizes
		1285
		1286	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1287
		1288	=for gengetinfo end program
		1289
		1290	=item @blobs = $program->binaries
		1291
		1292	Returns a string for the compiled binary for every device associated with
		1293	the program, empty strings indicate missing programs, and an empty result
		1294	means no program binaries are available.
		1295
		1296	These "binaries" are often, in fact, informative low-level assembly
		1297	sources.
		1298
		1299	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1300
		1301	=back
		1302
		1303	=head2 THE OpenCL::Kernel CLASS
		1304
		1305	=over 4
		1306
		1307	=item $packed_value = $kernel->info ($name)
		1308
		1309	See C<< $platform->info >> for details.
		1310
		1311	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1312
		1313	=for gengetinfo begin kernel
		1314
		1315	=item $string = $kernel->function_name
		1316
		1317	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1318
		1319	=item $uint = $kernel->num_args
		1320
		1321	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1322
		1323	=item $uint = $kernel->reference_count
		1324
		1325	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1326
		1327	=item $ctx = $kernel->context
		1328
		1329	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1330
		1331	=item $program = $kernel->program
		1332
		1333	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1334
		1335	=for gengetinfo end kernel
		1336
		1337	=item $packed_value = $kernel->work_group_info ($device, $name)
		1338
		1339	See C<< $platform->info >> for details.
		1340
		1341	The reason this method is not called C<info> is that there already is an
		1342	C<< ->info >> method.
		1343
		1344	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1345
		1346	=for gengetinfo begin kernel_work_group
		1347
		1348	=item $int = $kernel->work_group_size ($device)
		1349
		1350	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1351
		1352	=item @ints = $kernel->compile_work_group_size ($device)
		1353
		1354	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1355
		1356	=item $ulong = $kernel->local_mem_size ($device)
		1357
		1358	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1359
		1360	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1361
		1362	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1363
		1364	=item $ulong = $kernel->private_mem_size ($device)
		1365
		1366	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1367
		1368	=for gengetinfo end kernel_work_group
		1369
		1370	=item $kernel->set_TYPE ($index, $value)
		1371
		1372	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
		1373
		1374	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
		1375	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
		1376	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
		1377
		1378	Chars and integers (including the half type) are specified as integers,
		1379	float and double as floating point values, memory/buffer/image2d/image3d
		1380	must be an object of that type or C<undef>, local-memory arguments are
		1381	set by specifying the size, and sampler and event must be objects of that
		1382	type.
		1383
		1384	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
		1385
		1386	=back
		1387
		1388	=head2 THE OpenCL::Event CLASS
		1389
		1390	This is the superclass for all event objects (including OpenCL::UserEvent
		1391	objects).
		1392
		1393	=over 4
		1394
		1395	=item $ev->wait
		1396
		1397	Waits for the event to complete.
		1398
		1399	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1400
		1401	=item $packed_value = $ev->info ($name)
		1402
		1403	See C<< $platform->info >> for details.
		1404
		1405	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
		1406
		1407	=for gengetinfo begin event
		1408
		1409	=item $queue = $event->command_queue
		1410
		1411	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1412
		1413	=item $command_type = $event->command_type
		1414
		1415	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1416
		1417	=item $uint = $event->reference_count
		1418
		1419	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1420
		1421	=item $uint = $event->command_execution_status
		1422
		1423	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1424
		1425	=item $ctx = $event->context
		1426
		1427	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1428
		1429	=for gengetinfo end event
		1430
		1431	=item $packed_value = $ev->profiling_info ($name)
		1432
		1433	See C<< $platform->info >> for details.
		1434
		1435	The reason this method is not called C<info> is that there already is an
		1436	C<< ->info >> method.
		1437
		1438	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1439
		1440	=for gengetinfo begin profiling
		1441
		1442	=item $ulong = $event->profiling_command_queued
		1443
		1444	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1445
		1446	=item $ulong = $event->profiling_command_submit
		1447
		1448	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1449
		1450	=item $ulong = $event->profiling_command_start
		1451
		1452	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1453
		1454	=item $ulong = $event->profiling_command_end
		1455
		1456	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1457
		1458	=for gengetinfo end profiling
		1459
		1460	=back
		1461
		1462	=head2 THE OpenCL::UserEvent CLASS
		1463
		1464	This is a subclass of OpenCL::Event.
		1465
		1466	=over 4
		1467
		1468	=item $ev->set_status ($execution_status)
		1469
		1470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
		1471
		1472	=back
		1473
33	=cut	1474	=cut
34		1475
35	package OpenCL;	1476	package OpenCL;
36		1477
		1478	use common::sense;
		1479
37	BEGIN {	1480	BEGIN {
38	$VERSION = '0.01';	1481	our $VERSION = '0.96';
39		1482
40	require XSLoader;	1483	require XSLoader;
41	XSLoader::load (__PACKAGE__, $VERSION);	1484	XSLoader::load (__PACKAGE__, $VERSION);
		1485
		1486	@OpenCL::Buffer::ISA =
		1487	@OpenCL::Image::ISA = OpenCL::Memory::;
		1488
		1489	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1490
		1491	@OpenCL::Image2D::ISA =
		1492	@OpenCL::Image3D::ISA = OpenCL::Image::;
		1493
		1494	@OpenCL::UserEvent::ISA = OpenCL::Event::;
42	}	1495	}
43		1496
44	1;	1497	1;
45
46	=back
47		1498
48	=head1 AUTHOR	1499	=head1 AUTHOR
49		1500
50	Marc Lehmann <schmorp@schmorp.de>	1501	Marc Lehmann <schmorp@schmorp.de>
51	http://home.schmorp.de/	1502	http://home.schmorp.de/

Diff Legend

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