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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC vs.
Revision 1.72 by root, Fri May 4 14:49:42 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
…		…
499	use Async::Interrupt ();	547	use Async::Interrupt ();
500		548
501	our $POLL_FUNC; # set by XS	549	our $POLL_FUNC; # set by XS
502		550
503	BEGIN {	551	BEGIN {
504	our $VERSION = '0.98';	552	our $VERSION = '0.99';
505		553
506	require XSLoader;	554	require XSLoader;
507	XSLoader::load (__PACKAGE__, $VERSION);	555	XSLoader::load (__PACKAGE__, $VERSION);
508		556
509	@OpenCL::Platform::ISA =	557	@OpenCL::Platform::ISA =
…		…
514	@OpenCL::Sampler::ISA =	562	@OpenCL::Sampler::ISA =
515	@OpenCL::Program::ISA =	563	@OpenCL::Program::ISA =
516	@OpenCL::Kernel::ISA =	564	@OpenCL::Kernel::ISA =
517	@OpenCL::Event::ISA = OpenCL::Object::;	565	@OpenCL::Event::ISA = OpenCL::Object::;
518		566
		567	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		568
519	@OpenCL::Buffer::ISA =	569	@OpenCL::Buffer::ISA =
520	@OpenCL::Image::ISA = OpenCL::Memory::;	570	@OpenCL::Image::ISA = OpenCL::Memory::;
521		571
522	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	572	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
523		573
…		…
527	@OpenCL::Image1D::ISA =	577	@OpenCL::Image1D::ISA =
528	@OpenCL::Image1DArray::ISA =	578	@OpenCL::Image1DArray::ISA =
529	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	579	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
530		580
531	@OpenCL::UserEvent::ISA = OpenCL::Event::;	581	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		582
		583	@OpenCL::MappedBuffer::ISA =
		584	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
532	}	585	}
533		586
534	=head2 THE OpenCL PACKAGE	587	=head2 THE OpenCL PACKAGE
535		588
536	=over 4	589	=over 4
…		…
561		614
562	=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
563		616
564	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.
565		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
566	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>
567		623
568	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	624	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
569		625
570	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
…		…
683		739
684	=for gengetinfo begin platform	740	=for gengetinfo begin platform
685		741
686	=item $string = $platform->profile	742	=item $string = $platform->profile
687		743
688	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.
689		745
690	=item $string = $platform->version	746	=item $string = $platform->version
691		747
692	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.
693		749
694	=item $string = $platform->name	750	=item $string = $platform->name
695		751
696	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.
697		753
698	=item $string = $platform->vendor	754	=item $string = $platform->vendor
699		755
700	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.
701		757
702	=item $string = $platform->extensions	758	=item $string = $platform->extensions
703		759
704	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.
705		761
706	=for gengetinfo end platform	762	=for gengetinfo end platform
707		763
708	=back	764	=back
709		765
…		…
715		771
716	See C<< $platform->info >> for details.	772	See C<< $platform->info >> for details.
717		773
718	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>
719		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
720	=for gengetinfo begin device	782	=for gengetinfo begin device
721		783
722	=item $device_type = $device->type	784	=item $device_type = $device->type
723		785
724	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.
725		787
726	=item $uint = $device->vendor_id	788	=item $uint = $device->vendor_id
727		789
728	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.
729		791
730	=item $uint = $device->max_compute_units	792	=item $uint = $device->max_compute_units
731		793
732	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.
733		795
734	=item $uint = $device->max_work_item_dimensions	796	=item $uint = $device->max_work_item_dimensions
735		797
736	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.
737		799
738	=item $int = $device->max_work_group_size	800	=item $int = $device->max_work_group_size
739		801
740	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.
741		803
742	=item @ints = $device->max_work_item_sizes	804	=item @ints = $device->max_work_item_sizes
743		805
744	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.
745		807
746	=item $uint = $device->preferred_vector_width_char	808	=item $uint = $device->preferred_vector_width_char
747		809
748	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.
749		811
750	=item $uint = $device->preferred_vector_width_short	812	=item $uint = $device->preferred_vector_width_short
751		813
752	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.
753		815
754	=item $uint = $device->preferred_vector_width_int	816	=item $uint = $device->preferred_vector_width_int
755		817
756	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.
757		819
758	=item $uint = $device->preferred_vector_width_long	820	=item $uint = $device->preferred_vector_width_long
759		821
760	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.
761		823
762	=item $uint = $device->preferred_vector_width_float	824	=item $uint = $device->preferred_vector_width_float
763		825
764	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.
765		827
766	=item $uint = $device->preferred_vector_width_double	828	=item $uint = $device->preferred_vector_width_double
767		829
768	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.
769		831
770	=item $uint = $device->max_clock_frequency	832	=item $uint = $device->max_clock_frequency
771		833
772	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.
773		835
774	=item $bitfield = $device->address_bits	836	=item $bitfield = $device->address_bits
775		837
776	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.
777		839
778	=item $uint = $device->max_read_image_args	840	=item $uint = $device->max_read_image_args
779		841
780	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.
781		843
782	=item $uint = $device->max_write_image_args	844	=item $uint = $device->max_write_image_args
783		845
784	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.
785		847
786	=item $ulong = $device->max_mem_alloc_size	848	=item $ulong = $device->max_mem_alloc_size
787		849
788	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.
789		851
790	=item $int = $device->image2d_max_width	852	=item $int = $device->image2d_max_width
791		853
792	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.
793		855
794	=item $int = $device->image2d_max_height	856	=item $int = $device->image2d_max_height
795		857
796	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.
797		859
798	=item $int = $device->image3d_max_width	860	=item $int = $device->image3d_max_width
799		861
800	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.
801		863
802	=item $int = $device->image3d_max_height	864	=item $int = $device->image3d_max_height
803		865
804	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.
805		867
806	=item $int = $device->image3d_max_depth	868	=item $int = $device->image3d_max_depth
807		869
808	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.
809		871
810	=item $uint = $device->image_support	872	=item $uint = $device->image_support
811		873
812	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.
813		875
814	=item $int = $device->max_parameter_size	876	=item $int = $device->max_parameter_size
815		877
816	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.
817		879
818	=item $uint = $device->max_samplers	880	=item $uint = $device->max_samplers
819		881
820	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.
821		883
822	=item $uint = $device->mem_base_addr_align	884	=item $uint = $device->mem_base_addr_align
823		885
824	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.
825		887
826	=item $uint = $device->min_data_type_align_size	888	=item $uint = $device->min_data_type_align_size
827		889
828	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.
829		891
830	=item $device_fp_config = $device->single_fp_config	892	=item $device_fp_config = $device->single_fp_config
831		893
832	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.
833		895
834	=item $device_mem_cache_type = $device->global_mem_cache_type	896	=item $device_mem_cache_type = $device->global_mem_cache_type
835		897
836	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.
837		899
838	=item $uint = $device->global_mem_cacheline_size	900	=item $uint = $device->global_mem_cacheline_size
839		901
840	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.
841		903
842	=item $ulong = $device->global_mem_cache_size	904	=item $ulong = $device->global_mem_cache_size
843		905
844	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.
845		907
846	=item $ulong = $device->global_mem_size	908	=item $ulong = $device->global_mem_size
847		909
848	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.
849		911
850	=item $ulong = $device->max_constant_buffer_size	912	=item $ulong = $device->max_constant_buffer_size
851		913
852	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.
853		915
854	=item $uint = $device->max_constant_args	916	=item $uint = $device->max_constant_args
855		917
856	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.
857		919
858	=item $device_local_mem_type = $device->local_mem_type	920	=item $device_local_mem_type = $device->local_mem_type
859		921
860	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.
861		923
862	=item $ulong = $device->local_mem_size	924	=item $ulong = $device->local_mem_size
863		925
864	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.
865		927
866	=item $boolean = $device->error_correction_support	928	=item $boolean = $device->error_correction_support
867		929
868	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.
869		931
870	=item $int = $device->profiling_timer_resolution	932	=item $int = $device->profiling_timer_resolution
871		933
872	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.
873		935
874	=item $boolean = $device->endian_little	936	=item $boolean = $device->endian_little
875		937
876	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.
877		939
878	=item $boolean = $device->available	940	=item $boolean = $device->available
879		941
880	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.
881		943
882	=item $boolean = $device->compiler_available	944	=item $boolean = $device->compiler_available
883		945
884	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.
885		947
886	=item $device_exec_capabilities = $device->execution_capabilities	948	=item $device_exec_capabilities = $device->execution_capabilities
887		949
888	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.
889		951
890	=item $command_queue_properties = $device->properties	952	=item $command_queue_properties = $device->properties
891		953
892	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.
893		955
894	=item $ = $device->platform	956	=item $ = $device->platform
895		957
896	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.
897		959
898	=item $string = $device->name	960	=item $string = $device->name
899		961
900	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.
901		963
902	=item $string = $device->vendor	964	=item $string = $device->vendor
903		965
904	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.
905		967
906	=item $string = $device->driver_version	968	=item $string = $device->driver_version
907		969
908	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.
909		971
910	=item $string = $device->profile	972	=item $string = $device->profile
911		973
912	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.
913		975
914	=item $string = $device->version	976	=item $string = $device->version
915		977
916	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.
917		979
918	=item $string = $device->extensions	980	=item $string = $device->extensions
919		981
920	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.
921		983
922	=item $uint = $device->preferred_vector_width_half	984	=item $uint = $device->preferred_vector_width_half
923		985
924	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.
925		987
926	=item $uint = $device->native_vector_width_char	988	=item $uint = $device->native_vector_width_char
927		989
928	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.
929		991
930	=item $uint = $device->native_vector_width_short	992	=item $uint = $device->native_vector_width_short
931		993
932	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.
933		995
934	=item $uint = $device->native_vector_width_int	996	=item $uint = $device->native_vector_width_int
935		997
936	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.
937		999
938	=item $uint = $device->native_vector_width_long	1000	=item $uint = $device->native_vector_width_long
939		1001
940	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.
941		1003
942	=item $uint = $device->native_vector_width_float	1004	=item $uint = $device->native_vector_width_float
943		1005
944	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.
945		1007
946	=item $uint = $device->native_vector_width_double	1008	=item $uint = $device->native_vector_width_double
947		1009
948	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.
949		1011
950	=item $uint = $device->native_vector_width_half	1012	=item $uint = $device->native_vector_width_half
951		1013
952	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.
953		1015
954	=item $device_fp_config = $device->double_fp_config	1016	=item $device_fp_config = $device->double_fp_config
955		1017
956	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.
957		1019
958	=item $device_fp_config = $device->half_fp_config	1020	=item $device_fp_config = $device->half_fp_config
959		1021
960	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.
961		1023
962	=item $boolean = $device->host_unified_memory	1024	=item $boolean = $device->host_unified_memory
963		1025
964	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.
965		1027
966	=item $device = $device->parent_device_ext	1028	=item $device = $device->parent_device_ext
967		1029
968	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.
969		1031
970	=item @device_partition_property_exts = $device->partition_types_ext	1032	=item @device_partition_property_exts = $device->partition_types_ext
971		1033
972	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.
973		1035
974	=item @device_partition_property_exts = $device->affinity_domains_ext	1036	=item @device_partition_property_exts = $device->affinity_domains_ext
975		1037
976	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.
977		1039
978	=item $uint = $device->reference_count_ext	1040	=item $uint = $device->reference_count_ext
979		1041
980	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.
981		1043
982	=item @device_partition_property_exts = $device->partition_style_ext	1044	=item @device_partition_property_exts = $device->partition_style_ext
983		1045
984	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.
985		1047
986	=for gengetinfo end device	1048	=for gengetinfo end device
987		1049
988	=back	1050	=back
989		1051
990	=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
991		1079
992	=over 4	1080	=over 4
993		1081
994	=item $prog = $ctx->build_program ($program, $options = "")	1082	=item $prog = $ctx->build_program ($program, $options = "")
995		1083
…		…
1009	$prog = $self->program_with_source ($prog)	1097	$prog = $self->program_with_source ($prog)
1010	unless ref $prog;	1098	unless ref $prog;
1011		1099
1012	eval { $prog->build (undef, $options); 1 }	1100	eval { $prog->build (undef, $options); 1 }
1013	or errno == BUILD_PROGRAM_FAILURE	1101	or errno == BUILD_PROGRAM_FAILURE
		1102	or errno == INVALID_BINARY # workaround nvidia bug
1014	or Carp::croak "OpenCL::Context->build_program: " . err2str;	1103	or Carp::croak "OpenCL::Context->build_program: " . err2str;
1015		1104
1016	# we check status for all devices	1105	# we check status for all devices
1017	for my $dev ($self->devices) {	1106	for my $dev ($self->devices) {
1018	$prog->build_status ($dev) == BUILD_SUCCESS	1107	$prog->build_status ($dev) == BUILD_SUCCESS
…		…
1042	=item $buf = $ctx->buffer ($flags, $len)	1131	=item $buf = $ctx->buffer ($flags, $len)
1043		1132
1044	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1133	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1045	given flags and octet-size.	1134	given flags and octet-size.
1046		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
1047	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>
1048		1141
1049	=item $buf = $ctx->buffer_sv ($flags, $data)	1142	=item $buf = $ctx->buffer_sv ($flags, $data)
1050		1143
1051	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1144	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
…		…
1054	=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)
1055		1148
1056	Creates a new OpenCL::Image object and optionally initialises it with	1149	Creates a new OpenCL::Image object and optionally initialises it with
1057	the given data values.	1150	the given data values.
1058		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
1059	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>
1060		1169
1061	=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)
1062		1171
1063	Creates a new OpenCL::Image2D object and optionally initialises it with	1172	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1075	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1184	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1076		1185
1077	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
1078	OpenGL buffer object.	1187	OpenGL buffer object.
1079		1188
		1189	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1190
1080	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
1081		1192
1082	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1193	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1083		1194
1084	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
1085	texture object or buffer.	1196	texture object or buffer.
1086		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
1087	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
1088		1206
1089	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1207	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1090		1208
1091	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
…		…
1116		1234
1117	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1235	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1118		1236
1119	Creates a new OpenCL::Sampler object.	1237	Creates a new OpenCL::Sampler object.
1120		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
1121	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>
1122		1245
1123	=item $program = $ctx->program_with_source ($string)	1246	=item $program = $ctx->program_with_source ($string)
1124		1247
1125	Creates a new OpenCL::Program object from the given source code.	1248	Creates a new OpenCL::Program object from the given source code.
1126		1249
1127	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>
1128		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
1129	=item $packed_value = $ctx->info ($name)	1269	=item $packed_value = $ctx->info ($name)
1130		1270
1131	See C<< $platform->info >> for details.	1271	See C<< $platform->info >> for details.
1132		1272
1133	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>
1134		1274
1135	=for gengetinfo begin context	1275	=for gengetinfo begin context
1136		1276
1137	=item $uint = $context->reference_count	1277	=item $uint = $context->reference_count
1138		1278
1139	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.
1140		1280
1141	=item @devices = $context->devices	1281	=item @devices = $context->devices
1142		1282
1143	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.
1144		1284
1145	=item @property_ints = $context->properties	1285	=item @property_ints = $context->properties
1146		1286
1147	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.
1148		1288
1149	=item $uint = $context->num_devices	1289	=item $uint = $context->num_devices
1150		1290
1151	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.
1152		1292
1153	=for gengetinfo end context	1293	=for gengetinfo end context
1154		1294
1155	=back	1295	=back
1156		1296
…		…
1203		1343
1204	=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...)
1205		1345
1206	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
1207		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
1208	=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...)
1209		1353
1210	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
1211		1355	module uses the image width (and height) to supply default values.
1212	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1213		1356
1214	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>
1215		1358
1216	=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...)
1217		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.
1218	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>
1219		1364
1220	=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...)
1221		1366
1222	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>
…		…
1267	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
1268	elements as \@global_work_size.	1413	elements as \@global_work_size.
1269		1414
1270	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>
1271		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
1272	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1425	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1273		1426
1274	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
1275	for subsequent OpenCL usage.	1428	for subsequent OpenCL usage.
1276		1429
…		…
1311		1464
1312	=for gengetinfo begin command_queue	1465	=for gengetinfo begin command_queue
1313		1466
1314	=item $ctx = $command_queue->context	1467	=item $ctx = $command_queue->context
1315		1468
1316	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.
1317		1470
1318	=item $device = $command_queue->device	1471	=item $device = $command_queue->device
1319		1472
1320	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.
1321		1474
1322	=item $uint = $command_queue->reference_count	1475	=item $uint = $command_queue->reference_count
1323		1476
1324	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.
1325		1478
1326	=item $command_queue_properties = $command_queue->properties	1479	=item $command_queue_properties = $command_queue->properties
1327		1480
1328	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.
1329		1482
1330	=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.
1331		1553
1332	=back	1554	=back
1333		1555
1334	=head2 THE OpenCL::Memory CLASS	1556	=head2 THE OpenCL::Memory CLASS
1335		1557
…		…
1346		1568
1347	=for gengetinfo begin mem	1569	=for gengetinfo begin mem
1348		1570
1349	=item $mem_object_type = $mem->type	1571	=item $mem_object_type = $mem->type
1350		1572
1351	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.
1352		1574
1353	=item $mem_flags = $mem->flags	1575	=item $mem_flags = $mem->flags
1354		1576
1355	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.
1356		1578
1357	=item $int = $mem->size	1579	=item $int = $mem->size
1358		1580
1359	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.
1360		1582
1361	=item $ptr_value = $mem->host_ptr	1583	=item $ptr_value = $mem->host_ptr
1362		1584
1363	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.
1364		1586
1365	=item $uint = $mem->map_count	1587	=item $uint = $mem->map_count
1366		1588
1367	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.
1368		1590
1369	=item $uint = $mem->reference_count	1591	=item $uint = $mem->reference_count
1370		1592
1371	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.
1372		1594
1373	=item $ctx = $mem->context	1595	=item $ctx = $mem->context
1374		1596
1375	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.
1376		1598
1377	=item $mem = $mem->associated_memobject	1599	=item $mem = $mem->associated_memobject
1378		1600
1379	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.
1380		1602
1381	=item $int = $mem->offset	1603	=item $int = $mem->offset
1382		1604
1383	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.
1384		1606
1385	=for gengetinfo end mem	1607	=for gengetinfo end mem
1386		1608
1387	=item ($type, $name) = $mem->gl_object_info	1609	=item ($type, $name) = $mem->gl_object_info
1388		1610
…		…
1440		1662
1441	=for gengetinfo begin image	1663	=for gengetinfo begin image
1442		1664
1443	=item $int = $image->element_size	1665	=item $int = $image->element_size
1444		1666
1445	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.
1446		1668
1447	=item $int = $image->row_pitch	1669	=item $int = $image->row_pitch
1448		1670
1449	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.
1450		1672
1451	=item $int = $image->slice_pitch	1673	=item $int = $image->slice_pitch
1452		1674
1453	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.
1454		1676
1455	=item $int = $image->width	1677	=item $int = $image->width
1456		1678
1457	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.
1458		1680
1459	=item $int = $image->height	1681	=item $int = $image->height
1460		1682
1461	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.
1462		1684
1463	=item $int = $image->depth	1685	=item $int = $image->depth
1464		1686
1465	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.
1466		1688
1467	=for gengetinfo end image	1689	=for gengetinfo end image
1468		1690
1469	=for gengetinfo begin gl_texture	1691	=for gengetinfo begin gl_texture
1470		1692
1471	=item $GLenum = $gl_texture->target	1693	=item $GLenum = $gl_texture->target
1472		1694
1473	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.
1474		1696
1475	=item $GLint = $gl_texture->gl_mipmap_level	1697	=item $GLint = $gl_texture->gl_mipmap_level
1476		1698
1477	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.
1478		1700
1479	=for gengetinfo end gl_texture	1701	=for gengetinfo end gl_texture
1480		1702
1481	=back	1703	=back
1482		1704
…		…
1492		1714
1493	=for gengetinfo begin sampler	1715	=for gengetinfo begin sampler
1494		1716
1495	=item $uint = $sampler->reference_count	1717	=item $uint = $sampler->reference_count
1496		1718
1497	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.
1498		1720
1499	=item $ctx = $sampler->context	1721	=item $ctx = $sampler->context
1500		1722
1501	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.
1502		1724
1503	=item $addressing_mode = $sampler->normalized_coords	1725	=item $addressing_mode = $sampler->normalized_coords
1504		1726
1505	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.
1506		1728
1507	=item $filter_mode = $sampler->addressing_mode	1729	=item $filter_mode = $sampler->addressing_mode
1508		1730
1509	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.
1510		1732
1511	=item $boolean = $sampler->filter_mode	1733	=item $boolean = $sampler->filter_mode
1512		1734
1513	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.
1514		1736
1515	=for gengetinfo end sampler	1737	=for gengetinfo end sampler
1516		1738
1517	=back	1739	=back
1518		1740
…		…
1528	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
1529	finished. Note that many OpenCL implementations block your program while	1751	finished. Note that many OpenCL implementations block your program while
1530	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
1531	want to make sure the build is done in the background.	1753	want to make sure the build is done in the background.
1532		1754
1533	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
1534	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
1535	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
1536	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.
1537		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
1538	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>
1539		1772
1540	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1773	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1541		1774
1542	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
1543	need to check the compilation status form the callback, or by polling).	1776	need to check the compilation status form the callback, or by polling).
1544		1777
		1778	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1779	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1780
1545	=item $packed_value = $program->build_info ($device, $name)	1781	=item $packed_value = $program->build_info ($device, $name)
1546		1782
1547	Similar to C<< $platform->info >>, but returns build info for a previous	1783	Similar to C<< $platform->info >>, but returns build info for a previous
1548	build attempt for the given device.	1784	build attempt for the given device.
1549		1785
…		…
1564		1800
1565	=for gengetinfo begin program_build	1801	=for gengetinfo begin program_build
1566		1802
1567	=item $build_status = $program->build_status ($device)	1803	=item $build_status = $program->build_status ($device)
1568		1804
1569	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1805	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1570		1806
1571	=item $string = $program->build_options ($device)	1807	=item $string = $program->build_options ($device)
1572		1808
1573	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.
1574		1810
1575	=item $string = $program->build_log ($device)	1811	=item $string = $program->build_log ($device)
1576		1812
1577	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.
1578		1814
1579	=for gengetinfo end program_build	1815	=for gengetinfo end program_build
1580		1816
1581	=item $packed_value = $program->info ($name)	1817	=item $packed_value = $program->info ($name)
1582		1818
…		…
1586		1822
1587	=for gengetinfo begin program	1823	=for gengetinfo begin program
1588		1824
1589	=item $uint = $program->reference_count	1825	=item $uint = $program->reference_count
1590		1826
1591	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.
1592		1828
1593	=item $ctx = $program->context	1829	=item $ctx = $program->context
1594		1830
1595	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.
1596		1832
1597	=item $uint = $program->num_devices	1833	=item $uint = $program->num_devices
1598		1834
1599	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.
1600		1836
1601	=item @devices = $program->devices	1837	=item @devices = $program->devices
1602		1838
1603	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.
1604		1840
1605	=item $string = $program->source	1841	=item $string = $program->source
1606		1842
1607	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.
1608		1844
1609	=item @ints = $program->binary_sizes	1845	=item @ints = $program->binary_sizes
1610		1846
1611	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.
1612		1848
1613	=for gengetinfo end program	1849	=for gengetinfo end program
1614		1850
1615	=item @blobs = $program->binaries	1851	=item @blobs = $program->binaries
1616		1852
…		…
1637		1873
1638	=for gengetinfo begin kernel	1874	=for gengetinfo begin kernel
1639		1875
1640	=item $string = $kernel->function_name	1876	=item $string = $kernel->function_name
1641		1877
1642	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.
1643		1879
1644	=item $uint = $kernel->num_args	1880	=item $uint = $kernel->num_args
1645		1881
1646	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.
1647		1883
1648	=item $uint = $kernel->reference_count	1884	=item $uint = $kernel->reference_count
1649		1885
1650	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.
1651		1887
1652	=item $ctx = $kernel->context	1888	=item $ctx = $kernel->context
1653		1889
1654	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.
1655		1891
1656	=item $program = $kernel->program	1892	=item $program = $kernel->program
1657		1893
1658	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.
1659		1895
1660	=for gengetinfo end kernel	1896	=for gengetinfo end kernel
1661		1897
1662	=item $packed_value = $kernel->work_group_info ($device, $name)	1898	=item $packed_value = $kernel->work_group_info ($device, $name)
1663		1899
…		…
1670		1906
1671	=for gengetinfo begin kernel_work_group	1907	=for gengetinfo begin kernel_work_group
1672		1908
1673	=item $int = $kernel->work_group_size ($device)	1909	=item $int = $kernel->work_group_size ($device)
1674		1910
1675	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.
1676		1912
1677	=item @ints = $kernel->compile_work_group_size ($device)	1913	=item @ints = $kernel->compile_work_group_size ($device)
1678		1914
1679	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.
1680		1916
1681	=item $ulong = $kernel->local_mem_size ($device)	1917	=item $ulong = $kernel->local_mem_size ($device)
1682		1918
1683	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.
1684		1920
1685	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1921	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1686		1922
1687	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.
1688		1924
1689	=item $ulong = $kernel->private_mem_size ($device)	1925	=item $ulong = $kernel->private_mem_size ($device)
1690		1926
1691	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.
1692		1928
1693	=for gengetinfo end kernel_work_group	1929	=for gengetinfo end kernel_work_group
		1930
		1931	=for gengetinfo begin kernel_arg_info
		1932
		1933	=for gengetinfo end kernel_arg_info
1694		1934
1695	=item $kernel->setf ($format, ...)	1935	=item $kernel->setf ($format, ...)
1696		1936
1697	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic	1937	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1698	way to set arguments (and with OpenCL 1.2 it might be rather slow), you	1938	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
…		…
1810		2050
1811	=for gengetinfo begin event	2051	=for gengetinfo begin event
1812		2052
1813	=item $queue = $event->command_queue	2053	=item $queue = $event->command_queue
1814		2054
1815	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2055	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1816		2056
1817	=item $command_type = $event->command_type	2057	=item $command_type = $event->command_type
1818		2058
1819	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2059	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1820		2060
1821	=item $uint = $event->reference_count	2061	=item $uint = $event->reference_count
1822		2062
1823	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2063	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1824		2064
1825	=item $uint = $event->command_execution_status	2065	=item $uint = $event->command_execution_status
1826		2066
1827	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2067	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1828		2068
1829	=item $ctx = $event->context	2069	=item $ctx = $event->context
1830		2070
1831	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2071	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1832		2072
1833	=for gengetinfo end event	2073	=for gengetinfo end event
1834		2074
1835	=item $packed_value = $ev->profiling_info ($name)	2075	=item $packed_value = $ev->profiling_info ($name)
1836		2076
…		…
1843		2083
1844	=for gengetinfo begin profiling	2084	=for gengetinfo begin profiling
1845		2085
1846	=item $ulong = $event->profiling_command_queued	2086	=item $ulong = $event->profiling_command_queued
1847		2087
1848	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2088	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1849		2089
1850	=item $ulong = $event->profiling_command_submit	2090	=item $ulong = $event->profiling_command_submit
1851		2091
1852	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2092	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1853		2093
1854	=item $ulong = $event->profiling_command_start	2094	=item $ulong = $event->profiling_command_start
1855		2095
1856	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2096	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1857		2097
1858	=item $ulong = $event->profiling_command_end	2098	=item $ulong = $event->profiling_command_end
1859		2099
1860	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2100	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1861		2101
1862	=for gengetinfo end profiling	2102	=for gengetinfo end profiling
1863		2103
1864	=back	2104	=back
1865		2105
…		…
1872	=item $ev->set_status ($execution_status)	2112	=item $ev->set_status ($execution_status)
1873		2113
1874	Sets the execution status of the user event. Can only be called once,	2114	Sets the execution status of the user event. Can only be called once,
1875	either with OpenCL::COMPLETE or a negative number as status.	2115	either with OpenCL::COMPLETE or a negative number as status.
1876		2116
		2117	execution_status: OpenCL::COMPLETE or a negative integer.
		2118
1877	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2119	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1878		2120
1879	=back	2121	=back
		2122
		2123	=head2 THE OpenCL::Mapped CLASS
		2124
		2125	This class represents objects mapped into host memory. They are
		2126	represented by a blessed string scalar. The string data is the mapped
		2127	memory area, that is, if you read or write it, then the mapped object is
		2128	accessed directly.
		2129
		2130	You must only ever use operations that modify the string in-place - for
		2131	example, a C<substr> that doesn't change the length, or maybe a regex that
		2132	doesn't change the length. Any other operation might cause the data to be
		2133	copied.
		2134
		2135	When the object is destroyed it will enqueue an implicit unmap operation
		2136	on the queue that was used to create it.
		2137
		2138	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2139	OpenCL sees the changes, even if some implementations don't need this
		2140	sometimes.
		2141
		2142	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2143
		2144	my $mapped = $queue->map_buffer ($buf, ...
		2145	$mapped->event->wait; # make sure it's there
		2146
		2147	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2148	# we blindly assume device endianness to equal host endianness
		2149	# (and of course, we assume iee 754 single precision floats :)
		2150	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2151
		2152	=over 4
		2153
		2154	=item $ev = $mapped->unmap ($wait_events...)
		2155
		2156	Unmaps the mapped memory object, using the queue originally used to create
		2157	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2158
		2159	=item $bool = $mapped->mapped
		2160
		2161	Returns whether the object is still mapped - true before an C<unmap> is
		2162	enqueued, false afterwards.
		2163
		2164	=item $ev = $mapped->event
		2165
		2166	Return the event object associated with the mapped object. Initially, this
		2167	will be the event object created when mapping the object, and after an
		2168	unmap, this will be the event object that the unmap operation created.
		2169
		2170	=item $mapped->wait
		2171
		2172	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2173	mapped object are outstanding.
		2174
		2175	=item $bytes = $mapped->size
		2176
		2177	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2178
		2179	=item $ptr = $mapped->ptr
		2180
		2181	Returns the raw memory address of the mapped area.
		2182
		2183	=item $mapped->set ($offset, $data)
		2184
		2185	Replaces the data at the given C<$offset> in the memory area by the new
		2186	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2187	because it does bounds-checking, but also slower.
		2188
		2189	=item $data = $mapped->get ($offset, $length)
		2190
		2191	Returns (without copying) a scalar representing the data at the given
		2192	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2193	the following substr, except much slower;
		2194
		2195	$data = substr $$mapped, $offset, $length
		2196
		2197	=cut
		2198
		2199	sub OpenCL::Mapped::get {
		2200	substr ${$_[0]}, $_[1], $_[2]
		2201	}
		2202
		2203	=back
		2204
		2205	=head2 THE OpenCL::MappedBuffer CLASS
		2206
		2207	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2208
		2209	=head2 THE OpenCL::MappedImage CLASS
		2210
		2211	This is a subclass of OpenCL::Mapped, representing mapped images.
		2212
		2213	=over 4
		2214
		2215	=item $bytes = $mapped->row_pitch
		2216
		2217	=item $bytes = $mapped->slice_pitch
		2218
		2219	Return the row or slice pitch of the image that has been mapped.
		2220
		2221	=back
		2222
1880		2223
1881	=cut	2224	=cut
1882		2225
1883	1;	2226	1;
1884		2227

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC vs. Revision 1.72 by root, Fri May 4 14:49:42 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.62 by root, Sat Apr 28 13:33:04 2012 UTC vs.
Revision 1.72 by root, Fri May 4 14:49:42 2012 UTC