ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.14 by root, Thu Nov 17 03:02:25 2011 UTC vs.
Revision 1.52 by root, Tue Apr 24 14:24:42 2012 UTC

…		…
27	OpenCL::Program objects, which store source code and, after building for a	27	OpenCL::Program objects, which store source code and, after building for a
28	specific device ("compiling and linking"), also binary programs. For each	28	specific device ("compiling and linking"), also binary programs. For each
29	kernel function in a program you can then create an OpenCL::Kernel object	29	kernel function in a program you can then create an OpenCL::Kernel object
30	which represents 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 (refer to the	73	To get something done, you basically have to do this once (refer to the
60	examples below for actual code, this is just a high-level description):	74	examples below for actual code, this is just a high-level description):
61		75
…		…
87		101
88	Best run this once to get a feel for the platforms and devices in your	102	Best run this once to get a feel for the platforms and devices in your
89	system.	103	system.
90		104
91	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
92	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
93	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
94	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
95	printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
96	my $ctx = $device->context;	110	my $ctx = $platform->context (undef, [$device]);
97	# do stuff	111	# do stuff
98	}	112	}
99	}	113	}
100		114
101	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
…		…
135		149
136	=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
137	functions.	151	functions.
138		152
139	my $src = '	153	my $src = '
140	__kernel void	154	kernel void
141	squareit (__global float *input, __global float *output)	155	squareit (global float *input, global float *output)
142	{	156	{
143	size_t id = get_global_id (0);	157	$id = get_global_id (0);
144	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
145	}	159	}
146	';	160	';
147		161
148	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->build_program ($src);
149
150	# build croaks on compile errors, so catch it and print the compile errors
151	eval { $prog->build ($dev); 1 }
152	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
153
154	my $kernel = $prog->kernel ("squareit");	163	my $kernel = $prog->kernel ("squareit");
155		164
156	=head2 Create some input and output float buffers, then call the	165	=head2 Create some input and output float buffers, then call the
157	'squareit' kernel on them.	166	'squareit' kernel on them.
158		167
…		…
196	# enqueue an async read	205	# enqueue an async read
197	$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);
198		207
199	# wait for the last event to complete	208	# wait for the last event to complete
200	$ev->wait;	209	$ev->wait;
		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	}
201		303
202	=head1 DOCUMENTATION	304	=head1 DOCUMENTATION
203		305
204	=head2 BASIC CONVENTIONS	306	=head2 BASIC CONVENTIONS
205		307
…		…
212		314
213	=item * Object lifetime managament is automatic - there is no need	315	=item * Object lifetime managament is automatic - there is no need
214	to free objects explicitly (C<clReleaseXXX>), the release function	316	to free objects explicitly (C<clReleaseXXX>), the release function
215	is called automatically once all Perl references to it go away.	317	is called automatically once all Perl references to it go away.
216		318
217	=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
218	while this module uses underscores as word separator and often leaves out	321	uses underscores as word separator and often leaves out prefixes
219	prefixes (C<< $platform->info >>).	322	(C<OpenCL::platforms>, C<< $platform->info >>).
220		323
221	=item * OpenCL often specifies fixed vector function arguments as short	324	=item * OpenCL often specifies fixed vector function arguments as short
222	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
223	components as separate arguments-	326	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		327	function calls.
224		328
225	=item * Structures are often specified with their components, and returned	329	=item * Structures are often specified by flattening out their components
226	as arrayrefs.	330	as with short vectors, and returned as arrayrefs.
227
228	=item * Where possible, one of the pitch values is calculated from the
229	perl scalar length and need not be specified.
230		331
231	=item * When enqueuing commands, the wait list is specified by adding	332	=item * When enqueuing commands, the wait list is specified by adding
232	extra arguments to the function - anywhere a C<$wait_events...> argument	333	extra arguments to the function - anywhere a C<$wait_events...> argument
233	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.
234		337
235	=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
236	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
237	by the method.	340	by the method.
238		341
…		…
258	ulong IV - Q	361	ulong IV - Q
259	float NV float f	362	float NV float f
260	half IV ushort S	363	half IV ushort S
261	double NV double d	364	double NV double d
262		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.96';
		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
263	=head2 THE OpenCL PACKAGE	418	=head2 THE OpenCL PACKAGE
264		419
265	=over 4	420	=over 4
266		421
267	=item $int = OpenCL::errno	422	=item $int = OpenCL::errno
…		…
273		428
274	Comverts an error value into a human readable string.	429	Comverts an error value into a human readable string.
275		430
276	=item $str = OpenCL::enum2str $enum	431	=item $str = OpenCL::enum2str $enum
277		432
278	Converts most enum values (inof parameter names, image format constants,	433	Converts most enum values (of parameter names, image format constants,
279	object types, addressing and filter modes, command types etc.) into a	434	object types, addressing and filter modes, command types etc.) into a
280	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
281	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
282	string out of it.	437	string out of it.
283		438
284	=item @platforms = OpenCL::platforms	439	=item @platforms = OpenCL::platforms
285		440
…		…
299		454
300	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>
301		456
302	=back	457	=back
303		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
304	=head2 THE OpenCL::Platform CLASS	482	=head2 THE OpenCL::Platform CLASS
305		483
306	=over 4	484	=over 4
307		485
308	=item $packed_value = $platform->info ($name)
309
310	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
311	strings, this will be the string, for other values you probably need to
312	use the correct C<unpack>. This might get improved in the future. Hopefully.
313
314	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
315
316	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	486	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
317		487
318	Returns a list of matching OpenCL::Device objects.	488	Returns a list of matching OpenCL::Device objects.
319		489
320	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	490	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
321		491
322	Tries to create a context. Never worked for me, and you need devices explitly anyway.	492	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
323		493
324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	494	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
325		495
326	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	496	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
327		497
328	Create a new OpenCL::Context object using the given device object(s)- a	498	Create a new OpenCL::Context object using the given device object(s)- a
329	CL_CONTEXT_PLATFORM property is supplied automatically.	499	CL_CONTEXT_PLATFORM property is supplied automatically.
330		500
331	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	501	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
332		502
		503	=item $packed_value = $platform->info ($name)
		504
		505	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
		506	strings, this will be the string (possibly including terminating \0), for
		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.
		511
		512	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
		513
		514	=item $platform->unload_compiler
		515
		516	Attempts to unload the compiler for this platform, for endless
		517	profit. Does nothing on OpenCL 1.1.
		518
		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
		544
333	=back	545	=back
334		546
335	=head2 THE OpenCL::Device CLASS	547	=head2 THE OpenCL::Device CLASS
336		548
337	=over 4	549	=over 4
…		…
340		552
341	See C<< $platform->info >> for details.	553	See C<< $platform->info >> for details.
342		554
343	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>
344		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
		655	=item $uint = $device->max_samplers
		656
		657	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		658
		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
		824
345	=back	825	=back
346		826
347	=head2 THE OpenCL::Context CLASS	827	=head2 THE OpenCL::Context CLASS
348		828
349	=over 4	829	=over 4
350		830
351	=item $packed_value = $ctx->info ($name)	831	=item $prog = $ctx->build_program ($program, $options = "")
352		832
353	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.
354		836
355	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	$prog = $self->program_with_source ($prog)
		847	unless ref $prog;
		848
		849	for my $dev ($self->devices) {
		850	eval { $prog->build ($dev, $options); 1 }
		851	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
		852	. $prog->build_log ($dev);
		853	}
		854
		855	$prog
		856	}
356		857
357	=item $queue = $ctx->queue ($device, $properties)	858	=item $queue = $ctx->queue ($device, $properties)
358		859
359	Create a new OpenCL::Queue object from the context and the given device.	860	Create a new OpenCL::Queue object from the context and the given device.
360		861
361	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	862	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
362		863
		864	Example: create an out-of-order queue.
		865
		866	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		867
363	=item $ev = $ctx->user_event	868	=item $ev = $ctx->user_event
364		869
365	Creates a new OpenCL::UserEvent object.	870	Creates a new OpenCL::UserEvent object.
366		871
367	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	872	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
368		873
369	=item $buf = $ctx->buffer ($flags, $len)	874	=item $buf = $ctx->buffer ($flags, $len)
370		875
371	Creates a new OpenCL::Buffer object with the given flags and octet-size.	876	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		877	given flags and octet-size.
372		878
373	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	879	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
374		880
375	=item $buf = $ctx->buffer_sv ($flags, $data)	881	=item $buf = $ctx->buffer_sv ($flags, $data)
376		882
377	Creates a new OpenCL::Buffer object and initialise it with the given data values.	883	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		884	initialise it with the given data values.
378		885
		886	=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)
		887
		888	Creates a new OpenCL::Image object and optionally initialises it with
		889	the given data values.
		890
		891	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
		892
379	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	893	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
380		894
381	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	895	Creates a new OpenCL::Image2D object and optionally initialises it with
		896	the given data values.
382		897
383	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	898	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
384		899
385	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	900	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
386		901
387	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	902	Creates a new OpenCL::Image3D object and optionally initialises it with
		903	the given data values.
388		904
389	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	905	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		906
		907	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		908
		909	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		910	OpenGL buffer object.
		911
		912	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		913
		914	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		915
		916	Creates a new OpenCL::Image object that refers to the given OpenGL
		917	texture object or buffer.
		918
		919	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		920
		921	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		922
		923	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		924	2D texture object.
		925
		926	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		927
		928	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		929
		930	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		931	3D texture object.
		932
		933	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		934
		935	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		936
		937	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		938	render buffer.
		939
		940	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
390		941
391	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	942	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
392		943
393	Returns a list of matching image formats - each format is an arrayref with	944	Returns a list of matching image formats - each format is an arrayref with
394	two values, $channel_order and $channel_type, in it.	945	two values, $channel_order and $channel_type, in it.
…		…
404	=item $program = $ctx->program_with_source ($string)	955	=item $program = $ctx->program_with_source ($string)
405		956
406	Creates a new OpenCL::Program object from the given source code.	957	Creates a new OpenCL::Program object from the given source code.
407		958
408	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	959	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		960
		961	=item $packed_value = $ctx->info ($name)
		962
		963	See C<< $platform->info >> for details.
		964
		965	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		966
		967	=for gengetinfo begin context
		968
		969	=item $uint = $context->reference_count
		970
		971	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		972
		973	=item @devices = $context->devices
		974
		975	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		976
		977	=item @property_ints = $context->properties
		978
		979	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		980
		981	=item $uint = $context->num_devices
		982
		983	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		984
		985	=for gengetinfo end context
409		986
410	=back	987	=back
411		988
412	=head2 THE OpenCL::Queue CLASS	989	=head2 THE OpenCL::Queue CLASS
413		990
…		…
419	for completion, unless the method is called in void context, in which case	996	for completion, unless the method is called in void context, in which case
420	no event object is created.	997	no event object is created.
421		998
422	They also allow you to specify any number of other event objects that this	999	They also allow you to specify any number of other event objects that this
423	request has to wait for before it starts executing, by simply passing the	1000	request has to wait for before it starts executing, by simply passing the
424	event objects as extra parameters to the enqueue methods.	1001	event objects as extra parameters to the enqueue methods. To simplify
		1002	program design, this module ignores any C<undef> values in the list of
		1003	events. This makes it possible to code operations such as this, without
		1004	having to put a valid event object into C<$event> first:
		1005
		1006	$event = $queue->enqueue_xxx (..., $event);
425		1007
426	Queues execute in-order by default, without any parallelism, so in most	1008	Queues execute in-order by default, without any parallelism, so in most
427	cases (i.e. you use only one queue) it's not necessary to wait for or	1009	cases (i.e. you use only one queue) it's not necessary to wait for or
428	create event objects.	1010	create event objects, althoguh an our of order queue is often a bit
		1011	faster.
429		1012
430	=over 4	1013	=over 4
431		1014
432	=item $packed_value = $ctx->info ($name)
433
434	See C<< $platform->info >> for details.
435
436	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
437
438	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1015	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
439		1016
440	Reads data from buffer into the given string.	1017	Reads data from buffer into the given string.
441		1018
442	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1019	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
449		1026
450	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1027	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
451		1028
452	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1029	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
453		1030
		1031	=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...)
		1032
		1033	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		1034
		1035	=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...)
		1036
		1037	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		1038
454	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1039	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
455		1040
		1041	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		1042
		1043	=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...)
		1044
456	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1045	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
457		1046
458	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	1047	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
459		1048
460	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1049	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
461		1050
		1051	=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...)
		1052
		1053	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		1054
		1055	=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...)
		1056
		1057	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		1058
462	=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...)	1059	=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...)
463		1060
464	Yeah.	1061	Yeah.
465		1062
466	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
467
468	=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, ...)
469
470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1063	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
471		1064
472	=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, ...)	1065	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
473		1066
		1067	Fills the given buffer object with repeated applications of C<$pattern>,
		1068	starting at C<$offset> for C<$size> octets.
		1069
		1070	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1071
		1072	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1073
		1074	Fills the given image area with the given rgba colour components. The
		1075	components are normally floating point values between C<0> and C<1>,
		1076	except when the image channel data type is a signe dor unsigned
		1077	unnormalised format, in which case the range is determined by the format.
		1078
474	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1079	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
475
476	=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, ...)
477
478	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
479		1080
480	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1081	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
481		1082
482	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1083	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
483		1084
…		…
497	reference to an array of local work sizes, with the same number of	1098	reference to an array of local work sizes, with the same number of
498	elements as @$global_work_size.	1099	elements as @$global_work_size.
499		1100
500	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1101	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
501		1102
502	=item $ev = $queue->enqueue_marker	1103	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
503		1104
		1105	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1106	for subsequent OpenCL usage.
		1107
504	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1108	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		1109
		1110	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		1111
		1112	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1113	for subsequent OpenGL usage.
		1114
		1115	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
505		1116
506	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1117	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
507		1118
508	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1119	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
509		1120
510	=item $queue->enqueue_barrier	1121	=item $ev = $queue->enqueue_marker ($wait_events...)
511		1122
		1123	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1124
		1125	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1126
512	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1127	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
513		1128
514	=item $queue->flush	1129	=item $queue->flush
515		1130
516	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1131	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
517		1132
518	=item $queue->finish	1133	=item $queue->finish
519		1134
520	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	1135	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
521		1136
		1137	=item $packed_value = $queue->info ($name)
		1138
		1139	See C<< $platform->info >> for details.
		1140
		1141	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1142
		1143	=for gengetinfo begin command_queue
		1144
		1145	=item $ctx = $command_queue->context
		1146
		1147	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1148
		1149	=item $device = $command_queue->device
		1150
		1151	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1152
		1153	=item $uint = $command_queue->reference_count
		1154
		1155	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1156
		1157	=item $command_queue_properties = $command_queue->properties
		1158
		1159	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1160
		1161	=for gengetinfo end command_queue
		1162
522	=back	1163	=back
523		1164
524	=head2 THE OpenCL::Memory CLASS	1165	=head2 THE OpenCL::Memory CLASS
525		1166
526	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	1167	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
527	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	1168	OpenCL::Image2D and OpenCL::Image3D.
528	currently only exist to allow type-checking.
529		1169
530	=over 4	1170	=over 4
531		1171
532	=item $packed_value = $memory->info ($name)	1172	=item $packed_value = $memory->info ($name)
533		1173
534	See C<< $platform->info >> for details.	1174	See C<< $platform->info >> for details.
535		1175
536	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1176	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
537		1177
		1178	=for gengetinfo begin mem
		1179
		1180	=item $mem_object_type = $mem->type
		1181
		1182	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1183
		1184	=item $mem_flags = $mem->flags
		1185
		1186	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1187
		1188	=item $int = $mem->size
		1189
		1190	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1191
		1192	=item $ptr_value = $mem->host_ptr
		1193
		1194	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1195
		1196	=item $uint = $mem->map_count
		1197
		1198	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1199
		1200	=item $uint = $mem->reference_count
		1201
		1202	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1203
		1204	=item $ctx = $mem->context
		1205
		1206	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1207
		1208	=item $mem = $mem->associated_memobject
		1209
		1210	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1211
		1212	=item $int = $mem->offset
		1213
		1214	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1215
		1216	=for gengetinfo end mem
		1217
		1218	=item ($type, $name) = $mem->gl_object_info
		1219
		1220	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1221	object "name" (e.g. the texture name) used to create this memory object.
		1222
		1223	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1224
538	=back	1225	=back
539		1226
		1227	=head2 THE OpenCL::Buffer CLASS
		1228
		1229	This is a subclass of OpenCL::Memory, and the superclass of
		1230	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1231	and sub-buffers.
		1232
		1233	=head2 THE OpenCL::BufferObj CLASS
		1234
		1235	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1236	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1237	sub buffers from these sub buffers.
		1238
		1239	=over 4
		1240
		1241	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1242
		1243	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1244	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1245
		1246	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1247
		1248	=back
		1249
		1250	=head2 THE OpenCL::Image CLASS
		1251
		1252	This is the superclass of all image objects - OpenCL::Image1D,
		1253	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1254	OpenCL::Image2DArray and OpenCL::Image3D.
		1255
		1256	=over 4
		1257
		1258	=item $packed_value = $ev->image_info ($name)
		1259
		1260	See C<< $platform->info >> for details.
		1261
		1262	The reason this method is not called C<info> is that there already is an
		1263	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1264
		1265	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1266
		1267	=for gengetinfo begin image
		1268
		1269	=item $int = $image->element_size
		1270
		1271	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1272
		1273	=item $int = $image->row_pitch
		1274
		1275	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1276
		1277	=item $int = $image->slice_pitch
		1278
		1279	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1280
		1281	=item $int = $image->width
		1282
		1283	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1284
		1285	=item $int = $image->height
		1286
		1287	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1288
		1289	=item $int = $image->depth
		1290
		1291	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1292
		1293	=for gengetinfo end image
		1294
		1295	=for gengetinfo begin gl_texture
		1296
		1297	=item $GLenum = $gl_texture->target
		1298
		1299	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1300
		1301	=item $GLint = $gl_texture->gl_mipmap_level
		1302
		1303	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1304
		1305	=for gengetinfo end gl_texture
		1306
		1307	=back
		1308
540	=head2 THE OpenCL::Sampler CLASS	1309	=head2 THE OpenCL::Sampler CLASS
541		1310
542	=over 4	1311	=over 4
543		1312
544	=item $packed_value = $sampler->info ($name)	1313	=item $packed_value = $sampler->info ($name)
545		1314
546	See C<< $platform->info >> for details.	1315	See C<< $platform->info >> for details.
547		1316
548	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1317	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
549		1318
		1319	=for gengetinfo begin sampler
		1320
		1321	=item $uint = $sampler->reference_count
		1322
		1323	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1324
		1325	=item $ctx = $sampler->context
		1326
		1327	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1328
		1329	=item $addressing_mode = $sampler->normalized_coords
		1330
		1331	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1332
		1333	=item $filter_mode = $sampler->addressing_mode
		1334
		1335	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1336
		1337	=item $boolean = $sampler->filter_mode
		1338
		1339	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1340
		1341	=for gengetinfo end sampler
		1342
550	=back	1343	=back
551		1344
552	=head2 THE OpenCL::Program CLASS	1345	=head2 THE OpenCL::Program CLASS
553		1346
554	=over 4	1347	=over 4
555		1348
556	=item $packed_value = $program->info ($name)
557
558	See C<< $platform->info >> for details.
559
560	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
561
562	=item $program->build ($device, $options = "")	1349	=item $program->build ($device, $options = "")
563		1350
564	Tries to build the program with the givne options.	1351	Tries to build the program with the given options. See also the
		1352	C<$ctx->build> convenience function.
565		1353
566	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1354	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
567		1355
568	=item $packed_value = $program->build_info ($device, $name)	1356	=item $packed_value = $program->build_info ($device, $name)
569		1357
…		…
577	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1365	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
578	the program.	1366	the program.
579		1367
580	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1368	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
581		1369
		1370	=item @kernels = $program->kernels_in_program
		1371
		1372	Returns all kernels successfully compiled for all devices in program.
		1373
		1374	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
		1375
		1376	=for gengetinfo begin program_build
		1377
		1378	=item $build_status = $program->build_status ($device)
		1379
		1380	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1381
		1382	=item $string = $program->build_options ($device)
		1383
		1384	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1385
		1386	=item $string = $program->build_log ($device)
		1387
		1388	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1389
		1390	=for gengetinfo end program_build
		1391
		1392	=item $packed_value = $program->info ($name)
		1393
		1394	See C<< $platform->info >> for details.
		1395
		1396	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1397
		1398	=for gengetinfo begin program
		1399
		1400	=item $uint = $program->reference_count
		1401
		1402	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1403
		1404	=item $ctx = $program->context
		1405
		1406	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1407
		1408	=item $uint = $program->num_devices
		1409
		1410	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1411
		1412	=item @devices = $program->devices
		1413
		1414	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1415
		1416	=item $string = $program->source
		1417
		1418	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1419
		1420	=item @ints = $program->binary_sizes
		1421
		1422	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1423
		1424	=for gengetinfo end program
		1425
		1426	=item @blobs = $program->binaries
		1427
		1428	Returns a string for the compiled binary for every device associated with
		1429	the program, empty strings indicate missing programs, and an empty result
		1430	means no program binaries are available.
		1431
		1432	These "binaries" are often, in fact, informative low-level assembly
		1433	sources.
		1434
		1435	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1436
582	=back	1437	=back
583		1438
584	=head2 THE OpenCL::Kernel CLASS	1439	=head2 THE OpenCL::Kernel CLASS
585		1440
586	=over 4	1441	=over 4
…		…
588	=item $packed_value = $kernel->info ($name)	1443	=item $packed_value = $kernel->info ($name)
589		1444
590	See C<< $platform->info >> for details.	1445	See C<< $platform->info >> for details.
591		1446
592	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1447	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1448
		1449	=for gengetinfo begin kernel
		1450
		1451	=item $string = $kernel->function_name
		1452
		1453	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1454
		1455	=item $uint = $kernel->num_args
		1456
		1457	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1458
		1459	=item $uint = $kernel->reference_count
		1460
		1461	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1462
		1463	=item $ctx = $kernel->context
		1464
		1465	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1466
		1467	=item $program = $kernel->program
		1468
		1469	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1470
		1471	=for gengetinfo end kernel
		1472
		1473	=item $packed_value = $kernel->work_group_info ($device, $name)
		1474
		1475	See C<< $platform->info >> for details.
		1476
		1477	The reason this method is not called C<info> is that there already is an
		1478	C<< ->info >> method.
		1479
		1480	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1481
		1482	=for gengetinfo begin kernel_work_group
		1483
		1484	=item $int = $kernel->work_group_size ($device)
		1485
		1486	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1487
		1488	=item @ints = $kernel->compile_work_group_size ($device)
		1489
		1490	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1491
		1492	=item $ulong = $kernel->local_mem_size ($device)
		1493
		1494	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1495
		1496	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1497
		1498	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1499
		1500	=item $ulong = $kernel->private_mem_size ($device)
		1501
		1502	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1503
		1504	=for gengetinfo end kernel_work_group
593		1505
594	=item $kernel->set_TYPE ($index, $value)	1506	=item $kernel->set_TYPE ($index, $value)
595		1507
596	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1508	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
597		1509
598	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,	1510	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
599	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,	1511	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
600	C<image2d>, C<image3d>, C<sampler> or C<event>.	1512	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
601		1513
602	Chars and integers (including the half type) are specified as integers,	1514	Chars and integers (including the half type) are specified as integers,
603	float and double as floating point values, memory/buffer/image2d/image3d	1515	float and double as floating point values, memory/buffer/image2d/image3d
604	must be an object of that type or C<undef>, and sampler and event must be	1516	must be an object of that type or C<undef>, local-memory arguments are
605	objects of that type.	1517	set by specifying the size, and sampler and event must be objects of that
		1518	type.
		1519
		1520	Setting an argument for a kernel does NOT keep a reference to the object -
		1521	for example, if you set an argument to some image object, free the image,
		1522	and call the kernel, you will run into undefined behaviour.
606		1523
607	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1524	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
608		1525
609	=back	1526	=back
610		1527
…		…
613	This is the superclass for all event objects (including OpenCL::UserEvent	1530	This is the superclass for all event objects (including OpenCL::UserEvent
614	objects).	1531	objects).
615		1532
616	=over 4	1533	=over 4
617		1534
		1535	=item $ev->wait
		1536
		1537	Waits for the event to complete.
		1538
		1539	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1540
618	=item $packed_value = $ev->info ($name)	1541	=item $packed_value = $ev->info ($name)
619		1542
620	See C<< $platform->info >> for details.	1543	See C<< $platform->info >> for details.
621		1544
622	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1545	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
623		1546
624	=item $ev->wait	1547	=for gengetinfo begin event
625		1548
626	Waits for the event to complete.	1549	=item $queue = $event->command_queue
627		1550
		1551	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1552
		1553	=item $command_type = $event->command_type
		1554
		1555	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1556
		1557	=item $uint = $event->reference_count
		1558
		1559	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1560
		1561	=item $uint = $event->command_execution_status
		1562
		1563	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1564
		1565	=item $ctx = $event->context
		1566
		1567	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1568
		1569	=for gengetinfo end event
		1570
		1571	=item $packed_value = $ev->profiling_info ($name)
		1572
		1573	See C<< $platform->info >> for details.
		1574
		1575	The reason this method is not called C<info> is that there already is an
		1576	C<< ->info >> method.
		1577
628	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1578	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1579
		1580	=for gengetinfo begin profiling
		1581
		1582	=item $ulong = $event->profiling_command_queued
		1583
		1584	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1585
		1586	=item $ulong = $event->profiling_command_submit
		1587
		1588	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1589
		1590	=item $ulong = $event->profiling_command_start
		1591
		1592	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1593
		1594	=item $ulong = $event->profiling_command_end
		1595
		1596	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1597
		1598	=for gengetinfo end profiling
629		1599
630	=back	1600	=back
631		1601
632	=head2 THE OpenCL::UserEvent CLASS	1602	=head2 THE OpenCL::UserEvent CLASS
633		1603
…		…
640	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1610	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
641		1611
642	=back	1612	=back
643		1613
644	=cut	1614	=cut
645
646	package OpenCL;
647
648	use common::sense;
649
650	BEGIN {
651	our $VERSION = '0.14';
652
653	require XSLoader;
654	XSLoader::load (__PACKAGE__, $VERSION);
655
656	@OpenCL::Buffer::ISA =
657	@OpenCL::Image::ISA = OpenCL::Memory::;
658
659	@OpenCL::Image2D::ISA =
660	@OpenCL::Image3D::ISA = OpenCL::Image::;
661
662	@OpenCL::UserEvent::ISA = OpenCL::Event::;
663	}
664		1615
665	1;	1616	1;
666		1617
667	=head1 AUTHOR	1618	=head1 AUTHOR
668		1619

Diff Legend

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