ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.59 by root, Wed Apr 25 20:49:13 2012 UTC vs.
Revision 1.79 by root, Sat May 5 13:30:07 2012 UTC

…		…
43		43
44	OpenCL::Event objects are used to signal when something is complete.	44	OpenCL::Event objects are used to signal when something is complete.
45		45
46	=head2 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
47		47
48	The OpenCL specs used to develop this module:	48	The OpenCL specs used to develop this module - download these and keept
		49	hema round, they are required reference material:
49		50
50	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf	52	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf	53	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53		54
…		…
95	initialised at creation time).	96	initialised at creation time).
96		97
97	Enqueue the kernel execution.	98	Enqueue the kernel execution.
98		99
99	Enqueue buffer reads for your output buffer to read results.	100	Enqueue buffer reads for your output buffer to read results.
		101
		102	=head1 OPENCL 1.1 VS. OPENCL 1.2
		103
		104	This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
		105	1.2 interface hasn't been tested much for lack of availability of an
		106	actual implementation.
		107
		108	Every function or method in this manual page that interfaces to a
		109	particular OpenCL function has a link to the its C manual page.
		110
		111	If the link contains a F<1.1>, then this function is an OpenCL 1.1
		112	function. Most but not all also exist in OpenCL 1.2, and this module
		113	tries to emulate the missing ones for you, when told to do so at
		114	compiletime. You cna check whether a function was removed in OpenCL 1.2 by
		115	replacing the F<1.1> component in the URL by F<1.2>.
		116
		117	If the link contains a F<1.2>, then this is a OpenCL 1.2-only
		118	function. Even if the module was compiled with OpenCL 1.2 header files
		119	and has an 1.2 OpenCL library, calling such a function on a platform that
		120	doesn't implement 1.2 causes undefined behaviour, usually a crash (But
		121	this is not guaranteed).
		122
		123	You can find out whether this module was compiled to prefer 1.1
		124	functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
		125	1.1 functions generally are implemented using 1.1 OpenCL functions. If it
		126	is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
		127	fucntions.
		128
		129	This is a somewhat sorry state of affairs, but the Khronos group choose to
		130	make every release of OpenCL source and binary incompatible with previous
		131	releases.
100		132
101	=head1 EXAMPLES	133	=head1 EXAMPLES
102		134
103	=head2 Enumerate all devices and get contexts for them.	135	=head2 Enumerate all devices and get contexts for them.
104		136
…		…
210		242
211	# wait for the last event to complete	243	# wait for the last event to complete
212	$ev->wait;	244	$ev->wait;
213		245
214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia	246	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215	set tunnel effect.	247	set flight effect.
216		248
217	This is quite a long example to get you going.	249	This is quite a long example to get you going - you can download it from
		250	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
218		251
219	use OpenGL ":all";	252	use OpenGL ":all";
220	use OpenCL;	253	use OpenCL;
221		254
		255	my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
		256
222	# open a window and create a gl texture	257	# open a window and create a gl texture
223	OpenGL::glpOpenWindow width => 256, height => 256;	258	OpenGL::glpOpenWindow width => $S, height => $S;
224	my $texid = glGenTextures_p 1;	259	my $texid = glGenTextures_p 1;
225	glBindTexture GL_TEXTURE_2D, $texid;	260	glBindTexture GL_TEXTURE_2D, $texid;
226	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;	261	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
227		262
228	# find and use the first opencl device that let's us get a shared opengl context	263	# find and use the first opencl device that let's us get a shared opengl context
229	my $platform;	264	my $platform;
230	my $dev;	265	my $dev;
231	my $ctx;	266	my $ctx;
…		…
250	# now the boring opencl code	285	# now the boring opencl code
251	my $src = <<EOF;	286	my $src = <<EOF;
252	kernel void	287	kernel void
253	juliatunnel (write_only image2d_t img, float time)	288	juliatunnel (write_only image2d_t img, float time)
254	{	289	{
255	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;	290	int2 xy = (int2)(get_global_id (0), get_global_id (1));
		291	float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
256		292
257	float2 m = (float2)(1.f, p.y) / fabs (p.x);	293	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
258	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;	294	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
259		295
260	float2 z = m;	296	float2 z = m;
261	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	297	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
262		298
263	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)	299	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
264	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;	300	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
265		301
266	float3 colour = (float3)(z.x, z.y, z.x * z.y);	302	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
267	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));	303	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
268	}	304	}
269	EOF	305	EOF
270		306
271	my $prog = $ctx->build_program ($src);	307	my $prog = $ctx->build_program ($src);
272	my $kernel = $prog->kernel ("juliatunnel");	308	my $kernel = $prog->kernel ("juliatunnel");
…		…
276	for (my $time; ; ++$time) {	312	for (my $time; ; ++$time) {
277	# acquire objects from opengl	313	# acquire objects from opengl
278	$queue->acquire_gl_objects ([$tex]);	314	$queue->acquire_gl_objects ([$tex]);
279		315
280	# configure and run our kernel	316	# configure and run our kernel
281	$kernel->set_image2d (0, $tex);	317	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
282	$kernel->set_float (1, $time);
283	$queue->nd_range_kernel ($kernel, undef, [256, 256], undef);	318	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
284		319
285	# release objects to opengl again	320	# release objects to opengl again
286	$queue->release_gl_objects ([$tex]);	321	$queue->release_gl_objects ([$tex]);
287		322
288	# wait	323	# wait
…		…
302	glXSwapBuffers;	337	glXSwapBuffers;
303		338
304	select undef, undef, undef, 1/60;	339	select undef, undef, undef, 1/60;
305	}	340	}
306		341
		342	=head2 How to modify the previous example to not rely on GL sharing.
		343
		344	For those poor souls with only a sucky CPU OpenCL implementation, you
		345	currently have to read the image into some perl scalar, and then modify a
		346	texture or use glDrawPixels or so).
		347
		348	First, when you don't need gl sharing, you can create the context much simpler:
		349
		350	$ctx = $platform->context (undef, [$dev])
		351
		352	To use a texture, you would modify the above example by creating an
		353	OpenCL::Image manually instead of deriving it from a texture:
		354
		355	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
		356
		357	And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
		358	would read the image2d after the kernel has written it:
		359
		360	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
		361
		362	And then you would upload the pixel data to the texture (or use glDrawPixels):
		363
		364	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
		365
		366	The fully modified example can be found at
		367	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
		368
		369	=head2 Julia sets look soooo 80ies.
		370
		371	Then colour them differently, e.g. using orbit traps! Replace the loop and
		372	colour calculation from the previous examples by this:
		373
		374	float2 dm = (float2)(1.f, 1.f);
		375
		376	for (int i = 0; i < 25; ++i)
		377	{
		378	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		379	dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
		380	}
		381
		382	float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
		383
		384	Also try C<-10.f> instead of C<-1.f>.
		385
307	=head1 DOCUMENTATION	386	=head1 DOCUMENTATION
308		387
309	=head2 BASIC CONVENTIONS	388	=head2 BASIC CONVENTIONS
310		389
311	This is not a one-to-one C-style translation of OpenCL to Perl - instead	390	This is not a one-to-one C-style translation of OpenCL to Perl - instead
…		…
340		419
341	=item * When enqueuing commands, if the enqueue method is called in void	420	=item * When enqueuing commands, if the enqueue method is called in void
342	context, no event is created. In all other contexts an event is returned	421	context, no event is created. In all other contexts an event is returned
343	by the method.	422	by the method.
344		423
345	=item * This module expects all functions to return C<CL_SUCCESS>. If any	424	=item * This module expects all functions to return C<OpenCL::SUCCESS>. If any
346	other status is returned the function will throw an exception, so you	425	other status is returned the function will throw an exception, so you
347	don't normally have to to any error checking.	426	don't normally have to to any error checking.
348		427
349	=back	428	=back
350		429
…		…
386	OpenCL can generate a number of (potentially) asynchronous events, for	465	OpenCL can generate a number of (potentially) asynchronous events, for
387	example, after compiling a program, to signal a context-related error or,	466	example, after compiling a program, to signal a context-related error or,
388	perhaps most important, to signal completion of queued jobs (by setting	467	perhaps most important, to signal completion of queued jobs (by setting
389	callbacks on OpenCL::Event objects).	468	callbacks on OpenCL::Event objects).
390		469
		470	The OpenCL module converts all these callbacks into events - you can
		471	still register callbacks, but they are not executed when your OpenCL
		472	implementation calls the actual callback, but only later. Therefore, none
		473	of the limitations of OpenCL callbacks apply to the perl implementation:
		474	it is perfectly safe to make blocking operations from event callbacks, and
		475	enqueued operations don't need to be flushed.
		476
391	To facilitate this, this module maintains an event queue - each	477	To facilitate this, this module maintains an event queue - each
392	time an asynchronous event happens, it is queued, and perl will be	478	time an asynchronous event happens, it is queued, and perl will be
393	interrupted. This is implemented via the L<Async::Interrupt> module. In	479	interrupted. This is implemented via the L<Async::Interrupt> module. In
394	addition, this module has L<AnyEvent> support, so it can seamlessly	480	addition, this module has L<AnyEvent> support, so it can seamlessly
395	integrate itself into many event loops.	481	integrate itself into many event loops.
396		482
397	Since this module is a bit hard to understand, here are some case examples:	483	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
398		484
399	=head3 Don't use callbacks.	485	=head3 Don't use callbacks.
400		486
401	When your program never uses any callbacks, then there will never be any	487	When your program never uses any callbacks, then there will never be any
402	notifications you need to take care of, and therefore no need to worry	488	notifications you need to take care of, and therefore no need to worry
…		…
493	=cut	579	=cut
494		580
495	package OpenCL;	581	package OpenCL;
496		582
497	use common::sense;	583	use common::sense;
		584	use Carp ();
498	use Async::Interrupt ();	585	use Async::Interrupt ();
499		586
500	our $POLL_FUNC; # set by XS	587	our $POLL_FUNC; # set by XS
501		588
502	BEGIN {	589	BEGIN {
503	our $VERSION = '0.97';	590	our $VERSION = '0.99';
504		591
505	require XSLoader;	592	require XSLoader;
506	XSLoader::load (__PACKAGE__, $VERSION);	593	XSLoader::load (__PACKAGE__, $VERSION);
507		594
508	@OpenCL::Platform::ISA =	595	@OpenCL::Platform::ISA =
…		…
513	@OpenCL::Sampler::ISA =	600	@OpenCL::Sampler::ISA =
514	@OpenCL::Program::ISA =	601	@OpenCL::Program::ISA =
515	@OpenCL::Kernel::ISA =	602	@OpenCL::Kernel::ISA =
516	@OpenCL::Event::ISA = OpenCL::Object::;	603	@OpenCL::Event::ISA = OpenCL::Object::;
517		604
		605	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		606
518	@OpenCL::Buffer::ISA =	607	@OpenCL::Buffer::ISA =
519	@OpenCL::Image::ISA = OpenCL::Memory::;	608	@OpenCL::Image::ISA = OpenCL::Memory::;
520		609
521	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	610	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
522		611
…		…
526	@OpenCL::Image1D::ISA =	615	@OpenCL::Image1D::ISA =
527	@OpenCL::Image1DArray::ISA =	616	@OpenCL::Image1DArray::ISA =
528	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	617	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
529		618
530	@OpenCL::UserEvent::ISA = OpenCL::Event::;	619	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		620
		621	@OpenCL::MappedBuffer::ISA =
		622	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
531	}	623	}
532		624
533	=head2 THE OpenCL PACKAGE	625	=head2 THE OpenCL PACKAGE
534		626
535	=over 4	627	=over 4
…		…
537	=item $int = OpenCL::errno	629	=item $int = OpenCL::errno
538		630
539	The last error returned by a function - it's only valid after an error occured	631	The last error returned by a function - it's only valid after an error occured
540	and before calling another OpenCL function.	632	and before calling another OpenCL function.
541		633
542	=item $str = OpenCL::err2str $errval	634	=item $str = OpenCL::err2str [$errval]
543		635
544	Comverts an error value into a human readable string.	636	Converts an error value into a human readable string. IF no error value is
		637	given, then the last error will be used (as returned by OpenCL::errno).
545		638
546	=item $str = OpenCL::enum2str $enum	639	=item $str = OpenCL::enum2str $enum
547		640
548	Converts most enum values (of parameter names, image format constants,	641	Converts most enum values (of parameter names, image format constants,
549	object types, addressing and filter modes, command types etc.) into a	642	object types, addressing and filter modes, command types etc.) into a
…		…
558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	651	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
559		652
560	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	653	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
561		654
562	Tries to create a context from a default device and platform type - never worked for me.	655	Tries to create a context from a default device and platform type - never worked for me.
		656	Consider using C<< $platform->context_from_type >> instead.
		657
		658	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		659	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
563		660
564	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	661	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
565		662
566	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	663	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
567		664
568	Create a new OpenCL::Context object using the given device object(s). This	665	Create a new OpenCL::Context object using the given device object(s).
569	function isn't implemented yet, use C<< $platform->context >> instead.	666	Consider using C<< $platform->context >> instead.
570		667
571	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	668	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
572		669
573	=item OpenCL::wait_for_events $wait_events...	670	=item OpenCL::wait_for_events $wait_events...
574		671
…		…
655	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	752	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
656		753
657	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)	754	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
658		755
659	Create a new OpenCL::Context object using the given device object(s)- a	756	Create a new OpenCL::Context object using the given device object(s)- a
660	CL_CONTEXT_PLATFORM property is supplied automatically.	757	OpenCL::CONTEXT_PLATFORM property is supplied automatically.
661		758
662	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	759	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
663		760
664	=item $packed_value = $platform->info ($name)	761	=item $packed_value = $platform->info ($name)
665		762
…		…
681		778
682	=for gengetinfo begin platform	779	=for gengetinfo begin platform
683		780
684	=item $string = $platform->profile	781	=item $string = $platform->profile
685		782
686	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	783	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
687		784
688	=item $string = $platform->version	785	=item $string = $platform->version
689		786
690	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	787	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
691		788
692	=item $string = $platform->name	789	=item $string = $platform->name
693		790
694	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	791	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
695		792
696	=item $string = $platform->vendor	793	=item $string = $platform->vendor
697		794
698	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	795	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
699		796
700	=item $string = $platform->extensions	797	=item $string = $platform->extensions
701		798
702	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	799	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
703		800
704	=for gengetinfo end platform	801	=for gengetinfo end platform
705		802
706	=back	803	=back
707		804
…		…
711		808
712	=item $packed_value = $device->info ($name)	809	=item $packed_value = $device->info ($name)
713		810
714	See C<< $platform->info >> for details.	811	See C<< $platform->info >> for details.
715		812
		813	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
		814	OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
		815	OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
		816
		817	fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
		818	OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
		819	OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
		820
		821	mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
		822
		823	local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
		824
		825	exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
		826
		827	command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
		828	OpenCL::QUEUE_PROFILING_ENABLE.
		829
		830	partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
		831	OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
		832	OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
		833
		834	affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
		835	OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
		836	OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
		837	OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
		838
716	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	839	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
717		840
		841	=item @devices = $device->sub_devices (\@properties)
		842
		843	Creates OpencL::SubDevice objects by partitioning an existing device.
		844
		845	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		846
718	=for gengetinfo begin device	847	=for gengetinfo begin device
719		848
720	=item $device_type = $device->type	849	=item $device_type = $device->type
721		850
722	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	851	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
723		852
724	=item $uint = $device->vendor_id	853	=item $uint = $device->vendor_id
725		854
726	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	855	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
727		856
728	=item $uint = $device->max_compute_units	857	=item $uint = $device->max_compute_units
729		858
730	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	859	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
731		860
732	=item $uint = $device->max_work_item_dimensions	861	=item $uint = $device->max_work_item_dimensions
733		862
734	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	863	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
735		864
736	=item $int = $device->max_work_group_size	865	=item $int = $device->max_work_group_size
737		866
738	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	867	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
739		868
740	=item @ints = $device->max_work_item_sizes	869	=item @ints = $device->max_work_item_sizes
741		870
742	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	871	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
743		872
744	=item $uint = $device->preferred_vector_width_char	873	=item $uint = $device->preferred_vector_width_char
745		874
746	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	875	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
747		876
748	=item $uint = $device->preferred_vector_width_short	877	=item $uint = $device->preferred_vector_width_short
749		878
750	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	879	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
751		880
752	=item $uint = $device->preferred_vector_width_int	881	=item $uint = $device->preferred_vector_width_int
753		882
754	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	883	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
755		884
756	=item $uint = $device->preferred_vector_width_long	885	=item $uint = $device->preferred_vector_width_long
757		886
758	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	887	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
759		888
760	=item $uint = $device->preferred_vector_width_float	889	=item $uint = $device->preferred_vector_width_float
761		890
762	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	891	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
763		892
764	=item $uint = $device->preferred_vector_width_double	893	=item $uint = $device->preferred_vector_width_double
765		894
766	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	895	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
767		896
768	=item $uint = $device->max_clock_frequency	897	=item $uint = $device->max_clock_frequency
769		898
770	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	899	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
771		900
772	=item $bitfield = $device->address_bits	901	=item $bitfield = $device->address_bits
773		902
774	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	903	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
775		904
776	=item $uint = $device->max_read_image_args	905	=item $uint = $device->max_read_image_args
777		906
778	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	907	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
779		908
780	=item $uint = $device->max_write_image_args	909	=item $uint = $device->max_write_image_args
781		910
782	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	911	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
783		912
784	=item $ulong = $device->max_mem_alloc_size	913	=item $ulong = $device->max_mem_alloc_size
785		914
786	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	915	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
787		916
788	=item $int = $device->image2d_max_width	917	=item $int = $device->image2d_max_width
789		918
790	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	919	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
791		920
792	=item $int = $device->image2d_max_height	921	=item $int = $device->image2d_max_height
793		922
794	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	923	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
795		924
796	=item $int = $device->image3d_max_width	925	=item $int = $device->image3d_max_width
797		926
798	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	927	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
799		928
800	=item $int = $device->image3d_max_height	929	=item $int = $device->image3d_max_height
801		930
802	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	931	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
803		932
804	=item $int = $device->image3d_max_depth	933	=item $int = $device->image3d_max_depth
805		934
806	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	935	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
807		936
808	=item $uint = $device->image_support	937	=item $uint = $device->image_support
809		938
810	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	939	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
811		940
812	=item $int = $device->max_parameter_size	941	=item $int = $device->max_parameter_size
813		942
814	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	943	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
815		944
816	=item $uint = $device->max_samplers	945	=item $uint = $device->max_samplers
817		946
818	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	947	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
819		948
820	=item $uint = $device->mem_base_addr_align	949	=item $uint = $device->mem_base_addr_align
821		950
822	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	951	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
823		952
824	=item $uint = $device->min_data_type_align_size	953	=item $uint = $device->min_data_type_align_size
825		954
826	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	955	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
827		956
828	=item $device_fp_config = $device->single_fp_config	957	=item $device_fp_config = $device->single_fp_config
829		958
830	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	959	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
831		960
832	=item $device_mem_cache_type = $device->global_mem_cache_type	961	=item $device_mem_cache_type = $device->global_mem_cache_type
833		962
834	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	963	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
835		964
836	=item $uint = $device->global_mem_cacheline_size	965	=item $uint = $device->global_mem_cacheline_size
837		966
838	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	967	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
839		968
840	=item $ulong = $device->global_mem_cache_size	969	=item $ulong = $device->global_mem_cache_size
841		970
842	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	971	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
843		972
844	=item $ulong = $device->global_mem_size	973	=item $ulong = $device->global_mem_size
845		974
846	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	975	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
847		976
848	=item $ulong = $device->max_constant_buffer_size	977	=item $ulong = $device->max_constant_buffer_size
849		978
850	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	979	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
851		980
852	=item $uint = $device->max_constant_args	981	=item $uint = $device->max_constant_args
853		982
854	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	983	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
855		984
856	=item $device_local_mem_type = $device->local_mem_type	985	=item $device_local_mem_type = $device->local_mem_type
857		986
858	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	987	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
859		988
860	=item $ulong = $device->local_mem_size	989	=item $ulong = $device->local_mem_size
861		990
862	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	991	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
863		992
864	=item $boolean = $device->error_correction_support	993	=item $boolean = $device->error_correction_support
865		994
866	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	995	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
867		996
868	=item $int = $device->profiling_timer_resolution	997	=item $int = $device->profiling_timer_resolution
869		998
870	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	999	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
871		1000
872	=item $boolean = $device->endian_little	1001	=item $boolean = $device->endian_little
873		1002
874	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	1003	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
875		1004
876	=item $boolean = $device->available	1005	=item $boolean = $device->available
877		1006
878	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	1007	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
879		1008
880	=item $boolean = $device->compiler_available	1009	=item $boolean = $device->compiler_available
881		1010
882	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	1011	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
883		1012
884	=item $device_exec_capabilities = $device->execution_capabilities	1013	=item $device_exec_capabilities = $device->execution_capabilities
885		1014
886	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	1015	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
887		1016
888	=item $command_queue_properties = $device->properties	1017	=item $command_queue_properties = $device->properties
889		1018
890	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	1019	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
891		1020
892	=item $ = $device->platform	1021	=item $ = $device->platform
893		1022
894	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	1023	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
895		1024
896	=item $string = $device->name	1025	=item $string = $device->name
897		1026
898	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	1027	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
899		1028
900	=item $string = $device->vendor	1029	=item $string = $device->vendor
901		1030
902	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	1031	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
903		1032
904	=item $string = $device->driver_version	1033	=item $string = $device->driver_version
905		1034
906	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	1035	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
907		1036
908	=item $string = $device->profile	1037	=item $string = $device->profile
909		1038
910	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	1039	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
911		1040
912	=item $string = $device->version	1041	=item $string = $device->version
913		1042
914	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	1043	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
915		1044
916	=item $string = $device->extensions	1045	=item $string = $device->extensions
917		1046
918	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	1047	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
919		1048
920	=item $uint = $device->preferred_vector_width_half	1049	=item $uint = $device->preferred_vector_width_half
921		1050
922	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	1051	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
923		1052
924	=item $uint = $device->native_vector_width_char	1053	=item $uint = $device->native_vector_width_char
925		1054
926	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	1055	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
927		1056
928	=item $uint = $device->native_vector_width_short	1057	=item $uint = $device->native_vector_width_short
929		1058
930	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1059	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
931		1060
932	=item $uint = $device->native_vector_width_int	1061	=item $uint = $device->native_vector_width_int
933		1062
934	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1063	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
935		1064
936	=item $uint = $device->native_vector_width_long	1065	=item $uint = $device->native_vector_width_long
937		1066
938	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1067	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
939		1068
940	=item $uint = $device->native_vector_width_float	1069	=item $uint = $device->native_vector_width_float
941		1070
942	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1071	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
943		1072
944	=item $uint = $device->native_vector_width_double	1073	=item $uint = $device->native_vector_width_double
945		1074
946	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1075	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
947		1076
948	=item $uint = $device->native_vector_width_half	1077	=item $uint = $device->native_vector_width_half
949		1078
950	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1079	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
951		1080
952	=item $device_fp_config = $device->double_fp_config	1081	=item $device_fp_config = $device->double_fp_config
953		1082
954	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1083	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
955		1084
956	=item $device_fp_config = $device->half_fp_config	1085	=item $device_fp_config = $device->half_fp_config
957		1086
958	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1087	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
959		1088
960	=item $boolean = $device->host_unified_memory	1089	=item $boolean = $device->host_unified_memory
961		1090
962	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1091	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
963		1092
964	=item $device = $device->parent_device_ext	1093	=item $device = $device->parent_device_ext
965		1094
966	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1095	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
967		1096
968	=item @device_partition_property_exts = $device->partition_types_ext	1097	=item @device_partition_property_exts = $device->partition_types_ext
969		1098
970	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1099	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
971		1100
972	=item @device_partition_property_exts = $device->affinity_domains_ext	1101	=item @device_partition_property_exts = $device->affinity_domains_ext
973		1102
974	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1103	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
975		1104
976	=item $uint = $device->reference_count_ext	1105	=item $uint = $device->reference_count_ext
977		1106
978	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1107	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
979		1108
980	=item @device_partition_property_exts = $device->partition_style_ext	1109	=item @device_partition_property_exts = $device->partition_style_ext
981		1110
982	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1111	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
983		1112
984	=for gengetinfo end device	1113	=for gengetinfo end device
985		1114
986	=back	1115	=back
987		1116
988	=head2 THE OpenCL::Context CLASS	1117	=head2 THE OpenCL::Context CLASS
		1118
		1119	An OpenCL::Context is basically a container, or manager, for a number of
		1120	devices of a platform. It is used to create all sorts of secondary objects
		1121	such as buffers, queues, programs and so on.
		1122
		1123	All context creation functions and methods take a list of properties
		1124	(type-value pairs). All property values can be specified as integers -
		1125	some additionally support other types:
		1126
		1127	=over 4
		1128
		1129	=item OpenCL::CONTEXT_PLATFORM
		1130
		1131	Also accepts OpenCL::Platform objects.
		1132
		1133	=item OpenCL::GLX_DISPLAY_KHR
		1134
		1135	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1136	to find the current glx display (see L<GLX SUPPORT>).
		1137
		1138	=item OpenCL::GL_CONTEXT_KHR
		1139
		1140	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1141	to find the current glx context (see L<GLX SUPPORT>).
		1142
		1143	=back
989		1144
990	=over 4	1145	=over 4
991		1146
992	=item $prog = $ctx->build_program ($program, $options = "")	1147	=item $prog = $ctx->build_program ($program, $options = "")
993		1148
…		…
1002	=cut	1157	=cut
1003		1158
1004	sub OpenCL::Context::build_program {	1159	sub OpenCL::Context::build_program {
1005	my ($self, $prog, $options) = @_;	1160	my ($self, $prog, $options) = @_;
1006		1161
1007	require Carp;
1008
1009	$prog = $self->program_with_source ($prog)	1162	$prog = $self->program_with_source ($prog)
1010	unless ref $prog;	1163	unless ref $prog;
1011		1164
1012	# we build separately per device so we instantly know which one failed	1165	eval { $prog->build (undef, $options); 1 }
		1166	or errno == BUILD_PROGRAM_FAILURE
		1167	or errno == INVALID_BINARY # workaround nvidia bug
		1168	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1169
		1170	# we check status for all devices
1013	for my $dev ($self->devices) {	1171	for my $dev ($self->devices) {
1014	eval { $prog->build ([$dev], $options); 1 }	1172	$prog->build_status ($dev) == BUILD_SUCCESS
1015	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"	1173	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1016	. $prog->build_log ($dev));	1174	. $prog->build_log ($dev);
1017	}	1175	}
1018		1176
1019	$prog	1177	$prog
1020	}	1178	}
1021		1179
…		…
1038	=item $buf = $ctx->buffer ($flags, $len)	1196	=item $buf = $ctx->buffer ($flags, $len)
1039		1197
1040	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1198	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1041	given flags and octet-size.	1199	given flags and octet-size.
1042		1200
		1201	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1202	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1203	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1204
1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1205	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1044		1206
1045	=item $buf = $ctx->buffer_sv ($flags, $data)	1207	=item $buf = $ctx->buffer_sv ($flags, $data)
1046		1208
1047	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1209	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
…		…
1050	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)	1212	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
1051		1213
1052	Creates a new OpenCL::Image object and optionally initialises it with	1214	Creates a new OpenCL::Image object and optionally initialises it with
1053	the given data values.	1215	the given data values.
1054		1216
		1217	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1218	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1219	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1220
		1221	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1222	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1223	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1224	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1225	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1226
		1227	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1228	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1229	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1230	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1231
1055	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1232	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1056		1233
1057	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1234	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1058		1235
1059	Creates a new OpenCL::Image2D object and optionally initialises it with	1236	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1071	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1248	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1072		1249
1073	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1250	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1074	OpenGL buffer object.	1251	OpenGL buffer object.
1075		1252
		1253	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1254
1076	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1255	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1077		1256
1078	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1257	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1079		1258
1080	Creates a new OpenCL::Image object that refers to the given OpenGL	1259	Creates a new OpenCL::Image object that refers to the given OpenGL
1081	texture object or buffer.	1260	texture object or buffer.
1082		1261
		1262	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1263	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1264	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1265	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1266	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1267	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1268
1083	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1269	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1084		1270
1085	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1271	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1086		1272
1087	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1273	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1112		1298
1113	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1299	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1114		1300
1115	Creates a new OpenCL::Sampler object.	1301	Creates a new OpenCL::Sampler object.
1116		1302
		1303	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1304	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1305
		1306	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1307
1117	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1308	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1118		1309
1119	=item $program = $ctx->program_with_source ($string)	1310	=item $program = $ctx->program_with_source ($string)
1120		1311
1121	Creates a new OpenCL::Program object from the given source code.	1312	Creates a new OpenCL::Program object from the given source code.
1122		1313
1123	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1314	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1124		1315
		1316	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1317
		1318	Creates a new OpenCL::Program object from the given binaries.
		1319
		1320	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1321
		1322	Example: clone an existing program object that contains a successfully
		1323	compiled program, no matter how useless this is.
		1324
		1325	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1326
		1327	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1328
		1329	Creates a new OpenCL::Program object from the given built-in kernel names.
		1330
		1331	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1332
		1333	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1334
		1335	Links all (already compiled) program objects specified in C<@programs>
		1336	together and returns a new OpenCL::Program object with the result.
		1337
		1338	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1339
1125	=item $packed_value = $ctx->info ($name)	1340	=item $packed_value = $ctx->info ($name)
1126		1341
1127	See C<< $platform->info >> for details.	1342	See C<< $platform->info >> for details.
1128		1343
1129	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1344	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1130		1345
1131	=for gengetinfo begin context	1346	=for gengetinfo begin context
1132		1347
1133	=item $uint = $context->reference_count	1348	=item $uint = $context->reference_count
1134		1349
1135	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1350	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1136		1351
1137	=item @devices = $context->devices	1352	=item @devices = $context->devices
1138		1353
1139	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1354	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1140		1355
1141	=item @property_ints = $context->properties	1356	=item @property_ints = $context->properties
1142		1357
1143	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1358	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1144		1359
1145	=item $uint = $context->num_devices	1360	=item $uint = $context->num_devices
1146		1361
1147	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1362	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1148		1363
1149	=for gengetinfo end context	1364	=for gengetinfo end context
1150		1365
1151	=back	1366	=back
1152		1367
…		…
1199		1414
1200	=item $ev = $queue->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...)	1415	=item $ev = $queue->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...)
1201		1416
1202	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1417	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1203		1418
		1419	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1420
		1421	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1422
1204	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1423	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1205		1424
1206	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1425	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1207		1426	module uses the image width (and height) to supply default values.
1208	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1209		1427
1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1428	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1211		1429
1212	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1430	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1213		1431
		1432	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1433	module uses the image width (and height) to supply default values.
1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1434	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1215		1435
1216	=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)	1436	=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1217		1437
1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1438	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
…		…
1263	reference to an array of local work sizes, with the same number of	1483	reference to an array of local work sizes, with the same number of
1264	elements as \@global_work_size.	1484	elements as \@global_work_size.
1265		1485
1266	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1486	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1267		1487
		1488	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1489
		1490	Migrates a number of OpenCL::Memory objects to or from the device.
		1491
		1492	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1493
		1494	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1495
1268	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1496	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1269		1497
1270	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1498	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1271	for subsequent OpenCL usage.	1499	for subsequent OpenCL usage.
1272		1500
…		…
1307		1535
1308	=for gengetinfo begin command_queue	1536	=for gengetinfo begin command_queue
1309		1537
1310	=item $ctx = $command_queue->context	1538	=item $ctx = $command_queue->context
1311		1539
1312	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1540	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1313		1541
1314	=item $device = $command_queue->device	1542	=item $device = $command_queue->device
1315		1543
1316	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1544	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1317		1545
1318	=item $uint = $command_queue->reference_count	1546	=item $uint = $command_queue->reference_count
1319		1547
1320	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1548	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1321		1549
1322	=item $command_queue_properties = $command_queue->properties	1550	=item $command_queue_properties = $command_queue->properties
1323		1551
1324	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1552	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1325		1553
1326	=for gengetinfo end command_queue	1554	=for gengetinfo end command_queue
		1555
		1556	=back
		1557
		1558	=head3 MEMORY MAPPED BUFFERS
		1559
		1560	OpenCL allows you to map buffers and images to host memory (read: perl
		1561	scalars). This is done much like reading or copying a buffer, by enqueuing
		1562	a map or unmap operation on the command queue.
		1563
		1564	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1565	OpenCL::Mapped CLASS> section for details on what to do with these
		1566	objects.
		1567
		1568	The object will be unmapped automatically when the mapped object is
		1569	destroyed (you can use a barrier to make sure the unmap has finished,
		1570	before using the buffer in a kernel), but you can also enqueue an unmap
		1571	operation manually.
		1572
		1573	=over 4
		1574
		1575	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1576
		1577	Maps the given buffer into host memory and returns an
		1578	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1579	the map will extend to the end of the buffer.
		1580
		1581	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1582
		1583	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1584
		1585	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1586
		1587	{
		1588	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1589	substr $$mapped, 0, 4, "abcd";
		1590	} # asynchronously unmap because $mapped is destroyed
		1591
		1592	=item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...)
		1593
		1594	Maps the given image area into host memory and return an
		1595	C<OpenCL::MappedImage> object.
		1596
		1597	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1598	will be replaced by the maximum possible value.
		1599
		1600	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1601
		1602	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1603	the first channel of the leftmost column to 5, then explicitly unmap
		1604	it. You are not necessarily meant to do it this way, this example just
		1605	shows you the accessors to use :)
		1606
		1607	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1608
		1609	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1610	for 0..$image->height;
		1611
		1612	$mapped->unmap;.
		1613	$mapped->wait; # only needed for out of order queues normally
		1614
		1615	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1616
		1617	Unmaps the data from host memory. You must not call any methods that
		1618	modify the data, or modify the data scalar directly, after calling this
		1619	method.
		1620
		1621	The mapped event object will always be passed as part of the
		1622	$wait_events. The mapped event object will be replaced by the new event
		1623	object that this request creates.
1327		1624
1328	=back	1625	=back
1329		1626
1330	=head2 THE OpenCL::Memory CLASS	1627	=head2 THE OpenCL::Memory CLASS
1331		1628
…		…
1342		1639
1343	=for gengetinfo begin mem	1640	=for gengetinfo begin mem
1344		1641
1345	=item $mem_object_type = $mem->type	1642	=item $mem_object_type = $mem->type
1346		1643
1347	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1644	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1348		1645
1349	=item $mem_flags = $mem->flags	1646	=item $mem_flags = $mem->flags
1350		1647
1351	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1648	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1352		1649
1353	=item $int = $mem->size	1650	=item $int = $mem->size
1354		1651
1355	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1652	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1356		1653
1357	=item $ptr_value = $mem->host_ptr	1654	=item $ptr_value = $mem->host_ptr
1358		1655
1359	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1656	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1360		1657
1361	=item $uint = $mem->map_count	1658	=item $uint = $mem->map_count
1362		1659
1363	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1660	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1364		1661
1365	=item $uint = $mem->reference_count	1662	=item $uint = $mem->reference_count
1366		1663
1367	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1664	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1368		1665
1369	=item $ctx = $mem->context	1666	=item $ctx = $mem->context
1370		1667
1371	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1668	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1372		1669
1373	=item $mem = $mem->associated_memobject	1670	=item $mem = $mem->associated_memobject
1374		1671
1375	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1672	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1376		1673
1377	=item $int = $mem->offset	1674	=item $int = $mem->offset
1378		1675
1379	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1676	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1380		1677
1381	=for gengetinfo end mem	1678	=for gengetinfo end mem
1382		1679
1383	=item ($type, $name) = $mem->gl_object_info	1680	=item ($type, $name) = $mem->gl_object_info
1384		1681
…		…
1404	=over 4	1701	=over 4
1405		1702
1406	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)	1703	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1407		1704
1408	Creates an OpenCL::Buffer objects from this buffer and returns it. The	1705	Creates an OpenCL::Buffer objects from this buffer and returns it. The
1409	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.	1706	C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1410		1707
1411	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>	1708	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1412		1709
1413	=back	1710	=back
1414		1711
…		…
1430	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1727	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1431		1728
1432	=item ($channel_order, $channel_data_type) = $image->format	1729	=item ($channel_order, $channel_data_type) = $image->format
1433		1730
1434	Returns the channel order and type used to create the image by calling	1731	Returns the channel order and type used to create the image by calling
1435	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.	1732	C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1436		1733
1437	=for gengetinfo begin image	1734	=for gengetinfo begin image
1438		1735
1439	=item $int = $image->element_size	1736	=item $int = $image->element_size
1440		1737
1441	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1738	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1442		1739
1443	=item $int = $image->row_pitch	1740	=item $int = $image->row_pitch
1444		1741
1445	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1742	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1446		1743
1447	=item $int = $image->slice_pitch	1744	=item $int = $image->slice_pitch
1448		1745
1449	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1746	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1450		1747
1451	=item $int = $image->width	1748	=item $int = $image->width
1452		1749
1453	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1750	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1454		1751
1455	=item $int = $image->height	1752	=item $int = $image->height
1456		1753
1457	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1754	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1458		1755
1459	=item $int = $image->depth	1756	=item $int = $image->depth
1460		1757
1461	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1758	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1462		1759
1463	=for gengetinfo end image	1760	=for gengetinfo end image
1464		1761
1465	=for gengetinfo begin gl_texture	1762	=for gengetinfo begin gl_texture
1466		1763
1467	=item $GLenum = $gl_texture->target	1764	=item $GLenum = $gl_texture->target
1468		1765
1469	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1766	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1470		1767
1471	=item $GLint = $gl_texture->gl_mipmap_level	1768	=item $GLint = $gl_texture->gl_mipmap_level
1472		1769
1473	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1770	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1474		1771
1475	=for gengetinfo end gl_texture	1772	=for gengetinfo end gl_texture
1476		1773
1477	=back	1774	=back
1478		1775
…		…
1488		1785
1489	=for gengetinfo begin sampler	1786	=for gengetinfo begin sampler
1490		1787
1491	=item $uint = $sampler->reference_count	1788	=item $uint = $sampler->reference_count
1492		1789
1493	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1790	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1494		1791
1495	=item $ctx = $sampler->context	1792	=item $ctx = $sampler->context
1496		1793
1497	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1794	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1498		1795
1499	=item $addressing_mode = $sampler->normalized_coords	1796	=item $addressing_mode = $sampler->normalized_coords
1500		1797
1501	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1798	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1502		1799
1503	=item $filter_mode = $sampler->addressing_mode	1800	=item $filter_mode = $sampler->addressing_mode
1504		1801
1505	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1802	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1506		1803
1507	=item $boolean = $sampler->filter_mode	1804	=item $boolean = $sampler->filter_mode
1508		1805
1509	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1806	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1510		1807
1511	=for gengetinfo end sampler	1808	=for gengetinfo end sampler
1512		1809
1513	=back	1810	=back
1514		1811
…		…
1524	If a callback is specified, then it will be called when compilation is	1821	If a callback is specified, then it will be called when compilation is
1525	finished. Note that many OpenCL implementations block your program while	1822	finished. Note that many OpenCL implementations block your program while
1526	compiling whether you use a callback or not. See C<build_async> if you	1823	compiling whether you use a callback or not. See C<build_async> if you
1527	want to make sure the build is done in the background.	1824	want to make sure the build is done in the background.
1528		1825
1529	Note that some OpenCL implementations atc up badly, and don't call the	1826	Note that some OpenCL implementations act up badly, and don't call the
1530	callback in some error cases (but call it in others). This implementation	1827	callback in some error cases (but call it in others). This implementation
1531	assumes the callback will always be called, and leaks memory if this is	1828	assumes the callback will always be called, and leaks memory if this is
1532	not so. So best make sure you don't pass in invalid values.	1829	not so. So best make sure you don't pass in invalid values.
1533		1830
		1831	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1832	compilation state is successful but some later stage fails.
		1833
		1834	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1835	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1836	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1837	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1838	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1839	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1840	C<-create-library>, C<-enable-link-options>.
		1841
		1842	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1843	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1844
1534	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1845	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1535		1846
1536	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1847	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1537		1848
1538	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1849	Similar to C<< ->build >>, except it starts a thread, and never fails (you
1539	need to check the compilation status form the callback, or by polling).	1850	need to check the compilation status form the callback, or by polling).
1540		1851
		1852	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1853
		1854	Compiles the given program for the given devices (or all devices if
		1855	undef). If C<$headers> is given, it must be a hashref with include name =>
		1856	OpenCL::Program pairs.
		1857
		1858	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
		1859
1541	=item $packed_value = $program->build_info ($device, $name)	1860	=item $packed_value = $program->build_info ($device, $name)
1542		1861
1543	Similar to C<< $platform->info >>, but returns build info for a previous	1862	Similar to C<< $platform->info >>, but returns build info for a previous
1544	build attempt for the given device.	1863	build attempt for the given device.
1545		1864
		1865	binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
		1866	OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
		1867	OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
		1868	OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
		1869
1546	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>	1870	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1547		1871
1548	=item $kernel = $program->kernel ($function_name)	1872	=item $kernel = $program->kernel ($function_name)
1549		1873
1550	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1874	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
…		…
1560		1884
1561	=for gengetinfo begin program_build	1885	=for gengetinfo begin program_build
1562		1886
1563	=item $build_status = $program->build_status ($device)	1887	=item $build_status = $program->build_status ($device)
1564		1888
1565	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1889	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1566		1890
1567	=item $string = $program->build_options ($device)	1891	=item $string = $program->build_options ($device)
1568		1892
1569	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1893	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1570		1894
1571	=item $string = $program->build_log ($device)	1895	=item $string = $program->build_log ($device)
1572		1896
1573	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1897	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
		1898
		1899	=item $binary_type = $program->binary_type ($device)
		1900
		1901	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1574		1902
1575	=for gengetinfo end program_build	1903	=for gengetinfo end program_build
1576		1904
1577	=item $packed_value = $program->info ($name)	1905	=item $packed_value = $program->info ($name)
1578		1906
…		…
1582		1910
1583	=for gengetinfo begin program	1911	=for gengetinfo begin program
1584		1912
1585	=item $uint = $program->reference_count	1913	=item $uint = $program->reference_count
1586		1914
1587	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1915	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1588		1916
1589	=item $ctx = $program->context	1917	=item $ctx = $program->context
1590		1918
1591	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1919	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1592		1920
1593	=item $uint = $program->num_devices	1921	=item $uint = $program->num_devices
1594		1922
1595	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1923	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1596		1924
1597	=item @devices = $program->devices	1925	=item @devices = $program->devices
1598		1926
1599	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1927	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1600		1928
1601	=item $string = $program->source	1929	=item $string = $program->source
1602		1930
1603	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1931	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1604		1932
1605	=item @ints = $program->binary_sizes	1933	=item @ints = $program->binary_sizes
1606		1934
1607	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1935	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1608		1936
1609	=for gengetinfo end program	1937	=for gengetinfo end program
1610		1938
1611	=item @blobs = $program->binaries	1939	=item @blobs = $program->binaries
1612		1940
…		…
1633		1961
1634	=for gengetinfo begin kernel	1962	=for gengetinfo begin kernel
1635		1963
1636	=item $string = $kernel->function_name	1964	=item $string = $kernel->function_name
1637		1965
1638	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1966	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1639		1967
1640	=item $uint = $kernel->num_args	1968	=item $uint = $kernel->num_args
1641		1969
1642	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1970	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1643		1971
1644	=item $uint = $kernel->reference_count	1972	=item $uint = $kernel->reference_count
1645		1973
1646	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1974	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1647		1975
1648	=item $ctx = $kernel->context	1976	=item $ctx = $kernel->context
1649		1977
1650	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1978	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1651		1979
1652	=item $program = $kernel->program	1980	=item $program = $kernel->program
1653		1981
1654	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1982	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1655		1983
1656	=for gengetinfo end kernel	1984	=for gengetinfo end kernel
1657		1985
1658	=item $packed_value = $kernel->work_group_info ($device, $name)	1986	=item $packed_value = $kernel->work_group_info ($device, $name)
1659		1987
1660	See C<< $platform->info >> for details.	1988	See C<< $platform->info >> for details.
1661		1989
1662	The reason this method is not called C<info> is that there already is an
1663	C<< ->info >> method.
1664
1665	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1990	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1666		1991
1667	=for gengetinfo begin kernel_work_group	1992	=for gengetinfo begin kernel_work_group
1668		1993
1669	=item $int = $kernel->work_group_size ($device)	1994	=item $int = $kernel->work_group_size ($device)
1670		1995
1671	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1996	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1672		1997
1673	=item @ints = $kernel->compile_work_group_size ($device)	1998	=item @ints = $kernel->compile_work_group_size ($device)
1674		1999
1675	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	2000	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1676		2001
1677	=item $ulong = $kernel->local_mem_size ($device)	2002	=item $ulong = $kernel->local_mem_size ($device)
1678		2003
1679	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	2004	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1680		2005
1681	=item $int = $kernel->preferred_work_group_size_multiple ($device)	2006	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1682		2007
1683	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	2008	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1684		2009
1685	=item $ulong = $kernel->private_mem_size ($device)	2010	=item $ulong = $kernel->private_mem_size ($device)
1686		2011
1687	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	2012	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1688		2013
1689	=for gengetinfo end kernel_work_group	2014	=for gengetinfo end kernel_work_group
		2015
		2016	=item $packed_value = $kernel->arg_info ($idx, $name)
		2017
		2018	See C<< $platform->info >> for details.
		2019
		2020	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		2021
		2022	=for gengetinfo begin kernel_arg
		2023
		2024	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		2025
		2026	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		2027
		2028	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		2029
		2030	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		2031
		2032	=item $string = $kernel->arg_type_name ($idx)
		2033
		2034	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		2035
		2036	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		2037
		2038	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		2039
		2040	=item $string = $kernel->arg_name ($idx)
		2041
		2042	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		2043
		2044	=for gengetinfo end kernel_arg
		2045
		2046	=item $kernel->setf ($format, ...)
		2047
		2048	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		2049	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		2050	need to specify a format argument, much as with C<printf>, to tell OpenCL
		2051	what type of argument it is.
		2052
		2053	The format arguments are single letters:
		2054
		2055	c char
		2056	C unsigned char
		2057	s short
		2058	S unsigned short
		2059	i int
		2060	I unsigned int
		2061	l long
		2062	L unsigned long
		2063
		2064	h half float (0..65535)
		2065	f float
		2066	d double
		2067
		2068	z local (octet size)
		2069
		2070	m memory object (buffer or image)
		2071	a sampler
		2072	e event
		2073
		2074	Space characters in the format string are ignored.
		2075
		2076	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		2077
		2078	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
1690		2079
1691	=item $kernel->set_TYPE ($index, $value)	2080	=item $kernel->set_TYPE ($index, $value)
1692		2081
1693	=item $kernel->set_char ($index, $value)	2082	=item $kernel->set_char ($index, $value)
1694		2083
…		…
1772		2161
1773	=for gengetinfo begin event	2162	=for gengetinfo begin event
1774		2163
1775	=item $queue = $event->command_queue	2164	=item $queue = $event->command_queue
1776		2165
1777	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2166	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1778		2167
1779	=item $command_type = $event->command_type	2168	=item $command_type = $event->command_type
1780		2169
1781	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2170	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1782		2171
1783	=item $uint = $event->reference_count	2172	=item $uint = $event->reference_count
1784		2173
1785	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2174	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1786		2175
1787	=item $uint = $event->command_execution_status	2176	=item $uint = $event->command_execution_status
1788		2177
1789	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2178	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1790		2179
1791	=item $ctx = $event->context	2180	=item $ctx = $event->context
1792		2181
1793	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2182	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1794		2183
1795	=for gengetinfo end event	2184	=for gengetinfo end event
1796		2185
1797	=item $packed_value = $ev->profiling_info ($name)	2186	=item $packed_value = $ev->profiling_info ($name)
1798		2187
…		…
1805		2194
1806	=for gengetinfo begin profiling	2195	=for gengetinfo begin profiling
1807		2196
1808	=item $ulong = $event->profiling_command_queued	2197	=item $ulong = $event->profiling_command_queued
1809		2198
1810	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2199	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1811		2200
1812	=item $ulong = $event->profiling_command_submit	2201	=item $ulong = $event->profiling_command_submit
1813		2202
1814	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2203	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1815		2204
1816	=item $ulong = $event->profiling_command_start	2205	=item $ulong = $event->profiling_command_start
1817		2206
1818	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2207	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1819		2208
1820	=item $ulong = $event->profiling_command_end	2209	=item $ulong = $event->profiling_command_end
1821		2210
1822	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2211	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1823		2212
1824	=for gengetinfo end profiling	2213	=for gengetinfo end profiling
1825		2214
1826	=back	2215	=back
1827		2216
…		…
1834	=item $ev->set_status ($execution_status)	2223	=item $ev->set_status ($execution_status)
1835		2224
1836	Sets the execution status of the user event. Can only be called once,	2225	Sets the execution status of the user event. Can only be called once,
1837	either with OpenCL::COMPLETE or a negative number as status.	2226	either with OpenCL::COMPLETE or a negative number as status.
1838		2227
		2228	execution_status: OpenCL::COMPLETE or a negative integer.
		2229
1839	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2230	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1840		2231
1841	=back	2232	=back
		2233
		2234	=head2 THE OpenCL::Mapped CLASS
		2235
		2236	This class represents objects mapped into host memory. They are
		2237	represented by a blessed string scalar. The string data is the mapped
		2238	memory area, that is, if you read or write it, then the mapped object is
		2239	accessed directly.
		2240
		2241	You must only ever use operations that modify the string in-place - for
		2242	example, a C<substr> that doesn't change the length, or maybe a regex that
		2243	doesn't change the length. Any other operation might cause the data to be
		2244	copied.
		2245
		2246	When the object is destroyed it will enqueue an implicit unmap operation
		2247	on the queue that was used to create it.
		2248
		2249	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2250	OpenCL sees the changes, even if some implementations don't need this
		2251	sometimes.
		2252
		2253	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2254
		2255	my $mapped = $queue->map_buffer ($buf, ...
		2256	$mapped->event->wait; # make sure it's there
		2257
		2258	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2259	# we blindly assume device endianness to equal host endianness
		2260	# (and of course, we assume iee 754 single precision floats :)
		2261	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2262
		2263	=over 4
		2264
		2265	=item $ev = $mapped->unmap ($wait_events...)
		2266
		2267	Unmaps the mapped memory object, using the queue originally used to create
		2268	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2269
		2270	=item $bool = $mapped->mapped
		2271
		2272	Returns whether the object is still mapped - true before an C<unmap> is
		2273	enqueued, false afterwards.
		2274
		2275	=item $ev = $mapped->event
		2276
		2277	Return the event object associated with the mapped object. Initially, this
		2278	will be the event object created when mapping the object, and after an
		2279	unmap, this will be the event object that the unmap operation created.
		2280
		2281	=item $mapped->wait
		2282
		2283	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2284	mapped object are outstanding.
		2285
		2286	=item $bytes = $mapped->size
		2287
		2288	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2289
		2290	=item $ptr = $mapped->ptr
		2291
		2292	Returns the raw memory address of the mapped area.
		2293
		2294	=item $mapped->set ($offset, $data)
		2295
		2296	Replaces the data at the given C<$offset> in the memory area by the new
		2297	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2298	because it does bounds-checking, but also slower.
		2299
		2300	=item $data = $mapped->get ($offset, $length)
		2301
		2302	Returns (without copying) a scalar representing the data at the given
		2303	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2304	the following substr, except much slower;
		2305
		2306	$data = substr $$mapped, $offset, $length
		2307
		2308	=cut
		2309
		2310	sub OpenCL::Mapped::get {
		2311	substr ${$_[0]}, $_[1], $_[2]
		2312	}
		2313
		2314	=back
		2315
		2316	=head2 THE OpenCL::MappedBuffer CLASS
		2317
		2318	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2319
		2320	=head2 THE OpenCL::MappedImage CLASS
		2321
		2322	This is a subclass of OpenCL::Mapped, representing mapped images.
		2323
		2324	=over 4
		2325
		2326	=item $bytes = $mapped->row_pitch
		2327
		2328	=item $bytes = $mapped->slice_pitch
		2329
		2330	Return the row or slice pitch of the image that has been mapped.
		2331
		2332	=back
		2333
1842		2334
1843	=cut	2335	=cut
1844		2336
1845	1;	2337	1;
1846		2338

Diff Legend

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