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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.9 by root, Thu Nov 17 01:36:52 2011 UTC vs.
Revision 1.25 by root, Tue Nov 22 10:39:47 2011 UTC

…		…
18	vendors) - usually there is only one.	18	vendors) - usually there is only one.
19		19
20	Each platform gives you access to a number of OpenCL::Device objects, e.g.	20	Each platform gives you access to a number of OpenCL::Device objects, e.g.
21	your graphics card.	21	your graphics card.
22		22
23	From a platform and some devices, you create an OpenCL::Context, which is	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	24	a very central object in OpenCL: Once you have a context you can create
25	most other objects:	25	most other objects:
26		26
27	OpenCL::Program objects, which store source code and, after building	27	OpenCL::Program objects, which store source code and, after building for a
28	("compiling and linking"), also binary programs. For each kernel function	28	specific device ("compiling and linking"), also binary programs. For each
29	in a program you can then create an OpenCL::Kernel object which represents	29	kernel function in a program you can then create an OpenCL::Kernel object
30	basically a function call with argument values.	30	which represents basically a function call with argument values.
31		31
32	OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat	32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33	memory areas, think array) and OpenCL::Image objects (think 2d or 3d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34	array) for bulk data and input and output for kernels.	34	or 3d array) for bulk data and input and output for kernels.
35		35
36	OpenCL::Sampler objects, which are kind of like texture filter modes in	36	OpenCL::Sampler objects, which are kind of like texture filter modes in
37	OpenGL.	37	OpenGL.
38		38
39	OpenCL::Queue objects - command queues, which allow you to submit memory	39	OpenCL::Queue objects - command queues, which allow you to submit memory
…		…
52		52
53	OpenCL manpages:	53	OpenCL manpages:
54		54
55	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/
56		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
57	=head1 BASIC WORKFLOW	71	=head1 BASIC WORKFLOW
58		72
59	To get something done, you basically have to do this once:	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):
60		75
61	Find some platform (e.g. the first one) and some device (e.g. the first	76	Find some platform (e.g. the first one) and some device(s) (e.g. the first
62	device you can find), and create a context from those.	77	device of the platform), and create a context from those.
63		78
64	Create a command queue from your context, and program objects from your	79	Create program objects from your OpenCL source code, then build (compile)
65	OpenCL source code, build the programs.	80	the programs for each device you want to run them on.
66		81
67	Create kernel objects for all kernels you want to use.	82	Create kernel objects for all kernels you want to use (surprisingly, these
		83	are not device-specific).
68		84
69	Then, to execute stuff, you repeat this:	85	Then, to execute stuff, you repeat these steps, possibly resuing or
		86	sharing some buffers:
70		87
71	Create some input and output buffers from your context. Initialise the	88	Create some input and output buffers from your context. Set these as
72	input buffers with data. Set these as arguments to your kernel.	89	arguments to your kernel.
		90
		91	Enqueue buffer writes to initialise your input buffers (when not
		92	initialised at creation time).
73		93
74	Enqueue the kernel execution.	94	Enqueue the kernel execution.
75		95
76	Enqueue buffer reads for your output buffer to read results.	96	Enqueue buffer reads for your output buffer to read results.
77		97
78	The next section shows how this can be done.
79
80	=head1 EXAMPLES	98	=head1 EXAMPLES
81		99
82	=head2 Enumerate all devices and get contexts for them.	100	=head2 Enumerate all devices and get contexts for them.
83		101
		102	Best run this once to get a feel for the platforms and devices in your
		103	system.
		104
84	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
85	warn $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
86	warn $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
87	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
88	warn $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
89	my $ctx = $device->context_simple;	110	my $ctx = $device->context;
90	# do stuff	111	# do stuff
91	}	112	}
92	}	113	}
93		114
94	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
95		116
96	my $dev = ((OpenCL::platforms)[0]->devices)[0];	117	This is a useful boilerplate for any OpenCL program that only wants to use
97	my $ctx = $dev->context_simple;	118	one device,
98	my $queue = $ctx->queue ($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
99		124
100	=head2 Print all supported image formats of a context.	125	=head2 Print all supported image formats of a context.
101		126
		127	Best run this once for your context, to see whats available and how to
		128	gather information.
		129
102	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {	130	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
103	say "supported image formats for ", OpenCL::enum2str $type;	131	print "supported image formats for ", OpenCL::enum2str $type, "\n";
104		132
105	for my $f ($ctx->supported_image_formats (0, $type)) {	133	for my $f ($ctx->supported_image_formats (0, $type)) {
106	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];
107	}	135	}
108	}	136	}
…		…
111	then asynchronously.	139	then asynchronously.
112		140
113	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
114		142
115	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);
116	warn $data;	144	print "$data\n";
117		145
118	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);
119	$ev->wait;	147	$ev->wait;
120	warn $data;	148	print "$data\n"; # prints "elm"
121		149
122	=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
123	functions.	151	functions.
124		152
125	my $src = '	153	my $src = '
126	__kernel void	154	__kernel void
127	squareit (__global float input, __global float output)	155	squareit (__global float input, __global float output)
128	{	156	{
129	size_t id = get_global_id (0);	157	$id = get_global_id (0);
130	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
131	}	159	}
132	';	160	';
133		161
134	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->program_with_source ($src);
135		163
		164	# build croaks on compile errors, so catch it and print the compile errors
136	eval { $prog->build ($dev); 1 }	165	eval { $prog->build ($dev); 1 }
137	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);	166	or die $prog->build_log;
138		167
139	my $kernel = $prog->kernel ("squareit");	168	my $kernel = $prog->kernel ("squareit");
140		169
141	=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.
142		172
143	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);
144	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);	174	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
145		175
146	# set buffer	176	# set buffer
…		…
152		182
153	# enqueue a synchronous read	183	# enqueue a synchronous read
154	$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);
155		185
156	# print the results:	186	# print the results:
157	say join ", ", unpack "f*", $data;	187	printf "%s\n", join ", ", unpack "f*", $data;
158		188
159	=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,
160	showing off barriers.	190	showing off barriers.
161		191
162	# execute it for all 4 numbers	192	# execute it for all 4 numbers
…		…
185		215
186	=head1 DOCUMENTATION	216	=head1 DOCUMENTATION
187		217
188	=head2 BASIC CONVENTIONS	218	=head2 BASIC CONVENTIONS
189		219
190	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
191	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
192	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
193	differences between the OpenCL C API and this module:	223	differences between the OpenCL C API and this module:
194		224
195	=over 4	225	=over 4
196		226
197	=item * Object lifetime managament is automatic - there is no need	227	=item * Object lifetime managament is automatic - there is no need
198	to free objects explicitly (C<clReleaseXXX>), the release function	228	to free objects explicitly (C<clReleaseXXX>), the release function
199	is called automatically once all Perl references to it go away.	229	is called automatically once all Perl references to it go away.
200		230
201	=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
202	while this module uses underscores as word separator and often leaves out	233	uses underscores as word separator and often leaves out prefixes
203	prefixes (C<< $platform->info >>).	234	(C<OpenCL::platforms>, C<< $platform->info >>).
204		235
205	=item * OpenCL often specifies fixed vector function arguments as short	236	=item * OpenCL often specifies fixed vector function arguments as short
206	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
207	components as separate arguments-	238	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		239	function calls.
208		240
209	=item * Where possible, one of the pitch values is calculated from the	241	=item * Structures are often specified by flattening out their components
210	perl scalar length and need not be specified.	242	as with short vectors, and returned as arrayrefs.
211		243
212	=item * When enqueuing commands, the wait list is specified by adding	244	=item * When enqueuing commands, the wait list is specified by adding
213	extra arguments to the function - anywhere a C<$wait_events...> argument	245	extra arguments to the function - anywhere a C<$wait_events...> argument
214	is documented this can be any number of event objects.	246	is documented this can be any number of event objects.
215		247
…		…
245		277
246	=over 4	278	=over 4
247		279
248	=item $int = OpenCL::errno	280	=item $int = OpenCL::errno
249		281
250	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.
251		284
252	=item $str = OpenCL::err2str $errval	285	=item $str = OpenCL::err2str $errval
253		286
254	Comverts an error value into a human readable string.	287	Comverts an error value into a human readable string.
255		288
…		…
265		298
266	Returns all available OpenCL::Platform objects.	299	Returns all available OpenCL::Platform objects.
267		300
268	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>
269		302
270	=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
271		304
272	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.
273		306
274	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>
275		308
…		…
283		316
284	=head2 THE OpenCL::Platform CLASS	317	=head2 THE OpenCL::Platform CLASS
285		318
286	=over 4	319	=over 4
287		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
288	=item $packed_value = $platform->info ($name)	338	=item $packed_value = $platform->info ($name)
289		339
290	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	340	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
291	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
292	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.
293		346
294	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>
295		348
296	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	349	=for gengetinfo begin platform
297		350
298	Returns a list of matching OpenCL::Device objects.	351	=item $string = $platform->profile
299		352
300	=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.
301		354
302	Tries to create a context. Never worked for me.	355	=item $string = $platform->version
303		356
304	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
305		372
306	=back	373	=back
307		374
308	=head2 THE OpenCL::Device CLASS	375	=head2 THE OpenCL::Device CLASS
309		376
…		…
313		380
314	See C<< $platform->info >> for details.	381	See C<< $platform->info >> for details.
315		382
316	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>
317		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
318	=item $ctx = $device->context_simple	483	=item $uint = $device->max_samplers
319		484
320	Convenience function to create a new OpenCL::Context object.	485	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
321		486
322	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
323		652
324	=back	653	=back
325		654
326	=head2 THE OpenCL::Context CLASS	655	=head2 THE OpenCL::Context CLASS
327		656
328	=over 4	657	=over 4
329		658
330	=item $packed_value = $ctx->info ($name)
331
332	See C<< $platform->info >> for details.
333
334	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
335
336	=item $queue = $ctx->queue ($device, $properties)	659	=item $queue = $ctx->queue ($device, $properties)
337		660
338	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.
339		662
340	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>
…		…
353		676
354	=item $buf = $ctx->buffer_sv ($flags, $data)	677	=item $buf = $ctx->buffer_sv ($flags, $data)
355		678
356	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.
357		680
358	=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)
359		682
360	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.
361		684
362	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>
363		686
364	=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)
365		688
366	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.
367		690
368	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>
369		692
…		…
383	=item $program = $ctx->program_with_source ($string)	706	=item $program = $ctx->program_with_source ($string)
384		707
385	Creates a new OpenCL::Program object from the given source code.	708	Creates a new OpenCL::Program object from the given source code.
386		709
387	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
388		737
389	=back	738	=back
390		739
391	=head2 THE OpenCL::Queue CLASS	740	=head2 THE OpenCL::Queue CLASS
392		741
…		…
406	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
407	create event objects.	756	create event objects.
408		757
409	=over 4	758	=over 4
410		759
411	=item $packed_value = $ctx->info ($name)
412
413	See C<< $platform->info >> for details.
414
415	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
416
417	=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...)
418		761
419	Reads data from buffer into the given string.	762	Reads data from buffer into the given string.
420		763
421	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>
…		…
428		771
429	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	772	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
430		773
431	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	774	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
432		775
		776	=item $ev = $queue->enqueue_read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
		777
		778	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		779
		780	=item $ev = $queue->enqueue_write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
		781
		782	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		783
433	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	784	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
434		785
435	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	786	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
436		787
437	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	788	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
438		789
439	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	790	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
440		791
441	=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...)	792	=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...)
442		793
443	Yeah.	794	Yeah.
444		795
445	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	796	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
446		797
447	=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, ...)	798	=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...)
448		799
449	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	800	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
450		801
451	=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, ...)	802	=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...)
452		803
453	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
454		805
455	=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, ...)	806	=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...)
456		807
457	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	808	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
458		809
459	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	810	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
460		811
…		…
496		847
497	=item $queue->finish	848	=item $queue->finish
498		849
499	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	850	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
500		851
		852	=item $packed_value = $queue->info ($name)
		853
		854	See C<< $platform->info >> for details.
		855
		856	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		857
		858	=for gengetinfo begin command_queue
		859
		860	=item $ctx = $command_queue->context
		861
		862	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		863
		864	=item $device = $command_queue->device
		865
		866	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		867
		868	=item $uint = $command_queue->reference_count
		869
		870	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		871
		872	=item $command_queue_properties = $command_queue->properties
		873
		874	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		875
		876	=for gengetinfo end command_queue
		877
501	=back	878	=back
502		879
503	=head2 THE OpenCL::Memory CLASS	880	=head2 THE OpenCL::Memory CLASS
504		881
505	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	882	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
506	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	883	OpenCL::Image2D and OpenCL::Image3D.
507	currently only exist to allow type-checking.
508		884
509	=over 4	885	=over 4
510		886
511	=item $packed_value = $memory->info ($name)	887	=item $packed_value = $memory->info ($name)
512		888
513	See C<< $platform->info >> for details.	889	See C<< $platform->info >> for details.
514		890
515	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	891	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
516		892
		893	=for gengetinfo begin mem
		894
		895	=item $mem_object_type = $mem->type
		896
		897	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		898
		899	=item $mem_flags = $mem->flags
		900
		901	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		902
		903	=item $int = $mem->size
		904
		905	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		906
		907	=item $ptr_value = $mem->host_ptr
		908
		909	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		910
		911	=item $uint = $mem->map_count
		912
		913	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		914
		915	=item $uint = $mem->reference_count
		916
		917	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		918
		919	=item $ctx = $mem->context
		920
		921	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		922
		923	=item $mem = $mem->associated_memobject
		924
		925	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		926
		927	=item $int = $mem->offset
		928
		929	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		930
		931	=for gengetinfo end mem
		932
517	=back	933	=back
518		934
		935	=head2 THE OpenCL::Image CLASS
		936
		937	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		938
		939	=over 4
		940
		941	=item $packed_value = $ev->image_info ($name)
		942
		943	See C<< $platform->info >> for details.
		944
		945	The reason this method is not called C<info> is that there already is an
		946	C<< ->info >> method inherited from C<OpenCL::Memory>.
		947
		948	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		949
		950	=for gengetinfo begin image
		951
		952	=item $int = $image->element_size
		953
		954	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		955
		956	=item $int = $image->row_pitch
		957
		958	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		959
		960	=item $int = $image->slice_pitch
		961
		962	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		963
		964	=item $int = $image->width
		965
		966	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		967
		968	=item $int = $image->height
		969
		970	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		971
		972	=item $int = $image->depth
		973
		974	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		975
		976	=for gengetinfo end image
		977
		978	=back
		979
519	=head2 THE OpenCL::Sampler CLASS	980	=head2 THE OpenCL::Sampler CLASS
520		981
521	=over 4	982	=over 4
522		983
523	=item $packed_value = $sampler->info ($name)	984	=item $packed_value = $sampler->info ($name)
524		985
525	See C<< $platform->info >> for details.	986	See C<< $platform->info >> for details.
526		987
527	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	988	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
528		989
		990	=for gengetinfo begin sampler
		991
		992	=item $uint = $sampler->reference_count
		993
		994	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		995
		996	=item $ctx = $sampler->context
		997
		998	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		999
		1000	=item $addressing_mode = $sampler->normalized_coords
		1001
		1002	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1003
		1004	=item $filter_mode = $sampler->addressing_mode
		1005
		1006	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1007
		1008	=item $boolean = $sampler->filter_mode
		1009
		1010	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1011
		1012	=for gengetinfo end sampler
		1013
529	=back	1014	=back
530		1015
531	=head2 THE OpenCL::Program CLASS	1016	=head2 THE OpenCL::Program CLASS
532		1017
533	=over 4	1018	=over 4
534
535	=item $packed_value = $program->info ($name)
536
537	See C<< $platform->info >> for details.
538
539	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
540		1019
541	=item $program->build ($device, $options = "")	1020	=item $program->build ($device, $options = "")
542		1021
543	Tries to build the program with the givne options.	1022	Tries to build the program with the givne options.
544		1023
…		…
556	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1035	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
557	the program.	1036	the program.
558		1037
559	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1038	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
560		1039
		1040	=for gengetinfo begin program_build
		1041
		1042	=item $build_status = $program->build_status ($device)
		1043
		1044	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1045
		1046	=item $string = $program->build_options ($device)
		1047
		1048	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1049
		1050	=item $string = $program->build_log ($device)
		1051
		1052	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		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	=item $uint = $program->reference_count
		1065
		1066	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1067
		1068	=item $ctx = $program->context
		1069
		1070	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1071
		1072	=item $uint = $program->num_devices
		1073
		1074	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1075
		1076	=item @devices = $program->devices
		1077
		1078	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1079
		1080	=item $string = $program->source
		1081
		1082	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1083
		1084	=item @ints = $program->binary_sizes
		1085
		1086	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1087
		1088	=for gengetinfo end program
		1089
		1090	=item @blobs = $program->binaries
		1091
		1092	Returns a string for the compiled binary for every device associated with
		1093	the program, empty strings indicate missing programs, and an empty result
		1094	means no program binaries are available.
		1095
		1096	These "binaries" are often, in fact, informative low-level assembly
		1097	sources.
		1098
		1099	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1100
561	=back	1101	=back
562		1102
563	=head2 THE OpenCL::Kernel CLASS	1103	=head2 THE OpenCL::Kernel CLASS
564		1104
565	=over 4	1105	=over 4
…		…
567	=item $packed_value = $kernel->info ($name)	1107	=item $packed_value = $kernel->info ($name)
568		1108
569	See C<< $platform->info >> for details.	1109	See C<< $platform->info >> for details.
570		1110
571	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1111	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1112
		1113	=for gengetinfo begin kernel
		1114
		1115	=item $string = $kernel->function_name
		1116
		1117	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1118
		1119	=item $uint = $kernel->num_args
		1120
		1121	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1122
		1123	=item $uint = $kernel->reference_count
		1124
		1125	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1126
		1127	=item $ctx = $kernel->context
		1128
		1129	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1130
		1131	=item $program = $kernel->program
		1132
		1133	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1134
		1135	=for gengetinfo end kernel
		1136
		1137	=item $packed_value = $kernel->work_group_info ($device, $name)
		1138
		1139	See C<< $platform->info >> for details.
		1140
		1141	The reason this method is not called C<info> is that there already is an
		1142	C<< ->info >> method.
		1143
		1144	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1145
		1146	=for gengetinfo begin kernel_work_group
		1147
		1148	=item $int = $kernel->work_group_size ($device)
		1149
		1150	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1151
		1152	=item @ints = $kernel->compile_work_group_size ($device)
		1153
		1154	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1155
		1156	=item $ulong = $kernel->local_mem_size ($device)
		1157
		1158	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1159
		1160	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1161
		1162	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1163
		1164	=item $ulong = $kernel->private_mem_size ($device)
		1165
		1166	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1167
		1168	=for gengetinfo end kernel_work_group
572		1169
573	=item $kernel->set_TYPE ($index, $value)	1170	=item $kernel->set_TYPE ($index, $value)
574		1171
575	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1172	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
576		1173
…		…
592	This is the superclass for all event objects (including OpenCL::UserEvent	1189	This is the superclass for all event objects (including OpenCL::UserEvent
593	objects).	1190	objects).
594		1191
595	=over 4	1192	=over 4
596		1193
		1194	=item $ev->wait
		1195
		1196	Waits for the event to complete.
		1197
		1198	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1199
597	=item $packed_value = $ev->info ($name)	1200	=item $packed_value = $ev->info ($name)
598		1201
599	See C<< $platform->info >> for details.	1202	See C<< $platform->info >> for details.
600		1203
601	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1204	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
602		1205
603	=item $ev->wait	1206	=for gengetinfo begin event
604		1207
605	Waits for the event to complete.	1208	=item $queue = $event->command_queue
606		1209
		1210	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1211
		1212	=item $command_type = $event->command_type
		1213
		1214	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1215
		1216	=item $uint = $event->reference_count
		1217
		1218	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1219
		1220	=item $uint = $event->command_execution_status
		1221
		1222	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1223
		1224	=item $ctx = $event->context
		1225
		1226	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1227
		1228	=for gengetinfo end event
		1229
		1230	=item $packed_value = $ev->profiling_info ($name)
		1231
		1232	See C<< $platform->info >> for details.
		1233
		1234	The reason this method is not called C<info> is that there already is an
		1235	C<< ->info >> method.
		1236
607	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1237	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1238
		1239	=for gengetinfo begin profiling
		1240
		1241	=item $ulong = $event->profiling_command_queued
		1242
		1243	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1244
		1245	=item $ulong = $event->profiling_command_submit
		1246
		1247	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1248
		1249	=item $ulong = $event->profiling_command_start
		1250
		1251	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1252
		1253	=item $ulong = $event->profiling_command_end
		1254
		1255	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1256
		1257	=for gengetinfo end profiling
608		1258
609	=back	1259	=back
610		1260
611	=head2 THE OpenCL::UserEvent CLASS	1261	=head2 THE OpenCL::UserEvent CLASS
612		1262
…		…
625	package OpenCL;	1275	package OpenCL;
626		1276
627	use common::sense;	1277	use common::sense;
628		1278
629	BEGIN {	1279	BEGIN {
630	our $VERSION = '0.03';	1280	our $VERSION = '0.55';
631		1281
632	require XSLoader;	1282	require XSLoader;
633	XSLoader::load (__PACKAGE__, $VERSION);	1283	XSLoader::load (__PACKAGE__, $VERSION);
634		1284
635	@OpenCL::Buffer::ISA =	1285	@OpenCL::Buffer::ISA =

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.9 by root, Thu Nov 17 01:36:52 2011 UTC vs. Revision 1.25 by root, Tue Nov 22 10:39:47 2011 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.9 by root, Thu Nov 17 01:36:52 2011 UTC vs.
Revision 1.25 by root, Tue Nov 22 10:39:47 2011 UTC