[ViewVC] Diff of: 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.78 by root, Sat May 5 13:07:19 2012 UTC

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

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC vs. Revision 1.78 by root, Sat May 5 13:07:19 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC vs.
Revision 1.78 by root, Sat May 5 13:07:19 2012 UTC