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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.66 by root, Tue May 1 16:37:23 2012 UTC vs.
Revision 1.76 by root, Sat May 5 02:45:38 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 - you can download it from	218	This is quite a long example to get you going - you can download it from
218	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.	219	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
219		220
220	use OpenGL ":all";	221	use OpenGL ":all";
…		…
320	To use a texture, you would modify the above example by creating an	321	To use a texture, you would modify the above example by creating an
321	OpenCL::Image manually instead of deriving it from a texture:	322	OpenCL::Image manually instead of deriving it from a texture:
322		323
323	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);	324	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
324		325
325	And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you	326	And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
326	would read the image2d after the kernel has written it:	327	would read the image2d after the kernel has written it:
327		328
328	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);	329	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
329		330
330	And then you would upload the pixel data to the texture (or use glDrawPixels):	331	And then you would upload the pixel data to the texture (or use glDrawPixels):
331		332
332	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;	333	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
333		334
334	The fully modified example can be found at	335	The fully modified example can be found at
335	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.	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>.
336		354
337	=head1 DOCUMENTATION	355	=head1 DOCUMENTATION
338		356
339	=head2 BASIC CONVENTIONS	357	=head2 BASIC CONVENTIONS
340		358
…		…
416	OpenCL can generate a number of (potentially) asynchronous events, for	434	OpenCL can generate a number of (potentially) asynchronous events, for
417	example, after compiling a program, to signal a context-related error or,	435	example, after compiling a program, to signal a context-related error or,
418	perhaps most important, to signal completion of queued jobs (by setting	436	perhaps most important, to signal completion of queued jobs (by setting
419	callbacks on OpenCL::Event objects).	437	callbacks on OpenCL::Event objects).
420		438
		439	The OpenCL module converts all these callbacks into events - you can
		440	still register callbacks, but they are not executed when your OpenCL
		441	implementation calls the actual callback, but only later. Therefore, none
		442	of the limitations of OpenCL callbacks apply to the perl implementation:
		443	it is perfectly safe to make blocking operations from event callbacks, and
		444	enqueued operations don't need to be flushed.
		445
421	To facilitate this, this module maintains an event queue - each	446	To facilitate this, this module maintains an event queue - each
422	time an asynchronous event happens, it is queued, and perl will be	447	time an asynchronous event happens, it is queued, and perl will be
423	interrupted. This is implemented via the L<Async::Interrupt> module. In	448	interrupted. This is implemented via the L<Async::Interrupt> module. In
424	addition, this module has L<AnyEvent> support, so it can seamlessly	449	addition, this module has L<AnyEvent> support, so it can seamlessly
425	integrate itself into many event loops.	450	integrate itself into many event loops.
426		451
427	Since this module is a bit hard to understand, here are some case examples:	452	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
428		453
429	=head3 Don't use callbacks.	454	=head3 Don't use callbacks.
430		455
431	When your program never uses any callbacks, then there will never be any	456	When your program never uses any callbacks, then there will never be any
432	notifications you need to take care of, and therefore no need to worry	457	notifications you need to take care of, and therefore no need to worry
…		…
529	use Async::Interrupt ();	554	use Async::Interrupt ();
530		555
531	our $POLL_FUNC; # set by XS	556	our $POLL_FUNC; # set by XS
532		557
533	BEGIN {	558	BEGIN {
534	our $VERSION = '0.98';	559	our $VERSION = '0.99';
535		560
536	require XSLoader;	561	require XSLoader;
537	XSLoader::load (__PACKAGE__, $VERSION);	562	XSLoader::load (__PACKAGE__, $VERSION);
538		563
539	@OpenCL::Platform::ISA =	564	@OpenCL::Platform::ISA =
…		…
544	@OpenCL::Sampler::ISA =	569	@OpenCL::Sampler::ISA =
545	@OpenCL::Program::ISA =	570	@OpenCL::Program::ISA =
546	@OpenCL::Kernel::ISA =	571	@OpenCL::Kernel::ISA =
547	@OpenCL::Event::ISA = OpenCL::Object::;	572	@OpenCL::Event::ISA = OpenCL::Object::;
548		573
		574	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		575
549	@OpenCL::Buffer::ISA =	576	@OpenCL::Buffer::ISA =
550	@OpenCL::Image::ISA = OpenCL::Memory::;	577	@OpenCL::Image::ISA = OpenCL::Memory::;
551		578
552	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	579	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
553		580
…		…
558	@OpenCL::Image1DArray::ISA =	585	@OpenCL::Image1DArray::ISA =
559	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	586	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
560		587
561	@OpenCL::UserEvent::ISA = OpenCL::Event::;	588	@OpenCL::UserEvent::ISA = OpenCL::Event::;
562		589
563	@OpenCL::MappedBuffer =	590	@OpenCL::MappedBuffer::ISA =
564	@OpenCL::MappedImage = OpenCL::Mapped::;	591	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
565	}	592	}
566		593
567	=head2 THE OpenCL PACKAGE	594	=head2 THE OpenCL PACKAGE
568		595
569	=over 4	596	=over 4
…		…
593	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	620	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
594		621
595	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	622	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
596		623
597	Tries to create a context from a default device and platform type - never worked for me.	624	Tries to create a context from a default device and platform type - never worked for me.
		625	Consider using C<< $platform->context_from_type >> instead.
		626
		627	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		628	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
598		629
599	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	630	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
600		631
601	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	632	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
602		633
603	Create a new OpenCL::Context object using the given device object(s). This	634	Create a new OpenCL::Context object using the given device object(s).
604	function isn't implemented yet, use C<< $platform->context >> instead.	635	Consider using C<< $platform->context >> instead.
605		636
606	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	637	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
607		638
608	=item OpenCL::wait_for_events $wait_events...	639	=item OpenCL::wait_for_events $wait_events...
609		640
…		…
716		747
717	=for gengetinfo begin platform	748	=for gengetinfo begin platform
718		749
719	=item $string = $platform->profile	750	=item $string = $platform->profile
720		751
721	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	752	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
722		753
723	=item $string = $platform->version	754	=item $string = $platform->version
724		755
725	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	756	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
726		757
727	=item $string = $platform->name	758	=item $string = $platform->name
728		759
729	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	760	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
730		761
731	=item $string = $platform->vendor	762	=item $string = $platform->vendor
732		763
733	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	764	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
734		765
735	=item $string = $platform->extensions	766	=item $string = $platform->extensions
736		767
737	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	768	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
738		769
739	=for gengetinfo end platform	770	=for gengetinfo end platform
740		771
741	=back	772	=back
742		773
…		…
748		779
749	See C<< $platform->info >> for details.	780	See C<< $platform->info >> for details.
750		781
751	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	782	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
752		783
		784	=item @devices = $device->sub_devices (\@properties)
		785
		786	Creates OpencL::SubDevice objects by partitioning an existing device.
		787
		788	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		789
753	=for gengetinfo begin device	790	=for gengetinfo begin device
754		791
755	=item $device_type = $device->type	792	=item $device_type = $device->type
756		793
757	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	794	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
758		795
759	=item $uint = $device->vendor_id	796	=item $uint = $device->vendor_id
760		797
761	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	798	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
762		799
763	=item $uint = $device->max_compute_units	800	=item $uint = $device->max_compute_units
764		801
765	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	802	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
766		803
767	=item $uint = $device->max_work_item_dimensions	804	=item $uint = $device->max_work_item_dimensions
768		805
769	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	806	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
770		807
771	=item $int = $device->max_work_group_size	808	=item $int = $device->max_work_group_size
772		809
773	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	810	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
774		811
775	=item @ints = $device->max_work_item_sizes	812	=item @ints = $device->max_work_item_sizes
776		813
777	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	814	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
778		815
779	=item $uint = $device->preferred_vector_width_char	816	=item $uint = $device->preferred_vector_width_char
780		817
781	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	818	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
782		819
783	=item $uint = $device->preferred_vector_width_short	820	=item $uint = $device->preferred_vector_width_short
784		821
785	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	822	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
786		823
787	=item $uint = $device->preferred_vector_width_int	824	=item $uint = $device->preferred_vector_width_int
788		825
789	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	826	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
790		827
791	=item $uint = $device->preferred_vector_width_long	828	=item $uint = $device->preferred_vector_width_long
792		829
793	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	830	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
794		831
795	=item $uint = $device->preferred_vector_width_float	832	=item $uint = $device->preferred_vector_width_float
796		833
797	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	834	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
798		835
799	=item $uint = $device->preferred_vector_width_double	836	=item $uint = $device->preferred_vector_width_double
800		837
801	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	838	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
802		839
803	=item $uint = $device->max_clock_frequency	840	=item $uint = $device->max_clock_frequency
804		841
805	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	842	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
806		843
807	=item $bitfield = $device->address_bits	844	=item $bitfield = $device->address_bits
808		845
809	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	846	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
810		847
811	=item $uint = $device->max_read_image_args	848	=item $uint = $device->max_read_image_args
812		849
813	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	850	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
814		851
815	=item $uint = $device->max_write_image_args	852	=item $uint = $device->max_write_image_args
816		853
817	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	854	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
818		855
819	=item $ulong = $device->max_mem_alloc_size	856	=item $ulong = $device->max_mem_alloc_size
820		857
821	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	858	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
822		859
823	=item $int = $device->image2d_max_width	860	=item $int = $device->image2d_max_width
824		861
825	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	862	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
826		863
827	=item $int = $device->image2d_max_height	864	=item $int = $device->image2d_max_height
828		865
829	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	866	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
830		867
831	=item $int = $device->image3d_max_width	868	=item $int = $device->image3d_max_width
832		869
833	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	870	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
834		871
835	=item $int = $device->image3d_max_height	872	=item $int = $device->image3d_max_height
836		873
837	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	874	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
838		875
839	=item $int = $device->image3d_max_depth	876	=item $int = $device->image3d_max_depth
840		877
841	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	878	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
842		879
843	=item $uint = $device->image_support	880	=item $uint = $device->image_support
844		881
845	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	882	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
846		883
847	=item $int = $device->max_parameter_size	884	=item $int = $device->max_parameter_size
848		885
849	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	886	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
850		887
851	=item $uint = $device->max_samplers	888	=item $uint = $device->max_samplers
852		889
853	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	890	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
854		891
855	=item $uint = $device->mem_base_addr_align	892	=item $uint = $device->mem_base_addr_align
856		893
857	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	894	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
858		895
859	=item $uint = $device->min_data_type_align_size	896	=item $uint = $device->min_data_type_align_size
860		897
861	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	898	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
862		899
863	=item $device_fp_config = $device->single_fp_config	900	=item $device_fp_config = $device->single_fp_config
864		901
865	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	902	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
866		903
867	=item $device_mem_cache_type = $device->global_mem_cache_type	904	=item $device_mem_cache_type = $device->global_mem_cache_type
868		905
869	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	906	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
870		907
871	=item $uint = $device->global_mem_cacheline_size	908	=item $uint = $device->global_mem_cacheline_size
872		909
873	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	910	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
874		911
875	=item $ulong = $device->global_mem_cache_size	912	=item $ulong = $device->global_mem_cache_size
876		913
877	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	914	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
878		915
879	=item $ulong = $device->global_mem_size	916	=item $ulong = $device->global_mem_size
880		917
881	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	918	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
882		919
883	=item $ulong = $device->max_constant_buffer_size	920	=item $ulong = $device->max_constant_buffer_size
884		921
885	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	922	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
886		923
887	=item $uint = $device->max_constant_args	924	=item $uint = $device->max_constant_args
888		925
889	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	926	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
890		927
891	=item $device_local_mem_type = $device->local_mem_type	928	=item $device_local_mem_type = $device->local_mem_type
892		929
893	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	930	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
894		931
895	=item $ulong = $device->local_mem_size	932	=item $ulong = $device->local_mem_size
896		933
897	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	934	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
898		935
899	=item $boolean = $device->error_correction_support	936	=item $boolean = $device->error_correction_support
900		937
901	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	938	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
902		939
903	=item $int = $device->profiling_timer_resolution	940	=item $int = $device->profiling_timer_resolution
904		941
905	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	942	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
906		943
907	=item $boolean = $device->endian_little	944	=item $boolean = $device->endian_little
908		945
909	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	946	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
910		947
911	=item $boolean = $device->available	948	=item $boolean = $device->available
912		949
913	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	950	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
914		951
915	=item $boolean = $device->compiler_available	952	=item $boolean = $device->compiler_available
916		953
917	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	954	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
918		955
919	=item $device_exec_capabilities = $device->execution_capabilities	956	=item $device_exec_capabilities = $device->execution_capabilities
920		957
921	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	958	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
922		959
923	=item $command_queue_properties = $device->properties	960	=item $command_queue_properties = $device->properties
924		961
925	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	962	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
926		963
927	=item $ = $device->platform	964	=item $ = $device->platform
928		965
929	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	966	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
930		967
931	=item $string = $device->name	968	=item $string = $device->name
932		969
933	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	970	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
934		971
935	=item $string = $device->vendor	972	=item $string = $device->vendor
936		973
937	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	974	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
938		975
939	=item $string = $device->driver_version	976	=item $string = $device->driver_version
940		977
941	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	978	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
942		979
943	=item $string = $device->profile	980	=item $string = $device->profile
944		981
945	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	982	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
946		983
947	=item $string = $device->version	984	=item $string = $device->version
948		985
949	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	986	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
950		987
951	=item $string = $device->extensions	988	=item $string = $device->extensions
952		989
953	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	990	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
954		991
955	=item $uint = $device->preferred_vector_width_half	992	=item $uint = $device->preferred_vector_width_half
956		993
957	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	994	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
958		995
959	=item $uint = $device->native_vector_width_char	996	=item $uint = $device->native_vector_width_char
960		997
961	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	998	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
962		999
963	=item $uint = $device->native_vector_width_short	1000	=item $uint = $device->native_vector_width_short
964		1001
965	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1002	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
966		1003
967	=item $uint = $device->native_vector_width_int	1004	=item $uint = $device->native_vector_width_int
968		1005
969	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1006	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
970		1007
971	=item $uint = $device->native_vector_width_long	1008	=item $uint = $device->native_vector_width_long
972		1009
973	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1010	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
974		1011
975	=item $uint = $device->native_vector_width_float	1012	=item $uint = $device->native_vector_width_float
976		1013
977	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1014	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
978		1015
979	=item $uint = $device->native_vector_width_double	1016	=item $uint = $device->native_vector_width_double
980		1017
981	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1018	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
982		1019
983	=item $uint = $device->native_vector_width_half	1020	=item $uint = $device->native_vector_width_half
984		1021
985	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1022	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
986		1023
987	=item $device_fp_config = $device->double_fp_config	1024	=item $device_fp_config = $device->double_fp_config
988		1025
989	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1026	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
990		1027
991	=item $device_fp_config = $device->half_fp_config	1028	=item $device_fp_config = $device->half_fp_config
992		1029
993	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1030	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
994		1031
995	=item $boolean = $device->host_unified_memory	1032	=item $boolean = $device->host_unified_memory
996		1033
997	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1034	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
998		1035
999	=item $device = $device->parent_device_ext	1036	=item $device = $device->parent_device_ext
1000		1037
1001	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1038	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
1002		1039
1003	=item @device_partition_property_exts = $device->partition_types_ext	1040	=item @device_partition_property_exts = $device->partition_types_ext
1004		1041
1005	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1042	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
1006		1043
1007	=item @device_partition_property_exts = $device->affinity_domains_ext	1044	=item @device_partition_property_exts = $device->affinity_domains_ext
1008		1045
1009	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1046	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
1010		1047
1011	=item $uint = $device->reference_count_ext	1048	=item $uint = $device->reference_count_ext
1012		1049
1013	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1050	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
1014		1051
1015	=item @device_partition_property_exts = $device->partition_style_ext	1052	=item @device_partition_property_exts = $device->partition_style_ext
1016		1053
1017	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1054	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
1018		1055
1019	=for gengetinfo end device	1056	=for gengetinfo end device
1020		1057
1021	=back	1058	=back
1022		1059
1023	=head2 THE OpenCL::Context CLASS	1060	=head2 THE OpenCL::Context CLASS
		1061
		1062	An OpenCL::Context is basically a container, or manager, for a number of
		1063	devices of a platform. It is used to create all sorts of secondary objects
		1064	such as buffers, queues, programs and so on.
		1065
		1066	All context creation functions and methods take a list of properties
		1067	(type-value pairs). All property values can be specified as integers -
		1068	some additionally support other types:
		1069
		1070	=over 4
		1071
		1072	=item OpenCL::CONTEXT_PLATFORM
		1073
		1074	Also accepts OpenCL::Platform objects.
		1075
		1076	=item OpenCL::GLX_DISPLAY_KHR
		1077
		1078	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1079	to find the current glx display (see L<GLX SUPPORT>).
		1080
		1081	=item OpenCL::GL_CONTEXT_KHR
		1082
		1083	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1084	to find the current glx context (see L<GLX SUPPORT>).
		1085
		1086	=back
1024		1087
1025	=over 4	1088	=over 4
1026		1089
1027	=item $prog = $ctx->build_program ($program, $options = "")	1090	=item $prog = $ctx->build_program ($program, $options = "")
1028		1091
…		…
1076	=item $buf = $ctx->buffer ($flags, $len)	1139	=item $buf = $ctx->buffer ($flags, $len)
1077		1140
1078	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1141	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1079	given flags and octet-size.	1142	given flags and octet-size.
1080		1143
		1144	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1145	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1146	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1147
1081	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1148	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1082		1149
1083	=item $buf = $ctx->buffer_sv ($flags, $data)	1150	=item $buf = $ctx->buffer_sv ($flags, $data)
1084		1151
1085	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1152	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
…		…
1088	=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)	1155	=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)
1089		1156
1090	Creates a new OpenCL::Image object and optionally initialises it with	1157	Creates a new OpenCL::Image object and optionally initialises it with
1091	the given data values.	1158	the given data values.
1092		1159
		1160	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1161	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1162	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1163
		1164	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1165	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1166	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1167	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1168	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1169
		1170
		1171	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1172	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1173	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1174	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1175
1093	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1176	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1094		1177
1095	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1178	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1096		1179
1097	Creates a new OpenCL::Image2D object and optionally initialises it with	1180	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1109	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1192	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1110		1193
1111	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1194	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1112	OpenGL buffer object.	1195	OpenGL buffer object.
1113		1196
		1197	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1198
1114	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1199	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1115		1200
1116	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1201	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1117		1202
1118	Creates a new OpenCL::Image object that refers to the given OpenGL	1203	Creates a new OpenCL::Image object that refers to the given OpenGL
1119	texture object or buffer.	1204	texture object or buffer.
1120		1205
		1206	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1207	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1208	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1209	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1210	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1211	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1212
1121	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1213	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1122		1214
1123	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1215	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1124		1216
1125	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1217	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1150		1242
1151	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1243	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1152		1244
1153	Creates a new OpenCL::Sampler object.	1245	Creates a new OpenCL::Sampler object.
1154		1246
		1247	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1248	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1249
		1250	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1251
1155	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1252	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1156		1253
1157	=item $program = $ctx->program_with_source ($string)	1254	=item $program = $ctx->program_with_source ($string)
1158		1255
1159	Creates a new OpenCL::Program object from the given source code.	1256	Creates a new OpenCL::Program object from the given source code.
1160		1257
1161	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1258	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1162		1259
		1260	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1261
		1262	Creates a new OpenCL::Program object from the given binaries.
		1263
		1264	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1265
		1266	Example: clone an existing program object that contains a successfully
		1267	compiled program, no matter how useless this is.
		1268
		1269	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1270
		1271	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1272
		1273	Creates a new OpenCL::Program object from the given built-in kernel names.
		1274
		1275	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1276
		1277	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1278
		1279	Links all (already compiled) program objects specified in C<@programs>
		1280	together and returns a new OpenCL::Program object with the result.
		1281
		1282	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1283
1163	=item $packed_value = $ctx->info ($name)	1284	=item $packed_value = $ctx->info ($name)
1164		1285
1165	See C<< $platform->info >> for details.	1286	See C<< $platform->info >> for details.
1166		1287
1167	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1168		1289
1169	=for gengetinfo begin context	1290	=for gengetinfo begin context
1170		1291
1171	=item $uint = $context->reference_count	1292	=item $uint = $context->reference_count
1172		1293
1173	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1294	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1174		1295
1175	=item @devices = $context->devices	1296	=item @devices = $context->devices
1176		1297
1177	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1298	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1178		1299
1179	=item @property_ints = $context->properties	1300	=item @property_ints = $context->properties
1180		1301
1181	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1302	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1182		1303
1183	=item $uint = $context->num_devices	1304	=item $uint = $context->num_devices
1184		1305
1185	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1306	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1186		1307
1187	=for gengetinfo end context	1308	=for gengetinfo end context
1188		1309
1189	=back	1310	=back
1190		1311
…		…
1306	reference to an array of local work sizes, with the same number of	1427	reference to an array of local work sizes, with the same number of
1307	elements as \@global_work_size.	1428	elements as \@global_work_size.
1308		1429
1309	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1430	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1310		1431
		1432	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1433
		1434	Migrates a number of OpenCL::Memory objects to or from the device.
		1435
		1436	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1437
		1438	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1439
1311	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1440	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1312		1441
1313	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1442	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1314	for subsequent OpenCL usage.	1443	for subsequent OpenCL usage.
1315		1444
…		…
1350		1479
1351	=for gengetinfo begin command_queue	1480	=for gengetinfo begin command_queue
1352		1481
1353	=item $ctx = $command_queue->context	1482	=item $ctx = $command_queue->context
1354		1483
1355	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1484	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1356		1485
1357	=item $device = $command_queue->device	1486	=item $device = $command_queue->device
1358		1487
1359	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1488	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1360		1489
1361	=item $uint = $command_queue->reference_count	1490	=item $uint = $command_queue->reference_count
1362		1491
1363	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1492	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1364		1493
1365	=item $command_queue_properties = $command_queue->properties	1494	=item $command_queue_properties = $command_queue->properties
1366		1495
1367	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1496	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1368		1497
1369	=for gengetinfo end command_queue	1498	=for gengetinfo end command_queue
1370		1499
1371	=back	1500	=back
1372		1501
…		…
1374		1503
1375	OpenCL allows you to map buffers and images to host memory (read: perl	1504	OpenCL allows you to map buffers and images to host memory (read: perl
1376	scalars). This is done much like reading or copying a buffer, by enqueuing	1505	scalars). This is done much like reading or copying a buffer, by enqueuing
1377	a map or unmap operation on the command queue.	1506	a map or unmap operation on the command queue.
1378		1507
1379	The map operations return a C<OpenCL::Mapped> object - see L<THE	1508	The map operations return an C<OpenCL::Mapped> object - see L<THE
1380	OpenCL::Mapped CLASS> section for details on what to do with these	1509	OpenCL::Mapped CLASS> section for details on what to do with these
1381	objects.	1510	objects.
1382		1511
1383	The object will be unmapped automatically when the mapped object is	1512	The object will be unmapped automatically when the mapped object is
1384	destroyed (you can use a barrier to make sure the unmap has finished,	1513	destroyed (you can use a barrier to make sure the unmap has finished,
1385	before using the buffer in a kernel), but you can also enqueue an unmap	1514	before using the buffer in a kernel), but you can also enqueue an unmap
1386	operation manually.	1515	operation manually.
1387		1516
1388	=over 4	1517	=over 4
1389		1518
1390	=item $mapped_buffer = $queue->map_buffer ($buf, $data, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $offset=0, $size=0, $wait_events...)	1519	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
1391		1520
1392	Maps the given buffer into host memory and returns a C<OpenCL::MappedBuffer> object.	1521	Maps the given buffer into host memory and returns an
		1522	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1523	the map will extend to the end of the buffer.
		1524
		1525	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1393		1526
1394	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>	1527	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1395		1528
		1529	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1530
		1531	{
		1532	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1533	substr $$mapped, 0, 4, "abcd";
		1534	} # asynchronously unmap because $mapped is destroyed
		1535
1396	=item $mapped_image = $queue->map_image ($img, $data, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=0, $height=0, $depth=0, $wait_events...)	1536	=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...)
1397		1537
1398	Maps the given image area into host memory and return a	1538	Maps the given image area into host memory and return an
1399	C<OpenCL::MappedImage> object. Although there are default values for most	1539	C<OpenCL::MappedImage> object.
1400	arguments, you currently have to specify all arguments, otherwise the call	1540
1401	will fail.	1541	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1542	will be replaced by the maximum possible value.
1402		1543
1403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>	1544	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1545
		1546	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1547	the first channel of the leftmost column to 5, then explicitly unmap
		1548	it. You are not necessarily meant to do it this way, this example just
		1549	shows you the accessors to use :)
		1550
		1551	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1552
		1553	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1554	for 0..$image->height;
		1555
		1556	$mapped->unmap;.
		1557	$mapped->wait; # only needed for out of order queues normally
1404		1558
1405	=item $ev = $queue->unmap ($mapped, $wait_events...)	1559	=item $ev = $queue->unmap ($mapped, $wait_events...)
1406		1560
1407	Unmaps the data from host memory. You must not call any methods that	1561	Unmaps the data from host memory. You must not call any methods that
1408	modify the data, or modify the data scalar directly, after calling this	1562	modify the data, or modify the data scalar directly, after calling this
…		…
1429		1583
1430	=for gengetinfo begin mem	1584	=for gengetinfo begin mem
1431		1585
1432	=item $mem_object_type = $mem->type	1586	=item $mem_object_type = $mem->type
1433		1587
1434	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1588	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1435		1589
1436	=item $mem_flags = $mem->flags	1590	=item $mem_flags = $mem->flags
1437		1591
1438	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1592	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1439		1593
1440	=item $int = $mem->size	1594	=item $int = $mem->size
1441		1595
1442	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1596	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1443		1597
1444	=item $ptr_value = $mem->host_ptr	1598	=item $ptr_value = $mem->host_ptr
1445		1599
1446	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1600	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1447		1601
1448	=item $uint = $mem->map_count	1602	=item $uint = $mem->map_count
1449		1603
1450	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1604	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1451		1605
1452	=item $uint = $mem->reference_count	1606	=item $uint = $mem->reference_count
1453		1607
1454	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1608	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1455		1609
1456	=item $ctx = $mem->context	1610	=item $ctx = $mem->context
1457		1611
1458	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1612	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1459		1613
1460	=item $mem = $mem->associated_memobject	1614	=item $mem = $mem->associated_memobject
1461		1615
1462	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1616	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1463		1617
1464	=item $int = $mem->offset	1618	=item $int = $mem->offset
1465		1619
1466	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1620	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1467		1621
1468	=for gengetinfo end mem	1622	=for gengetinfo end mem
1469		1623
1470	=item ($type, $name) = $mem->gl_object_info	1624	=item ($type, $name) = $mem->gl_object_info
1471		1625
…		…
1523		1677
1524	=for gengetinfo begin image	1678	=for gengetinfo begin image
1525		1679
1526	=item $int = $image->element_size	1680	=item $int = $image->element_size
1527		1681
1528	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1682	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1529		1683
1530	=item $int = $image->row_pitch	1684	=item $int = $image->row_pitch
1531		1685
1532	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1686	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1533		1687
1534	=item $int = $image->slice_pitch	1688	=item $int = $image->slice_pitch
1535		1689
1536	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1690	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1537		1691
1538	=item $int = $image->width	1692	=item $int = $image->width
1539		1693
1540	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1694	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1541		1695
1542	=item $int = $image->height	1696	=item $int = $image->height
1543		1697
1544	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1698	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1545		1699
1546	=item $int = $image->depth	1700	=item $int = $image->depth
1547		1701
1548	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1702	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1549		1703
1550	=for gengetinfo end image	1704	=for gengetinfo end image
1551		1705
1552	=for gengetinfo begin gl_texture	1706	=for gengetinfo begin gl_texture
1553		1707
1554	=item $GLenum = $gl_texture->target	1708	=item $GLenum = $gl_texture->target
1555		1709
1556	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1710	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1557		1711
1558	=item $GLint = $gl_texture->gl_mipmap_level	1712	=item $GLint = $gl_texture->gl_mipmap_level
1559		1713
1560	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1714	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1561		1715
1562	=for gengetinfo end gl_texture	1716	=for gengetinfo end gl_texture
1563		1717
1564	=back	1718	=back
1565		1719
…		…
1575		1729
1576	=for gengetinfo begin sampler	1730	=for gengetinfo begin sampler
1577		1731
1578	=item $uint = $sampler->reference_count	1732	=item $uint = $sampler->reference_count
1579		1733
1580	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1734	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1581		1735
1582	=item $ctx = $sampler->context	1736	=item $ctx = $sampler->context
1583		1737
1584	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1738	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1585		1739
1586	=item $addressing_mode = $sampler->normalized_coords	1740	=item $addressing_mode = $sampler->normalized_coords
1587		1741
1588	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1742	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1589		1743
1590	=item $filter_mode = $sampler->addressing_mode	1744	=item $filter_mode = $sampler->addressing_mode
1591		1745
1592	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1746	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1593		1747
1594	=item $boolean = $sampler->filter_mode	1748	=item $boolean = $sampler->filter_mode
1595		1749
1596	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1750	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1597		1751
1598	=for gengetinfo end sampler	1752	=for gengetinfo end sampler
1599		1753
1600	=back	1754	=back
1601		1755
…		…
1619	not so. So best make sure you don't pass in invalid values.	1773	not so. So best make sure you don't pass in invalid values.
1620		1774
1621	Some implementations fail with C<OpenCL::INVALID_BINARY> when the	1775	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1622	compilation state is successful but some later stage fails.	1776	compilation state is successful but some later stage fails.
1623		1777
		1778	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1779	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1780	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1781	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1782	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1783	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1784	C<-create-library>, C<-enable-link-options>.
		1785
		1786	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1787	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1788
1624	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1789	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1625		1790
1626	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1791	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1627		1792
1628	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1793	Similar to C<< ->build >>, except it starts a thread, and never fails (you
1629	need to check the compilation status form the callback, or by polling).	1794	need to check the compilation status form the callback, or by polling).
1630		1795
		1796	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1797
		1798	Compiles the given program for the given devices (or all devices if
		1799	undef). If C<$headers> is given, it must be a hashref with include name =>
		1800	OpenCL::Program pairs.
		1801
		1802	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
		1803
1631	=item $packed_value = $program->build_info ($device, $name)	1804	=item $packed_value = $program->build_info ($device, $name)
1632		1805
1633	Similar to C<< $platform->info >>, but returns build info for a previous	1806	Similar to C<< $platform->info >>, but returns build info for a previous
1634	build attempt for the given device.	1807	build attempt for the given device.
1635		1808
…		…
1650		1823
1651	=for gengetinfo begin program_build	1824	=for gengetinfo begin program_build
1652		1825
1653	=item $build_status = $program->build_status ($device)	1826	=item $build_status = $program->build_status ($device)
1654		1827
1655	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1828	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1656		1829
1657	=item $string = $program->build_options ($device)	1830	=item $string = $program->build_options ($device)
1658		1831
1659	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1832	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1660		1833
1661	=item $string = $program->build_log ($device)	1834	=item $string = $program->build_log ($device)
1662		1835
1663	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1836	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1664		1837
1665	=for gengetinfo end program_build	1838	=for gengetinfo end program_build
1666		1839
1667	=item $packed_value = $program->info ($name)	1840	=item $packed_value = $program->info ($name)
1668		1841
…		…
1672		1845
1673	=for gengetinfo begin program	1846	=for gengetinfo begin program
1674		1847
1675	=item $uint = $program->reference_count	1848	=item $uint = $program->reference_count
1676		1849
1677	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1850	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1678		1851
1679	=item $ctx = $program->context	1852	=item $ctx = $program->context
1680		1853
1681	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1854	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1682		1855
1683	=item $uint = $program->num_devices	1856	=item $uint = $program->num_devices
1684		1857
1685	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1858	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1686		1859
1687	=item @devices = $program->devices	1860	=item @devices = $program->devices
1688		1861
1689	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1862	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1690		1863
1691	=item $string = $program->source	1864	=item $string = $program->source
1692		1865
1693	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1866	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1694		1867
1695	=item @ints = $program->binary_sizes	1868	=item @ints = $program->binary_sizes
1696		1869
1697	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1870	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1698		1871
1699	=for gengetinfo end program	1872	=for gengetinfo end program
1700		1873
1701	=item @blobs = $program->binaries	1874	=item @blobs = $program->binaries
1702		1875
…		…
1723		1896
1724	=for gengetinfo begin kernel	1897	=for gengetinfo begin kernel
1725		1898
1726	=item $string = $kernel->function_name	1899	=item $string = $kernel->function_name
1727		1900
1728	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1901	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1729		1902
1730	=item $uint = $kernel->num_args	1903	=item $uint = $kernel->num_args
1731		1904
1732	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1905	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1733		1906
1734	=item $uint = $kernel->reference_count	1907	=item $uint = $kernel->reference_count
1735		1908
1736	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1909	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1737		1910
1738	=item $ctx = $kernel->context	1911	=item $ctx = $kernel->context
1739		1912
1740	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1913	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1741		1914
1742	=item $program = $kernel->program	1915	=item $program = $kernel->program
1743		1916
1744	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1917	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1745		1918
1746	=for gengetinfo end kernel	1919	=for gengetinfo end kernel
1747		1920
1748	=item $packed_value = $kernel->work_group_info ($device, $name)	1921	=item $packed_value = $kernel->work_group_info ($device, $name)
1749		1922
1750	See C<< $platform->info >> for details.	1923	See C<< $platform->info >> for details.
1751		1924
1752	The reason this method is not called C<info> is that there already is an
1753	C<< ->info >> method.
1754
1755	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1925	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1756		1926
1757	=for gengetinfo begin kernel_work_group	1927	=for gengetinfo begin kernel_work_group
1758		1928
1759	=item $int = $kernel->work_group_size ($device)	1929	=item $int = $kernel->work_group_size ($device)
1760		1930
1761	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1931	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1762		1932
1763	=item @ints = $kernel->compile_work_group_size ($device)	1933	=item @ints = $kernel->compile_work_group_size ($device)
1764		1934
1765	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	1935	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1766		1936
1767	=item $ulong = $kernel->local_mem_size ($device)	1937	=item $ulong = $kernel->local_mem_size ($device)
1768		1938
1769	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	1939	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1770		1940
1771	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1941	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1772		1942
1773	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	1943	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1774		1944
1775	=item $ulong = $kernel->private_mem_size ($device)	1945	=item $ulong = $kernel->private_mem_size ($device)
1776		1946
1777	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1947	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1778		1948
1779	=for gengetinfo end kernel_work_group	1949	=for gengetinfo end kernel_work_group
		1950
		1951	=item $packed_value = $kernel->arg_info ($idx, $name)
		1952
		1953	See C<< $platform->info >> for details.
		1954
		1955	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		1956
		1957	=for gengetinfo begin kernel_arg
		1958
		1959	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		1960
		1961	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		1962
		1963	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		1964
		1965	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		1966
		1967	=item $string = $kernel->arg_type_name ($idx)
		1968
		1969	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		1970
		1971	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		1972
		1973	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		1974
		1975	=item $string = $kernel->arg_name ($idx)
		1976
		1977	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		1978
		1979	=for gengetinfo end kernel_arg
1780		1980
1781	=item $kernel->setf ($format, ...)	1981	=item $kernel->setf ($format, ...)
1782		1982
1783	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic	1983	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1784	way to set arguments (and with OpenCL 1.2 it might be rather slow), you	1984	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
…		…
1896		2096
1897	=for gengetinfo begin event	2097	=for gengetinfo begin event
1898		2098
1899	=item $queue = $event->command_queue	2099	=item $queue = $event->command_queue
1900		2100
1901	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2101	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1902		2102
1903	=item $command_type = $event->command_type	2103	=item $command_type = $event->command_type
1904		2104
1905	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2105	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1906		2106
1907	=item $uint = $event->reference_count	2107	=item $uint = $event->reference_count
1908		2108
1909	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2109	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1910		2110
1911	=item $uint = $event->command_execution_status	2111	=item $uint = $event->command_execution_status
1912		2112
1913	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2113	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1914		2114
1915	=item $ctx = $event->context	2115	=item $ctx = $event->context
1916		2116
1917	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2117	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1918		2118
1919	=for gengetinfo end event	2119	=for gengetinfo end event
1920		2120
1921	=item $packed_value = $ev->profiling_info ($name)	2121	=item $packed_value = $ev->profiling_info ($name)
1922		2122
…		…
1929		2129
1930	=for gengetinfo begin profiling	2130	=for gengetinfo begin profiling
1931		2131
1932	=item $ulong = $event->profiling_command_queued	2132	=item $ulong = $event->profiling_command_queued
1933		2133
1934	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2134	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1935		2135
1936	=item $ulong = $event->profiling_command_submit	2136	=item $ulong = $event->profiling_command_submit
1937		2137
1938	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2138	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1939		2139
1940	=item $ulong = $event->profiling_command_start	2140	=item $ulong = $event->profiling_command_start
1941		2141
1942	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2142	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1943		2143
1944	=item $ulong = $event->profiling_command_end	2144	=item $ulong = $event->profiling_command_end
1945		2145
1946	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2146	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1947		2147
1948	=for gengetinfo end profiling	2148	=for gengetinfo end profiling
1949		2149
1950	=back	2150	=back
1951		2151
…		…
1957		2157
1958	=item $ev->set_status ($execution_status)	2158	=item $ev->set_status ($execution_status)
1959		2159
1960	Sets the execution status of the user event. Can only be called once,	2160	Sets the execution status of the user event. Can only be called once,
1961	either with OpenCL::COMPLETE or a negative number as status.	2161	either with OpenCL::COMPLETE or a negative number as status.
		2162
		2163	execution_status: OpenCL::COMPLETE or a negative integer.
1962		2164
1963	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2165	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1964		2166
1965	=back	2167	=back
1966		2168
…		…
1977	copied.	2179	copied.
1978		2180
1979	When the object is destroyed it will enqueue an implicit unmap operation	2181	When the object is destroyed it will enqueue an implicit unmap operation
1980	on the queue that was used to create it.	2182	on the queue that was used to create it.
1981		2183
		2184	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2185	OpenCL sees the changes, even if some implementations don't need this
		2186	sometimes.
		2187
1982	Example, replace the first two floats in the mapped buffer by 1 and 2.	2188	Example, replace the first two floats in the mapped buffer by 1 and 2.
1983		2189
1984	my $mapped = $queue->map_buffer ($buf, ...	2190	my $mapped = $queue->map_buffer ($buf, ...
1985	$mapped->event->wait; # make sure it's there	2191	$mapped->event->wait; # make sure it's there
1986		2192
…		…
1989	# (and of course, we assume iee 754 single precision floats :)	2195	# (and of course, we assume iee 754 single precision floats :)
1990	substr $$mapped, 0, 8, pack "f*", 1, 2;	2196	substr $$mapped, 0, 8, pack "f*", 1, 2;
1991		2197
1992	=over 4	2198	=over 4
1993		2199
		2200	=item $ev = $mapped->unmap ($wait_events...)
		2201
		2202	Unmaps the mapped memory object, using the queue originally used to create
		2203	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2204
1994	=item $bool = $mapped->mapped	2205	=item $bool = $mapped->mapped
1995		2206
1996	Returns whether the object is still mapped - true before an C<unmap> is	2207	Returns whether the object is still mapped - true before an C<unmap> is
1997	enqueued, false afterwards.	2208	enqueued, false afterwards.
1998		2209
…		…
2011		2222
2012	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.	2223	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
2013		2224
2014	=item $ptr = $mapped->ptr	2225	=item $ptr = $mapped->ptr
2015		2226
2016	Returns the raw memory address of the mapped area - same as C<$mapped+0>.	2227	Returns the raw memory address of the mapped area.
		2228
		2229	=item $mapped->set ($offset, $data)
		2230
		2231	Replaces the data at the given C<$offset> in the memory area by the new
		2232	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2233	because it does bounds-checking, but also slower.
		2234
		2235	=item $data = $mapped->get ($offset, $length)
		2236
		2237	Returns (without copying) a scalar representing the data at the given
		2238	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2239	the following substr, except much slower;
		2240
		2241	$data = substr $$mapped, $offset, $length
		2242
		2243	=cut
		2244
		2245	sub OpenCL::Mapped::get {
		2246	substr ${$_[0]}, $_[1], $_[2]
		2247	}
2017		2248
2018	=back	2249	=back
2019		2250
2020	=head2 THE OpenCL::MappedBuffer CLASS	2251	=head2 THE OpenCL::MappedBuffer CLASS
2021		2252
2022	This is a subclass of OpenCL::Mapped, representing mapped buffers.	2253	This is a subclass of OpenCL::Mapped, representing mapped buffers.
2023		2254
		2255	=head2 THE OpenCL::MappedImage CLASS
		2256
		2257	This is a subclass of OpenCL::Mapped, representing mapped images.
		2258
2024	=over 4	2259	=over 4
2025		2260
2026	=back	2261	=item $bytes = $mapped->row_pitch
2027		2262
2028	=head2 THE OpenCL::MappedImage CLASS	2263	=item $bytes = $mapped->slice_pitch
2029		2264
2030	This is a subclass of OpenCL::Mapped, representing mapped images.	2265	Return the row or slice pitch of the image that has been mapped.
2031
2032	=over 4
2033		2266
2034	=back	2267	=back
2035		2268
2036		2269
2037	=cut	2270	=cut

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.66 by root, Tue May 1 16:37:23 2012 UTC vs. Revision 1.76 by root, Sat May 5 02:45:38 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.66 by root, Tue May 1 16:37:23 2012 UTC vs.
Revision 1.76 by root, Sat May 5 02:45:38 2012 UTC