ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

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

Diff Legend

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