ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.64 by root, Mon Apr 30 23:12:43 2012 UTC vs.
Revision 1.86 by root, Mon May 7 01:00:31 2012 UTC

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

Diff Legend

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