[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.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";
…		…
304		336
305	glXSwapBuffers;	337	glXSwapBuffers;
306		338
307	select undef, undef, undef, 1/60;	339	select undef, undef, undef, 1/60;
308	}	340	}
		341
		342	=head2 How to modify the previous example to not rely on GL sharing.
		343
		344	For those poor souls with only a sucky CPU OpenCL implementation, you
		345	currently have to read the image into some perl scalar, and then modify a
		346	texture or use glDrawPixels or so).
		347
		348	First, when you don't need gl sharing, you can create the context much simpler:
		349
		350	$ctx = $platform->context (undef, [$dev])
		351
		352	To use a texture, you would modify the above example by creating an
		353	OpenCL::Image manually instead of deriving it from a texture:
		354
		355	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
		356
		357	And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
		358	would read the image2d after the kernel has written it:
		359
		360	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
		361
		362	And then you would upload the pixel data to the texture (or use glDrawPixels):
		363
		364	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
		365
		366	The fully modified example can be found at
		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>.
309		385
310	=head1 DOCUMENTATION	386	=head1 DOCUMENTATION
311		387
312	=head2 BASIC CONVENTIONS	388	=head2 BASIC CONVENTIONS
313		389
…		…
389	OpenCL can generate a number of (potentially) asynchronous events, for	465	OpenCL can generate a number of (potentially) asynchronous events, for
390	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,
391	perhaps most important, to signal completion of queued jobs (by setting	467	perhaps most important, to signal completion of queued jobs (by setting
392	callbacks on OpenCL::Event objects).	468	callbacks on OpenCL::Event objects).
393		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
394	To facilitate this, this module maintains an event queue - each	477	To facilitate this, this module maintains an event queue - each
395	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
396	interrupted. This is implemented via the L<Async::Interrupt> module. In	479	interrupted. This is implemented via the L<Async::Interrupt> module. In
397	addition, this module has L<AnyEvent> support, so it can seamlessly	480	addition, this module has L<AnyEvent> support, so it can seamlessly
398	integrate itself into many event loops.	481	integrate itself into many event loops.
399		482
400	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:
401		484
402	=head3 Don't use callbacks.	485	=head3 Don't use callbacks.
403		486
404	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
405	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
…		…
502	use Async::Interrupt ();	585	use Async::Interrupt ();
503		586
504	our $POLL_FUNC; # set by XS	587	our $POLL_FUNC; # set by XS
505		588
506	BEGIN {	589	BEGIN {
507	our $VERSION = '0.98';	590	our $VERSION = '0.99';
508		591
509	require XSLoader;	592	require XSLoader;
510	XSLoader::load (__PACKAGE__, $VERSION);	593	XSLoader::load (__PACKAGE__, $VERSION);
511		594
512	@OpenCL::Platform::ISA =	595	@OpenCL::Platform::ISA =
…		…
517	@OpenCL::Sampler::ISA =	600	@OpenCL::Sampler::ISA =
518	@OpenCL::Program::ISA =	601	@OpenCL::Program::ISA =
519	@OpenCL::Kernel::ISA =	602	@OpenCL::Kernel::ISA =
520	@OpenCL::Event::ISA = OpenCL::Object::;	603	@OpenCL::Event::ISA = OpenCL::Object::;
521		604
		605	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		606
522	@OpenCL::Buffer::ISA =	607	@OpenCL::Buffer::ISA =
523	@OpenCL::Image::ISA = OpenCL::Memory::;	608	@OpenCL::Image::ISA = OpenCL::Memory::;
524		609
525	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	610	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
526		611
…		…
530	@OpenCL::Image1D::ISA =	615	@OpenCL::Image1D::ISA =
531	@OpenCL::Image1DArray::ISA =	616	@OpenCL::Image1DArray::ISA =
532	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	617	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
533		618
534	@OpenCL::UserEvent::ISA = OpenCL::Event::;	619	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		620
		621	@OpenCL::MappedBuffer::ISA =
		622	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
535	}	623	}
536		624
537	=head2 THE OpenCL PACKAGE	625	=head2 THE OpenCL PACKAGE
538		626
539	=over 4	627	=over 4
…		…
563	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>
564		652
565	=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
566		654
567	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.
568		660
569	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>
570		662
571	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	663	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
572		664
573	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).
574	function isn't implemented yet, use C<< $platform->context >> instead.	666	Consider using C<< $platform->context >> instead.
575		667
576	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>
577		669
578	=item OpenCL::wait_for_events $wait_events...	670	=item OpenCL::wait_for_events $wait_events...
579		671
…		…
686		778
687	=for gengetinfo begin platform	779	=for gengetinfo begin platform
688		780
689	=item $string = $platform->profile	781	=item $string = $platform->profile
690		782
691	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.
692		784
693	=item $string = $platform->version	785	=item $string = $platform->version
694		786
695	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.
696		788
697	=item $string = $platform->name	789	=item $string = $platform->name
698		790
699	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.
700		792
701	=item $string = $platform->vendor	793	=item $string = $platform->vendor
702		794
703	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.
704		796
705	=item $string = $platform->extensions	797	=item $string = $platform->extensions
706		798
707	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.
708		800
709	=for gengetinfo end platform	801	=for gengetinfo end platform
710		802
711	=back	803	=back
712		804
…		…
718		810
719	See C<< $platform->info >> for details.	811	See C<< $platform->info >> for details.
720		812
721	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>
722		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
723	=for gengetinfo begin device	821	=for gengetinfo begin device
724		822
725	=item $device_type = $device->type	823	=item $device_type = $device->type
726		824
727	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.
728		826
729	=item $uint = $device->vendor_id	827	=item $uint = $device->vendor_id
730		828
731	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.
732		830
733	=item $uint = $device->max_compute_units	831	=item $uint = $device->max_compute_units
734		832
735	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.
736		834
737	=item $uint = $device->max_work_item_dimensions	835	=item $uint = $device->max_work_item_dimensions
738		836
739	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.
740		838
741	=item $int = $device->max_work_group_size	839	=item $int = $device->max_work_group_size
742		840
743	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.
744		842
745	=item @ints = $device->max_work_item_sizes	843	=item @ints = $device->max_work_item_sizes
746		844
747	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.
748		846
749	=item $uint = $device->preferred_vector_width_char	847	=item $uint = $device->preferred_vector_width_char
750		848
751	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.
752		850
753	=item $uint = $device->preferred_vector_width_short	851	=item $uint = $device->preferred_vector_width_short
754		852
755	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.
756		854
757	=item $uint = $device->preferred_vector_width_int	855	=item $uint = $device->preferred_vector_width_int
758		856
759	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.
760		858
761	=item $uint = $device->preferred_vector_width_long	859	=item $uint = $device->preferred_vector_width_long
762		860
763	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.
764		862
765	=item $uint = $device->preferred_vector_width_float	863	=item $uint = $device->preferred_vector_width_float
766		864
767	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.
768		866
769	=item $uint = $device->preferred_vector_width_double	867	=item $uint = $device->preferred_vector_width_double
770		868
771	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.
772		870
773	=item $uint = $device->max_clock_frequency	871	=item $uint = $device->max_clock_frequency
774		872
775	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.
776		874
777	=item $bitfield = $device->address_bits	875	=item $bitfield = $device->address_bits
778		876
779	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.
780		878
781	=item $uint = $device->max_read_image_args	879	=item $uint = $device->max_read_image_args
782		880
783	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.
784		882
785	=item $uint = $device->max_write_image_args	883	=item $uint = $device->max_write_image_args
786		884
787	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.
788		886
789	=item $ulong = $device->max_mem_alloc_size	887	=item $ulong = $device->max_mem_alloc_size
790		888
791	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.
792		890
793	=item $int = $device->image2d_max_width	891	=item $int = $device->image2d_max_width
794		892
795	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.
796		894
797	=item $int = $device->image2d_max_height	895	=item $int = $device->image2d_max_height
798		896
799	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.
800		898
801	=item $int = $device->image3d_max_width	899	=item $int = $device->image3d_max_width
802		900
803	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.
804		902
805	=item $int = $device->image3d_max_height	903	=item $int = $device->image3d_max_height
806		904
807	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.
808		906
809	=item $int = $device->image3d_max_depth	907	=item $int = $device->image3d_max_depth
810		908
811	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.
812		910
813	=item $uint = $device->image_support	911	=item $uint = $device->image_support
814		912
815	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.
816		914
817	=item $int = $device->max_parameter_size	915	=item $int = $device->max_parameter_size
818		916
819	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.
820		918
821	=item $uint = $device->max_samplers	919	=item $uint = $device->max_samplers
822		920
823	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.
824		922
825	=item $uint = $device->mem_base_addr_align	923	=item $uint = $device->mem_base_addr_align
826		924
827	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.
828		926
829	=item $uint = $device->min_data_type_align_size	927	=item $uint = $device->min_data_type_align_size
830		928
831	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.
832		930
833	=item $device_fp_config = $device->single_fp_config	931	=item $device_fp_config = $device->single_fp_config
834		932
835	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.
836		934
837	=item $device_mem_cache_type = $device->global_mem_cache_type	935	=item $device_mem_cache_type = $device->global_mem_cache_type
838		936
839	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.
840		938
841	=item $uint = $device->global_mem_cacheline_size	939	=item $uint = $device->global_mem_cacheline_size
842		940
843	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.
844		942
845	=item $ulong = $device->global_mem_cache_size	943	=item $ulong = $device->global_mem_cache_size
846		944
847	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.
848		946
849	=item $ulong = $device->global_mem_size	947	=item $ulong = $device->global_mem_size
850		948
851	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.
852		950
853	=item $ulong = $device->max_constant_buffer_size	951	=item $ulong = $device->max_constant_buffer_size
854		952
855	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.
856		954
857	=item $uint = $device->max_constant_args	955	=item $uint = $device->max_constant_args
858		956
859	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.
860		958
861	=item $device_local_mem_type = $device->local_mem_type	959	=item $device_local_mem_type = $device->local_mem_type
862		960
863	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.
864		962
865	=item $ulong = $device->local_mem_size	963	=item $ulong = $device->local_mem_size
866		964
867	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.
868		966
869	=item $boolean = $device->error_correction_support	967	=item $boolean = $device->error_correction_support
870		968
871	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.
872		970
873	=item $int = $device->profiling_timer_resolution	971	=item $int = $device->profiling_timer_resolution
874		972
875	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.
876		974
877	=item $boolean = $device->endian_little	975	=item $boolean = $device->endian_little
878		976
879	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.
880		978
881	=item $boolean = $device->available	979	=item $boolean = $device->available
882		980
883	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.
884		982
885	=item $boolean = $device->compiler_available	983	=item $boolean = $device->compiler_available
886		984
887	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.
888		986
889	=item $device_exec_capabilities = $device->execution_capabilities	987	=item $device_exec_capabilities = $device->execution_capabilities
890		988
891	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.
892		990
893	=item $command_queue_properties = $device->properties	991	=item $command_queue_properties = $device->properties
894		992
895	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.
896		994
897	=item $ = $device->platform	995	=item $ = $device->platform
898		996
899	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.
900		998
901	=item $string = $device->name	999	=item $string = $device->name
902		1000
903	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.
904		1002
905	=item $string = $device->vendor	1003	=item $string = $device->vendor
906		1004
907	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.
908		1006
909	=item $string = $device->driver_version	1007	=item $string = $device->driver_version
910		1008
911	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.
912		1010
913	=item $string = $device->profile	1011	=item $string = $device->profile
914		1012
915	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.
916		1014
917	=item $string = $device->version	1015	=item $string = $device->version
918		1016
919	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.
920		1018
921	=item $string = $device->extensions	1019	=item $string = $device->extensions
922		1020
923	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.
924		1022
925	=item $uint = $device->preferred_vector_width_half	1023	=item $uint = $device->preferred_vector_width_half
926		1024
927	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.
928		1026
929	=item $uint = $device->native_vector_width_char	1027	=item $uint = $device->native_vector_width_char
930		1028
931	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.
932		1030
933	=item $uint = $device->native_vector_width_short	1031	=item $uint = $device->native_vector_width_short
934		1032
935	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.
936		1034
937	=item $uint = $device->native_vector_width_int	1035	=item $uint = $device->native_vector_width_int
938		1036
939	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.
940		1038
941	=item $uint = $device->native_vector_width_long	1039	=item $uint = $device->native_vector_width_long
942		1040
943	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.
944		1042
945	=item $uint = $device->native_vector_width_float	1043	=item $uint = $device->native_vector_width_float
946		1044
947	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.
948		1046
949	=item $uint = $device->native_vector_width_double	1047	=item $uint = $device->native_vector_width_double
950		1048
951	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.
952		1050
953	=item $uint = $device->native_vector_width_half	1051	=item $uint = $device->native_vector_width_half
954		1052
955	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.
956		1054
957	=item $device_fp_config = $device->double_fp_config	1055	=item $device_fp_config = $device->double_fp_config
958		1056
959	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.
960		1058
961	=item $device_fp_config = $device->half_fp_config	1059	=item $device_fp_config = $device->half_fp_config
962		1060
963	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.
964		1062
965	=item $boolean = $device->host_unified_memory	1063	=item $boolean = $device->host_unified_memory
966		1064
967	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.
968		1066
969	=item $device = $device->parent_device_ext	1067	=item $device = $device->parent_device_ext
970		1068
971	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.
972		1070
973	=item @device_partition_property_exts = $device->partition_types_ext	1071	=item @device_partition_property_exts = $device->partition_types_ext
974		1072
975	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.
976		1074
977	=item @device_partition_property_exts = $device->affinity_domains_ext	1075	=item @device_partition_property_exts = $device->affinity_domains_ext
978		1076
979	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.
980		1078
981	=item $uint = $device->reference_count_ext	1079	=item $uint = $device->reference_count_ext
982		1080
983	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.
984		1082
985	=item @device_partition_property_exts = $device->partition_style_ext	1083	=item @device_partition_property_exts = $device->partition_style_ext
986		1084
987	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.
988		1086
989	=for gengetinfo end device	1087	=for gengetinfo end device
990		1088
991	=back	1089	=back
992		1090
993	=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
994		1118
995	=over 4	1119	=over 4
996		1120
997	=item $prog = $ctx->build_program ($program, $options = "")	1121	=item $prog = $ctx->build_program ($program, $options = "")
998		1122
…		…
1046	=item $buf = $ctx->buffer ($flags, $len)	1170	=item $buf = $ctx->buffer ($flags, $len)
1047		1171
1048	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1172	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1049	given flags and octet-size.	1173	given flags and octet-size.
1050		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
1051	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>
1052		1180
1053	=item $buf = $ctx->buffer_sv ($flags, $data)	1181	=item $buf = $ctx->buffer_sv ($flags, $data)
1054		1182
1055	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1183	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)	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)
1059		1187
1060	Creates a new OpenCL::Image object and optionally initialises it with	1188	Creates a new OpenCL::Image object and optionally initialises it with
1061	the given data values.	1189	the given data values.
1062		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
1063	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>
1064		1208
1065	=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)
1066		1210
1067	Creates a new OpenCL::Image2D object and optionally initialises it with	1211	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1079	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1223	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1080		1224
1081	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
1082	OpenGL buffer object.	1226	OpenGL buffer object.
1083		1227
		1228	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1229
1084	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
1085		1231
1086	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1232	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1087		1233
1088	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
1089	texture object or buffer.	1235	texture object or buffer.
1090		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
1091	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
1092		1245
1093	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1246	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1094		1247
1095	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
…		…
1120		1273
1121	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1274	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1122		1275
1123	Creates a new OpenCL::Sampler object.	1276	Creates a new OpenCL::Sampler object.
1124		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
1125	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>
1126		1284
1127	=item $program = $ctx->program_with_source ($string)	1285	=item $program = $ctx->program_with_source ($string)
1128		1286
1129	Creates a new OpenCL::Program object from the given source code.	1287	Creates a new OpenCL::Program object from the given source code.
1130		1288
1131	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>
1132		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
1133	=item $packed_value = $ctx->info ($name)	1315	=item $packed_value = $ctx->info ($name)
1134		1316
1135	See C<< $platform->info >> for details.	1317	See C<< $platform->info >> for details.
1136		1318
1137	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>
1138		1320
1139	=for gengetinfo begin context	1321	=for gengetinfo begin context
1140		1322
1141	=item $uint = $context->reference_count	1323	=item $uint = $context->reference_count
1142		1324
1143	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.
1144		1326
1145	=item @devices = $context->devices	1327	=item @devices = $context->devices
1146		1328
1147	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.
1148		1330
1149	=item @property_ints = $context->properties	1331	=item @property_ints = $context->properties
1150		1332
1151	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.
1152		1334
1153	=item $uint = $context->num_devices	1335	=item $uint = $context->num_devices
1154		1336
1155	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.
1156		1338
1157	=for gengetinfo end context	1339	=for gengetinfo end context
1158		1340
1159	=back	1341	=back
1160		1342
…		…
1207		1389
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...)	1390	=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		1391
1210	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1392	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1211		1393
		1394	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1395
		1396	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1397
1212	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1398	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1213		1399
1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1400	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1215		1401	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		1402
1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1219		1404
1220	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1405	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1221		1406
		1407	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1408	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>	1409	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1223		1410
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...)	1411	=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		1412
1226	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1413	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	1458	reference to an array of local work sizes, with the same number of
1272	elements as \@global_work_size.	1459	elements as \@global_work_size.
1273		1460
1274	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>
1275		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
1276	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1471	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1277		1472
1278	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
1279	for subsequent OpenCL usage.	1474	for subsequent OpenCL usage.
1280		1475
…		…
1315		1510
1316	=for gengetinfo begin command_queue	1511	=for gengetinfo begin command_queue
1317		1512
1318	=item $ctx = $command_queue->context	1513	=item $ctx = $command_queue->context
1319		1514
1320	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.
1321		1516
1322	=item $device = $command_queue->device	1517	=item $device = $command_queue->device
1323		1518
1324	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.
1325		1520
1326	=item $uint = $command_queue->reference_count	1521	=item $uint = $command_queue->reference_count
1327		1522
1328	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.
1329		1524
1330	=item $command_queue_properties = $command_queue->properties	1525	=item $command_queue_properties = $command_queue->properties
1331		1526
1332	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.
1333		1528
1334	=for gengetinfo end command_queue	1529	=for gengetinfo end command_queue
		1530
		1531	=back
		1532
		1533	=head3 MEMORY MAPPED BUFFERS
		1534
		1535	OpenCL allows you to map buffers and images to host memory (read: perl
		1536	scalars). This is done much like reading or copying a buffer, by enqueuing
		1537	a map or unmap operation on the command queue.
		1538
		1539	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1540	OpenCL::Mapped CLASS> section for details on what to do with these
		1541	objects.
		1542
		1543	The object will be unmapped automatically when the mapped object is
		1544	destroyed (you can use a barrier to make sure the unmap has finished,
		1545	before using the buffer in a kernel), but you can also enqueue an unmap
		1546	operation manually.
		1547
		1548	=over 4
		1549
		1550	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1551
		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.
		1557
		1558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		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
		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...)
		1568
		1569	Maps the given image area into host memory and return an
		1570	C<OpenCL::MappedImage> object.
		1571
		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.
		1574
		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
		1589
		1590	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1591
		1592	Unmaps the data from host memory. You must not call any methods that
		1593	modify the data, or modify the data scalar directly, after calling this
		1594	method.
		1595
		1596	The mapped event object will always be passed as part of the
		1597	$wait_events. The mapped event object will be replaced by the new event
		1598	object that this request creates.
1335		1599
1336	=back	1600	=back
1337		1601
1338	=head2 THE OpenCL::Memory CLASS	1602	=head2 THE OpenCL::Memory CLASS
1339		1603
…		…
1350		1614
1351	=for gengetinfo begin mem	1615	=for gengetinfo begin mem
1352		1616
1353	=item $mem_object_type = $mem->type	1617	=item $mem_object_type = $mem->type
1354		1618
1355	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.
1356		1620
1357	=item $mem_flags = $mem->flags	1621	=item $mem_flags = $mem->flags
1358		1622
1359	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.
1360		1624
1361	=item $int = $mem->size	1625	=item $int = $mem->size
1362		1626
1363	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.
1364		1628
1365	=item $ptr_value = $mem->host_ptr	1629	=item $ptr_value = $mem->host_ptr
1366		1630
1367	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.
1368		1632
1369	=item $uint = $mem->map_count	1633	=item $uint = $mem->map_count
1370		1634
1371	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.
1372		1636
1373	=item $uint = $mem->reference_count	1637	=item $uint = $mem->reference_count
1374		1638
1375	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.
1376		1640
1377	=item $ctx = $mem->context	1641	=item $ctx = $mem->context
1378		1642
1379	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.
1380		1644
1381	=item $mem = $mem->associated_memobject	1645	=item $mem = $mem->associated_memobject
1382		1646
1383	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.
1384		1648
1385	=item $int = $mem->offset	1649	=item $int = $mem->offset
1386		1650
1387	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.
1388		1652
1389	=for gengetinfo end mem	1653	=for gengetinfo end mem
1390		1654
1391	=item ($type, $name) = $mem->gl_object_info	1655	=item ($type, $name) = $mem->gl_object_info
1392		1656
…		…
1444		1708
1445	=for gengetinfo begin image	1709	=for gengetinfo begin image
1446		1710
1447	=item $int = $image->element_size	1711	=item $int = $image->element_size
1448		1712
1449	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.
1450		1714
1451	=item $int = $image->row_pitch	1715	=item $int = $image->row_pitch
1452		1716
1453	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.
1454		1718
1455	=item $int = $image->slice_pitch	1719	=item $int = $image->slice_pitch
1456		1720
1457	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.
1458		1722
1459	=item $int = $image->width	1723	=item $int = $image->width
1460		1724
1461	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.
1462		1726
1463	=item $int = $image->height	1727	=item $int = $image->height
1464		1728
1465	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.
1466		1730
1467	=item $int = $image->depth	1731	=item $int = $image->depth
1468		1732
1469	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.
1470		1734
1471	=for gengetinfo end image	1735	=for gengetinfo end image
1472		1736
1473	=for gengetinfo begin gl_texture	1737	=for gengetinfo begin gl_texture
1474		1738
1475	=item $GLenum = $gl_texture->target	1739	=item $GLenum = $gl_texture->target
1476		1740
1477	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.
1478		1742
1479	=item $GLint = $gl_texture->gl_mipmap_level	1743	=item $GLint = $gl_texture->gl_mipmap_level
1480		1744
1481	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.
1482		1746
1483	=for gengetinfo end gl_texture	1747	=for gengetinfo end gl_texture
1484		1748
1485	=back	1749	=back
1486		1750
…		…
1496		1760
1497	=for gengetinfo begin sampler	1761	=for gengetinfo begin sampler
1498		1762
1499	=item $uint = $sampler->reference_count	1763	=item $uint = $sampler->reference_count
1500		1764
1501	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.
1502		1766
1503	=item $ctx = $sampler->context	1767	=item $ctx = $sampler->context
1504		1768
1505	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.
1506		1770
1507	=item $addressing_mode = $sampler->normalized_coords	1771	=item $addressing_mode = $sampler->normalized_coords
1508		1772
1509	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.
1510		1774
1511	=item $filter_mode = $sampler->addressing_mode	1775	=item $filter_mode = $sampler->addressing_mode
1512		1776
1513	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.
1514		1778
1515	=item $boolean = $sampler->filter_mode	1779	=item $boolean = $sampler->filter_mode
1516		1780
1517	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.
1518		1782
1519	=for gengetinfo end sampler	1783	=for gengetinfo end sampler
1520		1784
1521	=back	1785	=back
1522		1786
…		…
1540	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.
1541		1805
1542	Some implementations fail with C<OpenCL::INVALID_BINARY> when the	1806	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1543	compilation state is successful but some later stage fails.	1807	compilation state is successful but some later stage fails.
1544		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
1545	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>
1546		1821
1547	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1822	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1548		1823
1549	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
1550	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).
1551		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
1552	=item $packed_value = $program->build_info ($device, $name)	1835	=item $packed_value = $program->build_info ($device, $name)
1553		1836
1554	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
1555	build attempt for the given device.	1838	build attempt for the given device.
1556		1839
…		…
1571		1854
1572	=for gengetinfo begin program_build	1855	=for gengetinfo begin program_build
1573		1856
1574	=item $build_status = $program->build_status ($device)	1857	=item $build_status = $program->build_status ($device)
1575		1858
1576	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.
1577		1860
1578	=item $string = $program->build_options ($device)	1861	=item $string = $program->build_options ($device)
1579		1862
1580	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.
1581		1864
1582	=item $string = $program->build_log ($device)	1865	=item $string = $program->build_log ($device)
1583		1866
1584	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.
1585		1868
1586	=for gengetinfo end program_build	1869	=for gengetinfo end program_build
1587		1870
1588	=item $packed_value = $program->info ($name)	1871	=item $packed_value = $program->info ($name)
1589		1872
…		…
1593		1876
1594	=for gengetinfo begin program	1877	=for gengetinfo begin program
1595		1878
1596	=item $uint = $program->reference_count	1879	=item $uint = $program->reference_count
1597		1880
1598	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.
1599		1882
1600	=item $ctx = $program->context	1883	=item $ctx = $program->context
1601		1884
1602	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.
1603		1886
1604	=item $uint = $program->num_devices	1887	=item $uint = $program->num_devices
1605		1888
1606	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.
1607		1890
1608	=item @devices = $program->devices	1891	=item @devices = $program->devices
1609		1892
1610	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.
1611		1894
1612	=item $string = $program->source	1895	=item $string = $program->source
1613		1896
1614	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.
1615		1898
1616	=item @ints = $program->binary_sizes	1899	=item @ints = $program->binary_sizes
1617		1900
1618	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.
1619		1902
1620	=for gengetinfo end program	1903	=for gengetinfo end program
1621		1904
1622	=item @blobs = $program->binaries	1905	=item @blobs = $program->binaries
1623		1906
…		…
1644		1927
1645	=for gengetinfo begin kernel	1928	=for gengetinfo begin kernel
1646		1929
1647	=item $string = $kernel->function_name	1930	=item $string = $kernel->function_name
1648		1931
1649	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.
1650		1933
1651	=item $uint = $kernel->num_args	1934	=item $uint = $kernel->num_args
1652		1935
1653	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.
1654		1937
1655	=item $uint = $kernel->reference_count	1938	=item $uint = $kernel->reference_count
1656		1939
1657	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.
1658		1941
1659	=item $ctx = $kernel->context	1942	=item $ctx = $kernel->context
1660		1943
1661	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.
1662		1945
1663	=item $program = $kernel->program	1946	=item $program = $kernel->program
1664		1947
1665	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.
1666		1949
1667	=for gengetinfo end kernel	1950	=for gengetinfo end kernel
1668		1951
1669	=item $packed_value = $kernel->work_group_info ($device, $name)	1952	=item $packed_value = $kernel->work_group_info ($device, $name)
1670		1953
1671	See C<< $platform->info >> for details.	1954	See C<< $platform->info >> for details.
1672		1955
1673	The reason this method is not called C<info> is that there already is an
1674	C<< ->info >> method.
1675
1676	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>
1677		1957
1678	=for gengetinfo begin kernel_work_group	1958	=for gengetinfo begin kernel_work_group
1679		1959
1680	=item $int = $kernel->work_group_size ($device)	1960	=item $int = $kernel->work_group_size ($device)
1681		1961
1682	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.
1683		1963
1684	=item @ints = $kernel->compile_work_group_size ($device)	1964	=item @ints = $kernel->compile_work_group_size ($device)
1685		1965
1686	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.
1687		1967
1688	=item $ulong = $kernel->local_mem_size ($device)	1968	=item $ulong = $kernel->local_mem_size ($device)
1689		1969
1690	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.
1691		1971
1692	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1972	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1693		1973
1694	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.
1695		1975
1696	=item $ulong = $kernel->private_mem_size ($device)	1976	=item $ulong = $kernel->private_mem_size ($device)
1697		1977
1698	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.
1699		1979
1700	=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
1701		2011
1702	=item $kernel->setf ($format, ...)	2012	=item $kernel->setf ($format, ...)
1703		2013
1704	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
1705	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
…		…
1817		2127
1818	=for gengetinfo begin event	2128	=for gengetinfo begin event
1819		2129
1820	=item $queue = $event->command_queue	2130	=item $queue = $event->command_queue
1821		2131
1822	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.
1823		2133
1824	=item $command_type = $event->command_type	2134	=item $command_type = $event->command_type
1825		2135
1826	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.
1827		2137
1828	=item $uint = $event->reference_count	2138	=item $uint = $event->reference_count
1829		2139
1830	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.
1831		2141
1832	=item $uint = $event->command_execution_status	2142	=item $uint = $event->command_execution_status
1833		2143
1834	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.
1835		2145
1836	=item $ctx = $event->context	2146	=item $ctx = $event->context
1837		2147
1838	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.
1839		2149
1840	=for gengetinfo end event	2150	=for gengetinfo end event
1841		2151
1842	=item $packed_value = $ev->profiling_info ($name)	2152	=item $packed_value = $ev->profiling_info ($name)
1843		2153
…		…
1850		2160
1851	=for gengetinfo begin profiling	2161	=for gengetinfo begin profiling
1852		2162
1853	=item $ulong = $event->profiling_command_queued	2163	=item $ulong = $event->profiling_command_queued
1854		2164
1855	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.
1856		2166
1857	=item $ulong = $event->profiling_command_submit	2167	=item $ulong = $event->profiling_command_submit
1858		2168
1859	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.
1860		2170
1861	=item $ulong = $event->profiling_command_start	2171	=item $ulong = $event->profiling_command_start
1862		2172
1863	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.
1864		2174
1865	=item $ulong = $event->profiling_command_end	2175	=item $ulong = $event->profiling_command_end
1866		2176
1867	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.
1868		2178
1869	=for gengetinfo end profiling	2179	=for gengetinfo end profiling
1870		2180
1871	=back	2181	=back
1872		2182
…		…
1879	=item $ev->set_status ($execution_status)	2189	=item $ev->set_status ($execution_status)
1880		2190
1881	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,
1882	either with OpenCL::COMPLETE or a negative number as status.	2192	either with OpenCL::COMPLETE or a negative number as status.
1883		2193
		2194	execution_status: OpenCL::COMPLETE or a negative integer.
		2195
1884	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>
1885		2197
1886	=back	2198	=back
		2199
		2200	=head2 THE OpenCL::Mapped CLASS
		2201
		2202	This class represents objects mapped into host memory. They are
		2203	represented by a blessed string scalar. The string data is the mapped
		2204	memory area, that is, if you read or write it, then the mapped object is
		2205	accessed directly.
		2206
		2207	You must only ever use operations that modify the string in-place - for
		2208	example, a C<substr> that doesn't change the length, or maybe a regex that
		2209	doesn't change the length. Any other operation might cause the data to be
		2210	copied.
		2211
		2212	When the object is destroyed it will enqueue an implicit unmap operation
		2213	on the queue that was used to create it.
		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
		2219	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2220
		2221	my $mapped = $queue->map_buffer ($buf, ...
		2222	$mapped->event->wait; # make sure it's there
		2223
		2224	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2225	# we blindly assume device endianness to equal host endianness
		2226	# (and of course, we assume iee 754 single precision floats :)
		2227	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2228
		2229	=over 4
		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
		2236	=item $bool = $mapped->mapped
		2237
		2238	Returns whether the object is still mapped - true before an C<unmap> is
		2239	enqueued, false afterwards.
		2240
		2241	=item $ev = $mapped->event
		2242
		2243	Return the event object associated with the mapped object. Initially, this
		2244	will be the event object created when mapping the object, and after an
		2245	unmap, this will be the event object that the unmap operation created.
		2246
		2247	=item $mapped->wait
		2248
		2249	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2250	mapped object are outstanding.
		2251
		2252	=item $bytes = $mapped->size
		2253
		2254	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2255
		2256	=item $ptr = $mapped->ptr
		2257
		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	}
		2279
		2280	=back
		2281
		2282	=head2 THE OpenCL::MappedBuffer CLASS
		2283
		2284	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2285
		2286	=head2 THE OpenCL::MappedImage CLASS
		2287
		2288	This is a subclass of OpenCL::Mapped, representing mapped images.
		2289
		2290	=over 4
		2291
		2292	=item $bytes = $mapped->row_pitch
		2293
		2294	=item $bytes = $mapped->slice_pitch
		2295
		2296	Return the row or slice pitch of the image that has been mapped.
		2297
		2298	=back
		2299
1887		2300
1888	=cut	2301	=cut
1889		2302
1890	1;	2303	1;
1891		2304

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.77 by root, Sat May 5 12:54:03 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.77 by root, Sat May 5 12:54:03 2012 UTC