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

Diff Legend

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