[ViewVC] Diff of: cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC vs.
Revision 1.71 by root, Fri May 4 14:29:35 2012 UTC

…		…
43		43
44	OpenCL::Event objects are used to signal when something is complete.	44	OpenCL::Event objects are used to signal when something is complete.
45		45
46	=head2 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
47		47
48	The OpenCL specs used to develop this module:	48	The OpenCL specs used to develop this module - download these and keept
		49	hema round, they are required reference material:
49		50
50	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf	52	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf	53	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53		54
…		…
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");
…		…
276	for (my $time; ; ++$time) {	281	for (my $time; ; ++$time) {
277	# acquire objects from opengl	282	# acquire objects from opengl
278	$queue->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->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->release_gl_objects ([$tex]);	290	$queue->release_gl_objects ([$tex]);
287		291
288	# wait	292	# wait
…		…
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
…		…
493	=cut	541	=cut
494		542
495	package OpenCL;	543	package OpenCL;
496		544
497	use common::sense;	545	use common::sense;
		546	use Carp ();
498	use Async::Interrupt ();	547	use Async::Interrupt ();
499		548
500	our $POLL_FUNC; # set by XS	549	our $POLL_FUNC; # set by XS
501		550
502	BEGIN {	551	BEGIN {
503	our $VERSION = '0.97';	552	our $VERSION = '0.99';
504		553
505	require XSLoader;	554	require XSLoader;
506	XSLoader::load (__PACKAGE__, $VERSION);	555	XSLoader::load (__PACKAGE__, $VERSION);
507		556
508	@OpenCL::Platform::ISA =	557	@OpenCL::Platform::ISA =
…		…
513	@OpenCL::Sampler::ISA =	562	@OpenCL::Sampler::ISA =
514	@OpenCL::Program::ISA =	563	@OpenCL::Program::ISA =
515	@OpenCL::Kernel::ISA =	564	@OpenCL::Kernel::ISA =
516	@OpenCL::Event::ISA = OpenCL::Object::;	565	@OpenCL::Event::ISA = OpenCL::Object::;
517		566
		567	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		568
518	@OpenCL::Buffer::ISA =	569	@OpenCL::Buffer::ISA =
519	@OpenCL::Image::ISA = OpenCL::Memory::;	570	@OpenCL::Image::ISA = OpenCL::Memory::;
520		571
521	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	572	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
522		573
…		…
526	@OpenCL::Image1D::ISA =	577	@OpenCL::Image1D::ISA =
527	@OpenCL::Image1DArray::ISA =	578	@OpenCL::Image1DArray::ISA =
528	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	579	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
529		580
530	@OpenCL::UserEvent::ISA = OpenCL::Event::;	581	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		582
		583	@OpenCL::MappedBuffer::ISA =
		584	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
531	}	585	}
532		586
533	=head2 THE OpenCL PACKAGE	587	=head2 THE OpenCL PACKAGE
534		588
535	=over 4	589	=over 4
…		…
560		614
561	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	615	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
562		616
563	Tries to create a context from a default device and platform type - never worked for me.	617	Tries to create a context from a default device and platform type - never worked for me.
564		618
		619	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		620	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
		621
565	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	622	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
566		623
567	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	624	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
568		625
569	Create a new OpenCL::Context object using the given device object(s). This	626	Create a new OpenCL::Context object using the given device object(s). This
…		…
682		739
683	=for gengetinfo begin platform	740	=for gengetinfo begin platform
684		741
685	=item $string = $platform->profile	742	=item $string = $platform->profile
686		743
687	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	744	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
688		745
689	=item $string = $platform->version	746	=item $string = $platform->version
690		747
691	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	748	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
692		749
693	=item $string = $platform->name	750	=item $string = $platform->name
694		751
695	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	752	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
696		753
697	=item $string = $platform->vendor	754	=item $string = $platform->vendor
698		755
699	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	756	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
700		757
701	=item $string = $platform->extensions	758	=item $string = $platform->extensions
702		759
703	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	760	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
704		761
705	=for gengetinfo end platform	762	=for gengetinfo end platform
706		763
707	=back	764	=back
708		765
…		…
714		771
715	See C<< $platform->info >> for details.	772	See C<< $platform->info >> for details.
716		773
717	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	774	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
718		775
		776	=item @devices = $device->sub_devices (\@properties)
		777
		778	Creates OpencL::SubDevice objects by partitioning an existing device.
		779
		780	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		781
719	=for gengetinfo begin device	782	=for gengetinfo begin device
720		783
721	=item $device_type = $device->type	784	=item $device_type = $device->type
722		785
723	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	786	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
724		787
725	=item $uint = $device->vendor_id	788	=item $uint = $device->vendor_id
726		789
727	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	790	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
728		791
729	=item $uint = $device->max_compute_units	792	=item $uint = $device->max_compute_units
730		793
731	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	794	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
732		795
733	=item $uint = $device->max_work_item_dimensions	796	=item $uint = $device->max_work_item_dimensions
734		797
735	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	798	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
736		799
737	=item $int = $device->max_work_group_size	800	=item $int = $device->max_work_group_size
738		801
739	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	802	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
740		803
741	=item @ints = $device->max_work_item_sizes	804	=item @ints = $device->max_work_item_sizes
742		805
743	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	806	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
744		807
745	=item $uint = $device->preferred_vector_width_char	808	=item $uint = $device->preferred_vector_width_char
746		809
747	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	810	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
748		811
749	=item $uint = $device->preferred_vector_width_short	812	=item $uint = $device->preferred_vector_width_short
750		813
751	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	814	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
752		815
753	=item $uint = $device->preferred_vector_width_int	816	=item $uint = $device->preferred_vector_width_int
754		817
755	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	818	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
756		819
757	=item $uint = $device->preferred_vector_width_long	820	=item $uint = $device->preferred_vector_width_long
758		821
759	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	822	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
760		823
761	=item $uint = $device->preferred_vector_width_float	824	=item $uint = $device->preferred_vector_width_float
762		825
763	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	826	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
764		827
765	=item $uint = $device->preferred_vector_width_double	828	=item $uint = $device->preferred_vector_width_double
766		829
767	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	830	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
768		831
769	=item $uint = $device->max_clock_frequency	832	=item $uint = $device->max_clock_frequency
770		833
771	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	834	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
772		835
773	=item $bitfield = $device->address_bits	836	=item $bitfield = $device->address_bits
774		837
775	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	838	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
776		839
777	=item $uint = $device->max_read_image_args	840	=item $uint = $device->max_read_image_args
778		841
779	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	842	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
780		843
781	=item $uint = $device->max_write_image_args	844	=item $uint = $device->max_write_image_args
782		845
783	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	846	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
784		847
785	=item $ulong = $device->max_mem_alloc_size	848	=item $ulong = $device->max_mem_alloc_size
786		849
787	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	850	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
788		851
789	=item $int = $device->image2d_max_width	852	=item $int = $device->image2d_max_width
790		853
791	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	854	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
792		855
793	=item $int = $device->image2d_max_height	856	=item $int = $device->image2d_max_height
794		857
795	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	858	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
796		859
797	=item $int = $device->image3d_max_width	860	=item $int = $device->image3d_max_width
798		861
799	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	862	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
800		863
801	=item $int = $device->image3d_max_height	864	=item $int = $device->image3d_max_height
802		865
803	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	866	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
804		867
805	=item $int = $device->image3d_max_depth	868	=item $int = $device->image3d_max_depth
806		869
807	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	870	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
808		871
809	=item $uint = $device->image_support	872	=item $uint = $device->image_support
810		873
811	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	874	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
812		875
813	=item $int = $device->max_parameter_size	876	=item $int = $device->max_parameter_size
814		877
815	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	878	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
816		879
817	=item $uint = $device->max_samplers	880	=item $uint = $device->max_samplers
818		881
819	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	882	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
820		883
821	=item $uint = $device->mem_base_addr_align	884	=item $uint = $device->mem_base_addr_align
822		885
823	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	886	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
824		887
825	=item $uint = $device->min_data_type_align_size	888	=item $uint = $device->min_data_type_align_size
826		889
827	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	890	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
828		891
829	=item $device_fp_config = $device->single_fp_config	892	=item $device_fp_config = $device->single_fp_config
830		893
831	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	894	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
832		895
833	=item $device_mem_cache_type = $device->global_mem_cache_type	896	=item $device_mem_cache_type = $device->global_mem_cache_type
834		897
835	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	898	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
836		899
837	=item $uint = $device->global_mem_cacheline_size	900	=item $uint = $device->global_mem_cacheline_size
838		901
839	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	902	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
840		903
841	=item $ulong = $device->global_mem_cache_size	904	=item $ulong = $device->global_mem_cache_size
842		905
843	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	906	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
844		907
845	=item $ulong = $device->global_mem_size	908	=item $ulong = $device->global_mem_size
846		909
847	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	910	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
848		911
849	=item $ulong = $device->max_constant_buffer_size	912	=item $ulong = $device->max_constant_buffer_size
850		913
851	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	914	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
852		915
853	=item $uint = $device->max_constant_args	916	=item $uint = $device->max_constant_args
854		917
855	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	918	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
856		919
857	=item $device_local_mem_type = $device->local_mem_type	920	=item $device_local_mem_type = $device->local_mem_type
858		921
859	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	922	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
860		923
861	=item $ulong = $device->local_mem_size	924	=item $ulong = $device->local_mem_size
862		925
863	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	926	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
864		927
865	=item $boolean = $device->error_correction_support	928	=item $boolean = $device->error_correction_support
866		929
867	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	930	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
868		931
869	=item $int = $device->profiling_timer_resolution	932	=item $int = $device->profiling_timer_resolution
870		933
871	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	934	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
872		935
873	=item $boolean = $device->endian_little	936	=item $boolean = $device->endian_little
874		937
875	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	938	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
876		939
877	=item $boolean = $device->available	940	=item $boolean = $device->available
878		941
879	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	942	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
880		943
881	=item $boolean = $device->compiler_available	944	=item $boolean = $device->compiler_available
882		945
883	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	946	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
884		947
885	=item $device_exec_capabilities = $device->execution_capabilities	948	=item $device_exec_capabilities = $device->execution_capabilities
886		949
887	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	950	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
888		951
889	=item $command_queue_properties = $device->properties	952	=item $command_queue_properties = $device->properties
890		953
891	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	954	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
892		955
893	=item $ = $device->platform	956	=item $ = $device->platform
894		957
895	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	958	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
896		959
897	=item $string = $device->name	960	=item $string = $device->name
898		961
899	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	962	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
900		963
901	=item $string = $device->vendor	964	=item $string = $device->vendor
902		965
903	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	966	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
904		967
905	=item $string = $device->driver_version	968	=item $string = $device->driver_version
906		969
907	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	970	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
908		971
909	=item $string = $device->profile	972	=item $string = $device->profile
910		973
911	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	974	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
912		975
913	=item $string = $device->version	976	=item $string = $device->version
914		977
915	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	978	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
916		979
917	=item $string = $device->extensions	980	=item $string = $device->extensions
918		981
919	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	982	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
920		983
921	=item $uint = $device->preferred_vector_width_half	984	=item $uint = $device->preferred_vector_width_half
922		985
923	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	986	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
924		987
925	=item $uint = $device->native_vector_width_char	988	=item $uint = $device->native_vector_width_char
926		989
927	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	990	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
928		991
929	=item $uint = $device->native_vector_width_short	992	=item $uint = $device->native_vector_width_short
930		993
931	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	994	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
932		995
933	=item $uint = $device->native_vector_width_int	996	=item $uint = $device->native_vector_width_int
934		997
935	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	998	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
936		999
937	=item $uint = $device->native_vector_width_long	1000	=item $uint = $device->native_vector_width_long
938		1001
939	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1002	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
940		1003
941	=item $uint = $device->native_vector_width_float	1004	=item $uint = $device->native_vector_width_float
942		1005
943	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1006	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
944		1007
945	=item $uint = $device->native_vector_width_double	1008	=item $uint = $device->native_vector_width_double
946		1009
947	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1010	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
948		1011
949	=item $uint = $device->native_vector_width_half	1012	=item $uint = $device->native_vector_width_half
950		1013
951	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1014	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
952		1015
953	=item $device_fp_config = $device->double_fp_config	1016	=item $device_fp_config = $device->double_fp_config
954		1017
955	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1018	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
956		1019
957	=item $device_fp_config = $device->half_fp_config	1020	=item $device_fp_config = $device->half_fp_config
958		1021
959	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1022	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
960		1023
961	=item $boolean = $device->host_unified_memory	1024	=item $boolean = $device->host_unified_memory
962		1025
963	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1026	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
964		1027
965	=item $device = $device->parent_device_ext	1028	=item $device = $device->parent_device_ext
966		1029
967	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1030	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
968		1031
969	=item @device_partition_property_exts = $device->partition_types_ext	1032	=item @device_partition_property_exts = $device->partition_types_ext
970		1033
971	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1034	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
972		1035
973	=item @device_partition_property_exts = $device->affinity_domains_ext	1036	=item @device_partition_property_exts = $device->affinity_domains_ext
974		1037
975	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1038	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
976		1039
977	=item $uint = $device->reference_count_ext	1040	=item $uint = $device->reference_count_ext
978		1041
979	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1042	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
980		1043
981	=item @device_partition_property_exts = $device->partition_style_ext	1044	=item @device_partition_property_exts = $device->partition_style_ext
982		1045
983	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1046	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
984		1047
985	=for gengetinfo end device	1048	=for gengetinfo end device
986		1049
987	=back	1050	=back
988		1051
989	=head2 THE OpenCL::Context CLASS	1052	=head2 THE OpenCL::Context CLASS
		1053
		1054	An OpenCL::Context is basically a container, or manager, for a number of
		1055	devices of a platform. It is used to create all sorts of secondary objects
		1056	such as buffers, queues, programs and so on.
		1057
		1058	All context creation functions and methods take a list of properties
		1059	(type-value pairs). All property values can be specified as integers -
		1060	some additionally support other types:
		1061
		1062	=over 4
		1063
		1064	=item OpenCL::CONTEXT_PLATFORM
		1065
		1066	Also accepts OpenCL::Platform objects.
		1067
		1068	=item OpenCL::GLX_DISPLAY_KHR
		1069
		1070	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1071	to find the current glx display (see L<GLX SUPPORT>).
		1072
		1073	=item OpenCL::GL_CONTEXT_KHR
		1074
		1075	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1076	to find the current glx context (see L<GLX SUPPORT>).
		1077
		1078	=back
990		1079
991	=over 4	1080	=over 4
992		1081
993	=item $prog = $ctx->build_program ($program, $options = "")	1082	=item $prog = $ctx->build_program ($program, $options = "")
994		1083
…		…
1003	=cut	1092	=cut
1004		1093
1005	sub OpenCL::Context::build_program {	1094	sub OpenCL::Context::build_program {
1006	my ($self, $prog, $options) = @_;	1095	my ($self, $prog, $options) = @_;
1007		1096
1008	require Carp;
1009
1010	$prog = $self->program_with_source ($prog)	1097	$prog = $self->program_with_source ($prog)
1011	unless ref $prog;	1098	unless ref $prog;
1012		1099
1013	eval { $prog->build (undef, $options); 1 }	1100	eval { $prog->build (undef, $options); 1 }
1014	or errno == BUILD_PROGRAM_FAILURE	1101	or errno == BUILD_PROGRAM_FAILURE
		1102	or errno == INVALID_BINARY # workaround nvidia bug
1015	or Carp::croak "OpenCL::Context->build_program: " . err2str;	1103	or Carp::croak "OpenCL::Context->build_program: " . err2str;
1016		1104
1017	# we check status for all devices	1105	# we check status for all devices
1018	for my $dev ($self->devices) {	1106	for my $dev ($self->devices) {
1019	$prog->build_status ($dev) == BUILD_SUCCESS	1107	$prog->build_status ($dev) == BUILD_SUCCESS
1020	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"	1108	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1021	. $prog->build_log ($dev));	1109	. $prog->build_log ($dev);
1022	}	1110	}
1023		1111
1024	$prog	1112	$prog
1025	}	1113	}
1026		1114
…		…
1043	=item $buf = $ctx->buffer ($flags, $len)	1131	=item $buf = $ctx->buffer ($flags, $len)
1044		1132
1045	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1133	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1046	given flags and octet-size.	1134	given flags and octet-size.
1047		1135
		1136	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1137	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1138	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1139
1048	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1140	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1049		1141
1050	=item $buf = $ctx->buffer_sv ($flags, $data)	1142	=item $buf = $ctx->buffer_sv ($flags, $data)
1051		1143
1052	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1144	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
…		…
1055	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)	1147	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
1056		1148
1057	Creates a new OpenCL::Image object and optionally initialises it with	1149	Creates a new OpenCL::Image object and optionally initialises it with
1058	the given data values.	1150	the given data values.
1059		1151
		1152	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1153	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1154	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1155
		1156	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1157	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1158	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1159	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1160	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1161
		1162
		1163	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1164	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1165	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1166	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1167
1060	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1168	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1061		1169
1062	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1170	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1063		1171
1064	Creates a new OpenCL::Image2D object and optionally initialises it with	1172	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1076	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1184	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1077		1185
1078	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1186	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1079	OpenGL buffer object.	1187	OpenGL buffer object.
1080		1188
		1189	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1190
1081	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1191	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1082		1192
1083	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1193	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1084		1194
1085	Creates a new OpenCL::Image object that refers to the given OpenGL	1195	Creates a new OpenCL::Image object that refers to the given OpenGL
1086	texture object or buffer.	1196	texture object or buffer.
1087		1197
		1198	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1199	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1200	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1201	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1202	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1203	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1204
1088	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1205	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1089		1206
1090	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1207	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1091		1208
1092	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1209	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1117		1234
1118	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1235	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1119		1236
1120	Creates a new OpenCL::Sampler object.	1237	Creates a new OpenCL::Sampler object.
1121		1238
		1239	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1240	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1241
		1242	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1243
1122	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1244	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1123		1245
1124	=item $program = $ctx->program_with_source ($string)	1246	=item $program = $ctx->program_with_source ($string)
1125		1247
1126	Creates a new OpenCL::Program object from the given source code.	1248	Creates a new OpenCL::Program object from the given source code.
1127		1249
1128	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1250	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1129		1251
		1252	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1253
		1254	Creates a new OpenCL::Program object from the given binaries.
		1255
		1256	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1257
		1258	Example: clone an existing program object that contains a successfully
		1259	compiled program, no matter how useless this is.
		1260
		1261	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1262
		1263	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1264
		1265	Creates a new OpenCL::Program object from the given built-in kernel names.
		1266
		1267	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1268
1130	=item $packed_value = $ctx->info ($name)	1269	=item $packed_value = $ctx->info ($name)
1131		1270
1132	See C<< $platform->info >> for details.	1271	See C<< $platform->info >> for details.
1133		1272
1134	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1273	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1135		1274
1136	=for gengetinfo begin context	1275	=for gengetinfo begin context
1137		1276
1138	=item $uint = $context->reference_count	1277	=item $uint = $context->reference_count
1139		1278
1140	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1279	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1141		1280
1142	=item @devices = $context->devices	1281	=item @devices = $context->devices
1143		1282
1144	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1283	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1145		1284
1146	=item @property_ints = $context->properties	1285	=item @property_ints = $context->properties
1147		1286
1148	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1287	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1149		1288
1150	=item $uint = $context->num_devices	1289	=item $uint = $context->num_devices
1151		1290
1152	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1291	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1153		1292
1154	=for gengetinfo end context	1293	=for gengetinfo end context
1155		1294
1156	=back	1295	=back
1157		1296
…		…
1204		1343
1205	=item $ev = $queue->write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)	1344	=item $ev = $queue->write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...)
1206		1345
1207	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1346	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1208		1347
		1348	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1349
		1350	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1351
1209	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1352	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1210		1353
1211	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1354	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1212		1355	module uses the image width (and height) to supply default values.
1213	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1214		1356
1215	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1357	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1216		1358
1217	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1359	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1218		1360
		1361	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1362	module uses the image width (and height) to supply default values.
1219	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1363	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1220		1364
1221	=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)	1365	=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1222		1366
1223	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1367	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
…		…
1268	reference to an array of local work sizes, with the same number of	1412	reference to an array of local work sizes, with the same number of
1269	elements as \@global_work_size.	1413	elements as \@global_work_size.
1270		1414
1271	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1415	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1272		1416
		1417	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1418
		1419	Migrates a number of OpenCL::Memory objects to or from the device.
		1420
		1421	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1422
		1423	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1424
1273	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1425	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1274		1426
1275	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1427	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1276	for subsequent OpenCL usage.	1428	for subsequent OpenCL usage.
1277		1429
…		…
1312		1464
1313	=for gengetinfo begin command_queue	1465	=for gengetinfo begin command_queue
1314		1466
1315	=item $ctx = $command_queue->context	1467	=item $ctx = $command_queue->context
1316		1468
1317	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1469	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1318		1470
1319	=item $device = $command_queue->device	1471	=item $device = $command_queue->device
1320		1472
1321	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1473	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1322		1474
1323	=item $uint = $command_queue->reference_count	1475	=item $uint = $command_queue->reference_count
1324		1476
1325	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1477	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1326		1478
1327	=item $command_queue_properties = $command_queue->properties	1479	=item $command_queue_properties = $command_queue->properties
1328		1480
1329	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1481	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1330		1482
1331	=for gengetinfo end command_queue	1483	=for gengetinfo end command_queue
		1484
		1485	=back
		1486
		1487	=head3 MEMORY MAPPED BUFFERS
		1488
		1489	OpenCL allows you to map buffers and images to host memory (read: perl
		1490	scalars). This is done much like reading or copying a buffer, by enqueuing
		1491	a map or unmap operation on the command queue.
		1492
		1493	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1494	OpenCL::Mapped CLASS> section for details on what to do with these
		1495	objects.
		1496
		1497	The object will be unmapped automatically when the mapped object is
		1498	destroyed (you can use a barrier to make sure the unmap has finished,
		1499	before using the buffer in a kernel), but you can also enqueue an unmap
		1500	operation manually.
		1501
		1502	=over 4
		1503
		1504	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1505
		1506	Maps the given buffer into host memory and returns an
		1507	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1508	the map will extend to the end of the buffer.
		1509
		1510	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1511
		1512	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1513
		1514	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1515
		1516	{
		1517	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1518	substr $$mapped, 0, 4, "abcd";
		1519	} # asynchronously unmap because $mapped is destroyed
		1520
		1521	=item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...)
		1522
		1523	Maps the given image area into host memory and return an
		1524	C<OpenCL::MappedImage> object.
		1525
		1526	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1527	will be replaced by the maximum possible value.
		1528
		1529	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1530
		1531	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1532	the first channel of the leftmost column to 5, then explicitly unmap
		1533	it. You are not necessarily meant to do it this way, this example just
		1534	shows you the accessors to use :)
		1535
		1536	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1537
		1538	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1539	for 0..$image->height;
		1540
		1541	$mapped->unmap;.
		1542	$mapped->wait; # only needed for out of order queues normally
		1543
		1544	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1545
		1546	Unmaps the data from host memory. You must not call any methods that
		1547	modify the data, or modify the data scalar directly, after calling this
		1548	method.
		1549
		1550	The mapped event object will always be passed as part of the
		1551	$wait_events. The mapped event object will be replaced by the new event
		1552	object that this request creates.
1332		1553
1333	=back	1554	=back
1334		1555
1335	=head2 THE OpenCL::Memory CLASS	1556	=head2 THE OpenCL::Memory CLASS
1336		1557
…		…
1347		1568
1348	=for gengetinfo begin mem	1569	=for gengetinfo begin mem
1349		1570
1350	=item $mem_object_type = $mem->type	1571	=item $mem_object_type = $mem->type
1351		1572
1352	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1573	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1353		1574
1354	=item $mem_flags = $mem->flags	1575	=item $mem_flags = $mem->flags
1355		1576
1356	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1577	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1357		1578
1358	=item $int = $mem->size	1579	=item $int = $mem->size
1359		1580
1360	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1581	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1361		1582
1362	=item $ptr_value = $mem->host_ptr	1583	=item $ptr_value = $mem->host_ptr
1363		1584
1364	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1585	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1365		1586
1366	=item $uint = $mem->map_count	1587	=item $uint = $mem->map_count
1367		1588
1368	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1589	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1369		1590
1370	=item $uint = $mem->reference_count	1591	=item $uint = $mem->reference_count
1371		1592
1372	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1593	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1373		1594
1374	=item $ctx = $mem->context	1595	=item $ctx = $mem->context
1375		1596
1376	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1597	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1377		1598
1378	=item $mem = $mem->associated_memobject	1599	=item $mem = $mem->associated_memobject
1379		1600
1380	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1601	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1381		1602
1382	=item $int = $mem->offset	1603	=item $int = $mem->offset
1383		1604
1384	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1605	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1385		1606
1386	=for gengetinfo end mem	1607	=for gengetinfo end mem
1387		1608
1388	=item ($type, $name) = $mem->gl_object_info	1609	=item ($type, $name) = $mem->gl_object_info
1389		1610
…		…
1441		1662
1442	=for gengetinfo begin image	1663	=for gengetinfo begin image
1443		1664
1444	=item $int = $image->element_size	1665	=item $int = $image->element_size
1445		1666
1446	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1667	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1447		1668
1448	=item $int = $image->row_pitch	1669	=item $int = $image->row_pitch
1449		1670
1450	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1671	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1451		1672
1452	=item $int = $image->slice_pitch	1673	=item $int = $image->slice_pitch
1453		1674
1454	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1675	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1455		1676
1456	=item $int = $image->width	1677	=item $int = $image->width
1457		1678
1458	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1679	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1459		1680
1460	=item $int = $image->height	1681	=item $int = $image->height
1461		1682
1462	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1683	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1463		1684
1464	=item $int = $image->depth	1685	=item $int = $image->depth
1465		1686
1466	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1687	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1467		1688
1468	=for gengetinfo end image	1689	=for gengetinfo end image
1469		1690
1470	=for gengetinfo begin gl_texture	1691	=for gengetinfo begin gl_texture
1471		1692
1472	=item $GLenum = $gl_texture->target	1693	=item $GLenum = $gl_texture->target
1473		1694
1474	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1695	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1475		1696
1476	=item $GLint = $gl_texture->gl_mipmap_level	1697	=item $GLint = $gl_texture->gl_mipmap_level
1477		1698
1478	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1699	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1479		1700
1480	=for gengetinfo end gl_texture	1701	=for gengetinfo end gl_texture
1481		1702
1482	=back	1703	=back
1483		1704
…		…
1493		1714
1494	=for gengetinfo begin sampler	1715	=for gengetinfo begin sampler
1495		1716
1496	=item $uint = $sampler->reference_count	1717	=item $uint = $sampler->reference_count
1497		1718
1498	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1719	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1499		1720
1500	=item $ctx = $sampler->context	1721	=item $ctx = $sampler->context
1501		1722
1502	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1723	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1503		1724
1504	=item $addressing_mode = $sampler->normalized_coords	1725	=item $addressing_mode = $sampler->normalized_coords
1505		1726
1506	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1727	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1507		1728
1508	=item $filter_mode = $sampler->addressing_mode	1729	=item $filter_mode = $sampler->addressing_mode
1509		1730
1510	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1731	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1511		1732
1512	=item $boolean = $sampler->filter_mode	1733	=item $boolean = $sampler->filter_mode
1513		1734
1514	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1735	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1515		1736
1516	=for gengetinfo end sampler	1737	=for gengetinfo end sampler
1517		1738
1518	=back	1739	=back
1519		1740
…		…
1529	If a callback is specified, then it will be called when compilation is	1750	If a callback is specified, then it will be called when compilation is
1530	finished. Note that many OpenCL implementations block your program while	1751	finished. Note that many OpenCL implementations block your program while
1531	compiling whether you use a callback or not. See C<build_async> if you	1752	compiling whether you use a callback or not. See C<build_async> if you
1532	want to make sure the build is done in the background.	1753	want to make sure the build is done in the background.
1533		1754
1534	Note that some OpenCL implementations atc up badly, and don't call the	1755	Note that some OpenCL implementations act up badly, and don't call the
1535	callback in some error cases (but call it in others). This implementation	1756	callback in some error cases (but call it in others). This implementation
1536	assumes the callback will always be called, and leaks memory if this is	1757	assumes the callback will always be called, and leaks memory if this is
1537	not so. So best make sure you don't pass in invalid values.	1758	not so. So best make sure you don't pass in invalid values.
1538		1759
		1760	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1761	compilation state is successful but some later stage fails.
		1762
		1763	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1764	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1765	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1766	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1767	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1768	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1769	C<-create-library>, C<-enable-link-options>.
		1770
1539	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1771	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1540		1772
1541	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1773	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1542		1774
1543	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1775	Similar to C<< ->build >>, except it starts a thread, and never fails (you
…		…
1565		1797
1566	=for gengetinfo begin program_build	1798	=for gengetinfo begin program_build
1567		1799
1568	=item $build_status = $program->build_status ($device)	1800	=item $build_status = $program->build_status ($device)
1569		1801
1570	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1802	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
		1803
		1804	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1805	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
1571		1806
1572	=item $string = $program->build_options ($device)	1807	=item $string = $program->build_options ($device)
1573		1808
1574	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1809	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1575		1810
1576	=item $string = $program->build_log ($device)	1811	=item $string = $program->build_log ($device)
1577		1812
1578	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1813	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1579		1814
1580	=for gengetinfo end program_build	1815	=for gengetinfo end program_build
1581		1816
1582	=item $packed_value = $program->info ($name)	1817	=item $packed_value = $program->info ($name)
1583		1818
…		…
1587		1822
1588	=for gengetinfo begin program	1823	=for gengetinfo begin program
1589		1824
1590	=item $uint = $program->reference_count	1825	=item $uint = $program->reference_count
1591		1826
1592	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1827	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1593		1828
1594	=item $ctx = $program->context	1829	=item $ctx = $program->context
1595		1830
1596	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1831	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1597		1832
1598	=item $uint = $program->num_devices	1833	=item $uint = $program->num_devices
1599		1834
1600	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1835	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1601		1836
1602	=item @devices = $program->devices	1837	=item @devices = $program->devices
1603		1838
1604	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1839	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1605		1840
1606	=item $string = $program->source	1841	=item $string = $program->source
1607		1842
1608	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1843	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1609		1844
1610	=item @ints = $program->binary_sizes	1845	=item @ints = $program->binary_sizes
1611		1846
1612	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1847	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1613		1848
1614	=for gengetinfo end program	1849	=for gengetinfo end program
1615		1850
1616	=item @blobs = $program->binaries	1851	=item @blobs = $program->binaries
1617		1852
…		…
1638		1873
1639	=for gengetinfo begin kernel	1874	=for gengetinfo begin kernel
1640		1875
1641	=item $string = $kernel->function_name	1876	=item $string = $kernel->function_name
1642		1877
1643	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1878	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1644		1879
1645	=item $uint = $kernel->num_args	1880	=item $uint = $kernel->num_args
1646		1881
1647	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1882	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1648		1883
1649	=item $uint = $kernel->reference_count	1884	=item $uint = $kernel->reference_count
1650		1885
1651	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1886	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1652		1887
1653	=item $ctx = $kernel->context	1888	=item $ctx = $kernel->context
1654		1889
1655	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1890	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1656		1891
1657	=item $program = $kernel->program	1892	=item $program = $kernel->program
1658		1893
1659	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1894	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1660		1895
1661	=for gengetinfo end kernel	1896	=for gengetinfo end kernel
1662		1897
1663	=item $packed_value = $kernel->work_group_info ($device, $name)	1898	=item $packed_value = $kernel->work_group_info ($device, $name)
1664		1899
…		…
1671		1906
1672	=for gengetinfo begin kernel_work_group	1907	=for gengetinfo begin kernel_work_group
1673		1908
1674	=item $int = $kernel->work_group_size ($device)	1909	=item $int = $kernel->work_group_size ($device)
1675		1910
1676	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1911	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1677		1912
1678	=item @ints = $kernel->compile_work_group_size ($device)	1913	=item @ints = $kernel->compile_work_group_size ($device)
1679		1914
1680	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	1915	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1681		1916
1682	=item $ulong = $kernel->local_mem_size ($device)	1917	=item $ulong = $kernel->local_mem_size ($device)
1683		1918
1684	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	1919	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1685		1920
1686	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1921	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1687		1922
1688	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	1923	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1689		1924
1690	=item $ulong = $kernel->private_mem_size ($device)	1925	=item $ulong = $kernel->private_mem_size ($device)
1691		1926
1692	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1927	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1693		1928
1694	=for gengetinfo end kernel_work_group	1929	=for gengetinfo end kernel_work_group
1695		1930
1696	=item $kernel->setf ($format, ...)	1931	=item $kernel->setf ($format, ...)
1697		1932
…		…
1811		2046
1812	=for gengetinfo begin event	2047	=for gengetinfo begin event
1813		2048
1814	=item $queue = $event->command_queue	2049	=item $queue = $event->command_queue
1815		2050
1816	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2051	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1817		2052
1818	=item $command_type = $event->command_type	2053	=item $command_type = $event->command_type
1819		2054
1820	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2055	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1821		2056
1822	=item $uint = $event->reference_count	2057	=item $uint = $event->reference_count
1823		2058
1824	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2059	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1825		2060
1826	=item $uint = $event->command_execution_status	2061	=item $uint = $event->command_execution_status
1827		2062
1828	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2063	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1829		2064
1830	=item $ctx = $event->context	2065	=item $ctx = $event->context
1831		2066
1832	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2067	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1833		2068
1834	=for gengetinfo end event	2069	=for gengetinfo end event
1835		2070
1836	=item $packed_value = $ev->profiling_info ($name)	2071	=item $packed_value = $ev->profiling_info ($name)
1837		2072
…		…
1844		2079
1845	=for gengetinfo begin profiling	2080	=for gengetinfo begin profiling
1846		2081
1847	=item $ulong = $event->profiling_command_queued	2082	=item $ulong = $event->profiling_command_queued
1848		2083
1849	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2084	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1850		2085
1851	=item $ulong = $event->profiling_command_submit	2086	=item $ulong = $event->profiling_command_submit
1852		2087
1853	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2088	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1854		2089
1855	=item $ulong = $event->profiling_command_start	2090	=item $ulong = $event->profiling_command_start
1856		2091
1857	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2092	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1858		2093
1859	=item $ulong = $event->profiling_command_end	2094	=item $ulong = $event->profiling_command_end
1860		2095
1861	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2096	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1862		2097
1863	=for gengetinfo end profiling	2098	=for gengetinfo end profiling
1864		2099
1865	=back	2100	=back
1866		2101
…		…
1873	=item $ev->set_status ($execution_status)	2108	=item $ev->set_status ($execution_status)
1874		2109
1875	Sets the execution status of the user event. Can only be called once,	2110	Sets the execution status of the user event. Can only be called once,
1876	either with OpenCL::COMPLETE or a negative number as status.	2111	either with OpenCL::COMPLETE or a negative number as status.
1877		2112
		2113	execution_status: OpenCL::COMPLETE or a negative integer.
		2114
1878	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2115	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1879		2116
1880	=back	2117	=back
		2118
		2119	=head2 THE OpenCL::Mapped CLASS
		2120
		2121	This class represents objects mapped into host memory. They are
		2122	represented by a blessed string scalar. The string data is the mapped
		2123	memory area, that is, if you read or write it, then the mapped object is
		2124	accessed directly.
		2125
		2126	You must only ever use operations that modify the string in-place - for
		2127	example, a C<substr> that doesn't change the length, or maybe a regex that
		2128	doesn't change the length. Any other operation might cause the data to be
		2129	copied.
		2130
		2131	When the object is destroyed it will enqueue an implicit unmap operation
		2132	on the queue that was used to create it.
		2133
		2134	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2135	OpenCL sees the changes, even if some implementations don't need this
		2136	sometimes.
		2137
		2138	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2139
		2140	my $mapped = $queue->map_buffer ($buf, ...
		2141	$mapped->event->wait; # make sure it's there
		2142
		2143	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2144	# we blindly assume device endianness to equal host endianness
		2145	# (and of course, we assume iee 754 single precision floats :)
		2146	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2147
		2148	=over 4
		2149
		2150	=item $ev = $mapped->unmap ($wait_events...)
		2151
		2152	Unmaps the mapped memory object, using the queue originally used to create
		2153	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2154
		2155	=item $bool = $mapped->mapped
		2156
		2157	Returns whether the object is still mapped - true before an C<unmap> is
		2158	enqueued, false afterwards.
		2159
		2160	=item $ev = $mapped->event
		2161
		2162	Return the event object associated with the mapped object. Initially, this
		2163	will be the event object created when mapping the object, and after an
		2164	unmap, this will be the event object that the unmap operation created.
		2165
		2166	=item $mapped->wait
		2167
		2168	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2169	mapped object are outstanding.
		2170
		2171	=item $bytes = $mapped->size
		2172
		2173	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2174
		2175	=item $ptr = $mapped->ptr
		2176
		2177	Returns the raw memory address of the mapped area.
		2178
		2179	=item $mapped->set ($offset, $data)
		2180
		2181	Replaces the data at the given C<$offset> in the memory area by the new
		2182	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2183	because it does bounds-checking, but also slower.
		2184
		2185	=item $data = $mapped->get ($offset, $length)
		2186
		2187	Returns (without copying) a scalar representing the data at the given
		2188	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2189	the following substr, except much slower;
		2190
		2191	$data = substr $$mapped, $offset, $length
		2192
		2193	=cut
		2194
		2195	sub OpenCL::Mapped::get {
		2196	substr ${$_[0]}, $_[1], $_[2]
		2197	}
		2198
		2199	=back
		2200
		2201	=head2 THE OpenCL::MappedBuffer CLASS
		2202
		2203	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2204
		2205	=head2 THE OpenCL::MappedImage CLASS
		2206
		2207	This is a subclass of OpenCL::Mapped, representing mapped images.
		2208
		2209	=over 4
		2210
		2211	=item $bytes = $mapped->row_pitch
		2212
		2213	=item $bytes = $mapped->slice_pitch
		2214
		2215	Return the row or slice pitch of the image that has been mapped.
		2216
		2217	=back
		2218
1881		2219
1882	=cut	2220	=cut
1883		2221
1884	1;	2222	1;
1885		2223

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC vs. Revision 1.71 by root, Fri May 4 14:29:35 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC vs.
Revision 1.71 by root, Fri May 4 14:29:35 2012 UTC