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.75 by root, Sat May 5 02:30:27 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
…		…
386	OpenCL can generate a number of (potentially) asynchronous events, for	434	OpenCL can generate a number of (potentially) asynchronous events, for
387	example, after compiling a program, to signal a context-related error or,	435	example, after compiling a program, to signal a context-related error or,
388	perhaps most important, to signal completion of queued jobs (by setting	436	perhaps most important, to signal completion of queued jobs (by setting
389	callbacks on OpenCL::Event objects).	437	callbacks on OpenCL::Event objects).
390		438
		439	The OpenCL module converts all these callbacks into events - you can
		440	still register callbacks, but they are not executed when your OpenCL
		441	implementation calls the actual callback, but only later. Therefore, none
		442	of the limitations of OpenCL callbacks apply to the perl implementation:
		443	it is perfectly safe to make blocking operations from event callbacks, and
		444	enqueued operations don't need to be flushed.
		445
391	To facilitate this, this module maintains an event queue - each	446	To facilitate this, this module maintains an event queue - each
392	time an asynchronous event happens, it is queued, and perl will be	447	time an asynchronous event happens, it is queued, and perl will be
393	interrupted. This is implemented via the L<Async::Interrupt> module. In	448	interrupted. This is implemented via the L<Async::Interrupt> module. In
394	addition, this module has L<AnyEvent> support, so it can seamlessly	449	addition, this module has L<AnyEvent> support, so it can seamlessly
395	integrate itself into many event loops.	450	integrate itself into many event loops.
396		451
397	Since this module is a bit hard to understand, here are some case examples:	452	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
398		453
399	=head3 Don't use callbacks.	454	=head3 Don't use callbacks.
400		455
401	When your program never uses any callbacks, then there will never be any	456	When your program never uses any callbacks, then there will never be any
402	notifications you need to take care of, and therefore no need to worry	457	notifications you need to take care of, and therefore no need to worry
…		…
420	use AnyEvent;	475	use AnyEvent;
421		476
422	# initialise AnyEvent, by creating a watcher, or:	477	# initialise AnyEvent, by creating a watcher, or:
423	AnyEvent::detect;	478	AnyEvent::detect;
424		479
425	my $e = $queue->enqueue_marker;	480	my $e = $queue->marker;
426	$e->cb (sub {	481	$e->cb (sub {
427	warn "opencl is finished\n";	482	warn "opencl is finished\n";
428	})	483	})
429		484
430	main Gtk2;	485	main Gtk2;
…		…
447	Asynchronously means that perl might execute your callbacks at any	502	Asynchronously means that perl might execute your callbacks at any
448	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),	503	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	504	the C<until> loop following the marker call will be interrupted by the
450	callback:	505	callback:
451		506
452	my $e = $queue->enqueue_marker;	507	my $e = $queue->marker;
453	my $flag;	508	my $flag;
454	$e->cb (sub { $flag = 1 });	509	$e->cb (sub { $flag = 1 });
455	1 until $flag;	510	1 until $flag;
456	# $flag is now 1	511	# $flag is now 1
457		512
…		…
493	=cut	548	=cut
494		549
495	package OpenCL;	550	package OpenCL;
496		551
497	use common::sense;	552	use common::sense;
		553	use Carp ();
498	use Async::Interrupt ();	554	use Async::Interrupt ();
499		555
500	our $POLL_FUNC; # set by XS	556	our $POLL_FUNC; # set by XS
501		557
502	BEGIN {	558	BEGIN {
503	our $VERSION = '0.97';	559	our $VERSION = '0.99';
504		560
505	require XSLoader;	561	require XSLoader;
506	XSLoader::load (__PACKAGE__, $VERSION);	562	XSLoader::load (__PACKAGE__, $VERSION);
507		563
508	@OpenCL::Platform::ISA =	564	@OpenCL::Platform::ISA =
…		…
513	@OpenCL::Sampler::ISA =	569	@OpenCL::Sampler::ISA =
514	@OpenCL::Program::ISA =	570	@OpenCL::Program::ISA =
515	@OpenCL::Kernel::ISA =	571	@OpenCL::Kernel::ISA =
516	@OpenCL::Event::ISA = OpenCL::Object::;	572	@OpenCL::Event::ISA = OpenCL::Object::;
517		573
		574	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		575
518	@OpenCL::Buffer::ISA =	576	@OpenCL::Buffer::ISA =
519	@OpenCL::Image::ISA = OpenCL::Memory::;	577	@OpenCL::Image::ISA = OpenCL::Memory::;
520		578
521	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	579	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
522		580
…		…
526	@OpenCL::Image1D::ISA =	584	@OpenCL::Image1D::ISA =
527	@OpenCL::Image1DArray::ISA =	585	@OpenCL::Image1DArray::ISA =
528	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	586	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
529		587
530	@OpenCL::UserEvent::ISA = OpenCL::Event::;	588	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		589
		590	@OpenCL::MappedBuffer::ISA =
		591	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
531	}	592	}
532		593
533	=head2 THE OpenCL PACKAGE	594	=head2 THE OpenCL PACKAGE
534		595
535	=over 4	596	=over 4
…		…
537	=item $int = OpenCL::errno	598	=item $int = OpenCL::errno
538		599
539	The last error returned by a function - it's only valid after an error occured	600	The last error returned by a function - it's only valid after an error occured
540	and before calling another OpenCL function.	601	and before calling another OpenCL function.
541		602
542	=item $str = OpenCL::err2str $errval	603	=item $str = OpenCL::err2str [$errval]
543		604
544	Comverts an error value into a human readable string.	605	Converts an error value into a human readable string. IF no error value is
		606	given, then the last error will be used (as returned by OpenCL::errno).
545		607
546	=item $str = OpenCL::enum2str $enum	608	=item $str = OpenCL::enum2str $enum
547		609
548	Converts most enum values (of parameter names, image format constants,	610	Converts most enum values (of parameter names, image format constants,
549	object types, addressing and filter modes, command types etc.) into a	611	object types, addressing and filter modes, command types etc.) into a
…		…
559		621
560	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	622	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
561		623
562	Tries to create a context from a default device and platform type - never worked for me.	624	Tries to create a context from a default device and platform type - never worked for me.
563		625
		626	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		627	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
		628
564	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	629	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
565		630
566	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	631	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
567		632
568	Create a new OpenCL::Context object using the given device object(s). This	633	Create a new OpenCL::Context object using the given device object(s). This
…		…
681		746
682	=for gengetinfo begin platform	747	=for gengetinfo begin platform
683		748
684	=item $string = $platform->profile	749	=item $string = $platform->profile
685		750
686	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	751	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
687		752
688	=item $string = $platform->version	753	=item $string = $platform->version
689		754
690	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	755	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
691		756
692	=item $string = $platform->name	757	=item $string = $platform->name
693		758
694	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	759	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
695		760
696	=item $string = $platform->vendor	761	=item $string = $platform->vendor
697		762
698	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	763	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
699		764
700	=item $string = $platform->extensions	765	=item $string = $platform->extensions
701		766
702	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	767	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
703		768
704	=for gengetinfo end platform	769	=for gengetinfo end platform
705		770
706	=back	771	=back
707		772
…		…
713		778
714	See C<< $platform->info >> for details.	779	See C<< $platform->info >> for details.
715		780
716	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	781	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
717		782
		783	=item @devices = $device->sub_devices (\@properties)
		784
		785	Creates OpencL::SubDevice objects by partitioning an existing device.
		786
		787	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		788
718	=for gengetinfo begin device	789	=for gengetinfo begin device
719		790
720	=item $device_type = $device->type	791	=item $device_type = $device->type
721		792
722	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	793	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
723		794
724	=item $uint = $device->vendor_id	795	=item $uint = $device->vendor_id
725		796
726	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	797	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
727		798
728	=item $uint = $device->max_compute_units	799	=item $uint = $device->max_compute_units
729		800
730	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	801	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
731		802
732	=item $uint = $device->max_work_item_dimensions	803	=item $uint = $device->max_work_item_dimensions
733		804
734	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	805	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
735		806
736	=item $int = $device->max_work_group_size	807	=item $int = $device->max_work_group_size
737		808
738	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	809	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
739		810
740	=item @ints = $device->max_work_item_sizes	811	=item @ints = $device->max_work_item_sizes
741		812
742	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	813	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
743		814
744	=item $uint = $device->preferred_vector_width_char	815	=item $uint = $device->preferred_vector_width_char
745		816
746	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	817	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
747		818
748	=item $uint = $device->preferred_vector_width_short	819	=item $uint = $device->preferred_vector_width_short
749		820
750	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	821	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
751		822
752	=item $uint = $device->preferred_vector_width_int	823	=item $uint = $device->preferred_vector_width_int
753		824
754	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	825	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
755		826
756	=item $uint = $device->preferred_vector_width_long	827	=item $uint = $device->preferred_vector_width_long
757		828
758	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	829	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
759		830
760	=item $uint = $device->preferred_vector_width_float	831	=item $uint = $device->preferred_vector_width_float
761		832
762	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	833	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
763		834
764	=item $uint = $device->preferred_vector_width_double	835	=item $uint = $device->preferred_vector_width_double
765		836
766	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	837	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
767		838
768	=item $uint = $device->max_clock_frequency	839	=item $uint = $device->max_clock_frequency
769		840
770	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	841	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
771		842
772	=item $bitfield = $device->address_bits	843	=item $bitfield = $device->address_bits
773		844
774	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	845	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
775		846
776	=item $uint = $device->max_read_image_args	847	=item $uint = $device->max_read_image_args
777		848
778	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	849	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
779		850
780	=item $uint = $device->max_write_image_args	851	=item $uint = $device->max_write_image_args
781		852
782	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	853	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
783		854
784	=item $ulong = $device->max_mem_alloc_size	855	=item $ulong = $device->max_mem_alloc_size
785		856
786	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	857	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
787		858
788	=item $int = $device->image2d_max_width	859	=item $int = $device->image2d_max_width
789		860
790	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	861	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
791		862
792	=item $int = $device->image2d_max_height	863	=item $int = $device->image2d_max_height
793		864
794	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	865	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
795		866
796	=item $int = $device->image3d_max_width	867	=item $int = $device->image3d_max_width
797		868
798	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	869	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
799		870
800	=item $int = $device->image3d_max_height	871	=item $int = $device->image3d_max_height
801		872
802	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	873	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
803		874
804	=item $int = $device->image3d_max_depth	875	=item $int = $device->image3d_max_depth
805		876
806	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	877	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
807		878
808	=item $uint = $device->image_support	879	=item $uint = $device->image_support
809		880
810	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	881	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
811		882
812	=item $int = $device->max_parameter_size	883	=item $int = $device->max_parameter_size
813		884
814	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	885	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
815		886
816	=item $uint = $device->max_samplers	887	=item $uint = $device->max_samplers
817		888
818	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	889	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
819		890
820	=item $uint = $device->mem_base_addr_align	891	=item $uint = $device->mem_base_addr_align
821		892
822	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	893	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
823		894
824	=item $uint = $device->min_data_type_align_size	895	=item $uint = $device->min_data_type_align_size
825		896
826	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	897	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
827		898
828	=item $device_fp_config = $device->single_fp_config	899	=item $device_fp_config = $device->single_fp_config
829		900
830	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	901	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
831		902
832	=item $device_mem_cache_type = $device->global_mem_cache_type	903	=item $device_mem_cache_type = $device->global_mem_cache_type
833		904
834	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	905	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
835		906
836	=item $uint = $device->global_mem_cacheline_size	907	=item $uint = $device->global_mem_cacheline_size
837		908
838	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	909	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
839		910
840	=item $ulong = $device->global_mem_cache_size	911	=item $ulong = $device->global_mem_cache_size
841		912
842	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	913	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
843		914
844	=item $ulong = $device->global_mem_size	915	=item $ulong = $device->global_mem_size
845		916
846	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	917	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
847		918
848	=item $ulong = $device->max_constant_buffer_size	919	=item $ulong = $device->max_constant_buffer_size
849		920
850	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	921	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
851		922
852	=item $uint = $device->max_constant_args	923	=item $uint = $device->max_constant_args
853		924
854	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	925	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
855		926
856	=item $device_local_mem_type = $device->local_mem_type	927	=item $device_local_mem_type = $device->local_mem_type
857		928
858	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	929	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
859		930
860	=item $ulong = $device->local_mem_size	931	=item $ulong = $device->local_mem_size
861		932
862	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	933	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
863		934
864	=item $boolean = $device->error_correction_support	935	=item $boolean = $device->error_correction_support
865		936
866	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	937	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
867		938
868	=item $int = $device->profiling_timer_resolution	939	=item $int = $device->profiling_timer_resolution
869		940
870	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	941	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
871		942
872	=item $boolean = $device->endian_little	943	=item $boolean = $device->endian_little
873		944
874	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	945	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
875		946
876	=item $boolean = $device->available	947	=item $boolean = $device->available
877		948
878	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	949	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
879		950
880	=item $boolean = $device->compiler_available	951	=item $boolean = $device->compiler_available
881		952
882	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	953	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
883		954
884	=item $device_exec_capabilities = $device->execution_capabilities	955	=item $device_exec_capabilities = $device->execution_capabilities
885		956
886	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	957	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
887		958
888	=item $command_queue_properties = $device->properties	959	=item $command_queue_properties = $device->properties
889		960
890	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	961	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
891		962
892	=item $ = $device->platform	963	=item $ = $device->platform
893		964
894	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	965	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
895		966
896	=item $string = $device->name	967	=item $string = $device->name
897		968
898	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	969	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
899		970
900	=item $string = $device->vendor	971	=item $string = $device->vendor
901		972
902	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	973	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
903		974
904	=item $string = $device->driver_version	975	=item $string = $device->driver_version
905		976
906	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	977	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
907		978
908	=item $string = $device->profile	979	=item $string = $device->profile
909		980
910	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	981	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
911		982
912	=item $string = $device->version	983	=item $string = $device->version
913		984
914	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	985	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
915		986
916	=item $string = $device->extensions	987	=item $string = $device->extensions
917		988
918	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	989	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
919		990
920	=item $uint = $device->preferred_vector_width_half	991	=item $uint = $device->preferred_vector_width_half
921		992
922	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	993	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
923		994
924	=item $uint = $device->native_vector_width_char	995	=item $uint = $device->native_vector_width_char
925		996
926	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	997	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
927		998
928	=item $uint = $device->native_vector_width_short	999	=item $uint = $device->native_vector_width_short
929		1000
930	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1001	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
931		1002
932	=item $uint = $device->native_vector_width_int	1003	=item $uint = $device->native_vector_width_int
933		1004
934	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1005	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
935		1006
936	=item $uint = $device->native_vector_width_long	1007	=item $uint = $device->native_vector_width_long
937		1008
938	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1009	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
939		1010
940	=item $uint = $device->native_vector_width_float	1011	=item $uint = $device->native_vector_width_float
941		1012
942	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1013	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
943		1014
944	=item $uint = $device->native_vector_width_double	1015	=item $uint = $device->native_vector_width_double
945		1016
946	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1017	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
947		1018
948	=item $uint = $device->native_vector_width_half	1019	=item $uint = $device->native_vector_width_half
949		1020
950	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1021	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
951		1022
952	=item $device_fp_config = $device->double_fp_config	1023	=item $device_fp_config = $device->double_fp_config
953		1024
954	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1025	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
955		1026
956	=item $device_fp_config = $device->half_fp_config	1027	=item $device_fp_config = $device->half_fp_config
957		1028
958	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1029	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
959		1030
960	=item $boolean = $device->host_unified_memory	1031	=item $boolean = $device->host_unified_memory
961		1032
962	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1033	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
963		1034
964	=item $device = $device->parent_device_ext	1035	=item $device = $device->parent_device_ext
965		1036
966	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1037	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
967		1038
968	=item @device_partition_property_exts = $device->partition_types_ext	1039	=item @device_partition_property_exts = $device->partition_types_ext
969		1040
970	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1041	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
971		1042
972	=item @device_partition_property_exts = $device->affinity_domains_ext	1043	=item @device_partition_property_exts = $device->affinity_domains_ext
973		1044
974	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1045	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
975		1046
976	=item $uint = $device->reference_count_ext	1047	=item $uint = $device->reference_count_ext
977		1048
978	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1049	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
979		1050
980	=item @device_partition_property_exts = $device->partition_style_ext	1051	=item @device_partition_property_exts = $device->partition_style_ext
981		1052
982	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1053	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
983		1054
984	=for gengetinfo end device	1055	=for gengetinfo end device
985		1056
986	=back	1057	=back
987		1058
988	=head2 THE OpenCL::Context CLASS	1059	=head2 THE OpenCL::Context CLASS
		1060
		1061	An OpenCL::Context is basically a container, or manager, for a number of
		1062	devices of a platform. It is used to create all sorts of secondary objects
		1063	such as buffers, queues, programs and so on.
		1064
		1065	All context creation functions and methods take a list of properties
		1066	(type-value pairs). All property values can be specified as integers -
		1067	some additionally support other types:
		1068
		1069	=over 4
		1070
		1071	=item OpenCL::CONTEXT_PLATFORM
		1072
		1073	Also accepts OpenCL::Platform objects.
		1074
		1075	=item OpenCL::GLX_DISPLAY_KHR
		1076
		1077	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1078	to find the current glx display (see L<GLX SUPPORT>).
		1079
		1080	=item OpenCL::GL_CONTEXT_KHR
		1081
		1082	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1083	to find the current glx context (see L<GLX SUPPORT>).
		1084
		1085	=back
989		1086
990	=over 4	1087	=over 4
991		1088
992	=item $prog = $ctx->build_program ($program, $options = "")	1089	=item $prog = $ctx->build_program ($program, $options = "")
993		1090
…		…
1002	=cut	1099	=cut
1003		1100
1004	sub OpenCL::Context::build_program {	1101	sub OpenCL::Context::build_program {
1005	my ($self, $prog, $options) = @_;	1102	my ($self, $prog, $options) = @_;
1006		1103
1007	require Carp;
1008
1009	$prog = $self->program_with_source ($prog)	1104	$prog = $self->program_with_source ($prog)
1010	unless ref $prog;	1105	unless ref $prog;
1011		1106
1012	# we build separately per device so we instantly know which one failed	1107	eval { $prog->build (undef, $options); 1 }
		1108	or errno == BUILD_PROGRAM_FAILURE
		1109	or errno == INVALID_BINARY # workaround nvidia bug
		1110	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1111
		1112	# we check status for all devices
1013	for my $dev ($self->devices) {	1113	for my $dev ($self->devices) {
1014	eval { $prog->build ([$dev], $options); 1 }	1114	$prog->build_status ($dev) == BUILD_SUCCESS
1015	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"	1115	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1016	. $prog->build_log ($dev));	1116	. $prog->build_log ($dev);
1017	}	1117	}
1018		1118
1019	$prog	1119	$prog
1020	}	1120	}
1021		1121
…		…
1038	=item $buf = $ctx->buffer ($flags, $len)	1138	=item $buf = $ctx->buffer ($flags, $len)
1039		1139
1040	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1140	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1041	given flags and octet-size.	1141	given flags and octet-size.
1042		1142
		1143	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1144	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1145	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1146
1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1147	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1044		1148
1045	=item $buf = $ctx->buffer_sv ($flags, $data)	1149	=item $buf = $ctx->buffer_sv ($flags, $data)
1046		1150
1047	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1151	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1048	initialise it with the given data values.	1152	initialise it with the given data values.
1049		1153
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)	1154	=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		1155
1052	Creates a new OpenCL::Image object and optionally initialises it with	1156	Creates a new OpenCL::Image object and optionally initialises it with
1053	the given data values.	1157	the given data values.
1054		1158
		1159	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1160	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1161	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1162
		1163	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1164	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1165	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1166	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1167	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1168
		1169
		1170	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1171	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1172	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1173	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1174
1055	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1175	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1056		1176
1057	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1177	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1058		1178
1059	Creates a new OpenCL::Image2D object and optionally initialises it with	1179	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1071	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1191	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1072		1192
1073	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1193	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1074	OpenGL buffer object.	1194	OpenGL buffer object.
1075		1195
		1196	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1197
1076	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1198	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1077		1199
1078	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1200	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1079		1201
1080	Creates a new OpenCL::Image object that refers to the given OpenGL	1202	Creates a new OpenCL::Image object that refers to the given OpenGL
1081	texture object or buffer.	1203	texture object or buffer.
1082		1204
		1205	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1206	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1207	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1208	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1209	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1210	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1211
1083	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1212	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1084		1213
1085	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1214	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1086		1215
1087	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1216	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1112		1241
1113	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1242	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1114		1243
1115	Creates a new OpenCL::Sampler object.	1244	Creates a new OpenCL::Sampler object.
1116		1245
		1246	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1247	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1248
		1249	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1250
1117	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1251	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1118		1252
1119	=item $program = $ctx->program_with_source ($string)	1253	=item $program = $ctx->program_with_source ($string)
1120		1254
1121	Creates a new OpenCL::Program object from the given source code.	1255	Creates a new OpenCL::Program object from the given source code.
1122		1256
1123	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1257	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1124		1258
		1259	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1260
		1261	Creates a new OpenCL::Program object from the given binaries.
		1262
		1263	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1264
		1265	Example: clone an existing program object that contains a successfully
		1266	compiled program, no matter how useless this is.
		1267
		1268	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1269
		1270	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1271
		1272	Creates a new OpenCL::Program object from the given built-in kernel names.
		1273
		1274	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1275
		1276	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1277
		1278	Links all (already compiled) program objects specified in C<@programs>
		1279	together and returns a new OpenCL::Program object with the result.
		1280
		1281	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1282
1125	=item $packed_value = $ctx->info ($name)	1283	=item $packed_value = $ctx->info ($name)
1126		1284
1127	See C<< $platform->info >> for details.	1285	See C<< $platform->info >> for details.
1128		1286
1129	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1287	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1130		1288
1131	=for gengetinfo begin context	1289	=for gengetinfo begin context
1132		1290
1133	=item $uint = $context->reference_count	1291	=item $uint = $context->reference_count
1134		1292
1135	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1293	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1136		1294
1137	=item @devices = $context->devices	1295	=item @devices = $context->devices
1138		1296
1139	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1297	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1140		1298
1141	=item @property_ints = $context->properties	1299	=item @property_ints = $context->properties
1142		1300
1143	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1301	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1144		1302
1145	=item $uint = $context->num_devices	1303	=item $uint = $context->num_devices
1146		1304
1147	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1305	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1148		1306
1149	=for gengetinfo end context	1307	=for gengetinfo end context
1150		1308
1151	=back	1309	=back
1152		1310
1153	=head2 THE OpenCL::Queue CLASS	1311	=head2 THE OpenCL::Queue CLASS
1154		1312
1155	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1313	An OpenCL::Queue represents an execution queue for OpenCL. You execute
1156	requests by calling their respective C<enqueue_xxx> method and waitinf for	1314	requests by calling their respective method and waiting for it to complete
1157	it to complete in some way.	1315	in some way.
1158		1316
1159	All the enqueue methods return an event object that can be used to wait	1317	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	1318	be used to wait for completion (optionally using a callback), unless
1161	no event object is created.	1319	the method is called in void context, in which case no event object is
		1320	created.
1162		1321
1163	They also allow you to specify any number of other event objects that this	1322	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	1323	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	1324	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	1325	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	1326	events. This makes it possible to code operations such as this, without
1168	having to put a valid event object into C<$event> first:	1327	having to put a valid event object into C<$event> first:
1169		1328
1170	$event = $queue->enqueue_xxx (..., $event);	1329	$event = $queue->xxx (..., $event);
1171		1330
1172	Queues execute in-order by default, without any parallelism, so in most	1331	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	1332	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	1333	create event objects, althoguh an our of order queue is often a bit
1175	faster.	1334	faster.
1176		1335
1177	=over 4	1336	=over 4
1178		1337
1179	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1338	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
1180		1339
1181	Reads data from buffer into the given string.	1340	Reads data from buffer into the given string.
1182		1341
1183	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1342	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
1184		1343
1185	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1344	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1186		1345
1187	Writes data to buffer from the given string.	1346	Writes data to buffer from the given string.
1188		1347
1189	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1348	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
1190		1349
1191	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1350	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1192		1351
1193	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1352	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1194		1353
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...)	1354	=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		1355
1197	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1356	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1198		1357
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...)	1358	=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		1359
1201	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1360	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1202		1361
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...)	1362	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1363
		1364	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1365
		1366	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1367
		1368	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1369	module uses the image width (and height) to supply default values.
1208		1370
1209	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1371	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1210		1372
1211	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1373	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1212		1374
		1375	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1376	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>	1377	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1214		1378
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...)	1379	=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		1380
1217	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1381	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1218		1382
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...)	1383	=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		1384
1221	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1385	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1222		1386
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...)	1387	=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		1388
1225	Yeah.	1389	Yeah.
1226		1390
1227	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1391	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1228		1392
1229	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1393	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1230		1394
1231	Fills the given buffer object with repeated applications of C<$pattern>,	1395	Fills the given buffer object with repeated applications of C<$pattern>,
1232	starting at C<$offset> for C<$size> octets.	1396	starting at C<$offset> for C<$size> octets.
1233		1397
1234	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>	1398	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1235		1399
1236	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)	1400	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1237		1401
1238	Fills the given image area with the given rgba colour components. The	1402	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>,	1403	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	1404	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.	1405	unnormalised format, in which case the range is determined by the format.
1242		1406
1243	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>	1407	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1244		1408
1245	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1409	=item $ev = $queue->task ($kernel, $wait_events...)
1246		1410
1247	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1411	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1248		1412
1249	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)	1413	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1250		1414
1251	Enqueues a kernel execution.	1415	Enqueues a kernel execution.
1252		1416
1253	\@global_work_size must be specified as a reference to an array of	1417	\@global_work_size must be specified as a reference to an array of
1254	integers specifying the work sizes (element counts).	1418	integers specifying the work sizes (element counts).
…		…
1262	reference to an array of local work sizes, with the same number of	1426	reference to an array of local work sizes, with the same number of
1263	elements as \@global_work_size.	1427	elements as \@global_work_size.
1264		1428
1265	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1429	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1266		1430
		1431	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1432
		1433	Migrates a number of OpenCL::Memory objects to or from the device.
		1434
		1435	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1436
		1437	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1438
1267	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1439	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1268		1440
1269	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1441	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1270	for subsequent OpenCL usage.	1442	for subsequent OpenCL usage.
1271		1443
1272	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1444	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1273		1445
1274	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1446	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1275		1447
1276	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1448	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1277	for subsequent OpenGL usage.	1449	for subsequent OpenGL usage.
1278		1450
1279	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1451	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1280		1452
1281	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1453	=item $ev = $queue->wait_for_events ($wait_events...)
1282		1454
1283	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1455	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1284		1456
1285	=item $ev = $queue->enqueue_marker ($wait_events...)	1457	=item $ev = $queue->marker ($wait_events...)
1286		1458
1287	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1459	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1288		1460
1289	=item $ev = $queue->enqueue_barrier ($wait_events...)	1461	=item $ev = $queue->barrier ($wait_events...)
1290		1462
1291	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1463	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1292		1464
1293	=item $queue->flush	1465	=item $queue->flush
1294		1466
…		…
1306		1478
1307	=for gengetinfo begin command_queue	1479	=for gengetinfo begin command_queue
1308		1480
1309	=item $ctx = $command_queue->context	1481	=item $ctx = $command_queue->context
1310		1482
1311	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1483	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1312		1484
1313	=item $device = $command_queue->device	1485	=item $device = $command_queue->device
1314		1486
1315	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1487	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1316		1488
1317	=item $uint = $command_queue->reference_count	1489	=item $uint = $command_queue->reference_count
1318		1490
1319	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1491	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1320		1492
1321	=item $command_queue_properties = $command_queue->properties	1493	=item $command_queue_properties = $command_queue->properties
1322		1494
1323	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1495	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1324		1496
1325	=for gengetinfo end command_queue	1497	=for gengetinfo end command_queue
		1498
		1499	=back
		1500
		1501	=head3 MEMORY MAPPED BUFFERS
		1502
		1503	OpenCL allows you to map buffers and images to host memory (read: perl
		1504	scalars). This is done much like reading or copying a buffer, by enqueuing
		1505	a map or unmap operation on the command queue.
		1506
		1507	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1508	OpenCL::Mapped CLASS> section for details on what to do with these
		1509	objects.
		1510
		1511	The object will be unmapped automatically when the mapped object is
		1512	destroyed (you can use a barrier to make sure the unmap has finished,
		1513	before using the buffer in a kernel), but you can also enqueue an unmap
		1514	operation manually.
		1515
		1516	=over 4
		1517
		1518	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1519
		1520	Maps the given buffer into host memory and returns an
		1521	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1522	the map will extend to the end of the buffer.
		1523
		1524	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1525
		1526	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1527
		1528	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1529
		1530	{
		1531	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1532	substr $$mapped, 0, 4, "abcd";
		1533	} # asynchronously unmap because $mapped is destroyed
		1534
		1535	=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...)
		1536
		1537	Maps the given image area into host memory and return an
		1538	C<OpenCL::MappedImage> object.
		1539
		1540	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1541	will be replaced by the maximum possible value.
		1542
		1543	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1544
		1545	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1546	the first channel of the leftmost column to 5, then explicitly unmap
		1547	it. You are not necessarily meant to do it this way, this example just
		1548	shows you the accessors to use :)
		1549
		1550	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1551
		1552	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1553	for 0..$image->height;
		1554
		1555	$mapped->unmap;.
		1556	$mapped->wait; # only needed for out of order queues normally
		1557
		1558	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1559
		1560	Unmaps the data from host memory. You must not call any methods that
		1561	modify the data, or modify the data scalar directly, after calling this
		1562	method.
		1563
		1564	The mapped event object will always be passed as part of the
		1565	$wait_events. The mapped event object will be replaced by the new event
		1566	object that this request creates.
1326		1567
1327	=back	1568	=back
1328		1569
1329	=head2 THE OpenCL::Memory CLASS	1570	=head2 THE OpenCL::Memory CLASS
1330		1571
…		…
1341		1582
1342	=for gengetinfo begin mem	1583	=for gengetinfo begin mem
1343		1584
1344	=item $mem_object_type = $mem->type	1585	=item $mem_object_type = $mem->type
1345		1586
1346	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1587	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1347		1588
1348	=item $mem_flags = $mem->flags	1589	=item $mem_flags = $mem->flags
1349		1590
1350	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1591	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1351		1592
1352	=item $int = $mem->size	1593	=item $int = $mem->size
1353		1594
1354	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1595	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1355		1596
1356	=item $ptr_value = $mem->host_ptr	1597	=item $ptr_value = $mem->host_ptr
1357		1598
1358	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1599	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1359		1600
1360	=item $uint = $mem->map_count	1601	=item $uint = $mem->map_count
1361		1602
1362	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1603	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1363		1604
1364	=item $uint = $mem->reference_count	1605	=item $uint = $mem->reference_count
1365		1606
1366	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1607	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1367		1608
1368	=item $ctx = $mem->context	1609	=item $ctx = $mem->context
1369		1610
1370	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1611	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1371		1612
1372	=item $mem = $mem->associated_memobject	1613	=item $mem = $mem->associated_memobject
1373		1614
1374	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1615	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1375		1616
1376	=item $int = $mem->offset	1617	=item $int = $mem->offset
1377		1618
1378	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1619	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1379		1620
1380	=for gengetinfo end mem	1621	=for gengetinfo end mem
1381		1622
1382	=item ($type, $name) = $mem->gl_object_info	1623	=item ($type, $name) = $mem->gl_object_info
1383		1624
…		…
1435		1676
1436	=for gengetinfo begin image	1677	=for gengetinfo begin image
1437		1678
1438	=item $int = $image->element_size	1679	=item $int = $image->element_size
1439		1680
1440	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1681	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1441		1682
1442	=item $int = $image->row_pitch	1683	=item $int = $image->row_pitch
1443		1684
1444	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1685	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1445		1686
1446	=item $int = $image->slice_pitch	1687	=item $int = $image->slice_pitch
1447		1688
1448	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1689	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1449		1690
1450	=item $int = $image->width	1691	=item $int = $image->width
1451		1692
1452	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1693	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1453		1694
1454	=item $int = $image->height	1695	=item $int = $image->height
1455		1696
1456	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1697	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1457		1698
1458	=item $int = $image->depth	1699	=item $int = $image->depth
1459		1700
1460	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1701	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1461		1702
1462	=for gengetinfo end image	1703	=for gengetinfo end image
1463		1704
1464	=for gengetinfo begin gl_texture	1705	=for gengetinfo begin gl_texture
1465		1706
1466	=item $GLenum = $gl_texture->target	1707	=item $GLenum = $gl_texture->target
1467		1708
1468	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1709	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1469		1710
1470	=item $GLint = $gl_texture->gl_mipmap_level	1711	=item $GLint = $gl_texture->gl_mipmap_level
1471		1712
1472	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1713	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1473		1714
1474	=for gengetinfo end gl_texture	1715	=for gengetinfo end gl_texture
1475		1716
1476	=back	1717	=back
1477		1718
…		…
1487		1728
1488	=for gengetinfo begin sampler	1729	=for gengetinfo begin sampler
1489		1730
1490	=item $uint = $sampler->reference_count	1731	=item $uint = $sampler->reference_count
1491		1732
1492	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1733	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1493		1734
1494	=item $ctx = $sampler->context	1735	=item $ctx = $sampler->context
1495		1736
1496	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1737	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1497		1738
1498	=item $addressing_mode = $sampler->normalized_coords	1739	=item $addressing_mode = $sampler->normalized_coords
1499		1740
1500	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1741	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1501		1742
1502	=item $filter_mode = $sampler->addressing_mode	1743	=item $filter_mode = $sampler->addressing_mode
1503		1744
1504	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1745	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1505		1746
1506	=item $boolean = $sampler->filter_mode	1747	=item $boolean = $sampler->filter_mode
1507		1748
1508	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1749	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1509		1750
1510	=for gengetinfo end sampler	1751	=for gengetinfo end sampler
1511		1752
1512	=back	1753	=back
1513		1754
…		…
1523	If a callback is specified, then it will be called when compilation is	1764	If a callback is specified, then it will be called when compilation is
1524	finished. Note that many OpenCL implementations block your program while	1765	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	1766	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.	1767	want to make sure the build is done in the background.
1527		1768
1528	Note that some OpenCL implementations atc up badly, and don't call the	1769	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	1770	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	1771	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.	1772	not so. So best make sure you don't pass in invalid values.
1532		1773
		1774	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1775	compilation state is successful but some later stage fails.
		1776
		1777	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1778	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1779	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1780	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1781	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1782	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1783	C<-create-library>, C<-enable-link-options>.
		1784
		1785	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1786	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1787
1533	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1788	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1534		1789
1535	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1790	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1536		1791
1537	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1792	Similar to C<< ->build >>, except it starts a thread, and never fails (you
1538	need to check the compilation status form the callback, or by polling).	1793	need to check the compilation status form the callback, or by polling).
1539		1794
		1795	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1796
		1797	Compiles the given program for the given devices (or all devices if
		1798	undef). If C<$headers> is given, it must be a hashref with include name =>
		1799	OpenCL::Program pairs.
		1800
		1801	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
		1802
1540	=item $packed_value = $program->build_info ($device, $name)	1803	=item $packed_value = $program->build_info ($device, $name)
1541		1804
1542	Similar to C<< $platform->info >>, but returns build info for a previous	1805	Similar to C<< $platform->info >>, but returns build info for a previous
1543	build attempt for the given device.	1806	build attempt for the given device.
1544		1807
…		…
1559		1822
1560	=for gengetinfo begin program_build	1823	=for gengetinfo begin program_build
1561		1824
1562	=item $build_status = $program->build_status ($device)	1825	=item $build_status = $program->build_status ($device)
1563		1826
1564	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1827	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1565		1828
1566	=item $string = $program->build_options ($device)	1829	=item $string = $program->build_options ($device)
1567		1830
1568	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1831	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1569		1832
1570	=item $string = $program->build_log ($device)	1833	=item $string = $program->build_log ($device)
1571		1834
1572	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1835	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1573		1836
1574	=for gengetinfo end program_build	1837	=for gengetinfo end program_build
1575		1838
1576	=item $packed_value = $program->info ($name)	1839	=item $packed_value = $program->info ($name)
1577		1840
…		…
1581		1844
1582	=for gengetinfo begin program	1845	=for gengetinfo begin program
1583		1846
1584	=item $uint = $program->reference_count	1847	=item $uint = $program->reference_count
1585		1848
1586	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1849	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1587		1850
1588	=item $ctx = $program->context	1851	=item $ctx = $program->context
1589		1852
1590	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1853	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1591		1854
1592	=item $uint = $program->num_devices	1855	=item $uint = $program->num_devices
1593		1856
1594	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1857	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1595		1858
1596	=item @devices = $program->devices	1859	=item @devices = $program->devices
1597		1860
1598	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1861	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1599		1862
1600	=item $string = $program->source	1863	=item $string = $program->source
1601		1864
1602	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1865	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1603		1866
1604	=item @ints = $program->binary_sizes	1867	=item @ints = $program->binary_sizes
1605		1868
1606	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1869	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1607		1870
1608	=for gengetinfo end program	1871	=for gengetinfo end program
1609		1872
1610	=item @blobs = $program->binaries	1873	=item @blobs = $program->binaries
1611		1874
…		…
1632		1895
1633	=for gengetinfo begin kernel	1896	=for gengetinfo begin kernel
1634		1897
1635	=item $string = $kernel->function_name	1898	=item $string = $kernel->function_name
1636		1899
1637	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1900	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1638		1901
1639	=item $uint = $kernel->num_args	1902	=item $uint = $kernel->num_args
1640		1903
1641	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1904	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1642		1905
1643	=item $uint = $kernel->reference_count	1906	=item $uint = $kernel->reference_count
1644		1907
1645	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1908	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1646		1909
1647	=item $ctx = $kernel->context	1910	=item $ctx = $kernel->context
1648		1911
1649	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1912	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1650		1913
1651	=item $program = $kernel->program	1914	=item $program = $kernel->program
1652		1915
1653	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1916	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1654		1917
1655	=for gengetinfo end kernel	1918	=for gengetinfo end kernel
1656		1919
1657	=item $packed_value = $kernel->work_group_info ($device, $name)	1920	=item $packed_value = $kernel->work_group_info ($device, $name)
1658		1921
1659	See C<< $platform->info >> for details.	1922	See C<< $platform->info >> for details.
1660		1923
1661	The reason this method is not called C<info> is that there already is an
1662	C<< ->info >> method.
1663
1664	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1924	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1665		1925
1666	=for gengetinfo begin kernel_work_group	1926	=for gengetinfo begin kernel_work_group
1667		1927
1668	=item $int = $kernel->work_group_size ($device)	1928	=item $int = $kernel->work_group_size ($device)
1669		1929
1670	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1930	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1671		1931
1672	=item @ints = $kernel->compile_work_group_size ($device)	1932	=item @ints = $kernel->compile_work_group_size ($device)
1673		1933
1674	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	1934	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1675		1935
1676	=item $ulong = $kernel->local_mem_size ($device)	1936	=item $ulong = $kernel->local_mem_size ($device)
1677		1937
1678	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	1938	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1679		1939
1680	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1940	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1681		1941
1682	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	1942	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1683		1943
1684	=item $ulong = $kernel->private_mem_size ($device)	1944	=item $ulong = $kernel->private_mem_size ($device)
1685		1945
1686	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1946	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1687		1947
1688	=for gengetinfo end kernel_work_group	1948	=for gengetinfo end kernel_work_group
1689		1949
		1950	=item $packed_value = $kernel->arg_info ($idx, $name)
		1951
		1952	See C<< $platform->info >> for details.
		1953
		1954	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		1955
		1956	=for gengetinfo begin kernel_arg
		1957
		1958	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		1959
		1960	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		1961
		1962	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		1963
		1964	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		1965
		1966	=item $string = $kernel->arg_type_name ($idx)
		1967
		1968	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		1969
		1970	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		1971
		1972	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		1973
		1974	=item $string = $kernel->arg_name ($idx)
		1975
		1976	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		1977
		1978	=for gengetinfo end kernel_arg
		1979
		1980	=item $kernel->setf ($format, ...)
		1981
		1982	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1983	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1984	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1985	what type of argument it is.
		1986
		1987	The format arguments are single letters:
		1988
		1989	c char
		1990	C unsigned char
		1991	s short
		1992	S unsigned short
		1993	i int
		1994	I unsigned int
		1995	l long
		1996	L unsigned long
		1997
		1998	h half float (0..65535)
		1999	f float
		2000	d double
		2001
		2002	z local (octet size)
		2003
		2004	m memory object (buffer or image)
		2005	a sampler
		2006	e event
		2007
		2008	Space characters in the format string are ignored.
		2009
		2010	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		2011
		2012	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		2013
1690	=item $kernel->set_TYPE ($index, $value)	2014	=item $kernel->set_TYPE ($index, $value)
1691		2015
		2016	=item $kernel->set_char ($index, $value)
		2017
		2018	=item $kernel->set_uchar ($index, $value)
		2019
		2020	=item $kernel->set_short ($index, $value)
		2021
		2022	=item $kernel->set_ushort ($index, $value)
		2023
		2024	=item $kernel->set_int ($index, $value)
		2025
		2026	=item $kernel->set_uint ($index, $value)
		2027
		2028	=item $kernel->set_long ($index, $value)
		2029
		2030	=item $kernel->set_ulong ($index, $value)
		2031
		2032	=item $kernel->set_half ($index, $value)
		2033
		2034	=item $kernel->set_float ($index, $value)
		2035
		2036	=item $kernel->set_double ($index, $value)
		2037
		2038	=item $kernel->set_memory ($index, $value)
		2039
		2040	=item $kernel->set_buffer ($index, $value)
		2041
		2042	=item $kernel->set_image ($index, $value)
		2043
		2044	=item $kernel->set_sampler ($index, $value)
		2045
		2046	=item $kernel->set_local ($index, $value)
		2047
		2048	=item $kernel->set_event ($index, $value)
		2049
1692	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	2050	This is a family of methods to set the kernel argument with the number
1693		2051	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		2052
1698	Chars and integers (including the half type) are specified as integers,	2053	Chars and integers (including the half type) are specified as integers,
1699	float and double as floating point values, memory/buffer/image2d/image3d	2054	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	2055	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	2056	specifying the size, and sampler and event must be objects of that type.
1702	type.	2057
		2058	Note that C<set_memory> works for all memory objects (all types of buffers
		2059	and images) - the main purpose of the more specific C<set_TYPE> functions
		2060	is type checking.
1703		2061
1704	Setting an argument for a kernel does NOT keep a reference to the object -	2062	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,	2063	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.	2064	and call the kernel, you will run into undefined behaviour.
1707		2065
…		…
1737		2095
1738	=for gengetinfo begin event	2096	=for gengetinfo begin event
1739		2097
1740	=item $queue = $event->command_queue	2098	=item $queue = $event->command_queue
1741		2099
1742	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2100	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1743		2101
1744	=item $command_type = $event->command_type	2102	=item $command_type = $event->command_type
1745		2103
1746	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2104	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1747		2105
1748	=item $uint = $event->reference_count	2106	=item $uint = $event->reference_count
1749		2107
1750	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2108	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1751		2109
1752	=item $uint = $event->command_execution_status	2110	=item $uint = $event->command_execution_status
1753		2111
1754	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2112	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1755		2113
1756	=item $ctx = $event->context	2114	=item $ctx = $event->context
1757		2115
1758	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2116	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1759		2117
1760	=for gengetinfo end event	2118	=for gengetinfo end event
1761		2119
1762	=item $packed_value = $ev->profiling_info ($name)	2120	=item $packed_value = $ev->profiling_info ($name)
1763		2121
…		…
1770		2128
1771	=for gengetinfo begin profiling	2129	=for gengetinfo begin profiling
1772		2130
1773	=item $ulong = $event->profiling_command_queued	2131	=item $ulong = $event->profiling_command_queued
1774		2132
1775	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2133	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1776		2134
1777	=item $ulong = $event->profiling_command_submit	2135	=item $ulong = $event->profiling_command_submit
1778		2136
1779	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2137	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1780		2138
1781	=item $ulong = $event->profiling_command_start	2139	=item $ulong = $event->profiling_command_start
1782		2140
1783	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2141	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1784		2142
1785	=item $ulong = $event->profiling_command_end	2143	=item $ulong = $event->profiling_command_end
1786		2144
1787	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2145	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1788		2146
1789	=for gengetinfo end profiling	2147	=for gengetinfo end profiling
1790		2148
1791	=back	2149	=back
1792		2150
…		…
1799	=item $ev->set_status ($execution_status)	2157	=item $ev->set_status ($execution_status)
1800		2158
1801	Sets the execution status of the user event. Can only be called once,	2159	Sets the execution status of the user event. Can only be called once,
1802	either with OpenCL::COMPLETE or a negative number as status.	2160	either with OpenCL::COMPLETE or a negative number as status.
1803		2161
		2162	execution_status: OpenCL::COMPLETE or a negative integer.
		2163
1804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2164	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1805		2165
1806	=back	2166	=back
		2167
		2168	=head2 THE OpenCL::Mapped CLASS
		2169
		2170	This class represents objects mapped into host memory. They are
		2171	represented by a blessed string scalar. The string data is the mapped
		2172	memory area, that is, if you read or write it, then the mapped object is
		2173	accessed directly.
		2174
		2175	You must only ever use operations that modify the string in-place - for
		2176	example, a C<substr> that doesn't change the length, or maybe a regex that
		2177	doesn't change the length. Any other operation might cause the data to be
		2178	copied.
		2179
		2180	When the object is destroyed it will enqueue an implicit unmap operation
		2181	on the queue that was used to create it.
		2182
		2183	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2184	OpenCL sees the changes, even if some implementations don't need this
		2185	sometimes.
		2186
		2187	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2188
		2189	my $mapped = $queue->map_buffer ($buf, ...
		2190	$mapped->event->wait; # make sure it's there
		2191
		2192	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2193	# we blindly assume device endianness to equal host endianness
		2194	# (and of course, we assume iee 754 single precision floats :)
		2195	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2196
		2197	=over 4
		2198
		2199	=item $ev = $mapped->unmap ($wait_events...)
		2200
		2201	Unmaps the mapped memory object, using the queue originally used to create
		2202	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2203
		2204	=item $bool = $mapped->mapped
		2205
		2206	Returns whether the object is still mapped - true before an C<unmap> is
		2207	enqueued, false afterwards.
		2208
		2209	=item $ev = $mapped->event
		2210
		2211	Return the event object associated with the mapped object. Initially, this
		2212	will be the event object created when mapping the object, and after an
		2213	unmap, this will be the event object that the unmap operation created.
		2214
		2215	=item $mapped->wait
		2216
		2217	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2218	mapped object are outstanding.
		2219
		2220	=item $bytes = $mapped->size
		2221
		2222	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2223
		2224	=item $ptr = $mapped->ptr
		2225
		2226	Returns the raw memory address of the mapped area.
		2227
		2228	=item $mapped->set ($offset, $data)
		2229
		2230	Replaces the data at the given C<$offset> in the memory area by the new
		2231	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2232	because it does bounds-checking, but also slower.
		2233
		2234	=item $data = $mapped->get ($offset, $length)
		2235
		2236	Returns (without copying) a scalar representing the data at the given
		2237	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2238	the following substr, except much slower;
		2239
		2240	$data = substr $$mapped, $offset, $length
		2241
		2242	=cut
		2243
		2244	sub OpenCL::Mapped::get {
		2245	substr ${$_[0]}, $_[1], $_[2]
		2246	}
		2247
		2248	=back
		2249
		2250	=head2 THE OpenCL::MappedBuffer CLASS
		2251
		2252	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2253
		2254	=head2 THE OpenCL::MappedImage CLASS
		2255
		2256	This is a subclass of OpenCL::Mapped, representing mapped images.
		2257
		2258	=over 4
		2259
		2260	=item $bytes = $mapped->row_pitch
		2261
		2262	=item $bytes = $mapped->slice_pitch
		2263
		2264	Return the row or slice pitch of the image that has been mapped.
		2265
		2266	=back
		2267
1807		2268
1808	=cut	2269	=cut
1809		2270
1810	1;	2271	1;
1811		2272

Diff Legend

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