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

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.24 by root, Sun Nov 20 22:31:48 2011 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.24 by root, Sun Nov 20 22:31:48 2011 UTC