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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.64 by root, Mon Apr 30 23:12:43 2012 UTC vs.
Revision 1.71 by root, Fri May 4 14:29:35 2012 UTC

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

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.64 by root, Mon Apr 30 23:12:43 2012 UTC vs. Revision 1.71 by root, Fri May 4 14:29:35 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.64 by root, Mon Apr 30 23:12:43 2012 UTC vs.
Revision 1.71 by root, Fri May 4 14:29:35 2012 UTC