ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.60 by root, Wed Apr 25 21:48:44 2012 UTC vs.
Revision 1.80 by root, Sat May 5 13:55:59 2012 UTC

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

Diff Legend

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