ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.57 by root, Tue Apr 24 23:58:34 2012 UTC vs.
Revision 1.71 by root, Fri May 4 14:29:35 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
…		…
141	=head2 Create a buffer with some predefined data, read it back synchronously,	142	=head2 Create a buffer with some predefined data, read it back synchronously,
142	then asynchronously.	143	then asynchronously.
143		144
144	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	145	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
145		146
146	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	147	$queue->read_buffer ($buf, 1, 1, 3, my $data);
147	print "$data\n";	148	print "$data\n";
148		149
149	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	150	my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
150	$ev->wait;	151	$ev->wait;
151	print "$data\n"; # prints "elm"	152	print "$data\n"; # prints "elm"
152		153
153	=head2 Create and build a program, then create a kernel out of one of its	154	=head2 Create and build a program, then create a kernel out of one of its
154	functions.	155	functions.
…		…
174	# set buffer	175	# set buffer
175	$kernel->set_buffer (0, $input);	176	$kernel->set_buffer (0, $input);
176	$kernel->set_buffer (1, $output);	177	$kernel->set_buffer (1, $output);
177		178
178	# execute it for all 4 numbers	179	# execute it for all 4 numbers
179	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	180	$queue->nd_range_kernel ($kernel, undef, [4], undef);
180		181
181	# enqueue a synchronous read	182	# enqueue a synchronous read
182	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	183	$queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
183		184
184	# print the results:	185	# print the results:
185	printf "%s\n", join ", ", unpack "f*", $data;	186	printf "%s\n", join ", ", unpack "f*", $data;
186		187
187	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	188	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
188	showing off barriers.	189	showing off barriers.
189		190
190	# execute it for all 4 numbers	191	# execute it for all 4 numbers
191	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	192	$queue->nd_range_kernel ($kernel, undef, [4], undef);
192		193
193	# enqueue a barrier to ensure in-order execution	194	# enqueue a barrier to ensure in-order execution
194	$queue->enqueue_barrier;	195	$queue->barrier;
195		196
196	# enqueue an async read	197	# enqueue an async read
197	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	198	$queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
198		199
199	# wait for all requests to finish	200	# wait for all requests to finish
200	$queue->finish;	201	$queue->finish;
201		202
202	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	203	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
203	showing off event objects and wait lists.	204	showing off event objects and wait lists.
204		205
205	# execute it for all 4 numbers	206	# execute it for all 4 numbers
206	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	207	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
207		208
208	# enqueue an async read	209	# enqueue an async read
209	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	210	$ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
210		211
211	# wait for the last event to complete	212	# wait for the last event to complete
212	$ev->wait;	213	$ev->wait;
213		214
214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia	215	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215	set tunnel effect.	216	set flight effect.
216		217
217	This is quite a long example to get you going.	218	This is quite a long example to get you going - you can download it from
		219	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
218		220
219	use OpenGL ":all";	221	use OpenGL ":all";
220	use OpenCL;	222	use OpenCL;
221		223
		224	my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
		225
222	# open a window and create a gl texture	226	# open a window and create a gl texture
223	OpenGL::glpOpenWindow width => 256, height => 256;	227	OpenGL::glpOpenWindow width => $S, height => $S;
224	my $texid = glGenTextures_p 1;	228	my $texid = glGenTextures_p 1;
225	glBindTexture GL_TEXTURE_2D, $texid;	229	glBindTexture GL_TEXTURE_2D, $texid;
226	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;	230	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
227		231
228	# find and use the first opencl device that let's us get a shared opengl context	232	# find and use the first opencl device that let's us get a shared opengl context
229	my $platform;	233	my $platform;
230	my $dev;	234	my $dev;
231	my $ctx;	235	my $ctx;
…		…
250	# now the boring opencl code	254	# now the boring opencl code
251	my $src = <<EOF;	255	my $src = <<EOF;
252	kernel void	256	kernel void
253	juliatunnel (write_only image2d_t img, float time)	257	juliatunnel (write_only image2d_t img, float time)
254	{	258	{
255	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;	259	int2 xy = (int2)(get_global_id (0), get_global_id (1));
		260	float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
256		261
257	float2 m = (float2)(1.f, p.y) / fabs (p.x);	262	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
258	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;	263	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
259		264
260	float2 z = m;	265	float2 z = m;
261	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	266	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
262		267
263	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)	268	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
264	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;	269	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
265		270
266	float3 colour = (float3)(z.x, z.y, z.x * z.y);	271	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
267	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));	272	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
268	}	273	}
269	EOF	274	EOF
270		275
271	my $prog = $ctx->build_program ($src);	276	my $prog = $ctx->build_program ($src);
272	my $kernel = $prog->kernel ("juliatunnel");	277	my $kernel = $prog->kernel ("juliatunnel");
273		278
274	# program compiled, kernel ready, now draw and loop	279	# program compiled, kernel ready, now draw and loop
275		280
276	for (my $time; ; ++$time) {	281	for (my $time; ; ++$time) {
277	# acquire objects from opengl	282	# acquire objects from opengl
278	$queue->enqueue_acquire_gl_objects ([$tex]);	283	$queue->acquire_gl_objects ([$tex]);
279		284
280	# configure and run our kernel	285	# configure and run our kernel
281	$kernel->set_image2d (0, $tex);	286	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
282	$kernel->set_float (1, $time);
283	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);	287	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
284		288
285	# release objects to opengl again	289	# release objects to opengl again
286	$queue->enqueue_release_gl_objects ([$tex]);	290	$queue->release_gl_objects ([$tex]);
287		291
288	# wait	292	# wait
289	$queue->finish;	293	$queue->finish;
290		294
291	# now draw the texture, the defaults should be all right	295	# now draw the texture, the defaults should be all right
…		…
301		305
302	glXSwapBuffers;	306	glXSwapBuffers;
303		307
304	select undef, undef, undef, 1/60;	308	select undef, undef, undef, 1/60;
305	}	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>.
306		354
307	=head1 DOCUMENTATION	355	=head1 DOCUMENTATION
308		356
309	=head2 BASIC CONVENTIONS	357	=head2 BASIC CONVENTIONS
310		358
…		…
420	use AnyEvent;	468	use AnyEvent;
421		469
422	# initialise AnyEvent, by creating a watcher, or:	470	# initialise AnyEvent, by creating a watcher, or:
423	AnyEvent::detect;	471	AnyEvent::detect;
424		472
425	my $e = $queue->enqueue_marker;	473	my $e = $queue->marker;
426	$e->cb (sub {	474	$e->cb (sub {
427	warn "opencl is finished\n";	475	warn "opencl is finished\n";
428	})	476	})
429		477
430	main Gtk2;	478	main Gtk2;
…		…
447	Asynchronously means that perl might execute your callbacks at any	495	Asynchronously means that perl might execute your callbacks at any
448	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),	496	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
449	the C<until> loop following the marker call will be interrupted by the	497	the C<until> loop following the marker call will be interrupted by the
450	callback:	498	callback:
451		499
452	my $e = $queue->enqueue_marker;	500	my $e = $queue->marker;
453	my $flag;	501	my $flag;
454	$e->cb (sub { $flag = 1 });	502	$e->cb (sub { $flag = 1 });
455	1 until $flag;	503	1 until $flag;
456	# $flag is now 1	504	# $flag is now 1
457		505
…		…
493	=cut	541	=cut
494		542
495	package OpenCL;	543	package OpenCL;
496		544
497	use common::sense;	545	use common::sense;
		546	use Carp ();
498	use Async::Interrupt ();	547	use Async::Interrupt ();
499		548
500	our $POLL_FUNC; # set by XS	549	our $POLL_FUNC; # set by XS
501		550
502	BEGIN {	551	BEGIN {
503	our $VERSION = '0.97';	552	our $VERSION = '0.99';
504		553
505	require XSLoader;	554	require XSLoader;
506	XSLoader::load (__PACKAGE__, $VERSION);	555	XSLoader::load (__PACKAGE__, $VERSION);
507		556
508	@OpenCL::Platform::ISA =	557	@OpenCL::Platform::ISA =
…		…
513	@OpenCL::Sampler::ISA =	562	@OpenCL::Sampler::ISA =
514	@OpenCL::Program::ISA =	563	@OpenCL::Program::ISA =
515	@OpenCL::Kernel::ISA =	564	@OpenCL::Kernel::ISA =
516	@OpenCL::Event::ISA = OpenCL::Object::;	565	@OpenCL::Event::ISA = OpenCL::Object::;
517		566
		567	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		568
518	@OpenCL::Buffer::ISA =	569	@OpenCL::Buffer::ISA =
519	@OpenCL::Image::ISA = OpenCL::Memory::;	570	@OpenCL::Image::ISA = OpenCL::Memory::;
520		571
521	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	572	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
522		573
…		…
526	@OpenCL::Image1D::ISA =	577	@OpenCL::Image1D::ISA =
527	@OpenCL::Image1DArray::ISA =	578	@OpenCL::Image1DArray::ISA =
528	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	579	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
529		580
530	@OpenCL::UserEvent::ISA = OpenCL::Event::;	581	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		582
		583	@OpenCL::MappedBuffer::ISA =
		584	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
531	}	585	}
532		586
533	=head2 THE OpenCL PACKAGE	587	=head2 THE OpenCL PACKAGE
534		588
535	=over 4	589	=over 4
…		…
537	=item $int = OpenCL::errno	591	=item $int = OpenCL::errno
538		592
539	The last error returned by a function - it's only valid after an error occured	593	The last error returned by a function - it's only valid after an error occured
540	and before calling another OpenCL function.	594	and before calling another OpenCL function.
541		595
542	=item $str = OpenCL::err2str $errval	596	=item $str = OpenCL::err2str [$errval]
543		597
544	Comverts an error value into a human readable string.	598	Converts an error value into a human readable string. IF no error value is
		599	given, then the last error will be used (as returned by OpenCL::errno).
545		600
546	=item $str = OpenCL::enum2str $enum	601	=item $str = OpenCL::enum2str $enum
547		602
548	Converts most enum values (of parameter names, image format constants,	603	Converts most enum values (of parameter names, image format constants,
549	object types, addressing and filter modes, command types etc.) into a	604	object types, addressing and filter modes, command types etc.) into a
…		…
559		614
560	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	615	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
561		616
562	Tries to create a context from a default device and platform type - never worked for me.	617	Tries to create a context from a default device and platform type - never worked for me.
563		618
		619	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		620	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
		621
564	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	622	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
565		623
566	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	624	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
567		625
568	Create a new OpenCL::Context object using the given device object(s). This	626	Create a new OpenCL::Context object using the given device object(s). This
…		…
681		739
682	=for gengetinfo begin platform	740	=for gengetinfo begin platform
683		741
684	=item $string = $platform->profile	742	=item $string = $platform->profile
685		743
686	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	744	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
687		745
688	=item $string = $platform->version	746	=item $string = $platform->version
689		747
690	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	748	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
691		749
692	=item $string = $platform->name	750	=item $string = $platform->name
693		751
694	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	752	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
695		753
696	=item $string = $platform->vendor	754	=item $string = $platform->vendor
697		755
698	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	756	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
699		757
700	=item $string = $platform->extensions	758	=item $string = $platform->extensions
701		759
702	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	760	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
703		761
704	=for gengetinfo end platform	762	=for gengetinfo end platform
705		763
706	=back	764	=back
707		765
…		…
713		771
714	See C<< $platform->info >> for details.	772	See C<< $platform->info >> for details.
715		773
716	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	774	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
717		775
		776	=item @devices = $device->sub_devices (\@properties)
		777
		778	Creates OpencL::SubDevice objects by partitioning an existing device.
		779
		780	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		781
718	=for gengetinfo begin device	782	=for gengetinfo begin device
719		783
720	=item $device_type = $device->type	784	=item $device_type = $device->type
721		785
722	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	786	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
723		787
724	=item $uint = $device->vendor_id	788	=item $uint = $device->vendor_id
725		789
726	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	790	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
727		791
728	=item $uint = $device->max_compute_units	792	=item $uint = $device->max_compute_units
729		793
730	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	794	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
731		795
732	=item $uint = $device->max_work_item_dimensions	796	=item $uint = $device->max_work_item_dimensions
733		797
734	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	798	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
735		799
736	=item $int = $device->max_work_group_size	800	=item $int = $device->max_work_group_size
737		801
738	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	802	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
739		803
740	=item @ints = $device->max_work_item_sizes	804	=item @ints = $device->max_work_item_sizes
741		805
742	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	806	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
743		807
744	=item $uint = $device->preferred_vector_width_char	808	=item $uint = $device->preferred_vector_width_char
745		809
746	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	810	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
747		811
748	=item $uint = $device->preferred_vector_width_short	812	=item $uint = $device->preferred_vector_width_short
749		813
750	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	814	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
751		815
752	=item $uint = $device->preferred_vector_width_int	816	=item $uint = $device->preferred_vector_width_int
753		817
754	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	818	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
755		819
756	=item $uint = $device->preferred_vector_width_long	820	=item $uint = $device->preferred_vector_width_long
757		821
758	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	822	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
759		823
760	=item $uint = $device->preferred_vector_width_float	824	=item $uint = $device->preferred_vector_width_float
761		825
762	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	826	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
763		827
764	=item $uint = $device->preferred_vector_width_double	828	=item $uint = $device->preferred_vector_width_double
765		829
766	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	830	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
767		831
768	=item $uint = $device->max_clock_frequency	832	=item $uint = $device->max_clock_frequency
769		833
770	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	834	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
771		835
772	=item $bitfield = $device->address_bits	836	=item $bitfield = $device->address_bits
773		837
774	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	838	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
775		839
776	=item $uint = $device->max_read_image_args	840	=item $uint = $device->max_read_image_args
777		841
778	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	842	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
779		843
780	=item $uint = $device->max_write_image_args	844	=item $uint = $device->max_write_image_args
781		845
782	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	846	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
783		847
784	=item $ulong = $device->max_mem_alloc_size	848	=item $ulong = $device->max_mem_alloc_size
785		849
786	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	850	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
787		851
788	=item $int = $device->image2d_max_width	852	=item $int = $device->image2d_max_width
789		853
790	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	854	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
791		855
792	=item $int = $device->image2d_max_height	856	=item $int = $device->image2d_max_height
793		857
794	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	858	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
795		859
796	=item $int = $device->image3d_max_width	860	=item $int = $device->image3d_max_width
797		861
798	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	862	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
799		863
800	=item $int = $device->image3d_max_height	864	=item $int = $device->image3d_max_height
801		865
802	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	866	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
803		867
804	=item $int = $device->image3d_max_depth	868	=item $int = $device->image3d_max_depth
805		869
806	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	870	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
807		871
808	=item $uint = $device->image_support	872	=item $uint = $device->image_support
809		873
810	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	874	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
811		875
812	=item $int = $device->max_parameter_size	876	=item $int = $device->max_parameter_size
813		877
814	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	878	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
815		879
816	=item $uint = $device->max_samplers	880	=item $uint = $device->max_samplers
817		881
818	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	882	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
819		883
820	=item $uint = $device->mem_base_addr_align	884	=item $uint = $device->mem_base_addr_align
821		885
822	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	886	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
823		887
824	=item $uint = $device->min_data_type_align_size	888	=item $uint = $device->min_data_type_align_size
825		889
826	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	890	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
827		891
828	=item $device_fp_config = $device->single_fp_config	892	=item $device_fp_config = $device->single_fp_config
829		893
830	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	894	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
831		895
832	=item $device_mem_cache_type = $device->global_mem_cache_type	896	=item $device_mem_cache_type = $device->global_mem_cache_type
833		897
834	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	898	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
835		899
836	=item $uint = $device->global_mem_cacheline_size	900	=item $uint = $device->global_mem_cacheline_size
837		901
838	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	902	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
839		903
840	=item $ulong = $device->global_mem_cache_size	904	=item $ulong = $device->global_mem_cache_size
841		905
842	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	906	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
843		907
844	=item $ulong = $device->global_mem_size	908	=item $ulong = $device->global_mem_size
845		909
846	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	910	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
847		911
848	=item $ulong = $device->max_constant_buffer_size	912	=item $ulong = $device->max_constant_buffer_size
849		913
850	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	914	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
851		915
852	=item $uint = $device->max_constant_args	916	=item $uint = $device->max_constant_args
853		917
854	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	918	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
855		919
856	=item $device_local_mem_type = $device->local_mem_type	920	=item $device_local_mem_type = $device->local_mem_type
857		921
858	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	922	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
859		923
860	=item $ulong = $device->local_mem_size	924	=item $ulong = $device->local_mem_size
861		925
862	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	926	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
863		927
864	=item $boolean = $device->error_correction_support	928	=item $boolean = $device->error_correction_support
865		929
866	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	930	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
867		931
868	=item $int = $device->profiling_timer_resolution	932	=item $int = $device->profiling_timer_resolution
869		933
870	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	934	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
871		935
872	=item $boolean = $device->endian_little	936	=item $boolean = $device->endian_little
873		937
874	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	938	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
875		939
876	=item $boolean = $device->available	940	=item $boolean = $device->available
877		941
878	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	942	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
879		943
880	=item $boolean = $device->compiler_available	944	=item $boolean = $device->compiler_available
881		945
882	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	946	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
883		947
884	=item $device_exec_capabilities = $device->execution_capabilities	948	=item $device_exec_capabilities = $device->execution_capabilities
885		949
886	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	950	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
887		951
888	=item $command_queue_properties = $device->properties	952	=item $command_queue_properties = $device->properties
889		953
890	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	954	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
891		955
892	=item $ = $device->platform	956	=item $ = $device->platform
893		957
894	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	958	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
895		959
896	=item $string = $device->name	960	=item $string = $device->name
897		961
898	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	962	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
899		963
900	=item $string = $device->vendor	964	=item $string = $device->vendor
901		965
902	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	966	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
903		967
904	=item $string = $device->driver_version	968	=item $string = $device->driver_version
905		969
906	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	970	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
907		971
908	=item $string = $device->profile	972	=item $string = $device->profile
909		973
910	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	974	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
911		975
912	=item $string = $device->version	976	=item $string = $device->version
913		977
914	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	978	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
915		979
916	=item $string = $device->extensions	980	=item $string = $device->extensions
917		981
918	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	982	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
919		983
920	=item $uint = $device->preferred_vector_width_half	984	=item $uint = $device->preferred_vector_width_half
921		985
922	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	986	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
923		987
924	=item $uint = $device->native_vector_width_char	988	=item $uint = $device->native_vector_width_char
925		989
926	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	990	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
927		991
928	=item $uint = $device->native_vector_width_short	992	=item $uint = $device->native_vector_width_short
929		993
930	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	994	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
931		995
932	=item $uint = $device->native_vector_width_int	996	=item $uint = $device->native_vector_width_int
933		997
934	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	998	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
935		999
936	=item $uint = $device->native_vector_width_long	1000	=item $uint = $device->native_vector_width_long
937		1001
938	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1002	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
939		1003
940	=item $uint = $device->native_vector_width_float	1004	=item $uint = $device->native_vector_width_float
941		1005
942	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1006	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
943		1007
944	=item $uint = $device->native_vector_width_double	1008	=item $uint = $device->native_vector_width_double
945		1009
946	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1010	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
947		1011
948	=item $uint = $device->native_vector_width_half	1012	=item $uint = $device->native_vector_width_half
949		1013
950	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1014	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
951		1015
952	=item $device_fp_config = $device->double_fp_config	1016	=item $device_fp_config = $device->double_fp_config
953		1017
954	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1018	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
955		1019
956	=item $device_fp_config = $device->half_fp_config	1020	=item $device_fp_config = $device->half_fp_config
957		1021
958	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1022	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
959		1023
960	=item $boolean = $device->host_unified_memory	1024	=item $boolean = $device->host_unified_memory
961		1025
962	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1026	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
963		1027
964	=item $device = $device->parent_device_ext	1028	=item $device = $device->parent_device_ext
965		1029
966	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1030	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
967		1031
968	=item @device_partition_property_exts = $device->partition_types_ext	1032	=item @device_partition_property_exts = $device->partition_types_ext
969		1033
970	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1034	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
971		1035
972	=item @device_partition_property_exts = $device->affinity_domains_ext	1036	=item @device_partition_property_exts = $device->affinity_domains_ext
973		1037
974	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1038	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
975		1039
976	=item $uint = $device->reference_count_ext	1040	=item $uint = $device->reference_count_ext
977		1041
978	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1042	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
979		1043
980	=item @device_partition_property_exts = $device->partition_style_ext	1044	=item @device_partition_property_exts = $device->partition_style_ext
981		1045
982	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1046	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
983		1047
984	=for gengetinfo end device	1048	=for gengetinfo end device
985		1049
986	=back	1050	=back
987		1051
988	=head2 THE OpenCL::Context CLASS	1052	=head2 THE OpenCL::Context CLASS
		1053
		1054	An OpenCL::Context is basically a container, or manager, for a number of
		1055	devices of a platform. It is used to create all sorts of secondary objects
		1056	such as buffers, queues, programs and so on.
		1057
		1058	All context creation functions and methods take a list of properties
		1059	(type-value pairs). All property values can be specified as integers -
		1060	some additionally support other types:
		1061
		1062	=over 4
		1063
		1064	=item OpenCL::CONTEXT_PLATFORM
		1065
		1066	Also accepts OpenCL::Platform objects.
		1067
		1068	=item OpenCL::GLX_DISPLAY_KHR
		1069
		1070	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1071	to find the current glx display (see L<GLX SUPPORT>).
		1072
		1073	=item OpenCL::GL_CONTEXT_KHR
		1074
		1075	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1076	to find the current glx context (see L<GLX SUPPORT>).
		1077
		1078	=back
989		1079
990	=over 4	1080	=over 4
991		1081
992	=item $prog = $ctx->build_program ($program, $options = "")	1082	=item $prog = $ctx->build_program ($program, $options = "")
993		1083
…		…
1002	=cut	1092	=cut
1003		1093
1004	sub OpenCL::Context::build_program {	1094	sub OpenCL::Context::build_program {
1005	my ($self, $prog, $options) = @_;	1095	my ($self, $prog, $options) = @_;
1006		1096
1007	require Carp;
1008
1009	$prog = $self->program_with_source ($prog)	1097	$prog = $self->program_with_source ($prog)
1010	unless ref $prog;	1098	unless ref $prog;
1011		1099
1012	# we build separately per device so we instantly know which one failed	1100	eval { $prog->build (undef, $options); 1 }
		1101	or errno == BUILD_PROGRAM_FAILURE
		1102	or errno == INVALID_BINARY # workaround nvidia bug
		1103	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1104
		1105	# we check status for all devices
1013	for my $dev ($self->devices) {	1106	for my $dev ($self->devices) {
1014	eval { $prog->build ([$dev], $options); 1 }	1107	$prog->build_status ($dev) == BUILD_SUCCESS
1015	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"	1108	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1016	. $prog->build_log ($dev));	1109	. $prog->build_log ($dev);
1017	}	1110	}
1018		1111
1019	$prog	1112	$prog
1020	}	1113	}
1021		1114
…		…
1038	=item $buf = $ctx->buffer ($flags, $len)	1131	=item $buf = $ctx->buffer ($flags, $len)
1039		1132
1040	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1133	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1041	given flags and octet-size.	1134	given flags and octet-size.
1042		1135
		1136	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1137	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1138	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1139
1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1140	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1044		1141
1045	=item $buf = $ctx->buffer_sv ($flags, $data)	1142	=item $buf = $ctx->buffer_sv ($flags, $data)
1046		1143
1047	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1144	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1048	initialise it with the given data values.	1145	initialise it with the given data values.
1049		1146
1050	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)	1147	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
1051		1148
1052	Creates a new OpenCL::Image object and optionally initialises it with	1149	Creates a new OpenCL::Image object and optionally initialises it with
1053	the given data values.	1150	the given data values.
1054		1151
		1152	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1153	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1154	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1155
		1156	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1157	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1158	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1159	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1160	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1161
		1162
		1163	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1164	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1165	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1166	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1167
1055	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1168	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1056		1169
1057	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1170	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1058		1171
1059	Creates a new OpenCL::Image2D object and optionally initialises it with	1172	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1071	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1184	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1072		1185
1073	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1186	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1074	OpenGL buffer object.	1187	OpenGL buffer object.
1075		1188
		1189	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1190
1076	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1191	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1077		1192
1078	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1193	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1079		1194
1080	Creates a new OpenCL::Image object that refers to the given OpenGL	1195	Creates a new OpenCL::Image object that refers to the given OpenGL
1081	texture object or buffer.	1196	texture object or buffer.
1082		1197
		1198	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1199	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1200	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1201	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1202	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1203	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1204
1083	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1205	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1084		1206
1085	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1207	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1086		1208
1087	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1209	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1112		1234
1113	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1235	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1114		1236
1115	Creates a new OpenCL::Sampler object.	1237	Creates a new OpenCL::Sampler object.
1116		1238
		1239	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1240	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1241
		1242	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1243
1117	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1244	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1118		1245
1119	=item $program = $ctx->program_with_source ($string)	1246	=item $program = $ctx->program_with_source ($string)
1120		1247
1121	Creates a new OpenCL::Program object from the given source code.	1248	Creates a new OpenCL::Program object from the given source code.
1122		1249
1123	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1250	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1124		1251
		1252	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1253
		1254	Creates a new OpenCL::Program object from the given binaries.
		1255
		1256	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1257
		1258	Example: clone an existing program object that contains a successfully
		1259	compiled program, no matter how useless this is.
		1260
		1261	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1262
		1263	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1264
		1265	Creates a new OpenCL::Program object from the given built-in kernel names.
		1266
		1267	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1268
1125	=item $packed_value = $ctx->info ($name)	1269	=item $packed_value = $ctx->info ($name)
1126		1270
1127	See C<< $platform->info >> for details.	1271	See C<< $platform->info >> for details.
1128		1272
1129	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1273	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1130		1274
1131	=for gengetinfo begin context	1275	=for gengetinfo begin context
1132		1276
1133	=item $uint = $context->reference_count	1277	=item $uint = $context->reference_count
1134		1278
1135	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1279	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1136		1280
1137	=item @devices = $context->devices	1281	=item @devices = $context->devices
1138		1282
1139	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1283	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1140		1284
1141	=item @property_ints = $context->properties	1285	=item @property_ints = $context->properties
1142		1286
1143	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1287	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1144		1288
1145	=item $uint = $context->num_devices	1289	=item $uint = $context->num_devices
1146		1290
1147	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1291	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1148		1292
1149	=for gengetinfo end context	1293	=for gengetinfo end context
1150		1294
1151	=back	1295	=back
1152		1296
1153	=head2 THE OpenCL::Queue CLASS	1297	=head2 THE OpenCL::Queue CLASS
1154		1298
1155	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1299	An OpenCL::Queue represents an execution queue for OpenCL. You execute
1156	requests by calling their respective C<enqueue_xxx> method and waitinf for	1300	requests by calling their respective method and waiting for it to complete
1157	it to complete in some way.	1301	in some way.
1158		1302
1159	All the enqueue methods return an event object that can be used to wait	1303	Most methods that enqueue some request return an event object that can
1160	for completion, unless the method is called in void context, in which case	1304	be used to wait for completion (optionally using a callback), unless
1161	no event object is created.	1305	the method is called in void context, in which case no event object is
		1306	created.
1162		1307
1163	They also allow you to specify any number of other event objects that this	1308	They also allow you to specify any number of other event objects that this
1164	request has to wait for before it starts executing, by simply passing the	1309	request has to wait for before it starts executing, by simply passing the
1165	event objects as extra parameters to the enqueue methods. To simplify	1310	event objects as extra parameters to the enqueue methods. To simplify
1166	program design, this module ignores any C<undef> values in the list of	1311	program design, this module ignores any C<undef> values in the list of
1167	events. This makes it possible to code operations such as this, without	1312	events. This makes it possible to code operations such as this, without
1168	having to put a valid event object into C<$event> first:	1313	having to put a valid event object into C<$event> first:
1169		1314
1170	$event = $queue->enqueue_xxx (..., $event);	1315	$event = $queue->xxx (..., $event);
1171		1316
1172	Queues execute in-order by default, without any parallelism, so in most	1317	Queues execute in-order by default, without any parallelism, so in most
1173	cases (i.e. you use only one queue) it's not necessary to wait for or	1318	cases (i.e. you use only one queue) it's not necessary to wait for or
1174	create event objects, althoguh an our of order queue is often a bit	1319	create event objects, althoguh an our of order queue is often a bit
1175	faster.	1320	faster.
1176		1321
1177	=over 4	1322	=over 4
1178		1323
1179	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1324	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
1180		1325
1181	Reads data from buffer into the given string.	1326	Reads data from buffer into the given string.
1182		1327
1183	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1328	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
1184		1329
1185	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1330	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1186		1331
1187	Writes data to buffer from the given string.	1332	Writes data to buffer from the given string.
1188		1333
1189	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1334	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
1190		1335
1191	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1336	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1192		1337
1193	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1338	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1194		1339
1195	=item $ev = $queue->enqueue_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...)	1340	=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...)
1196		1341
1197	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1342	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1198		1343
1199	=item $ev = $queue->enqueue_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...)	1344	=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...)
1200		1345
1201	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1346	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1202		1347
1203	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1204
1205	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1206
1207	=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)	1348	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1349
		1350	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1351
		1352	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1353
		1354	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1355	module uses the image width (and height) to supply default values.
1208		1356
1209	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1357	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1210		1358
1211	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1359	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1212		1360
		1361	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1362	module uses the image width (and height) to supply default values.
1213	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1363	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1214		1364
1215	=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)	1365	=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...)
1216		1366
1217	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1367	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1218		1368
1219	=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)	1369	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1220		1370
1221	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1371	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1222		1372
1223	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)	1373	=item $ev = $queue->copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
1224		1374
1225	Yeah.	1375	Yeah.
1226		1376
1227	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1377	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1228		1378
1229	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1379	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1230		1380
1231	Fills the given buffer object with repeated applications of C<$pattern>,	1381	Fills the given buffer object with repeated applications of C<$pattern>,
1232	starting at C<$offset> for C<$size> octets.	1382	starting at C<$offset> for C<$size> octets.
1233		1383
1234	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>	1384	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1235		1385
1236	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)	1386	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1237		1387
1238	Fills the given image area with the given rgba colour components. The	1388	Fills the given image area with the given rgba colour components. The
1239	components are normally floating point values between C<0> and C<1>,	1389	components are normally floating point values between C<0> and C<1>,
1240	except when the image channel data type is a signe dor unsigned	1390	except when the image channel data type is a signe dor unsigned
1241	unnormalised format, in which case the range is determined by the format.	1391	unnormalised format, in which case the range is determined by the format.
1242		1392
1243	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>	1393	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1244		1394
1245	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1395	=item $ev = $queue->task ($kernel, $wait_events...)
1246		1396
1247	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1397	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1248		1398
1249	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)	1399	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1250		1400
1251	Enqueues a kernel execution.	1401	Enqueues a kernel execution.
1252		1402
1253	\@global_work_size must be specified as a reference to an array of	1403	\@global_work_size must be specified as a reference to an array of
1254	integers specifying the work sizes (element counts).	1404	integers specifying the work sizes (element counts).
…		…
1262	reference to an array of local work sizes, with the same number of	1412	reference to an array of local work sizes, with the same number of
1263	elements as \@global_work_size.	1413	elements as \@global_work_size.
1264		1414
1265	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1415	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1266		1416
		1417	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1418
		1419	Migrates a number of OpenCL::Memory objects to or from the device.
		1420
		1421	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1422
		1423	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1424
1267	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1425	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1268		1426
1269	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1427	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1270	for subsequent OpenCL usage.	1428	for subsequent OpenCL usage.
1271		1429
1272	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1430	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1273		1431
1274	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1432	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1275		1433
1276	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1434	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1277	for subsequent OpenGL usage.	1435	for subsequent OpenGL usage.
1278		1436
1279	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1437	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1280		1438
1281	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1439	=item $ev = $queue->wait_for_events ($wait_events...)
1282		1440
1283	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1441	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1284		1442
1285	=item $ev = $queue->enqueue_marker ($wait_events...)	1443	=item $ev = $queue->marker ($wait_events...)
1286		1444
1287	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1445	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1288		1446
1289	=item $ev = $queue->enqueue_barrier ($wait_events...)	1447	=item $ev = $queue->barrier ($wait_events...)
1290		1448
1291	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1449	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1292		1450
1293	=item $queue->flush	1451	=item $queue->flush
1294		1452
…		…
1306		1464
1307	=for gengetinfo begin command_queue	1465	=for gengetinfo begin command_queue
1308		1466
1309	=item $ctx = $command_queue->context	1467	=item $ctx = $command_queue->context
1310		1468
1311	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1469	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1312		1470
1313	=item $device = $command_queue->device	1471	=item $device = $command_queue->device
1314		1472
1315	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1473	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1316		1474
1317	=item $uint = $command_queue->reference_count	1475	=item $uint = $command_queue->reference_count
1318		1476
1319	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1477	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1320		1478
1321	=item $command_queue_properties = $command_queue->properties	1479	=item $command_queue_properties = $command_queue->properties
1322		1480
1323	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1481	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1324		1482
1325	=for gengetinfo end command_queue	1483	=for gengetinfo end command_queue
		1484
		1485	=back
		1486
		1487	=head3 MEMORY MAPPED BUFFERS
		1488
		1489	OpenCL allows you to map buffers and images to host memory (read: perl
		1490	scalars). This is done much like reading or copying a buffer, by enqueuing
		1491	a map or unmap operation on the command queue.
		1492
		1493	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1494	OpenCL::Mapped CLASS> section for details on what to do with these
		1495	objects.
		1496
		1497	The object will be unmapped automatically when the mapped object is
		1498	destroyed (you can use a barrier to make sure the unmap has finished,
		1499	before using the buffer in a kernel), but you can also enqueue an unmap
		1500	operation manually.
		1501
		1502	=over 4
		1503
		1504	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1505
		1506	Maps the given buffer into host memory and returns an
		1507	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1508	the map will extend to the end of the buffer.
		1509
		1510	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1511
		1512	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1513
		1514	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1515
		1516	{
		1517	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1518	substr $$mapped, 0, 4, "abcd";
		1519	} # asynchronously unmap because $mapped is destroyed
		1520
		1521	=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...)
		1522
		1523	Maps the given image area into host memory and return an
		1524	C<OpenCL::MappedImage> object.
		1525
		1526	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1527	will be replaced by the maximum possible value.
		1528
		1529	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1530
		1531	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1532	the first channel of the leftmost column to 5, then explicitly unmap
		1533	it. You are not necessarily meant to do it this way, this example just
		1534	shows you the accessors to use :)
		1535
		1536	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1537
		1538	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1539	for 0..$image->height;
		1540
		1541	$mapped->unmap;.
		1542	$mapped->wait; # only needed for out of order queues normally
		1543
		1544	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1545
		1546	Unmaps the data from host memory. You must not call any methods that
		1547	modify the data, or modify the data scalar directly, after calling this
		1548	method.
		1549
		1550	The mapped event object will always be passed as part of the
		1551	$wait_events. The mapped event object will be replaced by the new event
		1552	object that this request creates.
1326		1553
1327	=back	1554	=back
1328		1555
1329	=head2 THE OpenCL::Memory CLASS	1556	=head2 THE OpenCL::Memory CLASS
1330		1557
…		…
1341		1568
1342	=for gengetinfo begin mem	1569	=for gengetinfo begin mem
1343		1570
1344	=item $mem_object_type = $mem->type	1571	=item $mem_object_type = $mem->type
1345		1572
1346	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1573	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1347		1574
1348	=item $mem_flags = $mem->flags	1575	=item $mem_flags = $mem->flags
1349		1576
1350	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1577	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1351		1578
1352	=item $int = $mem->size	1579	=item $int = $mem->size
1353		1580
1354	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1581	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1355		1582
1356	=item $ptr_value = $mem->host_ptr	1583	=item $ptr_value = $mem->host_ptr
1357		1584
1358	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1585	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1359		1586
1360	=item $uint = $mem->map_count	1587	=item $uint = $mem->map_count
1361		1588
1362	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1589	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1363		1590
1364	=item $uint = $mem->reference_count	1591	=item $uint = $mem->reference_count
1365		1592
1366	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1593	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1367		1594
1368	=item $ctx = $mem->context	1595	=item $ctx = $mem->context
1369		1596
1370	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1597	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1371		1598
1372	=item $mem = $mem->associated_memobject	1599	=item $mem = $mem->associated_memobject
1373		1600
1374	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1601	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1375		1602
1376	=item $int = $mem->offset	1603	=item $int = $mem->offset
1377		1604
1378	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1605	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1379		1606
1380	=for gengetinfo end mem	1607	=for gengetinfo end mem
1381		1608
1382	=item ($type, $name) = $mem->gl_object_info	1609	=item ($type, $name) = $mem->gl_object_info
1383		1610
…		…
1435		1662
1436	=for gengetinfo begin image	1663	=for gengetinfo begin image
1437		1664
1438	=item $int = $image->element_size	1665	=item $int = $image->element_size
1439		1666
1440	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1667	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1441		1668
1442	=item $int = $image->row_pitch	1669	=item $int = $image->row_pitch
1443		1670
1444	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1671	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1445		1672
1446	=item $int = $image->slice_pitch	1673	=item $int = $image->slice_pitch
1447		1674
1448	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1675	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1449		1676
1450	=item $int = $image->width	1677	=item $int = $image->width
1451		1678
1452	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1679	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1453		1680
1454	=item $int = $image->height	1681	=item $int = $image->height
1455		1682
1456	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1683	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1457		1684
1458	=item $int = $image->depth	1685	=item $int = $image->depth
1459		1686
1460	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1687	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1461		1688
1462	=for gengetinfo end image	1689	=for gengetinfo end image
1463		1690
1464	=for gengetinfo begin gl_texture	1691	=for gengetinfo begin gl_texture
1465		1692
1466	=item $GLenum = $gl_texture->target	1693	=item $GLenum = $gl_texture->target
1467		1694
1468	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1695	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1469		1696
1470	=item $GLint = $gl_texture->gl_mipmap_level	1697	=item $GLint = $gl_texture->gl_mipmap_level
1471		1698
1472	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1699	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1473		1700
1474	=for gengetinfo end gl_texture	1701	=for gengetinfo end gl_texture
1475		1702
1476	=back	1703	=back
1477		1704
…		…
1487		1714
1488	=for gengetinfo begin sampler	1715	=for gengetinfo begin sampler
1489		1716
1490	=item $uint = $sampler->reference_count	1717	=item $uint = $sampler->reference_count
1491		1718
1492	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1719	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1493		1720
1494	=item $ctx = $sampler->context	1721	=item $ctx = $sampler->context
1495		1722
1496	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1723	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1497		1724
1498	=item $addressing_mode = $sampler->normalized_coords	1725	=item $addressing_mode = $sampler->normalized_coords
1499		1726
1500	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1727	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1501		1728
1502	=item $filter_mode = $sampler->addressing_mode	1729	=item $filter_mode = $sampler->addressing_mode
1503		1730
1504	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1731	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1505		1732
1506	=item $boolean = $sampler->filter_mode	1733	=item $boolean = $sampler->filter_mode
1507		1734
1508	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1735	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1509		1736
1510	=for gengetinfo end sampler	1737	=for gengetinfo end sampler
1511		1738
1512	=back	1739	=back
1513		1740
…		…
1523	If a callback is specified, then it will be called when compilation is	1750	If a callback is specified, then it will be called when compilation is
1524	finished. Note that many OpenCL implementations block your program while	1751	finished. Note that many OpenCL implementations block your program while
1525	compiling whether you use a callback or not. See C<build_async> if you	1752	compiling whether you use a callback or not. See C<build_async> if you
1526	want to make sure the build is done in the background.	1753	want to make sure the build is done in the background.
1527		1754
1528	Note that some OpenCL implementations atc up badly, and don't call the	1755	Note that some OpenCL implementations act up badly, and don't call the
1529	callback in some error cases (but call it in others). This implementation	1756	callback in some error cases (but call it in others). This implementation
1530	assumes the callback will always be called, and leaks memory if this is	1757	assumes the callback will always be called, and leaks memory if this is
1531	not so. So best make sure you don't pass in invalid values.	1758	not so. So best make sure you don't pass in invalid values.
1532		1759
		1760	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1761	compilation state is successful but some later stage fails.
		1762
		1763	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1764	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1765	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1766	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1767	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1768	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1769	C<-create-library>, C<-enable-link-options>.
		1770
1533	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1771	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1534		1772
1535	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1773	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1536		1774
1537	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1775	Similar to C<< ->build >>, except it starts a thread, and never fails (you
…		…
1559		1797
1560	=for gengetinfo begin program_build	1798	=for gengetinfo begin program_build
1561		1799
1562	=item $build_status = $program->build_status ($device)	1800	=item $build_status = $program->build_status ($device)
1563		1801
1564	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1802	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
		1803
		1804	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1805	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1565		1806
1566	=item $string = $program->build_options ($device)	1807	=item $string = $program->build_options ($device)
1567		1808
1568	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1809	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1569		1810
1570	=item $string = $program->build_log ($device)	1811	=item $string = $program->build_log ($device)
1571		1812
1572	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1813	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1573		1814
1574	=for gengetinfo end program_build	1815	=for gengetinfo end program_build
1575		1816
1576	=item $packed_value = $program->info ($name)	1817	=item $packed_value = $program->info ($name)
1577		1818
…		…
1581		1822
1582	=for gengetinfo begin program	1823	=for gengetinfo begin program
1583		1824
1584	=item $uint = $program->reference_count	1825	=item $uint = $program->reference_count
1585		1826
1586	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1827	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1587		1828
1588	=item $ctx = $program->context	1829	=item $ctx = $program->context
1589		1830
1590	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1831	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1591		1832
1592	=item $uint = $program->num_devices	1833	=item $uint = $program->num_devices
1593		1834
1594	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1835	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1595		1836
1596	=item @devices = $program->devices	1837	=item @devices = $program->devices
1597		1838
1598	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1839	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1599		1840
1600	=item $string = $program->source	1841	=item $string = $program->source
1601		1842
1602	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1843	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1603		1844
1604	=item @ints = $program->binary_sizes	1845	=item @ints = $program->binary_sizes
1605		1846
1606	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1847	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1607		1848
1608	=for gengetinfo end program	1849	=for gengetinfo end program
1609		1850
1610	=item @blobs = $program->binaries	1851	=item @blobs = $program->binaries
1611		1852
…		…
1632		1873
1633	=for gengetinfo begin kernel	1874	=for gengetinfo begin kernel
1634		1875
1635	=item $string = $kernel->function_name	1876	=item $string = $kernel->function_name
1636		1877
1637	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1878	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1638		1879
1639	=item $uint = $kernel->num_args	1880	=item $uint = $kernel->num_args
1640		1881
1641	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1882	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1642		1883
1643	=item $uint = $kernel->reference_count	1884	=item $uint = $kernel->reference_count
1644		1885
1645	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1886	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1646		1887
1647	=item $ctx = $kernel->context	1888	=item $ctx = $kernel->context
1648		1889
1649	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1890	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1650		1891
1651	=item $program = $kernel->program	1892	=item $program = $kernel->program
1652		1893
1653	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1894	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1654		1895
1655	=for gengetinfo end kernel	1896	=for gengetinfo end kernel
1656		1897
1657	=item $packed_value = $kernel->work_group_info ($device, $name)	1898	=item $packed_value = $kernel->work_group_info ($device, $name)
1658		1899
…		…
1665		1906
1666	=for gengetinfo begin kernel_work_group	1907	=for gengetinfo begin kernel_work_group
1667		1908
1668	=item $int = $kernel->work_group_size ($device)	1909	=item $int = $kernel->work_group_size ($device)
1669		1910
1670	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1911	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1671		1912
1672	=item @ints = $kernel->compile_work_group_size ($device)	1913	=item @ints = $kernel->compile_work_group_size ($device)
1673		1914
1674	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	1915	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1675		1916
1676	=item $ulong = $kernel->local_mem_size ($device)	1917	=item $ulong = $kernel->local_mem_size ($device)
1677		1918
1678	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	1919	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1679		1920
1680	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1921	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1681		1922
1682	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	1923	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1683		1924
1684	=item $ulong = $kernel->private_mem_size ($device)	1925	=item $ulong = $kernel->private_mem_size ($device)
1685		1926
1686	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1927	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1687		1928
1688	=for gengetinfo end kernel_work_group	1929	=for gengetinfo end kernel_work_group
1689		1930
		1931	=item $kernel->setf ($format, ...)
		1932
		1933	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1934	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1935	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1936	what type of argument it is.
		1937
		1938	The format arguments are single letters:
		1939
		1940	c char
		1941	C unsigned char
		1942	s short
		1943	S unsigned short
		1944	i int
		1945	I unsigned int
		1946	l long
		1947	L unsigned long
		1948
		1949	h half float (0..65535)
		1950	f float
		1951	d double
		1952
		1953	z local (octet size)
		1954
		1955	m memory object (buffer or image)
		1956	a sampler
		1957	e event
		1958
		1959	Space characters in the format string are ignored.
		1960
		1961	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1962
		1963	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1964
1690	=item $kernel->set_TYPE ($index, $value)	1965	=item $kernel->set_TYPE ($index, $value)
1691		1966
		1967	=item $kernel->set_char ($index, $value)
		1968
		1969	=item $kernel->set_uchar ($index, $value)
		1970
		1971	=item $kernel->set_short ($index, $value)
		1972
		1973	=item $kernel->set_ushort ($index, $value)
		1974
		1975	=item $kernel->set_int ($index, $value)
		1976
		1977	=item $kernel->set_uint ($index, $value)
		1978
		1979	=item $kernel->set_long ($index, $value)
		1980
		1981	=item $kernel->set_ulong ($index, $value)
		1982
		1983	=item $kernel->set_half ($index, $value)
		1984
		1985	=item $kernel->set_float ($index, $value)
		1986
		1987	=item $kernel->set_double ($index, $value)
		1988
		1989	=item $kernel->set_memory ($index, $value)
		1990
		1991	=item $kernel->set_buffer ($index, $value)
		1992
		1993	=item $kernel->set_image ($index, $value)
		1994
		1995	=item $kernel->set_sampler ($index, $value)
		1996
		1997	=item $kernel->set_local ($index, $value)
		1998
		1999	=item $kernel->set_event ($index, $value)
		2000
1692	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	2001	This is a family of methods to set the kernel argument with the number
1693		2002	C<$index> to the give C<$value>.
1694	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1695	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1696	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1697		2003
1698	Chars and integers (including the half type) are specified as integers,	2004	Chars and integers (including the half type) are specified as integers,
1699	float and double as floating point values, memory/buffer/image2d/image3d	2005	float and double as floating point values, memory/buffer/image must be
1700	must be an object of that type or C<undef>, local-memory arguments are	2006	an object of that type or C<undef>, local-memory arguments are set by
1701	set by specifying the size, and sampler and event must be objects of that	2007	specifying the size, and sampler and event must be objects of that type.
1702	type.	2008
		2009	Note that C<set_memory> works for all memory objects (all types of buffers
		2010	and images) - the main purpose of the more specific C<set_TYPE> functions
		2011	is type checking.
1703		2012
1704	Setting an argument for a kernel does NOT keep a reference to the object -	2013	Setting an argument for a kernel does NOT keep a reference to the object -
1705	for example, if you set an argument to some image object, free the image,	2014	for example, if you set an argument to some image object, free the image,
1706	and call the kernel, you will run into undefined behaviour.	2015	and call the kernel, you will run into undefined behaviour.
1707		2016
…		…
1737		2046
1738	=for gengetinfo begin event	2047	=for gengetinfo begin event
1739		2048
1740	=item $queue = $event->command_queue	2049	=item $queue = $event->command_queue
1741		2050
1742	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2051	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1743		2052
1744	=item $command_type = $event->command_type	2053	=item $command_type = $event->command_type
1745		2054
1746	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2055	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1747		2056
1748	=item $uint = $event->reference_count	2057	=item $uint = $event->reference_count
1749		2058
1750	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2059	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1751		2060
1752	=item $uint = $event->command_execution_status	2061	=item $uint = $event->command_execution_status
1753		2062
1754	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2063	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1755		2064
1756	=item $ctx = $event->context	2065	=item $ctx = $event->context
1757		2066
1758	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2067	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1759		2068
1760	=for gengetinfo end event	2069	=for gengetinfo end event
1761		2070
1762	=item $packed_value = $ev->profiling_info ($name)	2071	=item $packed_value = $ev->profiling_info ($name)
1763		2072
…		…
1770		2079
1771	=for gengetinfo begin profiling	2080	=for gengetinfo begin profiling
1772		2081
1773	=item $ulong = $event->profiling_command_queued	2082	=item $ulong = $event->profiling_command_queued
1774		2083
1775	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2084	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1776		2085
1777	=item $ulong = $event->profiling_command_submit	2086	=item $ulong = $event->profiling_command_submit
1778		2087
1779	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2088	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1780		2089
1781	=item $ulong = $event->profiling_command_start	2090	=item $ulong = $event->profiling_command_start
1782		2091
1783	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2092	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1784		2093
1785	=item $ulong = $event->profiling_command_end	2094	=item $ulong = $event->profiling_command_end
1786		2095
1787	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2096	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1788		2097
1789	=for gengetinfo end profiling	2098	=for gengetinfo end profiling
1790		2099
1791	=back	2100	=back
1792		2101
…		…
1799	=item $ev->set_status ($execution_status)	2108	=item $ev->set_status ($execution_status)
1800		2109
1801	Sets the execution status of the user event. Can only be called once,	2110	Sets the execution status of the user event. Can only be called once,
1802	either with OpenCL::COMPLETE or a negative number as status.	2111	either with OpenCL::COMPLETE or a negative number as status.
1803		2112
		2113	execution_status: OpenCL::COMPLETE or a negative integer.
		2114
1804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2115	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1805		2116
1806	=back	2117	=back
		2118
		2119	=head2 THE OpenCL::Mapped CLASS
		2120
		2121	This class represents objects mapped into host memory. They are
		2122	represented by a blessed string scalar. The string data is the mapped
		2123	memory area, that is, if you read or write it, then the mapped object is
		2124	accessed directly.
		2125
		2126	You must only ever use operations that modify the string in-place - for
		2127	example, a C<substr> that doesn't change the length, or maybe a regex that
		2128	doesn't change the length. Any other operation might cause the data to be
		2129	copied.
		2130
		2131	When the object is destroyed it will enqueue an implicit unmap operation
		2132	on the queue that was used to create it.
		2133
		2134	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2135	OpenCL sees the changes, even if some implementations don't need this
		2136	sometimes.
		2137
		2138	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2139
		2140	my $mapped = $queue->map_buffer ($buf, ...
		2141	$mapped->event->wait; # make sure it's there
		2142
		2143	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2144	# we blindly assume device endianness to equal host endianness
		2145	# (and of course, we assume iee 754 single precision floats :)
		2146	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2147
		2148	=over 4
		2149
		2150	=item $ev = $mapped->unmap ($wait_events...)
		2151
		2152	Unmaps the mapped memory object, using the queue originally used to create
		2153	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2154
		2155	=item $bool = $mapped->mapped
		2156
		2157	Returns whether the object is still mapped - true before an C<unmap> is
		2158	enqueued, false afterwards.
		2159
		2160	=item $ev = $mapped->event
		2161
		2162	Return the event object associated with the mapped object. Initially, this
		2163	will be the event object created when mapping the object, and after an
		2164	unmap, this will be the event object that the unmap operation created.
		2165
		2166	=item $mapped->wait
		2167
		2168	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2169	mapped object are outstanding.
		2170
		2171	=item $bytes = $mapped->size
		2172
		2173	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2174
		2175	=item $ptr = $mapped->ptr
		2176
		2177	Returns the raw memory address of the mapped area.
		2178
		2179	=item $mapped->set ($offset, $data)
		2180
		2181	Replaces the data at the given C<$offset> in the memory area by the new
		2182	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2183	because it does bounds-checking, but also slower.
		2184
		2185	=item $data = $mapped->get ($offset, $length)
		2186
		2187	Returns (without copying) a scalar representing the data at the given
		2188	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2189	the following substr, except much slower;
		2190
		2191	$data = substr $$mapped, $offset, $length
		2192
		2193	=cut
		2194
		2195	sub OpenCL::Mapped::get {
		2196	substr ${$_[0]}, $_[1], $_[2]
		2197	}
		2198
		2199	=back
		2200
		2201	=head2 THE OpenCL::MappedBuffer CLASS
		2202
		2203	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2204
		2205	=head2 THE OpenCL::MappedImage CLASS
		2206
		2207	This is a subclass of OpenCL::Mapped, representing mapped images.
		2208
		2209	=over 4
		2210
		2211	=item $bytes = $mapped->row_pitch
		2212
		2213	=item $bytes = $mapped->slice_pitch
		2214
		2215	Return the row or slice pitch of the image that has been mapped.
		2216
		2217	=back
		2218
1807		2219
1808	=cut	2220	=cut
1809		2221
1810	1;	2222	1;
1811		2223

Diff Legend

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