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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.5 by root, Wed Nov 16 00:35:30 2011 UTC vs.
Revision 1.21 by root, Sun Nov 20 10:21:27 2011 UTC

…		…
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 might be useful, but hasn't seen any 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->info (OpenCL::PLATFORM_NAME);
30	warn $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->info (OpenCL::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->info (OpenCL::DEVICE_NAME);
33	my $ctx = $device->context_simple;	110	my $ctx = $device->context;
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_info ($dev, OpenCL::PROGRAM_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.
…		…
165	other status is returned the function will throw an exception, so you	253	other status is returned the function will throw an exception, so you
166	don't normally have to to any error checking.	254	don't normally have to to any error checking.
167		255
168	=back	256	=back
169		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
170	=head2 THE OpenCL PACKAGE	276	=head2 THE OpenCL PACKAGE
171		277
172	=over 4	278	=over 4
173		279
174	=item $int = OpenCL::errno	280	=item $int = OpenCL::errno
175		281
176	The last error returned by a function - it's only changed on errors.	282	The last error returned by a function - it's only valid after an error occured
		283	and before calling another OpenCL function.
177		284
178	=item $str = OpenCL::err2str $errval	285	=item $str = OpenCL::err2str $errval
179		286
180	Comverts an error value into a human readable string.	287	Comverts an error value into a human readable string.
181		288
182	=item $str = OpenCL::err2str $enum	289	=item $str = OpenCL::enum2str $enum
183		290
184	Converts most enum values (inof parameter names, image format constants,	291	Converts most enum values (inof parameter names, image format constants,
185	object types, addressing and filter modes, command types etc.) into a	292	object types, addressing and filter modes, command types etc.) into a
186	human readbale string. When confronted with some random integer it can be	293	human readbale string. When confronted with some random integer it can be
187	very helpful to pass it through this function to maybe get some readable	294	very helpful to pass it through this function to maybe get some readable
…		…
191		298
192	Returns all available OpenCL::Platform objects.	299	Returns all available OpenCL::Platform objects.
193		300
194	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	301	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
195		302
196	=item $ctx = OpenCL::context_from_type_simple $type = OpenCL::DEVICE_TYPE_DEFAULT	303	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef
197		304
198	Tries to create a context from a default device and platform - never worked for me.	305	Tries to create a context from a default device and platform - never worked for me.
199		306
200	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	307	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
201		308
…		…
208	=back	315	=back
209		316
210	=head2 THE OpenCL::Platform CLASS	317	=head2 THE OpenCL::Platform CLASS
211		318
212	=over 4	319	=over 4
		320
		321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
		322
		323	Returns a list of matching OpenCL::Device objects.
		324
		325	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
		326
		327	Tries to create a context. Never worked for me, and you need devices explitly anyway.
		328
		329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		330
		331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)
		332
		333	Create a new OpenCL::Context object using the given device object(s)- a
		334	CL_CONTEXT_PLATFORM property is supplied automatically.
		335
		336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
213		337
214	=item $packed_value = $platform->info ($name)	338	=item $packed_value = $platform->info ($name)
215		339
216	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	340	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
217	strings, this will be the string, for other values you probably need to	341	strings, this will be the string, for other values you probably need to
218	use the correct C<unpack>. This might get improved in the future. Hopefully.	342	use the correct C<unpack>.
		343
		344	It's best to avoid this method and use one of the predefined C<get_*>
		345	methods.
219		346
220	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
221		348
222	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	349	=for gengetinfo begin platform
223		350
224	Returns a list of matching OpenCL::Device objects.
225		351
226	=item $ctx = $platform->context_from_type_simple ($type = OpenCL::DEVICE_TYPE_DEFAULT)	352	=item $string = $platform->profile
227		353
228	Tries to create a context. Never worked for me.	354	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s).
229		355
230	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	356	=item $string = $platform->version
		357
		358	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s).
		359
		360	=item $string = $platform->name
		361
		362	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s).
		363
		364	=item $string = $platform->vendor
		365
		366	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s).
		367
		368	=item $string = $platform->extensions
		369
		370	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s).
		371
		372	=for gengetinfo end platform
231		373
232	=back	374	=back
233		375
234	=head2 THE OpenCL::Device CLASS	376	=head2 THE OpenCL::Device CLASS
235		377
…		…
239		381
240	See C<< $platform->info >> for details.	382	See C<< $platform->info >> for details.
241		383
242	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	384	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
243		385
		386	=for gengetinfo begin device
		387
		388
		389	=item $device_type = $device->type
		390
		391	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s).
		392
		393	=item $uint = $device->vendor_id
		394
		395	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s).
		396
		397	=item $uint = $device->max_compute_units
		398
		399	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s).
		400
		401	=item $uint = $device->max_work_item_dimensions
		402
		403	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s).
		404
		405	=item $int = $device->max_work_group_size
		406
		407	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s).
		408
		409	=item @ints = $device->max_work_item_sizes
		410
		411	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s).
		412
		413	=item $uint = $device->preferred_vector_width_char
		414
		415	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s).
		416
		417	=item $uint = $device->preferred_vector_width_short
		418
		419	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s).
		420
		421	=item $uint = $device->preferred_vector_width_int
		422
		423	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s).
		424
		425	=item $uint = $device->preferred_vector_width_long
		426
		427	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s).
		428
		429	=item $uint = $device->preferred_vector_width_float
		430
		431	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s).
		432
		433	=item $uint = $device->preferred_vector_width_double
		434
		435	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s).
		436
		437	=item $uint = $device->max_clock_frequency
		438
		439	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s).
		440
		441	=item $bitfield = $device->address_bits
		442
		443	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s).
		444
		445	=item $uint = $device->max_read_image_args
		446
		447	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s).
		448
		449	=item $uint = $device->max_write_image_args
		450
		451	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s).
		452
		453	=item $ulong = $device->max_mem_alloc_size
		454
		455	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s).
		456
		457	=item $int = $device->image2d_max_width
		458
		459	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s).
		460
		461	=item $int = $device->image2d_max_height
		462
		463	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s).
		464
		465	=item $int = $device->image3d_max_width
		466
		467	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s).
		468
		469	=item $int = $device->image3d_max_height
		470
		471	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s).
		472
		473	=item $int = $device->image3d_max_depth
		474
		475	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s).
		476
		477	=item $uint = $device->image_support
		478
		479	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s).
		480
		481	=item $int = $device->max_parameter_size
		482
		483	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s).
		484
244	=item $ctx = $device->context_simple	485	=item $uint = $device->max_samplers
245		486
246	Convenience function to create a new OpenCL::Context object.	487	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s).
247		488
248	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	489	=item $uint = $device->mem_base_addr_align
		490
		491	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s).
		492
		493	=item $uint = $device->min_data_type_align_size
		494
		495	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s).
		496
		497	=item $device_fp_config = $device->single_fp_config
		498
		499	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s).
		500
		501	=item $device_mem_cache_type = $device->global_mem_cache_type
		502
		503	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s).
		504
		505	=item $uint = $device->global_mem_cacheline_size
		506
		507	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s).
		508
		509	=item $ulong = $device->global_mem_cache_size
		510
		511	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s).
		512
		513	=item $ulong = $device->global_mem_size
		514
		515	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s).
		516
		517	=item $ulong = $device->max_constant_buffer_size
		518
		519	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s).
		520
		521	=item $uint = $device->max_constant_args
		522
		523	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s).
		524
		525	=item $device_local_mem_type = $device->local_mem_type
		526
		527	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s).
		528
		529	=item $ulong = $device->local_mem_size
		530
		531	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s).
		532
		533	=item $boolean = $device->error_correction_support
		534
		535	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s).
		536
		537	=item $int = $device->profiling_timer_resolution
		538
		539	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s).
		540
		541	=item $boolean = $device->endian_little
		542
		543	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s).
		544
		545	=item $boolean = $device->available
		546
		547	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s).
		548
		549	=item $boolean = $device->compiler_available
		550
		551	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s).
		552
		553	=item $device_exec_capabilities = $device->execution_capabilities
		554
		555	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s).
		556
		557	=item $command_queue_properties = $device->properties
		558
		559	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s).
		560
		561	=item $ = $device->platform
		562
		563	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s).
		564
		565	=item $string = $device->name
		566
		567	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s).
		568
		569	=item $string = $device->vendor
		570
		571	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s).
		572
		573	=item $string = $device->driver_version
		574
		575	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s).
		576
		577	=item $string = $device->profile
		578
		579	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s).
		580
		581	=item $string = $device->version
		582
		583	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s).
		584
		585	=item $string = $device->extensions
		586
		587	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s).
		588
		589	=item $uint = $device->preferred_vector_width_half
		590
		591	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s).
		592
		593	=item $uint = $device->native_vector_width_char
		594
		595	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s).
		596
		597	=item $uint = $device->native_vector_width_short
		598
		599	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s).
		600
		601	=item $uint = $device->native_vector_width_int
		602
		603	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s).
		604
		605	=item $uint = $device->native_vector_width_long
		606
		607	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s).
		608
		609	=item $uint = $device->native_vector_width_float
		610
		611	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s).
		612
		613	=item $uint = $device->native_vector_width_double
		614
		615	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s).
		616
		617	=item $uint = $device->native_vector_width_half
		618
		619	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s).
		620
		621	=item $device_fp_config = $device->double_fp_config
		622
		623	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s).
		624
		625	=item $device_fp_config = $device->half_fp_config
		626
		627	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s).
		628
		629	=item $boolean = $device->host_unified_memory
		630
		631	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s).
		632
		633	=item $device = $device->parent_device_ext
		634
		635	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s).
		636
		637	=item @device_partition_property_exts = $device->partition_types_ext
		638
		639	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s).
		640
		641	=item @device_partition_property_exts = $device->affinity_domains_ext
		642
		643	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s).
		644
		645	=item $uint = $device->reference_count_ext
		646
		647	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s).
		648
		649	=item @device_partition_property_exts = $device->partition_style_ext
		650
		651	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s).
		652
		653	=for gengetinfo end device
249		654
250	=back	655	=back
251		656
252	=head2 THE OpenCL::Context CLASS	657	=head2 THE OpenCL::Context CLASS
253		658
254	=over 4	659	=over 4
255		660
256	=item $packed_value = $ctx->info ($name)	661	=item $queue = $ctx->queue ($device, $properties)
257		662
258	See C<< $platform->info >> for details.
259
260	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
261
262	=item $queue = $ctx->command_queue_simple ($device)
263
264	Convenience function to create a new OpenCL::Queue object from the context and the given device.	663	Create a new OpenCL::Queue object from the context and the given device.
265		664
266	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	665	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
267		666
268	=item $ev = $ctx->user_event	667	=item $ev = $ctx->user_event
269		668
…		…
279		678
280	=item $buf = $ctx->buffer_sv ($flags, $data)	679	=item $buf = $ctx->buffer_sv ($flags, $data)
281		680
282	Creates a new OpenCL::Buffer object and initialise it with the given data values.	681	Creates a new OpenCL::Buffer object and initialise it with the given data values.
283		682
284	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	683	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
285		684
286	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	685	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.
287		686
288	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	687	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
289		688
290	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	689	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
291		690
292	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	691	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.
293		692
294	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	693	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
295		694
…		…
309	=item $program = $ctx->program_with_source ($string)	708	=item $program = $ctx->program_with_source ($string)
310		709
311	Creates a new OpenCL::Program object from the given source code.	710	Creates a new OpenCL::Program object from the given source code.
312		711
313	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	712	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		713
		714	=item $packed_value = $ctx->info ($name)
		715
		716	See C<< $platform->info >> for details.
		717
		718	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		719
		720	=for gengetinfo begin context
		721
		722
		723	=item $uint = $context->reference_count
		724
		725	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s).
		726
		727	=item @devices = $context->devices
		728
		729	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s).
		730
		731	=item @property_ints = $context->properties
		732
		733	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s).
		734
		735	=item $uint = $context->num_devices
		736
		737	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s).
		738
		739	=for gengetinfo end context
314		740
315	=back	741	=back
316		742
317	=head2 THE OpenCL::Queue CLASS	743	=head2 THE OpenCL::Queue CLASS
318		744
…		…
327	They also allow you to specify any number of other event objects that this	753	They also allow you to specify any number of other event objects that this
328	request has to wait for before it starts executing, by simply passing the	754	request has to wait for before it starts executing, by simply passing the
329	event objects as extra parameters to the enqueue methods.	755	event objects as extra parameters to the enqueue methods.
330		756
331	Queues execute in-order by default, without any parallelism, so in most	757	Queues execute in-order by default, without any parallelism, so in most
332	cases it's not necessary to wait for or create event objects.	758	cases (i.e. you use only one queue) it's not necessary to wait for or
		759	create event objects.
333		760
334	=over 4	761	=over 4
335		762
336	=item $packed_value = $ctx->info ($name)
337
338	See C<< $platform->info >> for details.
339
340	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
341
342	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	763	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
343		764
344	Reads data from buffer into the given string.	765	Reads data from buffer into the given string.
345		766
346	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	767	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
357		778
358	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	779	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
359		780
360	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	781	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
361		782
362	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	783	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
363		784
364	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	785	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
365		786
366	=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...)	787	=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...)
367		788
368	Yeah.	789	Yeah.
369		790
370	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	791	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
371		792
372	=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, ...)	793	=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...)
373		794
374	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	795	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
375		796
376	=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, ...)	797	=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...)
377		798
378	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	799	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
379		800
380	=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, ...)	801	=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...)
381		802
382	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	803	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
383		804
384	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	805	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
385		806
…		…
421		842
422	=item $queue->finish	843	=item $queue->finish
423		844
424	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	845	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
425		846
		847	=item $packed_value = $queue->info ($name)
		848
		849	See C<< $platform->info >> for details.
		850
		851	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		852
		853	=for gengetinfo begin command_queue
		854
		855
		856	=item $ctx = $command_queue->context
		857
		858	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s).
		859
		860	=item $device = $command_queue->device
		861
		862	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s).
		863
		864	=item $uint = $command_queue->reference_count
		865
		866	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s).
		867
		868	=item $command_queue_properties = $command_queue->properties
		869
		870	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s).
		871
		872	=for gengetinfo end command_queue
		873
426	=back	874	=back
427		875
428	=head2 THE OpenCL::Memory CLASS	876	=head2 THE OpenCL::Memory CLASS
429		877
430	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	878	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
431	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	879	OpenCL::Image2D and OpenCL::Image3D.
432	currently only exist to allow type-checking.
433		880
434	=over 4	881	=over 4
435		882
436	=item $packed_value = $memory->info ($name)	883	=item $packed_value = $memory->info ($name)
437		884
438	See C<< $platform->info >> for details.	885	See C<< $platform->info >> for details.
439		886
440	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	887	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
441		888
		889	=for gengetinfo begin mem
		890
		891
		892	=item $mem_object_type = $mem->type
		893
		894	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s).
		895
		896	=item $mem_flags = $mem->flags
		897
		898	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s).
		899
		900	=item $int = $mem->size
		901
		902	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s).
		903
		904	=item $ptr_value = $mem->host_ptr
		905
		906	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s).
		907
		908	=item $uint = $mem->map_count
		909
		910	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s).
		911
		912	=item $uint = $mem->reference_count
		913
		914	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s).
		915
		916	=item $ctx = $mem->context
		917
		918	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s).
		919
		920	=item $mem = $mem->associated_memobject
		921
		922	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s).
		923
		924	=item $int = $mem->offset
		925
		926	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s).
		927
		928	=for gengetinfo end mem
		929
442	=back	930	=back
443		931
		932	=head2 THE OpenCL::Image CLASS
		933
		934	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		935
		936	=over 4
		937
		938	=item $packed_value = $ev->image_info ($name)
		939
		940	See C<< $platform->info >> for details.
		941
		942	The reason this method is not called C<info> is that there already is an
		943	C<< ->info >> method inherited from C<OpenCL::Memory>.
		944
		945	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		946
		947	=for gengetinfo begin image
		948
		949
		950	=item $int = $image->element_size
		951
		952	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s).
		953
		954	=item $int = $image->row_pitch
		955
		956	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s).
		957
		958	=item $int = $image->slice_pitch
		959
		960	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s).
		961
		962	=item $int = $image->width
		963
		964	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s).
		965
		966	=item $int = $image->height
		967
		968	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s).
		969
		970	=item $int = $image->depth
		971
		972	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s).
		973
		974	=for gengetinfo end image
		975
		976	=back
		977
444	=head2 THE OpenCL::Sampler CLASS	978	=head2 THE OpenCL::Sampler CLASS
445		979
446	=over 4	980	=over 4
447		981
448	=item $packed_value = $sampler->info ($name)	982	=item $packed_value = $sampler->info ($name)
449		983
450	See C<< $platform->info >> for details.	984	See C<< $platform->info >> for details.
451		985
452	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	986	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
453		987
		988	=for gengetinfo begin sampler
		989
		990
		991	=item $uint = $sampler->reference_count
		992
		993	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s).
		994
		995	=item $ctx = $sampler->context
		996
		997	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s).
		998
		999	=item $addressing_mode = $sampler->normalized_coords
		1000
		1001	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s).
		1002
		1003	=item $filter_mode = $sampler->addressing_mode
		1004
		1005	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s).
		1006
		1007	=item $boolean = $sampler->filter_mode
		1008
		1009	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s).
		1010
		1011	=for gengetinfo end sampler
		1012
454	=back	1013	=back
455		1014
456	=head2 THE OpenCL::Program CLASS	1015	=head2 THE OpenCL::Program CLASS
457		1016
458	=over 4	1017	=over 4
459
460	=item $packed_value = $program->info ($name)
461
462	See C<< $platform->info >> for details.
463
464	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
465		1018
466	=item $program->build ($device, $options = "")	1019	=item $program->build ($device, $options = "")
467		1020
468	Tries to build the program with the givne options.	1021	Tries to build the program with the givne options.
469		1022
…		…
481	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1034	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
482	the program.	1035	the program.
483		1036
484	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1037	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
485		1038
		1039	=for gengetinfo begin program_build
		1040
		1041
		1042	=item $build_status = $program->build_status ($device)
		1043
		1044	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s).
		1045
		1046	=item $string = $program->build_options ($device)
		1047
		1048	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s).
		1049
		1050	=item $string = $program->build_log ($device)
		1051
		1052	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s).
		1053
		1054	=for gengetinfo end program_build
		1055
		1056	=item $packed_value = $program->info ($name)
		1057
		1058	See C<< $platform->info >> for details.
		1059
		1060	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1061
		1062	=for gengetinfo begin program
		1063
		1064
		1065	=item $uint = $program->reference_count
		1066
		1067	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s).
		1068
		1069	=item $ctx = $program->context
		1070
		1071	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s).
		1072
		1073	=item $uint = $program->num_devices
		1074
		1075	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s).
		1076
		1077	=item @devices = $program->devices
		1078
		1079	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s).
		1080
		1081	=item $string = $program->source
		1082
		1083	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s).
		1084
		1085	=item @ints = $program->binary_sizes
		1086
		1087	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s).
		1088
		1089	=for gengetinfo end program
		1090
486	=back	1091	=back
487		1092
488	=head2 THE OpenCL::Kernel CLASS	1093	=head2 THE OpenCL::Kernel CLASS
489		1094
490	=over 4	1095	=over 4
…		…
492	=item $packed_value = $kernel->info ($name)	1097	=item $packed_value = $kernel->info ($name)
493		1098
494	See C<< $platform->info >> for details.	1099	See C<< $platform->info >> for details.
495		1100
496	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1101	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1102
		1103	=for gengetinfo begin kernel
		1104
		1105
		1106	=item $string = $kernel->function_name
		1107
		1108	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s).
		1109
		1110	=item $uint = $kernel->num_args
		1111
		1112	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s).
		1113
		1114	=item $uint = $kernel->reference_count
		1115
		1116	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s).
		1117
		1118	=item $ctx = $kernel->context
		1119
		1120	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s).
		1121
		1122	=item $program = $kernel->program
		1123
		1124	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s).
		1125
		1126	=for gengetinfo end kernel
		1127
		1128	=item $packed_value = $kernel->work_group_info ($device, $name)
		1129
		1130	See C<< $platform->info >> for details.
		1131
		1132	The reason this method is not called C<info> is that there already is an
		1133	C<< ->info >> method.
		1134
		1135	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1136
		1137	=for gengetinfo begin kernel_work_group
		1138
		1139
		1140	=item $int = $kernel->work_group_size ($device)
		1141
		1142	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s).
		1143
		1144	=item @ints = $kernel->compile_work_group_size ($device)
		1145
		1146	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s).
		1147
		1148	=item $ulong = $kernel->local_mem_size ($device)
		1149
		1150	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s).
		1151
		1152	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1153
		1154	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s).
		1155
		1156	=item $ulong = $kernel->private_mem_size ($device)
		1157
		1158	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s).
		1159
		1160	=for gengetinfo end kernel_work_group
497		1161
498	=item $kernel->set_TYPE ($index, $value)	1162	=item $kernel->set_TYPE ($index, $value)
499		1163
500	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1164	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
501		1165
…		…
517	This is the superclass for all event objects (including OpenCL::UserEvent	1181	This is the superclass for all event objects (including OpenCL::UserEvent
518	objects).	1182	objects).
519		1183
520	=over 4	1184	=over 4
521		1185
		1186	=item $ev->wait
		1187
		1188	Waits for the event to complete.
		1189
		1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1191
522	=item $packed_value = $ev->info ($name)	1192	=item $packed_value = $ev->info ($name)
523		1193
524	See C<< $platform->info >> for details.	1194	See C<< $platform->info >> for details.
525		1195
526	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1196	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
527		1197
528	=item $ev->wait	1198	=for gengetinfo begin event
529		1199
530	Waits for the event to complete.
531		1200
		1201	=item $queue = $event->command_queue
		1202
		1203	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s).
		1204
		1205	=item $command_type = $event->command_type
		1206
		1207	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s).
		1208
		1209	=item $uint = $event->reference_count
		1210
		1211	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s).
		1212
		1213	=item $uint = $event->command_execution_status
		1214
		1215	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s).
		1216
		1217	=item $ctx = $event->context
		1218
		1219	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s).
		1220
		1221	=for gengetinfo end event
		1222
		1223	=item $packed_value = $ev->profiling_info ($name)
		1224
		1225	See C<< $platform->info >> for details.
		1226
		1227	The reason this method is not called C<info> is that there already is an
		1228	C<< ->info >> method.
		1229
532	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1230	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1231
		1232	=for gengetinfo begin profiling
		1233
		1234
		1235	=item $ulong = $event->profiling_command_queued
		1236
		1237	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s).
		1238
		1239	=item $ulong = $event->profiling_command_submit
		1240
		1241	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s).
		1242
		1243	=item $ulong = $event->profiling_command_start
		1244
		1245	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s).
		1246
		1247	=item $ulong = $event->profiling_command_end
		1248
		1249	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s).
		1250
		1251	=for gengetinfo end profiling
533		1252
534	=back	1253	=back
535		1254
536	=head2 THE OpenCL::UserEvent CLASS	1255	=head2 THE OpenCL::UserEvent CLASS
537		1256
…		…
550	package OpenCL;	1269	package OpenCL;
551		1270
552	use common::sense;	1271	use common::sense;
553		1272
554	BEGIN {	1273	BEGIN {
555	our $VERSION = '0.03';	1274	our $VERSION = '0.55';
556		1275
557	require XSLoader;	1276	require XSLoader;
558	XSLoader::load (__PACKAGE__, $VERSION);	1277	XSLoader::load (__PACKAGE__, $VERSION);
559		1278
560	@OpenCL::Buffer::ISA =	1279	@OpenCL::Buffer::ISA =

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.5 by root, Wed Nov 16 00:35:30 2011 UTC vs. Revision 1.21 by root, Sun Nov 20 10:21:27 2011 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.5 by root, Wed Nov 16 00:35:30 2011 UTC vs.
Revision 1.21 by root, Sun Nov 20 10:21:27 2011 UTC