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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.7 by root, Wed Nov 16 00:44:41 2011 UTC vs.
Revision 1.32 by root, Thu Apr 19 12:12:03 2012 UTC

…		…
8		8
9	=head1 DESCRIPTION	9	=head1 DESCRIPTION
10		10
11	This is an early release which might be useful, but hasn't seen much testing.	11	This is an early release which might be useful, but hasn't seen much testing.
12		12
		13	=head2 OpenCL FROM 10000 FEET HEIGHT
		14
		15	Here is a high level overview of OpenCL:
		16
		17	First you need to find one or more OpenCL::Platforms (kind of like
		18	vendors) - usually there is only one.
		19
		20	Each platform gives you access to a number of OpenCL::Device objects, e.g.
		21	your graphics card.
		22
		23	From a platform and some device(s), you create an OpenCL::Context, which is
		24	a very central object in OpenCL: Once you have a context you can create
		25	most other objects:
		26
		27	OpenCL::Program objects, which store source code and, after building for a
		28	specific device ("compiling and linking"), also binary programs. For each
		29	kernel function in a program you can then create an OpenCL::Kernel object
		30	which represents basically a function call with argument values.
		31
		32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
		33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
		34	or 3d array) for bulk data and input and output for kernels.
		35
		36	OpenCL::Sampler objects, which are kind of like texture filter modes in
		37	OpenGL.
		38
		39	OpenCL::Queue objects - command queues, which allow you to submit memory
		40	reads, writes and copies, as well as kernel calls to your devices. They
		41	also offer a variety of methods to synchronise request execution, for
		42	example with barriers or OpenCL::Event objects.
		43
		44	OpenCL::Event objects are used to signal when something is complete.
		45
13	=head1 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
14		47
15	The OpenCL spec used to develop this module (1.2 spec was available, but	48	The OpenCL spec used to develop this module (1.2 spec was available, but
16	no implementation was available to me :).	49	no implementation was available to me :).
17		50
18	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
19		52
20	OpenCL manpages:	53	OpenCL manpages:
21		54
22	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
23		56
		57	If you are into UML class diagrams, the following diagram might help - if
		58	not, it will be mildly cobfusing:
		59
		60	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html
		61
		62	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
		63	is, but at least it's free of charge:
		64
		65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
		66
		67	And here's NVIDIA's OpenCL Best Practises Guide:
		68
		69	http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
		70
		71	=head1 BASIC WORKFLOW
		72
		73	To get something done, you basically have to do this once (refer to the
		74	examples below for actual code, this is just a high-level description):
		75
		76	Find some platform (e.g. the first one) and some device(s) (e.g. the first
		77	device of the platform), and create a context from those.
		78
		79	Create program objects from your OpenCL source code, then build (compile)
		80	the programs for each device you want to run them on.
		81
		82	Create kernel objects for all kernels you want to use (surprisingly, these
		83	are not device-specific).
		84
		85	Then, to execute stuff, you repeat these steps, possibly resuing or
		86	sharing some buffers:
		87
		88	Create some input and output buffers from your context. Set these as
		89	arguments to your kernel.
		90
		91	Enqueue buffer writes to initialise your input buffers (when not
		92	initialised at creation time).
		93
		94	Enqueue the kernel execution.
		95
		96	Enqueue buffer reads for your output buffer to read results.
		97
24	=head1 EXAMPLES	98	=head1 EXAMPLES
25		99
26	=head2 Enumerate all devices and get contexts for them.	100	=head2 Enumerate all devices and get contexts for them.
27		101
		102	Best run this once to get a feel for the platforms and devices in your
		103	system.
		104
28	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
29	warn $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
30	warn $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
31	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
32	warn $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
33	my $ctx = $device->context_simple;	110	my $ctx = $platform->context (undef, [$device]);
34	# do stuff	111	# do stuff
35	}	112	}
36	}	113	}
37		114
38	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
39		116
40	my $dev = ((OpenCL::platforms)[0]->devices)[0];	117	This is a useful boilerplate for any OpenCL program that only wants to use
41	my $ctx = $dev->context_simple;	118	one device,
42	my $queue = $ctx->command_queue_simple ($dev);	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
43		124
44	=head2 Print all supported image formats of a context.	125	=head2 Print all supported image formats of a context.
45		126
		127	Best run this once for your context, to see whats available and how to
		128	gather information.
		129
46	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {	130	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
47	say "supported image formats for ", OpenCL::enum2str $type;	131	print "supported image formats for ", OpenCL::enum2str $type, "\n";
48		132
49	for my $f ($ctx->supported_image_formats (0, $type)) {	133	for my $f ($ctx->supported_image_formats (0, $type)) {
50	printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];	134	printf " %-10s %-20s\n", OpenCL::enum2str $f->[0], OpenCL::enum2str $f->[1];
51	}	135	}
52	}	136	}
…		…
55	then asynchronously.	139	then asynchronously.
56		140
57	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
58		142
59	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);
60	warn $data;	144	print "$data\n";
61		145
62	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	146	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);
63	$ev->wait;	147	$ev->wait;
64	warn $data;	148	print "$data\n"; # prints "elm"
65		149
66	=head2 Create and build a program, then create a kernel out of one of its	150	=head2 Create and build a program, then create a kernel out of one of its
67	functions.	151	functions.
68		152
69	my $src = '	153	my $src = '
70	__kernel void	154	kernel void
71	squareit (__global float input, __global float output)	155	squareit (global float input, global float output)
72	{	156	{
73	size_t id = get_global_id (0);	157	$id = get_global_id (0);
74	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
75	}	159	}
76	';	160	';
77		161
78	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->program_with_source ($src);
79		163
		164	# build croaks on compile errors, so catch it and print the compile errors
80	eval { $prog->build ($dev); 1 }	165	eval { $prog->build ($dev); 1 }
81	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);	166	or die $prog->build_log;
82		167
83	my $kernel = $prog->kernel ("squareit");	168	my $kernel = $prog->kernel ("squareit");
84		169
85	=head2 Create some input and output float buffers, then call squareit on them.	170	=head2 Create some input and output float buffers, then call the
		171	'squareit' kernel on them.
86		172
87	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);	173	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);
88	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);	174	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
89		175
90	# set buffer	176	# set buffer
…		…
96		182
97	# enqueue a synchronous read	183	# enqueue a synchronous read
98	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	184	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
99		185
100	# print the results:	186	# print the results:
101	say join ", ", unpack "f*", $data;	187	printf "%s\n", join ", ", unpack "f*", $data;
102		188
103	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	189	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
104	showing off barriers.	190	showing off barriers.
105		191
106	# execute it for all 4 numbers	192	# execute it for all 4 numbers
…		…
129		215
130	=head1 DOCUMENTATION	216	=head1 DOCUMENTATION
131		217
132	=head2 BASIC CONVENTIONS	218	=head2 BASIC CONVENTIONS
133		219
134	This is not a 1:1 C-style translation of OpenCL to Perl - instead I	220	This is not a one-to-one C-style translation of OpenCL to Perl - instead
135	attempted to make the interface as type-safe as possible and introducing	221	I attempted to make the interface as type-safe as possible by introducing
136	object syntax where it makes sense. There are a number of important	222	object syntax where it makes sense. There are a number of important
137	differences between the OpenCL C API and this module:	223	differences between the OpenCL C API and this module:
138		224
139	=over 4	225	=over 4
140		226
141	=item * Object lifetime managament is automatic - there is no need	227	=item * Object lifetime managament is automatic - there is no need
142	to free objects explicitly (C<clReleaseXXX>), the release function	228	to free objects explicitly (C<clReleaseXXX>), the release function
143	is called automatically once all Perl references to it go away.	229	is called automatically once all Perl references to it go away.
144		230
145	=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>),	231	=item * OpenCL uses CamelCase for function names
		232	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
146	while this module uses underscores as word separator and often leaves out	233	uses underscores as word separator and often leaves out prefixes
147	prefixes (C<< $platform->info >>).	234	(C<OpenCL::platforms>, C<< $platform->info >>).
148		235
149	=item * OpenCL often specifies fixed vector function arguments as short	236	=item * OpenCL often specifies fixed vector function arguments as short
150	arrays (C<size_t origin[3]>), while this module explicitly expects the	237	arrays (C<size_t origin[3]>), while this module explicitly expects the
151	components as separate arguments-	238	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		239	function calls.
152		240
153	=item * Where possible, the row_pitch value is calculated from the perl	241	=item * Structures are often specified by flattening out their components
154	scalar length and need not be specified.	242	as with short vectors, and returned as arrayrefs.
155		243
156	=item * When enqueuing commands, the wait list is specified by adding	244	=item * When enqueuing commands, the wait list is specified by adding
157	extra arguments to the function - everywhere a C<$wait_events...> argument	245	extra arguments to the function - anywhere a C<$wait_events...> argument
158	is documented this can be any number of event objects.	246	is documented this can be any number of event objects.
159		247
160	=item * When enqueuing commands, if the enqueue method is called in void	248	=item * When enqueuing commands, if the enqueue method is called in void
161	context, no event is created. In all other contexts an event is returned	249	context, no event is created. In all other contexts an event is returned
162	by the method.	250	by the method.
…		…
167		255
168	=back	256	=back
169		257
170	=head2 PERL AND OPENCL TYPES	258	=head2 PERL AND OPENCL TYPES
171		259
172	This handy(?) table lists OpenCL types and their perl and pack/unpack	260	This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
173	format equivalents:	261	format equivalents:
174		262
175	OpenCL perl pack/unpack	263	OpenCL perl PDL pack/unpack
176	char IV c	264	char IV - c
177	uchar IV C	265	uchar IV byte C
178	short IV s	266	short IV short s
179	ushort IV S	267	ushort IV ushort S
180	int IV l	268	int IV long? l
181	uint IV L	269	uint IV - L
182	long IV q	270	long IV longlong q
183	ulong IV Q	271	ulong IV - Q
184	float NV f	272	float NV float f
185	half IV S	273	half IV ushort S
186	double NV d	274	double NV double d
		275
		276	=head2 OpenGL sharing
		277
		278	This module can be optionally compiled with support for
		279	OpenGL sharing. The sharing functions are only available when
		280	C<OpenCL::HAVE_OPENGL> returns true, otherwise they are absent and cannot
		281	be called.
187		282
188	=head2 THE OpenCL PACKAGE	283	=head2 THE OpenCL PACKAGE
189		284
190	=over 4	285	=over 4
191		286
192	=item $int = OpenCL::errno	287	=item $int = OpenCL::errno
193		288
194	The last error returned by a function - it's only changed on errors.	289	The last error returned by a function - it's only valid after an error occured
		290	and before calling another OpenCL function.
195		291
196	=item $str = OpenCL::err2str $errval	292	=item $str = OpenCL::err2str $errval
197		293
198	Comverts an error value into a human readable string.	294	Comverts an error value into a human readable string.
199		295
200	=item $str = OpenCL::err2str $enum	296	=item $str = OpenCL::enum2str $enum
201		297
202	Converts most enum values (inof parameter names, image format constants,	298	Converts most enum values (of parameter names, image format constants,
203	object types, addressing and filter modes, command types etc.) into a	299	object types, addressing and filter modes, command types etc.) into a
204	human readbale string. When confronted with some random integer it can be	300	human readable string. When confronted with some random integer it can be
205	very helpful to pass it through this function to maybe get some readable	301	very helpful to pass it through this function to maybe get some readable
206	string out of it.	302	string out of it.
207		303
208	=item @platforms = OpenCL::platforms	304	=item @platforms = OpenCL::platforms
209		305
210	Returns all available OpenCL::Platform objects.	306	Returns all available OpenCL::Platform objects.
211		307
212	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	308	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
213		309
214	=item $ctx = OpenCL::context_from_type_simple $type = OpenCL::DEVICE_TYPE_DEFAULT	310	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef
215		311
216	Tries to create a context from a default device and platform - never worked for me.	312	Tries to create a context from a default device and platform - never worked for me.
217		313
218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	314	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
219		315
…		…
227		323
228	=head2 THE OpenCL::Platform CLASS	324	=head2 THE OpenCL::Platform CLASS
229		325
230	=over 4	326	=over 4
231		327
		328	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
		329
		330	Returns a list of matching OpenCL::Device objects.
		331
		332	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
		333
		334	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
		335
		336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		337
		338	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
		339
		340	Create a new OpenCL::Context object using the given device object(s)- a
		341	CL_CONTEXT_PLATFORM property is supplied automatically.
		342
		343	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		344
232	=item $packed_value = $platform->info ($name)	345	=item $packed_value = $platform->info ($name)
233		346
234	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	347	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
235	strings, this will be the string, for other values you probably need to	348	strings, this will be the string (possibly including terminating \0), for
236	use the correct C<unpack>. This might get improved in the future. Hopefully.	349	other values you probably need to use the correct C<unpack>.
		350
		351	It's best to avoid this method and use one of the following convenience
		352	wrappers.
237		353
238	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	354	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
239		355
240	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	356	=for gengetinfo begin platform
241		357
242	Returns a list of matching OpenCL::Device objects.	358	=item $string = $platform->profile
243		359
244	=item $ctx = $platform->context_from_type_simple ($type = OpenCL::DEVICE_TYPE_DEFAULT)	360	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
245		361
246	Tries to create a context. Never worked for me.	362	=item $string = $platform->version
247		363
248	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	364	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
		365
		366	=item $string = $platform->name
		367
		368	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
		369
		370	=item $string = $platform->vendor
		371
		372	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
		373
		374	=item $string = $platform->extensions
		375
		376	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		377
		378	=for gengetinfo end platform
249		379
250	=back	380	=back
251		381
252	=head2 THE OpenCL::Device CLASS	382	=head2 THE OpenCL::Device CLASS
253		383
…		…
257		387
258	See C<< $platform->info >> for details.	388	See C<< $platform->info >> for details.
259		389
260	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	390	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
261		391
		392	=for gengetinfo begin device
		393
		394	=item $device_type = $device->type
		395
		396	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		397
		398	=item $uint = $device->vendor_id
		399
		400	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		401
		402	=item $uint = $device->max_compute_units
		403
		404	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		405
		406	=item $uint = $device->max_work_item_dimensions
		407
		408	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		409
		410	=item $int = $device->max_work_group_size
		411
		412	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		413
		414	=item @ints = $device->max_work_item_sizes
		415
		416	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		417
		418	=item $uint = $device->preferred_vector_width_char
		419
		420	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		421
		422	=item $uint = $device->preferred_vector_width_short
		423
		424	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		425
		426	=item $uint = $device->preferred_vector_width_int
		427
		428	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		429
		430	=item $uint = $device->preferred_vector_width_long
		431
		432	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		433
		434	=item $uint = $device->preferred_vector_width_float
		435
		436	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		437
		438	=item $uint = $device->preferred_vector_width_double
		439
		440	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		441
		442	=item $uint = $device->max_clock_frequency
		443
		444	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		445
		446	=item $bitfield = $device->address_bits
		447
		448	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		449
		450	=item $uint = $device->max_read_image_args
		451
		452	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		453
		454	=item $uint = $device->max_write_image_args
		455
		456	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		457
		458	=item $ulong = $device->max_mem_alloc_size
		459
		460	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		461
		462	=item $int = $device->image2d_max_width
		463
		464	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		465
		466	=item $int = $device->image2d_max_height
		467
		468	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		469
		470	=item $int = $device->image3d_max_width
		471
		472	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		473
		474	=item $int = $device->image3d_max_height
		475
		476	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		477
		478	=item $int = $device->image3d_max_depth
		479
		480	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		481
		482	=item $uint = $device->image_support
		483
		484	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		485
		486	=item $int = $device->max_parameter_size
		487
		488	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		489
262	=item $ctx = $device->context_simple	490	=item $uint = $device->max_samplers
263		491
264	Convenience function to create a new OpenCL::Context object.	492	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
265		493
266	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	494	=item $uint = $device->mem_base_addr_align
		495
		496	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		497
		498	=item $uint = $device->min_data_type_align_size
		499
		500	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		501
		502	=item $device_fp_config = $device->single_fp_config
		503
		504	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		505
		506	=item $device_mem_cache_type = $device->global_mem_cache_type
		507
		508	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		509
		510	=item $uint = $device->global_mem_cacheline_size
		511
		512	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		513
		514	=item $ulong = $device->global_mem_cache_size
		515
		516	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		517
		518	=item $ulong = $device->global_mem_size
		519
		520	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		521
		522	=item $ulong = $device->max_constant_buffer_size
		523
		524	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		525
		526	=item $uint = $device->max_constant_args
		527
		528	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		529
		530	=item $device_local_mem_type = $device->local_mem_type
		531
		532	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		533
		534	=item $ulong = $device->local_mem_size
		535
		536	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		537
		538	=item $boolean = $device->error_correction_support
		539
		540	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		541
		542	=item $int = $device->profiling_timer_resolution
		543
		544	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		545
		546	=item $boolean = $device->endian_little
		547
		548	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		549
		550	=item $boolean = $device->available
		551
		552	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		553
		554	=item $boolean = $device->compiler_available
		555
		556	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		557
		558	=item $device_exec_capabilities = $device->execution_capabilities
		559
		560	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		561
		562	=item $command_queue_properties = $device->properties
		563
		564	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		565
		566	=item $ = $device->platform
		567
		568	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		569
		570	=item $string = $device->name
		571
		572	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		573
		574	=item $string = $device->vendor
		575
		576	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		577
		578	=item $string = $device->driver_version
		579
		580	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		581
		582	=item $string = $device->profile
		583
		584	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		585
		586	=item $string = $device->version
		587
		588	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		589
		590	=item $string = $device->extensions
		591
		592	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		593
		594	=item $uint = $device->preferred_vector_width_half
		595
		596	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		597
		598	=item $uint = $device->native_vector_width_char
		599
		600	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		601
		602	=item $uint = $device->native_vector_width_short
		603
		604	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		605
		606	=item $uint = $device->native_vector_width_int
		607
		608	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		609
		610	=item $uint = $device->native_vector_width_long
		611
		612	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		613
		614	=item $uint = $device->native_vector_width_float
		615
		616	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		617
		618	=item $uint = $device->native_vector_width_double
		619
		620	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		621
		622	=item $uint = $device->native_vector_width_half
		623
		624	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		625
		626	=item $device_fp_config = $device->double_fp_config
		627
		628	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		629
		630	=item $device_fp_config = $device->half_fp_config
		631
		632	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		633
		634	=item $boolean = $device->host_unified_memory
		635
		636	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		637
		638	=item $device = $device->parent_device_ext
		639
		640	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		641
		642	=item @device_partition_property_exts = $device->partition_types_ext
		643
		644	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		645
		646	=item @device_partition_property_exts = $device->affinity_domains_ext
		647
		648	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		649
		650	=item $uint = $device->reference_count_ext
		651
		652	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
		653
		654	=item @device_partition_property_exts = $device->partition_style_ext
		655
		656	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		657
		658	=for gengetinfo end device
267		659
268	=back	660	=back
269		661
270	=head2 THE OpenCL::Context CLASS	662	=head2 THE OpenCL::Context CLASS
271		663
272	=over 4	664	=over 4
273		665
274	=item $packed_value = $ctx->info ($name)	666	=item $queue = $ctx->queue ($device, $properties)
275		667
276	See C<< $platform->info >> for details.
277
278	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
279
280	=item $queue = $ctx->command_queue_simple ($device)
281
282	Convenience function to create a new OpenCL::Queue object from the context and the given device.	668	Create a new OpenCL::Queue object from the context and the given device.
283		669
284	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	670	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
285		671
286	=item $ev = $ctx->user_event	672	=item $ev = $ctx->user_event
287		673
…		…
289		675
290	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	676	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
291		677
292	=item $buf = $ctx->buffer ($flags, $len)	678	=item $buf = $ctx->buffer ($flags, $len)
293		679
294	Creates a new OpenCL::Buffer object with the given flags and octet-size.	680	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		681	given flags and octet-size.
295		682
296	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	683	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
297		684
298	=item $buf = $ctx->buffer_sv ($flags, $data)	685	=item $buf = $ctx->buffer_sv ($flags, $data)
299		686
300	Creates a new OpenCL::Buffer object and initialise it with the given data values.	687	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		688	initialise it with the given data values.
301		689
302	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	690	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
303		691
304	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	692	Creates a new OpenCL::Image2D object and optionally initialises it with
		693	the given data values.
305		694
306	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	695	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
307		696
308	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	697	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
309		698
310	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	699	Creates a new OpenCL::Image3D object and optionally initialises it with
		700	the given data values.
311		701
312	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	702	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
313		703
314	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	704	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
315		705
…		…
327	=item $program = $ctx->program_with_source ($string)	717	=item $program = $ctx->program_with_source ($string)
328		718
329	Creates a new OpenCL::Program object from the given source code.	719	Creates a new OpenCL::Program object from the given source code.
330		720
331	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	721	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		722
		723	=item $packed_value = $ctx->info ($name)
		724
		725	See C<< $platform->info >> for details.
		726
		727	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		728
		729	=for gengetinfo begin context
		730
		731	=item $uint = $context->reference_count
		732
		733	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		734
		735	=item @devices = $context->devices
		736
		737	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		738
		739	=item @property_ints = $context->properties
		740
		741	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		742
		743	=item $uint = $context->num_devices
		744
		745	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		746
		747	=for gengetinfo end context
332		748
333	=back	749	=back
334		750
335	=head2 THE OpenCL::Queue CLASS	751	=head2 THE OpenCL::Queue CLASS
336		752
…		…
350	cases (i.e. you use only one queue) it's not necessary to wait for or	766	cases (i.e. you use only one queue) it's not necessary to wait for or
351	create event objects.	767	create event objects.
352		768
353	=over 4	769	=over 4
354		770
355	=item $packed_value = $ctx->info ($name)
356
357	See C<< $platform->info >> for details.
358
359	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
360
361	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	771	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
362		772
363	Reads data from buffer into the given string.	773	Reads data from buffer into the given string.
364		774
365	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	775	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
372		782
373	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	783	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
374		784
375	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	785	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
376		786
		787	=item $ev = $queue->enqueue_read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
		788
		789	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		790
		791	=item $ev = $queue->enqueue_write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
		792
		793	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		794
377	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	795	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
378		796
		797	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		798
		799	=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		800
379	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	801	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
380		802
381	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	803	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
382		804
383	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	805	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
384		806
		807	=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		808
		809	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		810
		811	=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
		812
		813	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		814
385	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, 4dst_row_pitch, $dst_slice_pitch, $ait_event...)	815	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
386		816
387	Yeah.	817	Yeah.
388		818
389	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
390
391	=item $ev = $queue->enqueue_copy_buffer_to_image (OpenCL::Buffer src, OpenCL::Image dst, size_t src_offset, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
392
393	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	819	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
394
395	=item $ev = $queue->enqueue_copy_image (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
396
397	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
398
399	=item $ev = $queue->enqueue_copy_image_to_buffer (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t width, size_t height, size_t depth, size_t dst_offset, ...)
400
401	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
402		820
403	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	821	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
404		822
405	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	823	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
406		824
…		…
440		858
441	=item $queue->finish	859	=item $queue->finish
442		860
443	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	861	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
444		862
		863	=item $packed_value = $queue->info ($name)
		864
		865	See C<< $platform->info >> for details.
		866
		867	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		868
		869	=for gengetinfo begin command_queue
		870
		871	=item $ctx = $command_queue->context
		872
		873	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		874
		875	=item $device = $command_queue->device
		876
		877	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		878
		879	=item $uint = $command_queue->reference_count
		880
		881	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		882
		883	=item $command_queue_properties = $command_queue->properties
		884
		885	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		886
		887	=for gengetinfo end command_queue
		888
445	=back	889	=back
446		890
447	=head2 THE OpenCL::Memory CLASS	891	=head2 THE OpenCL::Memory CLASS
448		892
449	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	893	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
450	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	894	OpenCL::Image2D and OpenCL::Image3D.
451	currently only exist to allow type-checking.
452		895
453	=over 4	896	=over 4
454		897
455	=item $packed_value = $memory->info ($name)	898	=item $packed_value = $memory->info ($name)
456		899
457	See C<< $platform->info >> for details.	900	See C<< $platform->info >> for details.
458		901
459	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	902	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
460		903
		904	=for gengetinfo begin mem
		905
		906	=item $mem_object_type = $mem->type
		907
		908	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		909
		910	=item $mem_flags = $mem->flags
		911
		912	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		913
		914	=item $int = $mem->size
		915
		916	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		917
		918	=item $ptr_value = $mem->host_ptr
		919
		920	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		921
		922	=item $uint = $mem->map_count
		923
		924	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		925
		926	=item $uint = $mem->reference_count
		927
		928	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		929
		930	=item $ctx = $mem->context
		931
		932	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		933
		934	=item $mem = $mem->associated_memobject
		935
		936	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		937
		938	=item $int = $mem->offset
		939
		940	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		941
		942	=for gengetinfo end mem
		943
461	=back	944	=back
462		945
		946	=head2 THE OpenCL::Buffer CLASS
		947
		948	This is a subclass of OpenCL::Memory, and the superclass of
		949	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		950	and sub-buffers.
		951
		952	=head2 THE OpenCL::BufferObj CLASS
		953
		954	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		955	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		956	sub buffers from these sub buffers.
		957
		958	=over 4
		959
		960	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		961
		962	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		963	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		964
		965	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		966
		967	=back
		968
		969	=head2 THE OpenCL::Image CLASS
		970
		971	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		972
		973	=over 4
		974
		975	=item $packed_value = $ev->image_info ($name)
		976
		977	See C<< $platform->info >> for details.
		978
		979	The reason this method is not called C<info> is that there already is an
		980	C<< ->info >> method inherited from C<OpenCL::Memory>.
		981
		982	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		983
		984	=for gengetinfo begin image
		985
		986	=item $int = $image->element_size
		987
		988	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		989
		990	=item $int = $image->row_pitch
		991
		992	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		993
		994	=item $int = $image->slice_pitch
		995
		996	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		997
		998	=item $int = $image->width
		999
		1000	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1001
		1002	=item $int = $image->height
		1003
		1004	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1005
		1006	=item $int = $image->depth
		1007
		1008	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1009
		1010	=for gengetinfo end image
		1011
		1012	=back
		1013
463	=head2 THE OpenCL::Sampler CLASS	1014	=head2 THE OpenCL::Sampler CLASS
464		1015
465	=over 4	1016	=over 4
466		1017
467	=item $packed_value = $sampler->info ($name)	1018	=item $packed_value = $sampler->info ($name)
468		1019
469	See C<< $platform->info >> for details.	1020	See C<< $platform->info >> for details.
470		1021
471	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1022	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
472		1023
		1024	=for gengetinfo begin sampler
		1025
		1026	=item $uint = $sampler->reference_count
		1027
		1028	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1029
		1030	=item $ctx = $sampler->context
		1031
		1032	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1033
		1034	=item $addressing_mode = $sampler->normalized_coords
		1035
		1036	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1037
		1038	=item $filter_mode = $sampler->addressing_mode
		1039
		1040	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1041
		1042	=item $boolean = $sampler->filter_mode
		1043
		1044	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1045
		1046	=for gengetinfo end sampler
		1047
473	=back	1048	=back
474		1049
475	=head2 THE OpenCL::Program CLASS	1050	=head2 THE OpenCL::Program CLASS
476		1051
477	=over 4	1052	=over 4
478
479	=item $packed_value = $program->info ($name)
480
481	See C<< $platform->info >> for details.
482
483	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
484		1053
485	=item $program->build ($device, $options = "")	1054	=item $program->build ($device, $options = "")
486		1055
487	Tries to build the program with the givne options.	1056	Tries to build the program with the givne options.
488		1057
…		…
500	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1069	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
501	the program.	1070	the program.
502		1071
503	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1072	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
504		1073
		1074	=for gengetinfo begin program_build
		1075
		1076	=item $build_status = $program->build_status ($device)
		1077
		1078	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1079
		1080	=item $string = $program->build_options ($device)
		1081
		1082	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1083
		1084	=item $string = $program->build_log ($device)
		1085
		1086	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1087
		1088	=for gengetinfo end program_build
		1089
		1090	=item $packed_value = $program->info ($name)
		1091
		1092	See C<< $platform->info >> for details.
		1093
		1094	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1095
		1096	=for gengetinfo begin program
		1097
		1098	=item $uint = $program->reference_count
		1099
		1100	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1101
		1102	=item $ctx = $program->context
		1103
		1104	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1105
		1106	=item $uint = $program->num_devices
		1107
		1108	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1109
		1110	=item @devices = $program->devices
		1111
		1112	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1113
		1114	=item $string = $program->source
		1115
		1116	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1117
		1118	=item @ints = $program->binary_sizes
		1119
		1120	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1121
		1122	=for gengetinfo end program
		1123
		1124	=item @blobs = $program->binaries
		1125
		1126	Returns a string for the compiled binary for every device associated with
		1127	the program, empty strings indicate missing programs, and an empty result
		1128	means no program binaries are available.
		1129
		1130	These "binaries" are often, in fact, informative low-level assembly
		1131	sources.
		1132
		1133	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1134
505	=back	1135	=back
506		1136
507	=head2 THE OpenCL::Kernel CLASS	1137	=head2 THE OpenCL::Kernel CLASS
508		1138
509	=over 4	1139	=over 4
…		…
511	=item $packed_value = $kernel->info ($name)	1141	=item $packed_value = $kernel->info ($name)
512		1142
513	See C<< $platform->info >> for details.	1143	See C<< $platform->info >> for details.
514		1144
515	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1145	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1146
		1147	=for gengetinfo begin kernel
		1148
		1149	=item $string = $kernel->function_name
		1150
		1151	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1152
		1153	=item $uint = $kernel->num_args
		1154
		1155	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1156
		1157	=item $uint = $kernel->reference_count
		1158
		1159	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1160
		1161	=item $ctx = $kernel->context
		1162
		1163	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1164
		1165	=item $program = $kernel->program
		1166
		1167	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1168
		1169	=for gengetinfo end kernel
		1170
		1171	=item $packed_value = $kernel->work_group_info ($device, $name)
		1172
		1173	See C<< $platform->info >> for details.
		1174
		1175	The reason this method is not called C<info> is that there already is an
		1176	C<< ->info >> method.
		1177
		1178	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1179
		1180	=for gengetinfo begin kernel_work_group
		1181
		1182	=item $int = $kernel->work_group_size ($device)
		1183
		1184	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1185
		1186	=item @ints = $kernel->compile_work_group_size ($device)
		1187
		1188	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1189
		1190	=item $ulong = $kernel->local_mem_size ($device)
		1191
		1192	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1193
		1194	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1195
		1196	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1197
		1198	=item $ulong = $kernel->private_mem_size ($device)
		1199
		1200	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1201
		1202	=for gengetinfo end kernel_work_group
516		1203
517	=item $kernel->set_TYPE ($index, $value)	1204	=item $kernel->set_TYPE ($index, $value)
518		1205
519	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1206	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
520		1207
…		…
536	This is the superclass for all event objects (including OpenCL::UserEvent	1223	This is the superclass for all event objects (including OpenCL::UserEvent
537	objects).	1224	objects).
538		1225
539	=over 4	1226	=over 4
540		1227
		1228	=item $ev->wait
		1229
		1230	Waits for the event to complete.
		1231
		1232	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1233
541	=item $packed_value = $ev->info ($name)	1234	=item $packed_value = $ev->info ($name)
542		1235
543	See C<< $platform->info >> for details.	1236	See C<< $platform->info >> for details.
544		1237
545	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1238	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
546		1239
547	=item $ev->wait	1240	=for gengetinfo begin event
548		1241
549	Waits for the event to complete.	1242	=item $queue = $event->command_queue
550		1243
		1244	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1245
		1246	=item $command_type = $event->command_type
		1247
		1248	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1249
		1250	=item $uint = $event->reference_count
		1251
		1252	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1253
		1254	=item $uint = $event->command_execution_status
		1255
		1256	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1257
		1258	=item $ctx = $event->context
		1259
		1260	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1261
		1262	=for gengetinfo end event
		1263
		1264	=item $packed_value = $ev->profiling_info ($name)
		1265
		1266	See C<< $platform->info >> for details.
		1267
		1268	The reason this method is not called C<info> is that there already is an
		1269	C<< ->info >> method.
		1270
551	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1271	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1272
		1273	=for gengetinfo begin profiling
		1274
		1275	=item $ulong = $event->profiling_command_queued
		1276
		1277	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1278
		1279	=item $ulong = $event->profiling_command_submit
		1280
		1281	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1282
		1283	=item $ulong = $event->profiling_command_start
		1284
		1285	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1286
		1287	=item $ulong = $event->profiling_command_end
		1288
		1289	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1290
		1291	=for gengetinfo end profiling
552		1292
553	=back	1293	=back
554		1294
555	=head2 THE OpenCL::UserEvent CLASS	1295	=head2 THE OpenCL::UserEvent CLASS
556		1296
…		…
569	package OpenCL;	1309	package OpenCL;
570		1310
571	use common::sense;	1311	use common::sense;
572		1312
573	BEGIN {	1313	BEGIN {
574	our $VERSION = '0.03';	1314	our $VERSION = '0.92';
575		1315
576	require XSLoader;	1316	require XSLoader;
577	XSLoader::load (__PACKAGE__, $VERSION);	1317	XSLoader::load (__PACKAGE__, $VERSION);
578		1318
579	@OpenCL::Buffer::ISA =	1319	@OpenCL::Buffer::ISA =
580	@OpenCL::Image::ISA = OpenCL::Memory::;	1320	@OpenCL::Image::ISA = OpenCL::Memory::;
581		1321
		1322	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1323
582	@OpenCL::Image2D::ISA =	1324	@OpenCL::Image2D::ISA =
583	@OpenCL::Image3D::ISA = OpenCL::Image::;	1325	@OpenCL::Image3D::ISA = OpenCL::Image::;
584		1326
585	@OpenCL::UserEvent::ISA = OpenCL::Event::;	1327	@OpenCL::UserEvent::ISA = OpenCL::Event::;
586	}	1328	}
587		1329
588	1;	1330	1;
589		1331
590	=head1 AUTHOR	1332	=head1 AUTHOR

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.7 by root, Wed Nov 16 00:44:41 2011 UTC vs. Revision 1.32 by root, Thu Apr 19 12:12:03 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.7 by root, Wed Nov 16 00:44:41 2011 UTC vs.
Revision 1.32 by root, Thu Apr 19 12:12:03 2012 UTC