[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.77 by root, Sat May 5 12:54:03 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
…		…
95	initialised at creation time).	96	initialised at creation time).
96		97
97	Enqueue the kernel execution.	98	Enqueue the kernel execution.
98		99
99	Enqueue buffer reads for your output buffer to read results.	100	Enqueue buffer reads for your output buffer to read results.
		101
		102	=head1 OPENCL 1.1 VS. OPENCL 1.2
		103
		104	This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
		105	1.2 interface hasn't been tested much for lack of availability of an
		106	actual implementation.
		107
		108	Every function or method in this manual page that interfaces to a
		109	particular OpenCL function has a link to the its C manual page.
		110
		111	If the link contains a F<1.1>, then this function is an OpenCL 1.1
		112	function. Most but not all also exist in OpenCL 1.2, and this module
		113	tries to emulate the missing ones for you, when told to do so at
		114	compiletime. You cna check whether a function was removed in OpenCL 1.2 by
		115	replacing the F<1.1> component in the URL by F<1.2>.
		116
		117	If the link contains a F<1.2>, then this is a OpenCL 1.2-only
		118	function. Even if the module was compiled with OpenCL 1.2 header files
		119	and has an 1.2 OpenCL library, calling such a function on a platform that
		120	doesn't implement 1.2 causes undefined behaviour, usually a crash (But
		121	this is not guaranteed).
		122
		123	You can find out whether this module was compiled to prefer 1.1
		124	functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
		125	1.1 functions generally are implemented using 1.1 OpenCL functions. If it
		126	is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
		127	fucntions.
		128
		129	This is a somewhat sorry state of affairs, but the Khronos group choose to
		130	make every release of OpenCL source and binary incompatible with previous
		131	releases.
100		132
101	=head1 EXAMPLES	133	=head1 EXAMPLES
102		134
103	=head2 Enumerate all devices and get contexts for them.	135	=head2 Enumerate all devices and get contexts for them.
104		136
…		…
210		242
211	# wait for the last event to complete	243	# wait for the last event to complete
212	$ev->wait;	244	$ev->wait;
213		245
214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia	246	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215	set tunnel effect.	247	set flight effect.
216		248
217	This is quite a long example to get you going - you can download it from	249	This is quite a long example to get you going - you can download it from
218	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.	250	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
219		251
220	use OpenGL ":all";	252	use OpenGL ":all";
…		…
320	To use a texture, you would modify the above example by creating an	352	To use a texture, you would modify the above example by creating an
321	OpenCL::Image manually instead of deriving it from a texture:	353	OpenCL::Image manually instead of deriving it from a texture:
322		354
323	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);	355	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
324		356
325	And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you	357	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:	358	would read the image2d after the kernel has written it:
327		359
328	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);	360	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
329		361
330	And then you would upload the pixel data to the texture (or use glDrawPixels):	362	And then you would upload the pixel data to the texture (or use glDrawPixels):
331		363
332	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;	364	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
333		365
334	The fully modified example can be found at	366	The fully modified example can be found at
335	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.	367	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
		368
		369	=head2 Julia sets look soooo 80ies.
		370
		371	Then colour them differently, e.g. using orbit traps! Replace the loop and
		372	colour calculation from the previous examples by this:
		373
		374	float2 dm = (float2)(1.f, 1.f);
		375
		376	for (int i = 0; i < 25; ++i)
		377	{
		378	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		379	dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
		380	}
		381
		382	float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
		383
		384	Also try C<-10.f> instead of C<-1.f>.
336		385
337	=head1 DOCUMENTATION	386	=head1 DOCUMENTATION
338		387
339	=head2 BASIC CONVENTIONS	388	=head2 BASIC CONVENTIONS
340		389
…		…
416	OpenCL can generate a number of (potentially) asynchronous events, for	465	OpenCL can generate a number of (potentially) asynchronous events, for
417	example, after compiling a program, to signal a context-related error or,	466	example, after compiling a program, to signal a context-related error or,
418	perhaps most important, to signal completion of queued jobs (by setting	467	perhaps most important, to signal completion of queued jobs (by setting
419	callbacks on OpenCL::Event objects).	468	callbacks on OpenCL::Event objects).
420		469
		470	The OpenCL module converts all these callbacks into events - you can
		471	still register callbacks, but they are not executed when your OpenCL
		472	implementation calls the actual callback, but only later. Therefore, none
		473	of the limitations of OpenCL callbacks apply to the perl implementation:
		474	it is perfectly safe to make blocking operations from event callbacks, and
		475	enqueued operations don't need to be flushed.
		476
421	To facilitate this, this module maintains an event queue - each	477	To facilitate this, this module maintains an event queue - each
422	time an asynchronous event happens, it is queued, and perl will be	478	time an asynchronous event happens, it is queued, and perl will be
423	interrupted. This is implemented via the L<Async::Interrupt> module. In	479	interrupted. This is implemented via the L<Async::Interrupt> module. In
424	addition, this module has L<AnyEvent> support, so it can seamlessly	480	addition, this module has L<AnyEvent> support, so it can seamlessly
425	integrate itself into many event loops.	481	integrate itself into many event loops.
426		482
427	Since this module is a bit hard to understand, here are some case examples:	483	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
428		484
429	=head3 Don't use callbacks.	485	=head3 Don't use callbacks.
430		486
431	When your program never uses any callbacks, then there will never be any	487	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	488	notifications you need to take care of, and therefore no need to worry
…		…
529	use Async::Interrupt ();	585	use Async::Interrupt ();
530		586
531	our $POLL_FUNC; # set by XS	587	our $POLL_FUNC; # set by XS
532		588
533	BEGIN {	589	BEGIN {
534	our $VERSION = '0.98';	590	our $VERSION = '0.99';
535		591
536	require XSLoader;	592	require XSLoader;
537	XSLoader::load (__PACKAGE__, $VERSION);	593	XSLoader::load (__PACKAGE__, $VERSION);
538		594
539	@OpenCL::Platform::ISA =	595	@OpenCL::Platform::ISA =
…		…
544	@OpenCL::Sampler::ISA =	600	@OpenCL::Sampler::ISA =
545	@OpenCL::Program::ISA =	601	@OpenCL::Program::ISA =
546	@OpenCL::Kernel::ISA =	602	@OpenCL::Kernel::ISA =
547	@OpenCL::Event::ISA = OpenCL::Object::;	603	@OpenCL::Event::ISA = OpenCL::Object::;
548		604
		605	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		606
549	@OpenCL::Buffer::ISA =	607	@OpenCL::Buffer::ISA =
550	@OpenCL::Image::ISA = OpenCL::Memory::;	608	@OpenCL::Image::ISA = OpenCL::Memory::;
551		609
552	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	610	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
553		611
…		…
558	@OpenCL::Image1DArray::ISA =	616	@OpenCL::Image1DArray::ISA =
559	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	617	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
560		618
561	@OpenCL::UserEvent::ISA = OpenCL::Event::;	619	@OpenCL::UserEvent::ISA = OpenCL::Event::;
562		620
563	@OpenCL::MappedBuffer =	621	@OpenCL::MappedBuffer::ISA =
564	@OpenCL::MappedImage = OpenCL::Mapped::;	622	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
565	}	623	}
566		624
567	=head2 THE OpenCL PACKAGE	625	=head2 THE OpenCL PACKAGE
568		626
569	=over 4	627	=over 4
…		…
593	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	651	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
594		652
595	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	653	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
596		654
597	Tries to create a context from a default device and platform type - never worked for me.	655	Tries to create a context from a default device and platform type - never worked for me.
		656	Consider using C<< $platform->context_from_type >> instead.
		657
		658	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		659	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
598		660
599	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	661	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
600		662
601	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	663	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
602		664
603	Create a new OpenCL::Context object using the given device object(s). This	665	Create a new OpenCL::Context object using the given device object(s).
604	function isn't implemented yet, use C<< $platform->context >> instead.	666	Consider using C<< $platform->context >> instead.
605		667
606	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	668	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
607		669
608	=item OpenCL::wait_for_events $wait_events...	670	=item OpenCL::wait_for_events $wait_events...
609		671
…		…
716		778
717	=for gengetinfo begin platform	779	=for gengetinfo begin platform
718		780
719	=item $string = $platform->profile	781	=item $string = $platform->profile
720		782
721	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	783	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
722		784
723	=item $string = $platform->version	785	=item $string = $platform->version
724		786
725	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	787	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
726		788
727	=item $string = $platform->name	789	=item $string = $platform->name
728		790
729	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	791	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
730		792
731	=item $string = $platform->vendor	793	=item $string = $platform->vendor
732		794
733	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	795	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
734		796
735	=item $string = $platform->extensions	797	=item $string = $platform->extensions
736		798
737	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	799	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
738		800
739	=for gengetinfo end platform	801	=for gengetinfo end platform
740		802
741	=back	803	=back
742		804
…		…
748		810
749	See C<< $platform->info >> for details.	811	See C<< $platform->info >> for details.
750		812
751	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	813	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
752		814
		815	=item @devices = $device->sub_devices (\@properties)
		816
		817	Creates OpencL::SubDevice objects by partitioning an existing device.
		818
		819	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		820
753	=for gengetinfo begin device	821	=for gengetinfo begin device
754		822
755	=item $device_type = $device->type	823	=item $device_type = $device->type
756		824
757	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	825	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
758		826
759	=item $uint = $device->vendor_id	827	=item $uint = $device->vendor_id
760		828
761	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	829	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
762		830
763	=item $uint = $device->max_compute_units	831	=item $uint = $device->max_compute_units
764		832
765	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	833	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
766		834
767	=item $uint = $device->max_work_item_dimensions	835	=item $uint = $device->max_work_item_dimensions
768		836
769	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	837	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
770		838
771	=item $int = $device->max_work_group_size	839	=item $int = $device->max_work_group_size
772		840
773	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	841	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
774		842
775	=item @ints = $device->max_work_item_sizes	843	=item @ints = $device->max_work_item_sizes
776		844
777	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	845	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
778		846
779	=item $uint = $device->preferred_vector_width_char	847	=item $uint = $device->preferred_vector_width_char
780		848
781	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	849	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
782		850
783	=item $uint = $device->preferred_vector_width_short	851	=item $uint = $device->preferred_vector_width_short
784		852
785	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	853	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
786		854
787	=item $uint = $device->preferred_vector_width_int	855	=item $uint = $device->preferred_vector_width_int
788		856
789	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	857	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
790		858
791	=item $uint = $device->preferred_vector_width_long	859	=item $uint = $device->preferred_vector_width_long
792		860
793	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	861	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
794		862
795	=item $uint = $device->preferred_vector_width_float	863	=item $uint = $device->preferred_vector_width_float
796		864
797	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	865	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
798		866
799	=item $uint = $device->preferred_vector_width_double	867	=item $uint = $device->preferred_vector_width_double
800		868
801	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	869	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
802		870
803	=item $uint = $device->max_clock_frequency	871	=item $uint = $device->max_clock_frequency
804		872
805	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	873	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
806		874
807	=item $bitfield = $device->address_bits	875	=item $bitfield = $device->address_bits
808		876
809	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	877	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
810		878
811	=item $uint = $device->max_read_image_args	879	=item $uint = $device->max_read_image_args
812		880
813	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	881	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
814		882
815	=item $uint = $device->max_write_image_args	883	=item $uint = $device->max_write_image_args
816		884
817	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	885	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
818		886
819	=item $ulong = $device->max_mem_alloc_size	887	=item $ulong = $device->max_mem_alloc_size
820		888
821	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	889	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
822		890
823	=item $int = $device->image2d_max_width	891	=item $int = $device->image2d_max_width
824		892
825	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	893	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
826		894
827	=item $int = $device->image2d_max_height	895	=item $int = $device->image2d_max_height
828		896
829	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	897	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
830		898
831	=item $int = $device->image3d_max_width	899	=item $int = $device->image3d_max_width
832		900
833	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	901	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
834		902
835	=item $int = $device->image3d_max_height	903	=item $int = $device->image3d_max_height
836		904
837	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	905	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
838		906
839	=item $int = $device->image3d_max_depth	907	=item $int = $device->image3d_max_depth
840		908
841	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	909	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
842		910
843	=item $uint = $device->image_support	911	=item $uint = $device->image_support
844		912
845	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	913	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
846		914
847	=item $int = $device->max_parameter_size	915	=item $int = $device->max_parameter_size
848		916
849	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	917	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
850		918
851	=item $uint = $device->max_samplers	919	=item $uint = $device->max_samplers
852		920
853	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	921	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
854		922
855	=item $uint = $device->mem_base_addr_align	923	=item $uint = $device->mem_base_addr_align
856		924
857	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	925	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
858		926
859	=item $uint = $device->min_data_type_align_size	927	=item $uint = $device->min_data_type_align_size
860		928
861	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	929	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
862		930
863	=item $device_fp_config = $device->single_fp_config	931	=item $device_fp_config = $device->single_fp_config
864		932
865	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	933	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
866		934
867	=item $device_mem_cache_type = $device->global_mem_cache_type	935	=item $device_mem_cache_type = $device->global_mem_cache_type
868		936
869	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	937	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
870		938
871	=item $uint = $device->global_mem_cacheline_size	939	=item $uint = $device->global_mem_cacheline_size
872		940
873	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	941	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
874		942
875	=item $ulong = $device->global_mem_cache_size	943	=item $ulong = $device->global_mem_cache_size
876		944
877	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	945	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
878		946
879	=item $ulong = $device->global_mem_size	947	=item $ulong = $device->global_mem_size
880		948
881	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	949	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
882		950
883	=item $ulong = $device->max_constant_buffer_size	951	=item $ulong = $device->max_constant_buffer_size
884		952
885	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	953	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
886		954
887	=item $uint = $device->max_constant_args	955	=item $uint = $device->max_constant_args
888		956
889	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	957	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
890		958
891	=item $device_local_mem_type = $device->local_mem_type	959	=item $device_local_mem_type = $device->local_mem_type
892		960
893	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	961	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
894		962
895	=item $ulong = $device->local_mem_size	963	=item $ulong = $device->local_mem_size
896		964
897	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	965	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
898		966
899	=item $boolean = $device->error_correction_support	967	=item $boolean = $device->error_correction_support
900		968
901	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	969	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
902		970
903	=item $int = $device->profiling_timer_resolution	971	=item $int = $device->profiling_timer_resolution
904		972
905	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	973	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
906		974
907	=item $boolean = $device->endian_little	975	=item $boolean = $device->endian_little
908		976
909	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	977	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
910		978
911	=item $boolean = $device->available	979	=item $boolean = $device->available
912		980
913	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	981	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
914		982
915	=item $boolean = $device->compiler_available	983	=item $boolean = $device->compiler_available
916		984
917	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	985	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
918		986
919	=item $device_exec_capabilities = $device->execution_capabilities	987	=item $device_exec_capabilities = $device->execution_capabilities
920		988
921	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	989	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
922		990
923	=item $command_queue_properties = $device->properties	991	=item $command_queue_properties = $device->properties
924		992
925	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	993	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
926		994
927	=item $ = $device->platform	995	=item $ = $device->platform
928		996
929	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	997	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
930		998
931	=item $string = $device->name	999	=item $string = $device->name
932		1000
933	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	1001	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
934		1002
935	=item $string = $device->vendor	1003	=item $string = $device->vendor
936		1004
937	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	1005	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
938		1006
939	=item $string = $device->driver_version	1007	=item $string = $device->driver_version
940		1008
941	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	1009	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
942		1010
943	=item $string = $device->profile	1011	=item $string = $device->profile
944		1012
945	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	1013	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
946		1014
947	=item $string = $device->version	1015	=item $string = $device->version
948		1016
949	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	1017	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
950		1018
951	=item $string = $device->extensions	1019	=item $string = $device->extensions
952		1020
953	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	1021	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
954		1022
955	=item $uint = $device->preferred_vector_width_half	1023	=item $uint = $device->preferred_vector_width_half
956		1024
957	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	1025	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
958		1026
959	=item $uint = $device->native_vector_width_char	1027	=item $uint = $device->native_vector_width_char
960		1028
961	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	1029	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
962		1030
963	=item $uint = $device->native_vector_width_short	1031	=item $uint = $device->native_vector_width_short
964		1032
965	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1033	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
966		1034
967	=item $uint = $device->native_vector_width_int	1035	=item $uint = $device->native_vector_width_int
968		1036
969	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1037	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
970		1038
971	=item $uint = $device->native_vector_width_long	1039	=item $uint = $device->native_vector_width_long
972		1040
973	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1041	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
974		1042
975	=item $uint = $device->native_vector_width_float	1043	=item $uint = $device->native_vector_width_float
976		1044
977	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1045	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
978		1046
979	=item $uint = $device->native_vector_width_double	1047	=item $uint = $device->native_vector_width_double
980		1048
981	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1049	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
982		1050
983	=item $uint = $device->native_vector_width_half	1051	=item $uint = $device->native_vector_width_half
984		1052
985	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1053	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
986		1054
987	=item $device_fp_config = $device->double_fp_config	1055	=item $device_fp_config = $device->double_fp_config
988		1056
989	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1057	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
990		1058
991	=item $device_fp_config = $device->half_fp_config	1059	=item $device_fp_config = $device->half_fp_config
992		1060
993	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1061	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
994		1062
995	=item $boolean = $device->host_unified_memory	1063	=item $boolean = $device->host_unified_memory
996		1064
997	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1065	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
998		1066
999	=item $device = $device->parent_device_ext	1067	=item $device = $device->parent_device_ext
1000		1068
1001	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1069	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
1002		1070
1003	=item @device_partition_property_exts = $device->partition_types_ext	1071	=item @device_partition_property_exts = $device->partition_types_ext
1004		1072
1005	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1073	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
1006		1074
1007	=item @device_partition_property_exts = $device->affinity_domains_ext	1075	=item @device_partition_property_exts = $device->affinity_domains_ext
1008		1076
1009	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1077	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
1010		1078
1011	=item $uint = $device->reference_count_ext	1079	=item $uint = $device->reference_count_ext
1012		1080
1013	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1081	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
1014		1082
1015	=item @device_partition_property_exts = $device->partition_style_ext	1083	=item @device_partition_property_exts = $device->partition_style_ext
1016		1084
1017	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1085	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
1018		1086
1019	=for gengetinfo end device	1087	=for gengetinfo end device
1020		1088
1021	=back	1089	=back
1022		1090
1023	=head2 THE OpenCL::Context CLASS	1091	=head2 THE OpenCL::Context CLASS
		1092
		1093	An OpenCL::Context is basically a container, or manager, for a number of
		1094	devices of a platform. It is used to create all sorts of secondary objects
		1095	such as buffers, queues, programs and so on.
		1096
		1097	All context creation functions and methods take a list of properties
		1098	(type-value pairs). All property values can be specified as integers -
		1099	some additionally support other types:
		1100
		1101	=over 4
		1102
		1103	=item OpenCL::CONTEXT_PLATFORM
		1104
		1105	Also accepts OpenCL::Platform objects.
		1106
		1107	=item OpenCL::GLX_DISPLAY_KHR
		1108
		1109	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1110	to find the current glx display (see L<GLX SUPPORT>).
		1111
		1112	=item OpenCL::GL_CONTEXT_KHR
		1113
		1114	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1115	to find the current glx context (see L<GLX SUPPORT>).
		1116
		1117	=back
1024		1118
1025	=over 4	1119	=over 4
1026		1120
1027	=item $prog = $ctx->build_program ($program, $options = "")	1121	=item $prog = $ctx->build_program ($program, $options = "")
1028		1122
…		…
1076	=item $buf = $ctx->buffer ($flags, $len)	1170	=item $buf = $ctx->buffer ($flags, $len)
1077		1171
1078	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1172	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1079	given flags and octet-size.	1173	given flags and octet-size.
1080		1174
		1175	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1176	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1177	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1178
1081	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1179	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1082		1180
1083	=item $buf = $ctx->buffer_sv ($flags, $data)	1181	=item $buf = $ctx->buffer_sv ($flags, $data)
1084		1182
1085	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1183	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)	1186	=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		1187
1090	Creates a new OpenCL::Image object and optionally initialises it with	1188	Creates a new OpenCL::Image object and optionally initialises it with
1091	the given data values.	1189	the given data values.
1092		1190
		1191	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1192	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1193	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1194
		1195	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1196	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1197	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1198	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1199	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1200
		1201
		1202	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1203	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1204	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1205	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1206
1093	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1207	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1094		1208
1095	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1209	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1096		1210
1097	Creates a new OpenCL::Image2D object and optionally initialises it with	1211	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1109	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1223	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1110		1224
1111	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1225	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1112	OpenGL buffer object.	1226	OpenGL buffer object.
1113		1227
		1228	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1229
1114	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1230	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1115		1231
1116	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1232	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1117		1233
1118	Creates a new OpenCL::Image object that refers to the given OpenGL	1234	Creates a new OpenCL::Image object that refers to the given OpenGL
1119	texture object or buffer.	1235	texture object or buffer.
1120		1236
		1237	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1238	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1239	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1240	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1241	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1242	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1243
1121	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1244	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1122		1245
1123	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1246	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1124		1247
1125	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1248	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1150		1273
1151	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1274	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1152		1275
1153	Creates a new OpenCL::Sampler object.	1276	Creates a new OpenCL::Sampler object.
1154		1277
		1278	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1279	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1280
		1281	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1282
1155	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1283	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1156		1284
1157	=item $program = $ctx->program_with_source ($string)	1285	=item $program = $ctx->program_with_source ($string)
1158		1286
1159	Creates a new OpenCL::Program object from the given source code.	1287	Creates a new OpenCL::Program object from the given source code.
1160		1288
1161	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1289	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1162		1290
		1291	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1292
		1293	Creates a new OpenCL::Program object from the given binaries.
		1294
		1295	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1296
		1297	Example: clone an existing program object that contains a successfully
		1298	compiled program, no matter how useless this is.
		1299
		1300	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1301
		1302	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1303
		1304	Creates a new OpenCL::Program object from the given built-in kernel names.
		1305
		1306	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1307
		1308	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1309
		1310	Links all (already compiled) program objects specified in C<@programs>
		1311	together and returns a new OpenCL::Program object with the result.
		1312
		1313	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1314
1163	=item $packed_value = $ctx->info ($name)	1315	=item $packed_value = $ctx->info ($name)
1164		1316
1165	See C<< $platform->info >> for details.	1317	See C<< $platform->info >> for details.
1166		1318
1167	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1319	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1168		1320
1169	=for gengetinfo begin context	1321	=for gengetinfo begin context
1170		1322
1171	=item $uint = $context->reference_count	1323	=item $uint = $context->reference_count
1172		1324
1173	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1325	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1174		1326
1175	=item @devices = $context->devices	1327	=item @devices = $context->devices
1176		1328
1177	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1329	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1178		1330
1179	=item @property_ints = $context->properties	1331	=item @property_ints = $context->properties
1180		1332
1181	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1333	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1182		1334
1183	=item $uint = $context->num_devices	1335	=item $uint = $context->num_devices
1184		1336
1185	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1337	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1186		1338
1187	=for gengetinfo end context	1339	=for gengetinfo end context
1188		1340
1189	=back	1341	=back
1190		1342
…		…
1306	reference to an array of local work sizes, with the same number of	1458	reference to an array of local work sizes, with the same number of
1307	elements as \@global_work_size.	1459	elements as \@global_work_size.
1308		1460
1309	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1461	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1310		1462
		1463	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1464
		1465	Migrates a number of OpenCL::Memory objects to or from the device.
		1466
		1467	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1468
		1469	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1470
1311	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1471	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1312		1472
1313	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1473	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1314	for subsequent OpenCL usage.	1474	for subsequent OpenCL usage.
1315		1475
…		…
1350		1510
1351	=for gengetinfo begin command_queue	1511	=for gengetinfo begin command_queue
1352		1512
1353	=item $ctx = $command_queue->context	1513	=item $ctx = $command_queue->context
1354		1514
1355	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1515	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1356		1516
1357	=item $device = $command_queue->device	1517	=item $device = $command_queue->device
1358		1518
1359	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1519	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1360		1520
1361	=item $uint = $command_queue->reference_count	1521	=item $uint = $command_queue->reference_count
1362		1522
1363	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1523	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1364		1524
1365	=item $command_queue_properties = $command_queue->properties	1525	=item $command_queue_properties = $command_queue->properties
1366		1526
1367	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1527	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1368		1528
1369	=for gengetinfo end command_queue	1529	=for gengetinfo end command_queue
1370		1530
1371	=back	1531	=back
1372		1532
…		…
1374		1534
1375	OpenCL allows you to map buffers and images to host memory (read: perl	1535	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	1536	scalars). This is done much like reading or copying a buffer, by enqueuing
1377	a map or unmap operation on the command queue.	1537	a map or unmap operation on the command queue.
1378		1538
1379	The map operations return a C<OpenCL::Mapped> object - see L<THE	1539	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	1540	OpenCL::Mapped CLASS> section for details on what to do with these
1381	objects.	1541	objects.
1382		1542
1383	The object will be unmapped automatically when the mapped object is	1543	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,	1544	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	1545	before using the buffer in a kernel), but you can also enqueue an unmap
1386	operation manually.	1546	operation manually.
1387		1547
1388	=over 4	1548	=over 4
1389		1549
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...)	1550	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
1391		1551
1392	Maps the given buffer into host memory and returns a C<OpenCL::MappedBuffer> object.	1552	Maps the given buffer into host memory and returns an
		1553	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1554	the map will extend to the end of the buffer.
		1555
		1556	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
1393		1557
1394	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>	1558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
1395		1559
		1560	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1561
		1562	{
		1563	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1564	substr $$mapped, 0, 4, "abcd";
		1565	} # asynchronously unmap because $mapped is destroyed
		1566
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...)	1567	=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		1568
1398	Maps the given image area into host memory and return a	1569	Maps the given image area into host memory and return an
1399	C<OpenCL::MappedImage> object. Although there are default values for most	1570	C<OpenCL::MappedImage> object.
1400	arguments, you currently have to specify all arguments, otherwise the call	1571
1401	will fail.	1572	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1573	will be replaced by the maximum possible value.
1402		1574
1403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>	1575	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1576
		1577	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1578	the first channel of the leftmost column to 5, then explicitly unmap
		1579	it. You are not necessarily meant to do it this way, this example just
		1580	shows you the accessors to use :)
		1581
		1582	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1583
		1584	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1585	for 0..$image->height;
		1586
		1587	$mapped->unmap;.
		1588	$mapped->wait; # only needed for out of order queues normally
1404		1589
1405	=item $ev = $queue->unmap ($mapped, $wait_events...)	1590	=item $ev = $queue->unmap ($mapped, $wait_events...)
1406		1591
1407	Unmaps the data from host memory. You must not call any methods that	1592	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	1593	modify the data, or modify the data scalar directly, after calling this
…		…
1429		1614
1430	=for gengetinfo begin mem	1615	=for gengetinfo begin mem
1431		1616
1432	=item $mem_object_type = $mem->type	1617	=item $mem_object_type = $mem->type
1433		1618
1434	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1619	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1435		1620
1436	=item $mem_flags = $mem->flags	1621	=item $mem_flags = $mem->flags
1437		1622
1438	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1623	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1439		1624
1440	=item $int = $mem->size	1625	=item $int = $mem->size
1441		1626
1442	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1627	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1443		1628
1444	=item $ptr_value = $mem->host_ptr	1629	=item $ptr_value = $mem->host_ptr
1445		1630
1446	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1631	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1447		1632
1448	=item $uint = $mem->map_count	1633	=item $uint = $mem->map_count
1449		1634
1450	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1635	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1451		1636
1452	=item $uint = $mem->reference_count	1637	=item $uint = $mem->reference_count
1453		1638
1454	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1639	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1455		1640
1456	=item $ctx = $mem->context	1641	=item $ctx = $mem->context
1457		1642
1458	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1643	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1459		1644
1460	=item $mem = $mem->associated_memobject	1645	=item $mem = $mem->associated_memobject
1461		1646
1462	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1647	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1463		1648
1464	=item $int = $mem->offset	1649	=item $int = $mem->offset
1465		1650
1466	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1651	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1467		1652
1468	=for gengetinfo end mem	1653	=for gengetinfo end mem
1469		1654
1470	=item ($type, $name) = $mem->gl_object_info	1655	=item ($type, $name) = $mem->gl_object_info
1471		1656
…		…
1523		1708
1524	=for gengetinfo begin image	1709	=for gengetinfo begin image
1525		1710
1526	=item $int = $image->element_size	1711	=item $int = $image->element_size
1527		1712
1528	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1713	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1529		1714
1530	=item $int = $image->row_pitch	1715	=item $int = $image->row_pitch
1531		1716
1532	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1717	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1533		1718
1534	=item $int = $image->slice_pitch	1719	=item $int = $image->slice_pitch
1535		1720
1536	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1721	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1537		1722
1538	=item $int = $image->width	1723	=item $int = $image->width
1539		1724
1540	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1725	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1541		1726
1542	=item $int = $image->height	1727	=item $int = $image->height
1543		1728
1544	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1729	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1545		1730
1546	=item $int = $image->depth	1731	=item $int = $image->depth
1547		1732
1548	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1733	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1549		1734
1550	=for gengetinfo end image	1735	=for gengetinfo end image
1551		1736
1552	=for gengetinfo begin gl_texture	1737	=for gengetinfo begin gl_texture
1553		1738
1554	=item $GLenum = $gl_texture->target	1739	=item $GLenum = $gl_texture->target
1555		1740
1556	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1741	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1557		1742
1558	=item $GLint = $gl_texture->gl_mipmap_level	1743	=item $GLint = $gl_texture->gl_mipmap_level
1559		1744
1560	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1745	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1561		1746
1562	=for gengetinfo end gl_texture	1747	=for gengetinfo end gl_texture
1563		1748
1564	=back	1749	=back
1565		1750
…		…
1575		1760
1576	=for gengetinfo begin sampler	1761	=for gengetinfo begin sampler
1577		1762
1578	=item $uint = $sampler->reference_count	1763	=item $uint = $sampler->reference_count
1579		1764
1580	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1765	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1581		1766
1582	=item $ctx = $sampler->context	1767	=item $ctx = $sampler->context
1583		1768
1584	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1769	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1585		1770
1586	=item $addressing_mode = $sampler->normalized_coords	1771	=item $addressing_mode = $sampler->normalized_coords
1587		1772
1588	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1773	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1589		1774
1590	=item $filter_mode = $sampler->addressing_mode	1775	=item $filter_mode = $sampler->addressing_mode
1591		1776
1592	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1777	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1593		1778
1594	=item $boolean = $sampler->filter_mode	1779	=item $boolean = $sampler->filter_mode
1595		1780
1596	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1781	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1597		1782
1598	=for gengetinfo end sampler	1783	=for gengetinfo end sampler
1599		1784
1600	=back	1785	=back
1601		1786
…		…
1619	not so. So best make sure you don't pass in invalid values.	1804	not so. So best make sure you don't pass in invalid values.
1620		1805
1621	Some implementations fail with C<OpenCL::INVALID_BINARY> when the	1806	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1622	compilation state is successful but some later stage fails.	1807	compilation state is successful but some later stage fails.
1623		1808
		1809	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1810	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1811	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1812	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1813	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1814	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1815	C<-create-library>, C<-enable-link-options>.
		1816
		1817	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1818	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1819
1624	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1820	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1625		1821
1626	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1822	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1627		1823
1628	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1824	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).	1825	need to check the compilation status form the callback, or by polling).
1630		1826
		1827	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1828
		1829	Compiles the given program for the given devices (or all devices if
		1830	undef). If C<$headers> is given, it must be a hashref with include name =>
		1831	OpenCL::Program pairs.
		1832
		1833	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
		1834
1631	=item $packed_value = $program->build_info ($device, $name)	1835	=item $packed_value = $program->build_info ($device, $name)
1632		1836
1633	Similar to C<< $platform->info >>, but returns build info for a previous	1837	Similar to C<< $platform->info >>, but returns build info for a previous
1634	build attempt for the given device.	1838	build attempt for the given device.
1635		1839
…		…
1650		1854
1651	=for gengetinfo begin program_build	1855	=for gengetinfo begin program_build
1652		1856
1653	=item $build_status = $program->build_status ($device)	1857	=item $build_status = $program->build_status ($device)
1654		1858
1655	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1859	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1656		1860
1657	=item $string = $program->build_options ($device)	1861	=item $string = $program->build_options ($device)
1658		1862
1659	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1863	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1660		1864
1661	=item $string = $program->build_log ($device)	1865	=item $string = $program->build_log ($device)
1662		1866
1663	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1867	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1664		1868
1665	=for gengetinfo end program_build	1869	=for gengetinfo end program_build
1666		1870
1667	=item $packed_value = $program->info ($name)	1871	=item $packed_value = $program->info ($name)
1668		1872
…		…
1672		1876
1673	=for gengetinfo begin program	1877	=for gengetinfo begin program
1674		1878
1675	=item $uint = $program->reference_count	1879	=item $uint = $program->reference_count
1676		1880
1677	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1881	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1678		1882
1679	=item $ctx = $program->context	1883	=item $ctx = $program->context
1680		1884
1681	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1885	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1682		1886
1683	=item $uint = $program->num_devices	1887	=item $uint = $program->num_devices
1684		1888
1685	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1889	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1686		1890
1687	=item @devices = $program->devices	1891	=item @devices = $program->devices
1688		1892
1689	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1893	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1690		1894
1691	=item $string = $program->source	1895	=item $string = $program->source
1692		1896
1693	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1897	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1694		1898
1695	=item @ints = $program->binary_sizes	1899	=item @ints = $program->binary_sizes
1696		1900
1697	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1901	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1698		1902
1699	=for gengetinfo end program	1903	=for gengetinfo end program
1700		1904
1701	=item @blobs = $program->binaries	1905	=item @blobs = $program->binaries
1702		1906
…		…
1723		1927
1724	=for gengetinfo begin kernel	1928	=for gengetinfo begin kernel
1725		1929
1726	=item $string = $kernel->function_name	1930	=item $string = $kernel->function_name
1727		1931
1728	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1932	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1729		1933
1730	=item $uint = $kernel->num_args	1934	=item $uint = $kernel->num_args
1731		1935
1732	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1936	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1733		1937
1734	=item $uint = $kernel->reference_count	1938	=item $uint = $kernel->reference_count
1735		1939
1736	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1940	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1737		1941
1738	=item $ctx = $kernel->context	1942	=item $ctx = $kernel->context
1739		1943
1740	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1944	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1741		1945
1742	=item $program = $kernel->program	1946	=item $program = $kernel->program
1743		1947
1744	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1948	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1745		1949
1746	=for gengetinfo end kernel	1950	=for gengetinfo end kernel
1747		1951
1748	=item $packed_value = $kernel->work_group_info ($device, $name)	1952	=item $packed_value = $kernel->work_group_info ($device, $name)
1749		1953
1750	See C<< $platform->info >> for details.	1954	See C<< $platform->info >> for details.
1751		1955
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>	1956	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1756		1957
1757	=for gengetinfo begin kernel_work_group	1958	=for gengetinfo begin kernel_work_group
1758		1959
1759	=item $int = $kernel->work_group_size ($device)	1960	=item $int = $kernel->work_group_size ($device)
1760		1961
1761	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1962	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1762		1963
1763	=item @ints = $kernel->compile_work_group_size ($device)	1964	=item @ints = $kernel->compile_work_group_size ($device)
1764		1965
1765	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	1966	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1766		1967
1767	=item $ulong = $kernel->local_mem_size ($device)	1968	=item $ulong = $kernel->local_mem_size ($device)
1768		1969
1769	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	1970	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1770		1971
1771	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1972	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1772		1973
1773	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	1974	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1774		1975
1775	=item $ulong = $kernel->private_mem_size ($device)	1976	=item $ulong = $kernel->private_mem_size ($device)
1776		1977
1777	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1978	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1778		1979
1779	=for gengetinfo end kernel_work_group	1980	=for gengetinfo end kernel_work_group
		1981
		1982	=item $packed_value = $kernel->arg_info ($idx, $name)
		1983
		1984	See C<< $platform->info >> for details.
		1985
		1986	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		1987
		1988	=for gengetinfo begin kernel_arg
		1989
		1990	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		1991
		1992	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		1993
		1994	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		1995
		1996	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		1997
		1998	=item $string = $kernel->arg_type_name ($idx)
		1999
		2000	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		2001
		2002	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		2003
		2004	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		2005
		2006	=item $string = $kernel->arg_name ($idx)
		2007
		2008	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		2009
		2010	=for gengetinfo end kernel_arg
1780		2011
1781	=item $kernel->setf ($format, ...)	2012	=item $kernel->setf ($format, ...)
1782		2013
1783	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic	2014	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	2015	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
…		…
1896		2127
1897	=for gengetinfo begin event	2128	=for gengetinfo begin event
1898		2129
1899	=item $queue = $event->command_queue	2130	=item $queue = $event->command_queue
1900		2131
1901	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2132	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1902		2133
1903	=item $command_type = $event->command_type	2134	=item $command_type = $event->command_type
1904		2135
1905	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2136	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1906		2137
1907	=item $uint = $event->reference_count	2138	=item $uint = $event->reference_count
1908		2139
1909	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2140	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1910		2141
1911	=item $uint = $event->command_execution_status	2142	=item $uint = $event->command_execution_status
1912		2143
1913	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2144	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1914		2145
1915	=item $ctx = $event->context	2146	=item $ctx = $event->context
1916		2147
1917	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2148	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1918		2149
1919	=for gengetinfo end event	2150	=for gengetinfo end event
1920		2151
1921	=item $packed_value = $ev->profiling_info ($name)	2152	=item $packed_value = $ev->profiling_info ($name)
1922		2153
…		…
1929		2160
1930	=for gengetinfo begin profiling	2161	=for gengetinfo begin profiling
1931		2162
1932	=item $ulong = $event->profiling_command_queued	2163	=item $ulong = $event->profiling_command_queued
1933		2164
1934	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2165	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1935		2166
1936	=item $ulong = $event->profiling_command_submit	2167	=item $ulong = $event->profiling_command_submit
1937		2168
1938	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2169	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1939		2170
1940	=item $ulong = $event->profiling_command_start	2171	=item $ulong = $event->profiling_command_start
1941		2172
1942	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2173	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1943		2174
1944	=item $ulong = $event->profiling_command_end	2175	=item $ulong = $event->profiling_command_end
1945		2176
1946	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2177	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1947		2178
1948	=for gengetinfo end profiling	2179	=for gengetinfo end profiling
1949		2180
1950	=back	2181	=back
1951		2182
…		…
1957		2188
1958	=item $ev->set_status ($execution_status)	2189	=item $ev->set_status ($execution_status)
1959		2190
1960	Sets the execution status of the user event. Can only be called once,	2191	Sets the execution status of the user event. Can only be called once,
1961	either with OpenCL::COMPLETE or a negative number as status.	2192	either with OpenCL::COMPLETE or a negative number as status.
		2193
		2194	execution_status: OpenCL::COMPLETE or a negative integer.
1962		2195
1963	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2196	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1964		2197
1965	=back	2198	=back
1966		2199
…		…
1977	copied.	2210	copied.
1978		2211
1979	When the object is destroyed it will enqueue an implicit unmap operation	2212	When the object is destroyed it will enqueue an implicit unmap operation
1980	on the queue that was used to create it.	2213	on the queue that was used to create it.
1981		2214
		2215	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2216	OpenCL sees the changes, even if some implementations don't need this
		2217	sometimes.
		2218
1982	Example, replace the first two floats in the mapped buffer by 1 and 2.	2219	Example, replace the first two floats in the mapped buffer by 1 and 2.
1983		2220
1984	my $mapped = $queue->map_buffer ($buf, ...	2221	my $mapped = $queue->map_buffer ($buf, ...
1985	$mapped->event->wait; # make sure it's there	2222	$mapped->event->wait; # make sure it's there
1986		2223
…		…
1989	# (and of course, we assume iee 754 single precision floats :)	2226	# (and of course, we assume iee 754 single precision floats :)
1990	substr $$mapped, 0, 8, pack "f*", 1, 2;	2227	substr $$mapped, 0, 8, pack "f*", 1, 2;
1991		2228
1992	=over 4	2229	=over 4
1993		2230
		2231	=item $ev = $mapped->unmap ($wait_events...)
		2232
		2233	Unmaps the mapped memory object, using the queue originally used to create
		2234	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2235
1994	=item $bool = $mapped->mapped	2236	=item $bool = $mapped->mapped
1995		2237
1996	Returns whether the object is still mapped - true before an C<unmap> is	2238	Returns whether the object is still mapped - true before an C<unmap> is
1997	enqueued, false afterwards.	2239	enqueued, false afterwards.
1998		2240
…		…
2011		2253
2012	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.	2254	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
2013		2255
2014	=item $ptr = $mapped->ptr	2256	=item $ptr = $mapped->ptr
2015		2257
2016	Returns the raw memory address of the mapped area - same as C<$mapped+0>.	2258	Returns the raw memory address of the mapped area.
		2259
		2260	=item $mapped->set ($offset, $data)
		2261
		2262	Replaces the data at the given C<$offset> in the memory area by the new
		2263	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2264	because it does bounds-checking, but also slower.
		2265
		2266	=item $data = $mapped->get ($offset, $length)
		2267
		2268	Returns (without copying) a scalar representing the data at the given
		2269	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2270	the following substr, except much slower;
		2271
		2272	$data = substr $$mapped, $offset, $length
		2273
		2274	=cut
		2275
		2276	sub OpenCL::Mapped::get {
		2277	substr ${$_[0]}, $_[1], $_[2]
		2278	}
2017		2279
2018	=back	2280	=back
2019		2281
2020	=head2 THE OpenCL::MappedBuffer CLASS	2282	=head2 THE OpenCL::MappedBuffer CLASS
2021		2283
2022	This is a subclass of OpenCL::Mapped, representing mapped buffers.	2284	This is a subclass of OpenCL::Mapped, representing mapped buffers.
2023		2285
		2286	=head2 THE OpenCL::MappedImage CLASS
		2287
		2288	This is a subclass of OpenCL::Mapped, representing mapped images.
		2289
2024	=over 4	2290	=over 4
2025		2291
2026	=back	2292	=item $bytes = $mapped->row_pitch
2027		2293
2028	=head2 THE OpenCL::MappedImage CLASS	2294	=item $bytes = $mapped->slice_pitch
2029		2295
2030	This is a subclass of OpenCL::Mapped, representing mapped images.	2296	Return the row or slice pitch of the image that has been mapped.
2031
2032	=over 4
2033		2297
2034	=back	2298	=back
2035		2299
2036		2300
2037	=cut	2301	=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.77 by root, Sat May 5 12:54:03 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.77 by root, Sat May 5 12:54:03 2012 UTC