ViewVC Help

View File | Revision Log | Show Annotations | Download File

/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.54 by root, Tue Apr 24 14:57:06 2012 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 = $platform->context (undef, [$device]);
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->build_program ($src);
135
136	eval { $prog->build ($dev); 1 }
137	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
138
139	my $kernel = $prog->kernel ("squareit");	163	my $kernel = $prog->kernel ("squareit");
140		164
141	=head2 Create some input and output float buffers, then call squareit on them.	165	=head2 Create some input and output float buffers, then call the
		166	'squareit' kernel on them.
142		167
143	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);	168	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);	169	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
145		170
146	# set buffer	171	# set buffer
…		…
152		177
153	# enqueue a synchronous read	178	# enqueue a synchronous read
154	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	179	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
155		180
156	# print the results:	181	# print the results:
157	say join ", ", unpack "f*", $data;	182	printf "%s\n", join ", ", unpack "f*", $data;
158		183
159	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	184	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
160	showing off barriers.	185	showing off barriers.
161		186
162	# execute it for all 4 numbers	187	# execute it for all 4 numbers
…		…
181	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	206	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
182		207
183	# wait for the last event to complete	208	# wait for the last event to complete
184	$ev->wait;	209	$ev->wait;
185		210
		211	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
		212	set tunnel effect.
		213
		214	This is quite a long example to get you going.
		215
		216	use OpenGL ":all";
		217	use OpenCL;
		218
		219	# open a window and create a gl texture
		220	OpenGL::glpOpenWindow width => 256, height => 256;
		221	my $texid = glGenTextures_p 1;
		222	glBindTexture GL_TEXTURE_2D, $texid;
		223	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
		224
		225	# find and use the first opencl device that let's us get a shared opengl context
		226	my $platform;
		227	my $dev;
		228	my $ctx;
		229
		230	for (OpenCL::platforms) {
		231	$platform = $_;
		232	for ($platform->devices) {
		233	$dev = $_;
		234	$ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
		235	and last;
		236	}
		237	}
		238
		239	$ctx
		240	or die "cannot find suitable OpenCL device\n";
		241
		242	my $queue = $ctx->queue ($dev);
		243
		244	# now attach an opencl image2d object to the opengl texture
		245	my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
		246
		247	# now the boring opencl code
		248	my $src = <<EOF;
		249	kernel void
		250	juliatunnel (write_only image2d_t img, float time)
		251	{
		252	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
		253
		254	float2 m = (float2)(1.f, p.y) / fabs (p.x);
		255	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
		256
		257	float2 z = m;
		258	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
		259
		260	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
		261	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		262
		263	float3 colour = (float3)(z.x, z.y, z.x * z.y);
		264	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
		265	}
		266	EOF
		267
		268	my $prog = $ctx->build_program ($src);
		269	my $kernel = $prog->kernel ("juliatunnel");
		270
		271	# program compiled, kernel ready, now draw and loop
		272
		273	for (my $time; ; ++$time) {
		274	# acquire objects from opengl
		275	$queue->enqueue_acquire_gl_objects ([$tex]);
		276
		277	# configure and run our kernel
		278	$kernel->set_image2d (0, $tex);
		279	$kernel->set_float (1, $time);
		280	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
		281
		282	# release objects to opengl again
		283	$queue->enqueue_release_gl_objects ([$tex]);
		284
		285	# wait
		286	$queue->finish;
		287
		288	# now draw the texture, the defaults should be all right
		289	glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
		290
		291	glEnable GL_TEXTURE_2D;
		292	glBegin GL_QUADS;
		293	glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
		294	glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
		295	glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
		296	glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
		297	glEnd;
		298
		299	glXSwapBuffers;
		300
		301	select undef, undef, undef, 1/60;
		302	}
		303
186	=head1 DOCUMENTATION	304	=head1 DOCUMENTATION
187		305
188	=head2 BASIC CONVENTIONS	306	=head2 BASIC CONVENTIONS
189		307
190	This is not a 1:1 C-style translation of OpenCL to Perl - instead I	308	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	309	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	310	object syntax where it makes sense. There are a number of important
193	differences between the OpenCL C API and this module:	311	differences between the OpenCL C API and this module:
194		312
195	=over 4	313	=over 4
196		314
197	=item * Object lifetime managament is automatic - there is no need	315	=item * Object lifetime managament is automatic - there is no need
198	to free objects explicitly (C<clReleaseXXX>), the release function	316	to free objects explicitly (C<clReleaseXXX>), the release function
199	is called automatically once all Perl references to it go away.	317	is called automatically once all Perl references to it go away.
200		318
201	=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>),	319	=item * OpenCL uses CamelCase for function names
		320	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
202	while this module uses underscores as word separator and often leaves out	321	uses underscores as word separator and often leaves out prefixes
203	prefixes (C<< $platform->info >>).	322	(C<OpenCL::platforms>, C<< $platform->info >>).
204		323
205	=item * OpenCL often specifies fixed vector function arguments as short	324	=item * OpenCL often specifies fixed vector function arguments as short
206	arrays (C<size_t origin[3]>), while this module explicitly expects the	325	arrays (C<size_t origin[3]>), while this module explicitly expects the
207	components as separate arguments-	326	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		327	function calls.
208		328
209	=item * Where possible, one of the pitch values is calculated from the	329	=item * Structures are often specified by flattening out their components
210	perl scalar length and need not be specified.	330	as with short vectors, and returned as arrayrefs.
211		331
212	=item * When enqueuing commands, the wait list is specified by adding	332	=item * When enqueuing commands, the wait list is specified by adding
213	extra arguments to the function - anywhere a C<$wait_events...> argument	333	extra arguments to the function - anywhere a C<$wait_events...> argument
214	is documented this can be any number of event objects.	334	is documented this can be any number of event objects. As an extsnion
		335	implemented by this module, C<undef> values will be ignored in the event
		336	list.
215		337
216	=item * When enqueuing commands, if the enqueue method is called in void	338	=item * When enqueuing commands, if the enqueue method is called in void
217	context, no event is created. In all other contexts an event is returned	339	context, no event is created. In all other contexts an event is returned
218	by the method.	340	by the method.
219		341
…		…
239	ulong IV - Q	361	ulong IV - Q
240	float NV float f	362	float NV float f
241	half IV ushort S	363	half IV ushort S
242	double NV double d	364	double NV double d
243		365
		366	=head2 GLX SUPPORT
		367
		368	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		369	module, which has little to no documentation and has little to no support
		370	for glX), this module, as a special extension, treats context creation
		371	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		372	specially: If either or both of these are C<undef>, then the OpenCL
		373	module tries to dynamically resolve C<glXGetCurrentDisplay> and
		374	C<glXGetCurrentContext>, call these functions and use their return values
		375	instead.
		376
		377	For this to work, the OpenGL library must be loaded, a GLX context must
		378	have been created and be made current, and C<dlsym> must be available and
		379	capable of finding the function via C<RTLD_DEFAULT>.
		380
		381	=cut
		382
		383	package OpenCL;
		384
		385	use common::sense;
		386
		387	BEGIN {
		388	our $VERSION = '0.97';
		389
		390	require XSLoader;
		391	XSLoader::load (__PACKAGE__, $VERSION);
		392
		393	@OpenCL::Platform::ISA =
		394	@OpenCL::Device::ISA =
		395	@OpenCL::Context::ISA =
		396	@OpenCL::Queue::ISA =
		397	@OpenCL::Memory::ISA =
		398	@OpenCL::Sampler::ISA =
		399	@OpenCL::Program::ISA =
		400	@OpenCL::Kernel::ISA =
		401	@OpenCL::Event::ISA = OpenCL::Object::;
		402
		403	@OpenCL::Buffer::ISA =
		404	@OpenCL::Image::ISA = OpenCL::Memory::;
		405
		406	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		407
		408	@OpenCL::Image2D::ISA =
		409	@OpenCL::Image3D::ISA =
		410	@OpenCL::Image2DArray::ISA =
		411	@OpenCL::Image1D::ISA =
		412	@OpenCL::Image1DArray::ISA =
		413	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		414
		415	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		416	}
		417
244	=head2 THE OpenCL PACKAGE	418	=head2 THE OpenCL PACKAGE
245		419
246	=over 4	420	=over 4
247		421
248	=item $int = OpenCL::errno	422	=item $int = OpenCL::errno
249		423
250	The last error returned by a function - it's only changed on errors.	424	The last error returned by a function - it's only valid after an error occured
		425	and before calling another OpenCL function.
251		426
252	=item $str = OpenCL::err2str $errval	427	=item $str = OpenCL::err2str $errval
253		428
254	Comverts an error value into a human readable string.	429	Comverts an error value into a human readable string.
255		430
256	=item $str = OpenCL::enum2str $enum	431	=item $str = OpenCL::enum2str $enum
257		432
258	Converts most enum values (inof parameter names, image format constants,	433	Converts most enum values (of parameter names, image format constants,
259	object types, addressing and filter modes, command types etc.) into a	434	object types, addressing and filter modes, command types etc.) into a
260	human readbale string. When confronted with some random integer it can be	435	human readable string. When confronted with some random integer it can be
261	very helpful to pass it through this function to maybe get some readable	436	very helpful to pass it through this function to maybe get some readable
262	string out of it.	437	string out of it.
263		438
264	=item @platforms = OpenCL::platforms	439	=item @platforms = OpenCL::platforms
265		440
266	Returns all available OpenCL::Platform objects.	441	Returns all available OpenCL::Platform objects.
267		442
268	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	443	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
269		444
270	=item $ctx = OpenCL::context_from_type_simple $type = OpenCL::DEVICE_TYPE_DEFAULT	445	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef
271		446
272	Tries to create a context from a default device and platform - never worked for me.	447	Tries to create a context from a default device and platform - never worked for me.
273		448
274	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	449	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
275		450
…		…
279		454
280	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	455	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
281		456
282	=back	457	=back
283		458
		459	=head2 THE OpenCL::Object CLASS
		460
		461	This is the base class for all objects in the OpenCL module. The only
		462	method it implements is the C<id> method, which is only useful if you want
		463	to interface to OpenCL on the C level.
		464
		465	=over 4
		466
		467	=item $iv = $obj->id
		468
		469	OpenCL objects are represented by pointers or integers on the C level. If
		470	you want to interface to an OpenCL object directly on the C level, then
		471	you need this value, which is returned by this method. You should use an
		472	C<IV> type in your code and cast that to the correct type.
		473
		474	=cut
		475
		476	sub OpenCL::Object::id {
		477	${$_[0]}
		478	}
		479
		480	=back
		481
284	=head2 THE OpenCL::Platform CLASS	482	=head2 THE OpenCL::Platform CLASS
285		483
286	=over 4	484	=over 4
287		485
		486	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
		487
		488	Returns a list of matching OpenCL::Device objects.
		489
		490	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
		491
		492	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
		493
		494	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		495
		496	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
		497
		498	Create a new OpenCL::Context object using the given device object(s)- a
		499	CL_CONTEXT_PLATFORM property is supplied automatically.
		500
		501	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		502
288	=item $packed_value = $platform->info ($name)	503	=item $packed_value = $platform->info ($name)
289		504
290	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	505	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
291	strings, this will be the string, for other values you probably need to	506	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.	507	other values you probably need to use the correct C<unpack>.
		508
		509	It's best to avoid this method and use one of the following convenience
		510	wrappers.
293		511
294	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	512	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
295		513
296	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	514	=item $platform->unload_compiler
297		515
298	Returns a list of matching OpenCL::Device objects.	516	Attempts to unload the compiler for this platform, for endless
		517	profit. Does nothing on OpenCL 1.1.
299		518
300	=item $ctx = $platform->context_from_type_simple ($type = OpenCL::DEVICE_TYPE_DEFAULT)
301
302	Tries to create a context. Never worked for me.
303
304	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	519	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		520
		521	=for gengetinfo begin platform
		522
		523	=item $string = $platform->profile
		524
		525	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
		526
		527	=item $string = $platform->version
		528
		529	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
		530
		531	=item $string = $platform->name
		532
		533	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
		534
		535	=item $string = $platform->vendor
		536
		537	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
		538
		539	=item $string = $platform->extensions
		540
		541	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		542
		543	=for gengetinfo end platform
305		544
306	=back	545	=back
307		546
308	=head2 THE OpenCL::Device CLASS	547	=head2 THE OpenCL::Device CLASS
309		548
…		…
313		552
314	See C<< $platform->info >> for details.	553	See C<< $platform->info >> for details.
315		554
316	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	555	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
317		556
		557	=for gengetinfo begin device
		558
		559	=item $device_type = $device->type
		560
		561	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		562
		563	=item $uint = $device->vendor_id
		564
		565	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		566
		567	=item $uint = $device->max_compute_units
		568
		569	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		570
		571	=item $uint = $device->max_work_item_dimensions
		572
		573	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		574
		575	=item $int = $device->max_work_group_size
		576
		577	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		578
		579	=item @ints = $device->max_work_item_sizes
		580
		581	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		582
		583	=item $uint = $device->preferred_vector_width_char
		584
		585	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		586
		587	=item $uint = $device->preferred_vector_width_short
		588
		589	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		590
		591	=item $uint = $device->preferred_vector_width_int
		592
		593	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		594
		595	=item $uint = $device->preferred_vector_width_long
		596
		597	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		598
		599	=item $uint = $device->preferred_vector_width_float
		600
		601	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		602
		603	=item $uint = $device->preferred_vector_width_double
		604
		605	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		606
		607	=item $uint = $device->max_clock_frequency
		608
		609	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		610
		611	=item $bitfield = $device->address_bits
		612
		613	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		614
		615	=item $uint = $device->max_read_image_args
		616
		617	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		618
		619	=item $uint = $device->max_write_image_args
		620
		621	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		622
		623	=item $ulong = $device->max_mem_alloc_size
		624
		625	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		626
		627	=item $int = $device->image2d_max_width
		628
		629	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		630
		631	=item $int = $device->image2d_max_height
		632
		633	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		634
		635	=item $int = $device->image3d_max_width
		636
		637	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		638
		639	=item $int = $device->image3d_max_height
		640
		641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		642
		643	=item $int = $device->image3d_max_depth
		644
		645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		646
		647	=item $uint = $device->image_support
		648
		649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		650
		651	=item $int = $device->max_parameter_size
		652
		653	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		654
318	=item $ctx = $device->context_simple	655	=item $uint = $device->max_samplers
319		656
320	Convenience function to create a new OpenCL::Context object.	657	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
321		658
322	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	659	=item $uint = $device->mem_base_addr_align
		660
		661	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		662
		663	=item $uint = $device->min_data_type_align_size
		664
		665	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		666
		667	=item $device_fp_config = $device->single_fp_config
		668
		669	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		670
		671	=item $device_mem_cache_type = $device->global_mem_cache_type
		672
		673	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		674
		675	=item $uint = $device->global_mem_cacheline_size
		676
		677	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		678
		679	=item $ulong = $device->global_mem_cache_size
		680
		681	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		682
		683	=item $ulong = $device->global_mem_size
		684
		685	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		686
		687	=item $ulong = $device->max_constant_buffer_size
		688
		689	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		690
		691	=item $uint = $device->max_constant_args
		692
		693	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		694
		695	=item $device_local_mem_type = $device->local_mem_type
		696
		697	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		698
		699	=item $ulong = $device->local_mem_size
		700
		701	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		702
		703	=item $boolean = $device->error_correction_support
		704
		705	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		706
		707	=item $int = $device->profiling_timer_resolution
		708
		709	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		710
		711	=item $boolean = $device->endian_little
		712
		713	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		714
		715	=item $boolean = $device->available
		716
		717	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		718
		719	=item $boolean = $device->compiler_available
		720
		721	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		722
		723	=item $device_exec_capabilities = $device->execution_capabilities
		724
		725	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		726
		727	=item $command_queue_properties = $device->properties
		728
		729	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		730
		731	=item $ = $device->platform
		732
		733	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		734
		735	=item $string = $device->name
		736
		737	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		738
		739	=item $string = $device->vendor
		740
		741	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		742
		743	=item $string = $device->driver_version
		744
		745	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		746
		747	=item $string = $device->profile
		748
		749	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		750
		751	=item $string = $device->version
		752
		753	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		754
		755	=item $string = $device->extensions
		756
		757	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		758
		759	=item $uint = $device->preferred_vector_width_half
		760
		761	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		762
		763	=item $uint = $device->native_vector_width_char
		764
		765	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		766
		767	=item $uint = $device->native_vector_width_short
		768
		769	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		770
		771	=item $uint = $device->native_vector_width_int
		772
		773	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		774
		775	=item $uint = $device->native_vector_width_long
		776
		777	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		778
		779	=item $uint = $device->native_vector_width_float
		780
		781	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		782
		783	=item $uint = $device->native_vector_width_double
		784
		785	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		786
		787	=item $uint = $device->native_vector_width_half
		788
		789	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		790
		791	=item $device_fp_config = $device->double_fp_config
		792
		793	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		794
		795	=item $device_fp_config = $device->half_fp_config
		796
		797	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		798
		799	=item $boolean = $device->host_unified_memory
		800
		801	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		802
		803	=item $device = $device->parent_device_ext
		804
		805	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		806
		807	=item @device_partition_property_exts = $device->partition_types_ext
		808
		809	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		810
		811	=item @device_partition_property_exts = $device->affinity_domains_ext
		812
		813	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		814
		815	=item $uint = $device->reference_count_ext
		816
		817	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
		818
		819	=item @device_partition_property_exts = $device->partition_style_ext
		820
		821	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		822
		823	=for gengetinfo end device
323		824
324	=back	825	=back
325		826
326	=head2 THE OpenCL::Context CLASS	827	=head2 THE OpenCL::Context CLASS
327		828
328	=over 4	829	=over 4
329		830
330	=item $packed_value = $ctx->info ($name)	831	=item $prog = $ctx->build_program ($program, $options = "")
331		832
332	See C<< $platform->info >> for details.	833	This convenience function tries to build the program on all devices in
		834	the context. If the build fails, then the function will C<croak> with the
		835	build log. Otherwise ti returns the program object.
333		836
334	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	837	The C<$program> can either be a C<OpenCL::Program> object or a string
		838	containing the program. In the latter case, a program objetc will be
		839	created automatically.
		840
		841	=cut
		842
		843	sub OpenCL::Context::build_program {
		844	my ($self, $prog, $options) = @_;
		845
		846	require Carp;
		847
		848	$prog = $self->program_with_source ($prog)
		849	unless ref $prog;
		850
		851	for my $dev ($self->devices) {
		852	eval { $prog->build ($dev, $options); 1 }
		853	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
		854	. $prog->build_log ($dev));
		855	}
		856
		857	$prog
		858	}
335		859
336	=item $queue = $ctx->queue ($device, $properties)	860	=item $queue = $ctx->queue ($device, $properties)
337		861
338	Create a new OpenCL::Queue object from the context and the given device.	862	Create a new OpenCL::Queue object from the context and the given device.
339		863
340	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	864	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
341		865
		866	Example: create an out-of-order queue.
		867
		868	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		869
342	=item $ev = $ctx->user_event	870	=item $ev = $ctx->user_event
343		871
344	Creates a new OpenCL::UserEvent object.	872	Creates a new OpenCL::UserEvent object.
345		873
346	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	874	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
347		875
348	=item $buf = $ctx->buffer ($flags, $len)	876	=item $buf = $ctx->buffer ($flags, $len)
349		877
350	Creates a new OpenCL::Buffer object with the given flags and octet-size.	878	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		879	given flags and octet-size.
351		880
352	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	881	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
353		882
354	=item $buf = $ctx->buffer_sv ($flags, $data)	883	=item $buf = $ctx->buffer_sv ($flags, $data)
355		884
356	Creates a new OpenCL::Buffer object and initialise it with the given data values.	885	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		886	initialise it with the given data values.
357		887
		888	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
		889
		890	Creates a new OpenCL::Image object and optionally initialises it with
		891	the given data values.
		892
		893	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
		894
358	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	895	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
359		896
360	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	897	Creates a new OpenCL::Image2D object and optionally initialises it with
		898	the given data values.
361		899
362	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	900	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
363		901
364	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	902	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
365		903
366	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	904	Creates a new OpenCL::Image3D object and optionally initialises it with
		905	the given data values.
367		906
368	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	907	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		908
		909	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		910
		911	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		912	OpenGL buffer object.
		913
		914	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		915
		916	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		917
		918	Creates a new OpenCL::Image object that refers to the given OpenGL
		919	texture object or buffer.
		920
		921	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		922
		923	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		924
		925	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		926	2D texture object.
		927
		928	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		929
		930	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		931
		932	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		933	3D texture object.
		934
		935	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		936
		937	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		938
		939	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		940	render buffer.
		941
		942	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
369		943
370	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	944	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
371		945
372	Returns a list of matching image formats - each format is an arrayref with	946	Returns a list of matching image formats - each format is an arrayref with
373	two values, $channel_order and $channel_type, in it.	947	two values, $channel_order and $channel_type, in it.
…		…
383	=item $program = $ctx->program_with_source ($string)	957	=item $program = $ctx->program_with_source ($string)
384		958
385	Creates a new OpenCL::Program object from the given source code.	959	Creates a new OpenCL::Program object from the given source code.
386		960
387	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	961	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		962
		963	=item $packed_value = $ctx->info ($name)
		964
		965	See C<< $platform->info >> for details.
		966
		967	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		968
		969	=for gengetinfo begin context
		970
		971	=item $uint = $context->reference_count
		972
		973	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		974
		975	=item @devices = $context->devices
		976
		977	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		978
		979	=item @property_ints = $context->properties
		980
		981	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		982
		983	=item $uint = $context->num_devices
		984
		985	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		986
		987	=for gengetinfo end context
388		988
389	=back	989	=back
390		990
391	=head2 THE OpenCL::Queue CLASS	991	=head2 THE OpenCL::Queue CLASS
392		992
…		…
398	for completion, unless the method is called in void context, in which case	998	for completion, unless the method is called in void context, in which case
399	no event object is created.	999	no event object is created.
400		1000
401	They also allow you to specify any number of other event objects that this	1001	They also allow you to specify any number of other event objects that this
402	request has to wait for before it starts executing, by simply passing the	1002	request has to wait for before it starts executing, by simply passing the
403	event objects as extra parameters to the enqueue methods.	1003	event objects as extra parameters to the enqueue methods. To simplify
		1004	program design, this module ignores any C<undef> values in the list of
		1005	events. This makes it possible to code operations such as this, without
		1006	having to put a valid event object into C<$event> first:
		1007
		1008	$event = $queue->enqueue_xxx (..., $event);
404		1009
405	Queues execute in-order by default, without any parallelism, so in most	1010	Queues execute in-order by default, without any parallelism, so in most
406	cases (i.e. you use only one queue) it's not necessary to wait for or	1011	cases (i.e. you use only one queue) it's not necessary to wait for or
407	create event objects.	1012	create event objects, althoguh an our of order queue is often a bit
		1013	faster.
408		1014
409	=over 4	1015	=over 4
410		1016
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...)	1017	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
418		1018
419	Reads data from buffer into the given string.	1019	Reads data from buffer into the given string.
420		1020
421	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1021	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
428		1028
429	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1029	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
430		1030
431	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1031	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
432		1032
		1033	=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...)
		1034
		1035	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		1036
		1037	=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...)
		1038
		1039	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		1040
433	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1041	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
434		1042
		1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		1044
		1045	=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...)
		1046
435	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1047	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
436		1048
437	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	1049	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
438		1050
439	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1051	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
440		1052
		1053	=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...)
		1054
		1055	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		1056
		1057	=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...)
		1058
		1059	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		1060
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...)	1061	=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		1062
443	Yeah.	1063	Yeah.
444		1064
445	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
446
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, ...)
448
449	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1065	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
450		1066
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, ...)	1067	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
452		1068
		1069	Fills the given buffer object with repeated applications of C<$pattern>,
		1070	starting at C<$offset> for C<$size> octets.
		1071
		1072	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1073
		1074	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1075
		1076	Fills the given image area with the given rgba colour components. The
		1077	components are normally floating point values between C<0> and C<1>,
		1078	except when the image channel data type is a signe dor unsigned
		1079	unnormalised format, in which case the range is determined by the format.
		1080
453	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1081	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
454
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, ...)
456
457	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
458		1082
459	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1083	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
460		1084
461	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1085	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
462		1086
…		…
476	reference to an array of local work sizes, with the same number of	1100	reference to an array of local work sizes, with the same number of
477	elements as @$global_work_size.	1101	elements as @$global_work_size.
478		1102
479	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1103	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
480		1104
481	=item $ev = $queue->enqueue_marker	1105	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
482		1106
		1107	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1108	for subsequent OpenCL usage.
		1109
483	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1110	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		1111
		1112	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		1113
		1114	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1115	for subsequent OpenGL usage.
		1116
		1117	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
484		1118
485	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1119	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
486		1120
487	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1121	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
488		1122
489	=item $queue->enqueue_barrier	1123	=item $ev = $queue->enqueue_marker ($wait_events...)
490		1124
		1125	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1126
		1127	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1128
491	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1129	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
492		1130
493	=item $queue->flush	1131	=item $queue->flush
494		1132
495	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1133	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
496		1134
497	=item $queue->finish	1135	=item $queue->finish
498		1136
499	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	1137	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
500		1138
		1139	=item $packed_value = $queue->info ($name)
		1140
		1141	See C<< $platform->info >> for details.
		1142
		1143	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1144
		1145	=for gengetinfo begin command_queue
		1146
		1147	=item $ctx = $command_queue->context
		1148
		1149	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1150
		1151	=item $device = $command_queue->device
		1152
		1153	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1154
		1155	=item $uint = $command_queue->reference_count
		1156
		1157	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1158
		1159	=item $command_queue_properties = $command_queue->properties
		1160
		1161	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1162
		1163	=for gengetinfo end command_queue
		1164
501	=back	1165	=back
502		1166
503	=head2 THE OpenCL::Memory CLASS	1167	=head2 THE OpenCL::Memory CLASS
504		1168
505	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	1169	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
506	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	1170	OpenCL::Image2D and OpenCL::Image3D.
507	currently only exist to allow type-checking.
508		1171
509	=over 4	1172	=over 4
510		1173
511	=item $packed_value = $memory->info ($name)	1174	=item $packed_value = $memory->info ($name)
512		1175
513	See C<< $platform->info >> for details.	1176	See C<< $platform->info >> for details.
514		1177
515	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1178	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
516		1179
		1180	=for gengetinfo begin mem
		1181
		1182	=item $mem_object_type = $mem->type
		1183
		1184	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1185
		1186	=item $mem_flags = $mem->flags
		1187
		1188	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1189
		1190	=item $int = $mem->size
		1191
		1192	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1193
		1194	=item $ptr_value = $mem->host_ptr
		1195
		1196	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1197
		1198	=item $uint = $mem->map_count
		1199
		1200	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1201
		1202	=item $uint = $mem->reference_count
		1203
		1204	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1205
		1206	=item $ctx = $mem->context
		1207
		1208	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1209
		1210	=item $mem = $mem->associated_memobject
		1211
		1212	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1213
		1214	=item $int = $mem->offset
		1215
		1216	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1217
		1218	=for gengetinfo end mem
		1219
		1220	=item ($type, $name) = $mem->gl_object_info
		1221
		1222	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1223	object "name" (e.g. the texture name) used to create this memory object.
		1224
		1225	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1226
517	=back	1227	=back
518		1228
		1229	=head2 THE OpenCL::Buffer CLASS
		1230
		1231	This is a subclass of OpenCL::Memory, and the superclass of
		1232	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1233	and sub-buffers.
		1234
		1235	=head2 THE OpenCL::BufferObj CLASS
		1236
		1237	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1238	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1239	sub buffers from these sub buffers.
		1240
		1241	=over 4
		1242
		1243	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1244
		1245	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1246	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1247
		1248	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1249
		1250	=back
		1251
		1252	=head2 THE OpenCL::Image CLASS
		1253
		1254	This is the superclass of all image objects - OpenCL::Image1D,
		1255	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1256	OpenCL::Image2DArray and OpenCL::Image3D.
		1257
		1258	=over 4
		1259
		1260	=item $packed_value = $image->image_info ($name)
		1261
		1262	See C<< $platform->info >> for details.
		1263
		1264	The reason this method is not called C<info> is that there already is an
		1265	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1266
		1267	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1268
		1269	=item ($channel_order, $channel_data_type) = $image->format
		1270
		1271	Returns the channel order and type used to create the image by calling
		1272	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1273
		1274	=for gengetinfo begin image
		1275
		1276	=item $int = $image->element_size
		1277
		1278	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1279
		1280	=item $int = $image->row_pitch
		1281
		1282	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1283
		1284	=item $int = $image->slice_pitch
		1285
		1286	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1287
		1288	=item $int = $image->width
		1289
		1290	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1291
		1292	=item $int = $image->height
		1293
		1294	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1295
		1296	=item $int = $image->depth
		1297
		1298	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1299
		1300	=for gengetinfo end image
		1301
		1302	=for gengetinfo begin gl_texture
		1303
		1304	=item $GLenum = $gl_texture->target
		1305
		1306	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1307
		1308	=item $GLint = $gl_texture->gl_mipmap_level
		1309
		1310	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1311
		1312	=for gengetinfo end gl_texture
		1313
		1314	=back
		1315
519	=head2 THE OpenCL::Sampler CLASS	1316	=head2 THE OpenCL::Sampler CLASS
520		1317
521	=over 4	1318	=over 4
522		1319
523	=item $packed_value = $sampler->info ($name)	1320	=item $packed_value = $sampler->info ($name)
524		1321
525	See C<< $platform->info >> for details.	1322	See C<< $platform->info >> for details.
526		1323
527	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
528		1325
		1326	=for gengetinfo begin sampler
		1327
		1328	=item $uint = $sampler->reference_count
		1329
		1330	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1331
		1332	=item $ctx = $sampler->context
		1333
		1334	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1335
		1336	=item $addressing_mode = $sampler->normalized_coords
		1337
		1338	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1339
		1340	=item $filter_mode = $sampler->addressing_mode
		1341
		1342	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1343
		1344	=item $boolean = $sampler->filter_mode
		1345
		1346	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1347
		1348	=for gengetinfo end sampler
		1349
529	=back	1350	=back
530		1351
531	=head2 THE OpenCL::Program CLASS	1352	=head2 THE OpenCL::Program CLASS
532		1353
533	=over 4	1354	=over 4
534		1355
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
541	=item $program->build ($device, $options = "")	1356	=item $program->build ($device, $options = "")
542		1357
543	Tries to build the program with the givne options.	1358	Tries to build the program with the given options. See also the
		1359	C<$ctx->build> convenience function.
544		1360
545	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1361	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
546		1362
547	=item $packed_value = $program->build_info ($device, $name)	1363	=item $packed_value = $program->build_info ($device, $name)
548		1364
…		…
556	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1372	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
557	the program.	1373	the program.
558		1374
559	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1375	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
560		1376
		1377	=item @kernels = $program->kernels_in_program
		1378
		1379	Returns all kernels successfully compiled for all devices in program.
		1380
		1381	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
		1382
		1383	=for gengetinfo begin program_build
		1384
		1385	=item $build_status = $program->build_status ($device)
		1386
		1387	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1388
		1389	=item $string = $program->build_options ($device)
		1390
		1391	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1392
		1393	=item $string = $program->build_log ($device)
		1394
		1395	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1396
		1397	=for gengetinfo end program_build
		1398
		1399	=item $packed_value = $program->info ($name)
		1400
		1401	See C<< $platform->info >> for details.
		1402
		1403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1404
		1405	=for gengetinfo begin program
		1406
		1407	=item $uint = $program->reference_count
		1408
		1409	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1410
		1411	=item $ctx = $program->context
		1412
		1413	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1414
		1415	=item $uint = $program->num_devices
		1416
		1417	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1418
		1419	=item @devices = $program->devices
		1420
		1421	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1422
		1423	=item $string = $program->source
		1424
		1425	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1426
		1427	=item @ints = $program->binary_sizes
		1428
		1429	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1430
		1431	=for gengetinfo end program
		1432
		1433	=item @blobs = $program->binaries
		1434
		1435	Returns a string for the compiled binary for every device associated with
		1436	the program, empty strings indicate missing programs, and an empty result
		1437	means no program binaries are available.
		1438
		1439	These "binaries" are often, in fact, informative low-level assembly
		1440	sources.
		1441
		1442	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1443
561	=back	1444	=back
562		1445
563	=head2 THE OpenCL::Kernel CLASS	1446	=head2 THE OpenCL::Kernel CLASS
564		1447
565	=over 4	1448	=over 4
…		…
567	=item $packed_value = $kernel->info ($name)	1450	=item $packed_value = $kernel->info ($name)
568		1451
569	See C<< $platform->info >> for details.	1452	See C<< $platform->info >> for details.
570		1453
571	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1454	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1455
		1456	=for gengetinfo begin kernel
		1457
		1458	=item $string = $kernel->function_name
		1459
		1460	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1461
		1462	=item $uint = $kernel->num_args
		1463
		1464	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1465
		1466	=item $uint = $kernel->reference_count
		1467
		1468	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1469
		1470	=item $ctx = $kernel->context
		1471
		1472	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1473
		1474	=item $program = $kernel->program
		1475
		1476	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1477
		1478	=for gengetinfo end kernel
		1479
		1480	=item $packed_value = $kernel->work_group_info ($device, $name)
		1481
		1482	See C<< $platform->info >> for details.
		1483
		1484	The reason this method is not called C<info> is that there already is an
		1485	C<< ->info >> method.
		1486
		1487	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1488
		1489	=for gengetinfo begin kernel_work_group
		1490
		1491	=item $int = $kernel->work_group_size ($device)
		1492
		1493	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1494
		1495	=item @ints = $kernel->compile_work_group_size ($device)
		1496
		1497	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1498
		1499	=item $ulong = $kernel->local_mem_size ($device)
		1500
		1501	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1502
		1503	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1504
		1505	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1506
		1507	=item $ulong = $kernel->private_mem_size ($device)
		1508
		1509	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1510
		1511	=for gengetinfo end kernel_work_group
572		1512
573	=item $kernel->set_TYPE ($index, $value)	1513	=item $kernel->set_TYPE ($index, $value)
574		1514
575	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1515	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
576		1516
577	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,	1517	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
578	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,	1518	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
579	C<image2d>, C<image3d>, C<sampler> or C<event>.	1519	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
580		1520
581	Chars and integers (including the half type) are specified as integers,	1521	Chars and integers (including the half type) are specified as integers,
582	float and double as floating point values, memory/buffer/image2d/image3d	1522	float and double as floating point values, memory/buffer/image2d/image3d
583	must be an object of that type or C<undef>, and sampler and event must be	1523	must be an object of that type or C<undef>, local-memory arguments are
584	objects of that type.	1524	set by specifying the size, and sampler and event must be objects of that
		1525	type.
		1526
		1527	Setting an argument for a kernel does NOT keep a reference to the object -
		1528	for example, if you set an argument to some image object, free the image,
		1529	and call the kernel, you will run into undefined behaviour.
585		1530
586	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1531	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
587		1532
588	=back	1533	=back
589		1534
…		…
592	This is the superclass for all event objects (including OpenCL::UserEvent	1537	This is the superclass for all event objects (including OpenCL::UserEvent
593	objects).	1538	objects).
594		1539
595	=over 4	1540	=over 4
596		1541
		1542	=item $ev->wait
		1543
		1544	Waits for the event to complete.
		1545
		1546	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1547
597	=item $packed_value = $ev->info ($name)	1548	=item $packed_value = $ev->info ($name)
598		1549
599	See C<< $platform->info >> for details.	1550	See C<< $platform->info >> for details.
600		1551
601	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1552	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
602		1553
603	=item $ev->wait	1554	=for gengetinfo begin event
604		1555
605	Waits for the event to complete.	1556	=item $queue = $event->command_queue
606		1557
		1558	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1559
		1560	=item $command_type = $event->command_type
		1561
		1562	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1563
		1564	=item $uint = $event->reference_count
		1565
		1566	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1567
		1568	=item $uint = $event->command_execution_status
		1569
		1570	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1571
		1572	=item $ctx = $event->context
		1573
		1574	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1575
		1576	=for gengetinfo end event
		1577
		1578	=item $packed_value = $ev->profiling_info ($name)
		1579
		1580	See C<< $platform->info >> for details.
		1581
		1582	The reason this method is not called C<info> is that there already is an
		1583	C<< ->info >> method.
		1584
607	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1585	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1586
		1587	=for gengetinfo begin profiling
		1588
		1589	=item $ulong = $event->profiling_command_queued
		1590
		1591	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1592
		1593	=item $ulong = $event->profiling_command_submit
		1594
		1595	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1596
		1597	=item $ulong = $event->profiling_command_start
		1598
		1599	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1600
		1601	=item $ulong = $event->profiling_command_end
		1602
		1603	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1604
		1605	=for gengetinfo end profiling
608		1606
609	=back	1607	=back
610		1608
611	=head2 THE OpenCL::UserEvent CLASS	1609	=head2 THE OpenCL::UserEvent CLASS
612		1610
…		…
619	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1617	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
620		1618
621	=back	1619	=back
622		1620
623	=cut	1621	=cut
624
625	package OpenCL;
626
627	use common::sense;
628
629	BEGIN {
630	our $VERSION = '0.03';
631
632	require XSLoader;
633	XSLoader::load (__PACKAGE__, $VERSION);
634
635	@OpenCL::Buffer::ISA =
636	@OpenCL::Image::ISA = OpenCL::Memory::;
637
638	@OpenCL::Image2D::ISA =
639	@OpenCL::Image3D::ISA = OpenCL::Image::;
640
641	@OpenCL::UserEvent::ISA = OpenCL::Event::;
642	}
643		1622
644	1;	1623	1;
645		1624
646	=head1 AUTHOR	1625	=head1 AUTHOR
647		1626

Diff Legend

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