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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC vs.
Revision 1.76 by root, Sat May 5 02:45:38 2012 UTC

…		…
43		43
44	OpenCL::Event objects are used to signal when something is complete.	44	OpenCL::Event objects are used to signal when something is complete.
45		45
46	=head2 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
47		47
48	The OpenCL specs used to develop this module:	48	The OpenCL specs used to develop this module - download these and keept
		49	hema round, they are required reference material:
49		50
50	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf	52	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf	53	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53		54
…		…
210		211
211	# wait for the last event to complete	212	# wait for the last event to complete
212	$ev->wait;	213	$ev->wait;
213		214
214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia	215	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215	set tunnel effect.	216	set flight effect.
216		217
217	This is quite a long example to get you going.	218	This is quite a long example to get you going - you can download it from
		219	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
218		220
219	use OpenGL ":all";	221	use OpenGL ":all";
220	use OpenCL;	222	use OpenCL;
221		223
		224	my $S = $ARGV[0] \|\| 256; # window/texture size, smaller is faster
		225
222	# open a window and create a gl texture	226	# open a window and create a gl texture
223	OpenGL::glpOpenWindow width => 256, height => 256;	227	OpenGL::glpOpenWindow width => $S, height => $S;
224	my $texid = glGenTextures_p 1;	228	my $texid = glGenTextures_p 1;
225	glBindTexture GL_TEXTURE_2D, $texid;	229	glBindTexture GL_TEXTURE_2D, $texid;
226	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;	230	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
227		231
228	# find and use the first opencl device that let's us get a shared opengl context	232	# find and use the first opencl device that let's us get a shared opengl context
229	my $platform;	233	my $platform;
230	my $dev;	234	my $dev;
231	my $ctx;	235	my $ctx;
…		…
250	# now the boring opencl code	254	# now the boring opencl code
251	my $src = <<EOF;	255	my $src = <<EOF;
252	kernel void	256	kernel void
253	juliatunnel (write_only image2d_t img, float time)	257	juliatunnel (write_only image2d_t img, float time)
254	{	258	{
255	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;	259	int2 xy = (int2)(get_global_id (0), get_global_id (1));
		260	float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
256		261
257	float2 m = (float2)(1.f, p.y) / fabs (p.x);	262	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
258	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;	263	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
259		264
260	float2 z = m;	265	float2 z = m;
261	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	266	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
262		267
263	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)	268	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
264	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;	269	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
265		270
266	float3 colour = (float3)(z.x, z.y, z.x * z.y);	271	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
267	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));	272	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
268	}	273	}
269	EOF	274	EOF
270		275
271	my $prog = $ctx->build_program ($src);	276	my $prog = $ctx->build_program ($src);
272	my $kernel = $prog->kernel ("juliatunnel");	277	my $kernel = $prog->kernel ("juliatunnel");
…		…
276	for (my $time; ; ++$time) {	281	for (my $time; ; ++$time) {
277	# acquire objects from opengl	282	# acquire objects from opengl
278	$queue->acquire_gl_objects ([$tex]);	283	$queue->acquire_gl_objects ([$tex]);
279		284
280	# configure and run our kernel	285	# configure and run our kernel
281	$kernel->set_image2d (0, $tex);	286	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
282	$kernel->set_float (1, $time);
283	$queue->nd_range_kernel ($kernel, undef, [256, 256], undef);	287	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
284		288
285	# release objects to opengl again	289	# release objects to opengl again
286	$queue->release_gl_objects ([$tex]);	290	$queue->release_gl_objects ([$tex]);
287		291
288	# wait	292	# wait
…		…
301		305
302	glXSwapBuffers;	306	glXSwapBuffers;
303		307
304	select undef, undef, undef, 1/60;	308	select undef, undef, undef, 1/60;
305	}	309	}
		310
		311	=head2 How to modify the previous example to not rely on GL sharing.
		312
		313	For those poor souls with only a sucky CPU OpenCL implementation, you
		314	currently have to read the image into some perl scalar, and then modify a
		315	texture or use glDrawPixels or so).
		316
		317	First, when you don't need gl sharing, you can create the context much simpler:
		318
		319	$ctx = $platform->context (undef, [$dev])
		320
		321	To use a texture, you would modify the above example by creating an
		322	OpenCL::Image manually instead of deriving it from a texture:
		323
		324	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
		325
		326	And in the draw loop, intead of acquire_gl_objects/release_gl_objects, you
		327	would read the image2d after the kernel has written it:
		328
		329	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
		330
		331	And then you would upload the pixel data to the texture (or use glDrawPixels):
		332
		333	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
		334
		335	The fully modified example can be found at
		336	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
		337
		338	=head2 Julia sets look soooo 80ies.
		339
		340	Then colour them differently, e.g. using orbit traps! Replace the loop and
		341	colour calculation from the previous examples by this:
		342
		343	float2 dm = (float2)(1.f, 1.f);
		344
		345	for (int i = 0; i < 25; ++i)
		346	{
		347	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		348	dm = fmin (dm, (float2)(fabs (dot (z, z) - 1.f), fabs (z.x - 1.f)));
		349	}
		350
		351	float3 colour = (float3)(dm.x * dm.y, dm.x * dm.y, dm.x);
		352
		353	Also try C<-10.f> instead of C<-1.f>.
306		354
307	=head1 DOCUMENTATION	355	=head1 DOCUMENTATION
308		356
309	=head2 BASIC CONVENTIONS	357	=head2 BASIC CONVENTIONS
310		358
…		…
386	OpenCL can generate a number of (potentially) asynchronous events, for	434	OpenCL can generate a number of (potentially) asynchronous events, for
387	example, after compiling a program, to signal a context-related error or,	435	example, after compiling a program, to signal a context-related error or,
388	perhaps most important, to signal completion of queued jobs (by setting	436	perhaps most important, to signal completion of queued jobs (by setting
389	callbacks on OpenCL::Event objects).	437	callbacks on OpenCL::Event objects).
390		438
		439	The OpenCL module converts all these callbacks into events - you can
		440	still register callbacks, but they are not executed when your OpenCL
		441	implementation calls the actual callback, but only later. Therefore, none
		442	of the limitations of OpenCL callbacks apply to the perl implementation:
		443	it is perfectly safe to make blocking operations from event callbacks, and
		444	enqueued operations don't need to be flushed.
		445
391	To facilitate this, this module maintains an event queue - each	446	To facilitate this, this module maintains an event queue - each
392	time an asynchronous event happens, it is queued, and perl will be	447	time an asynchronous event happens, it is queued, and perl will be
393	interrupted. This is implemented via the L<Async::Interrupt> module. In	448	interrupted. This is implemented via the L<Async::Interrupt> module. In
394	addition, this module has L<AnyEvent> support, so it can seamlessly	449	addition, this module has L<AnyEvent> support, so it can seamlessly
395	integrate itself into many event loops.	450	integrate itself into many event loops.
396		451
397	Since this module is a bit hard to understand, here are some case examples:	452	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
398		453
399	=head3 Don't use callbacks.	454	=head3 Don't use callbacks.
400		455
401	When your program never uses any callbacks, then there will never be any	456	When your program never uses any callbacks, then there will never be any
402	notifications you need to take care of, and therefore no need to worry	457	notifications you need to take care of, and therefore no need to worry
…		…
499	use Async::Interrupt ();	554	use Async::Interrupt ();
500		555
501	our $POLL_FUNC; # set by XS	556	our $POLL_FUNC; # set by XS
502		557
503	BEGIN {	558	BEGIN {
504	our $VERSION = '0.98';	559	our $VERSION = '0.99';
505		560
506	require XSLoader;	561	require XSLoader;
507	XSLoader::load (__PACKAGE__, $VERSION);	562	XSLoader::load (__PACKAGE__, $VERSION);
508		563
509	@OpenCL::Platform::ISA =	564	@OpenCL::Platform::ISA =
…		…
514	@OpenCL::Sampler::ISA =	569	@OpenCL::Sampler::ISA =
515	@OpenCL::Program::ISA =	570	@OpenCL::Program::ISA =
516	@OpenCL::Kernel::ISA =	571	@OpenCL::Kernel::ISA =
517	@OpenCL::Event::ISA = OpenCL::Object::;	572	@OpenCL::Event::ISA = OpenCL::Object::;
518		573
		574	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		575
519	@OpenCL::Buffer::ISA =	576	@OpenCL::Buffer::ISA =
520	@OpenCL::Image::ISA = OpenCL::Memory::;	577	@OpenCL::Image::ISA = OpenCL::Memory::;
521		578
522	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	579	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
523		580
…		…
527	@OpenCL::Image1D::ISA =	584	@OpenCL::Image1D::ISA =
528	@OpenCL::Image1DArray::ISA =	585	@OpenCL::Image1DArray::ISA =
529	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	586	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
530		587
531	@OpenCL::UserEvent::ISA = OpenCL::Event::;	588	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		589
		590	@OpenCL::MappedBuffer::ISA =
		591	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
532	}	592	}
533		593
534	=head2 THE OpenCL PACKAGE	594	=head2 THE OpenCL PACKAGE
535		595
536	=over 4	596	=over 4
…		…
560	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	620	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
561		621
562	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	622	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
563		623
564	Tries to create a context from a default device and platform type - never worked for me.	624	Tries to create a context from a default device and platform type - never worked for me.
		625	Consider using C<< $platform->context_from_type >> instead.
		626
		627	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		628	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
565		629
566	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	630	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
567		631
568	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	632	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
569		633
570	Create a new OpenCL::Context object using the given device object(s). This	634	Create a new OpenCL::Context object using the given device object(s).
571	function isn't implemented yet, use C<< $platform->context >> instead.	635	Consider using C<< $platform->context >> instead.
572		636
573	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	637	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
574		638
575	=item OpenCL::wait_for_events $wait_events...	639	=item OpenCL::wait_for_events $wait_events...
576		640
…		…
683		747
684	=for gengetinfo begin platform	748	=for gengetinfo begin platform
685		749
686	=item $string = $platform->profile	750	=item $string = $platform->profile
687		751
688	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	752	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
689		753
690	=item $string = $platform->version	754	=item $string = $platform->version
691		755
692	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	756	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
693		757
694	=item $string = $platform->name	758	=item $string = $platform->name
695		759
696	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	760	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
697		761
698	=item $string = $platform->vendor	762	=item $string = $platform->vendor
699		763
700	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	764	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
701		765
702	=item $string = $platform->extensions	766	=item $string = $platform->extensions
703		767
704	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	768	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
705		769
706	=for gengetinfo end platform	770	=for gengetinfo end platform
707		771
708	=back	772	=back
709		773
…		…
715		779
716	See C<< $platform->info >> for details.	780	See C<< $platform->info >> for details.
717		781
718	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	782	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
719		783
		784	=item @devices = $device->sub_devices (\@properties)
		785
		786	Creates OpencL::SubDevice objects by partitioning an existing device.
		787
		788	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		789
720	=for gengetinfo begin device	790	=for gengetinfo begin device
721		791
722	=item $device_type = $device->type	792	=item $device_type = $device->type
723		793
724	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	794	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
725		795
726	=item $uint = $device->vendor_id	796	=item $uint = $device->vendor_id
727		797
728	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	798	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
729		799
730	=item $uint = $device->max_compute_units	800	=item $uint = $device->max_compute_units
731		801
732	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	802	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
733		803
734	=item $uint = $device->max_work_item_dimensions	804	=item $uint = $device->max_work_item_dimensions
735		805
736	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	806	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
737		807
738	=item $int = $device->max_work_group_size	808	=item $int = $device->max_work_group_size
739		809
740	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	810	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
741		811
742	=item @ints = $device->max_work_item_sizes	812	=item @ints = $device->max_work_item_sizes
743		813
744	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	814	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
745		815
746	=item $uint = $device->preferred_vector_width_char	816	=item $uint = $device->preferred_vector_width_char
747		817
748	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	818	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
749		819
750	=item $uint = $device->preferred_vector_width_short	820	=item $uint = $device->preferred_vector_width_short
751		821
752	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	822	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
753		823
754	=item $uint = $device->preferred_vector_width_int	824	=item $uint = $device->preferred_vector_width_int
755		825
756	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	826	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
757		827
758	=item $uint = $device->preferred_vector_width_long	828	=item $uint = $device->preferred_vector_width_long
759		829
760	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	830	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
761		831
762	=item $uint = $device->preferred_vector_width_float	832	=item $uint = $device->preferred_vector_width_float
763		833
764	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	834	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
765		835
766	=item $uint = $device->preferred_vector_width_double	836	=item $uint = $device->preferred_vector_width_double
767		837
768	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	838	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
769		839
770	=item $uint = $device->max_clock_frequency	840	=item $uint = $device->max_clock_frequency
771		841
772	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	842	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
773		843
774	=item $bitfield = $device->address_bits	844	=item $bitfield = $device->address_bits
775		845
776	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	846	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
777		847
778	=item $uint = $device->max_read_image_args	848	=item $uint = $device->max_read_image_args
779		849
780	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	850	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
781		851
782	=item $uint = $device->max_write_image_args	852	=item $uint = $device->max_write_image_args
783		853
784	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	854	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
785		855
786	=item $ulong = $device->max_mem_alloc_size	856	=item $ulong = $device->max_mem_alloc_size
787		857
788	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	858	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
789		859
790	=item $int = $device->image2d_max_width	860	=item $int = $device->image2d_max_width
791		861
792	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	862	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
793		863
794	=item $int = $device->image2d_max_height	864	=item $int = $device->image2d_max_height
795		865
796	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	866	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
797		867
798	=item $int = $device->image3d_max_width	868	=item $int = $device->image3d_max_width
799		869
800	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	870	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
801		871
802	=item $int = $device->image3d_max_height	872	=item $int = $device->image3d_max_height
803		873
804	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	874	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
805		875
806	=item $int = $device->image3d_max_depth	876	=item $int = $device->image3d_max_depth
807		877
808	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	878	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
809		879
810	=item $uint = $device->image_support	880	=item $uint = $device->image_support
811		881
812	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	882	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
813		883
814	=item $int = $device->max_parameter_size	884	=item $int = $device->max_parameter_size
815		885
816	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	886	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
817		887
818	=item $uint = $device->max_samplers	888	=item $uint = $device->max_samplers
819		889
820	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	890	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
821		891
822	=item $uint = $device->mem_base_addr_align	892	=item $uint = $device->mem_base_addr_align
823		893
824	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	894	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
825		895
826	=item $uint = $device->min_data_type_align_size	896	=item $uint = $device->min_data_type_align_size
827		897
828	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	898	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
829		899
830	=item $device_fp_config = $device->single_fp_config	900	=item $device_fp_config = $device->single_fp_config
831		901
832	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	902	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
833		903
834	=item $device_mem_cache_type = $device->global_mem_cache_type	904	=item $device_mem_cache_type = $device->global_mem_cache_type
835		905
836	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	906	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
837		907
838	=item $uint = $device->global_mem_cacheline_size	908	=item $uint = $device->global_mem_cacheline_size
839		909
840	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	910	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
841		911
842	=item $ulong = $device->global_mem_cache_size	912	=item $ulong = $device->global_mem_cache_size
843		913
844	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	914	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
845		915
846	=item $ulong = $device->global_mem_size	916	=item $ulong = $device->global_mem_size
847		917
848	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	918	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
849		919
850	=item $ulong = $device->max_constant_buffer_size	920	=item $ulong = $device->max_constant_buffer_size
851		921
852	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	922	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
853		923
854	=item $uint = $device->max_constant_args	924	=item $uint = $device->max_constant_args
855		925
856	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	926	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
857		927
858	=item $device_local_mem_type = $device->local_mem_type	928	=item $device_local_mem_type = $device->local_mem_type
859		929
860	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	930	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
861		931
862	=item $ulong = $device->local_mem_size	932	=item $ulong = $device->local_mem_size
863		933
864	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	934	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
865		935
866	=item $boolean = $device->error_correction_support	936	=item $boolean = $device->error_correction_support
867		937
868	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	938	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
869		939
870	=item $int = $device->profiling_timer_resolution	940	=item $int = $device->profiling_timer_resolution
871		941
872	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	942	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
873		943
874	=item $boolean = $device->endian_little	944	=item $boolean = $device->endian_little
875		945
876	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	946	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
877		947
878	=item $boolean = $device->available	948	=item $boolean = $device->available
879		949
880	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	950	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
881		951
882	=item $boolean = $device->compiler_available	952	=item $boolean = $device->compiler_available
883		953
884	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	954	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
885		955
886	=item $device_exec_capabilities = $device->execution_capabilities	956	=item $device_exec_capabilities = $device->execution_capabilities
887		957
888	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	958	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
889		959
890	=item $command_queue_properties = $device->properties	960	=item $command_queue_properties = $device->properties
891		961
892	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	962	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
893		963
894	=item $ = $device->platform	964	=item $ = $device->platform
895		965
896	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	966	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
897		967
898	=item $string = $device->name	968	=item $string = $device->name
899		969
900	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	970	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
901		971
902	=item $string = $device->vendor	972	=item $string = $device->vendor
903		973
904	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	974	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
905		975
906	=item $string = $device->driver_version	976	=item $string = $device->driver_version
907		977
908	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	978	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
909		979
910	=item $string = $device->profile	980	=item $string = $device->profile
911		981
912	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	982	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
913		983
914	=item $string = $device->version	984	=item $string = $device->version
915		985
916	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	986	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
917		987
918	=item $string = $device->extensions	988	=item $string = $device->extensions
919		989
920	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	990	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
921		991
922	=item $uint = $device->preferred_vector_width_half	992	=item $uint = $device->preferred_vector_width_half
923		993
924	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	994	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
925		995
926	=item $uint = $device->native_vector_width_char	996	=item $uint = $device->native_vector_width_char
927		997
928	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	998	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
929		999
930	=item $uint = $device->native_vector_width_short	1000	=item $uint = $device->native_vector_width_short
931		1001
932	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1002	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
933		1003
934	=item $uint = $device->native_vector_width_int	1004	=item $uint = $device->native_vector_width_int
935		1005
936	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1006	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
937		1007
938	=item $uint = $device->native_vector_width_long	1008	=item $uint = $device->native_vector_width_long
939		1009
940	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1010	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
941		1011
942	=item $uint = $device->native_vector_width_float	1012	=item $uint = $device->native_vector_width_float
943		1013
944	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1014	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
945		1015
946	=item $uint = $device->native_vector_width_double	1016	=item $uint = $device->native_vector_width_double
947		1017
948	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1018	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
949		1019
950	=item $uint = $device->native_vector_width_half	1020	=item $uint = $device->native_vector_width_half
951		1021
952	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1022	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
953		1023
954	=item $device_fp_config = $device->double_fp_config	1024	=item $device_fp_config = $device->double_fp_config
955		1025
956	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1026	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
957		1027
958	=item $device_fp_config = $device->half_fp_config	1028	=item $device_fp_config = $device->half_fp_config
959		1029
960	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1030	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
961		1031
962	=item $boolean = $device->host_unified_memory	1032	=item $boolean = $device->host_unified_memory
963		1033
964	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1034	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
965		1035
966	=item $device = $device->parent_device_ext	1036	=item $device = $device->parent_device_ext
967		1037
968	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1038	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
969		1039
970	=item @device_partition_property_exts = $device->partition_types_ext	1040	=item @device_partition_property_exts = $device->partition_types_ext
971		1041
972	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1042	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
973		1043
974	=item @device_partition_property_exts = $device->affinity_domains_ext	1044	=item @device_partition_property_exts = $device->affinity_domains_ext
975		1045
976	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1046	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
977		1047
978	=item $uint = $device->reference_count_ext	1048	=item $uint = $device->reference_count_ext
979		1049
980	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1050	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
981		1051
982	=item @device_partition_property_exts = $device->partition_style_ext	1052	=item @device_partition_property_exts = $device->partition_style_ext
983		1053
984	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1054	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
985		1055
986	=for gengetinfo end device	1056	=for gengetinfo end device
987		1057
988	=back	1058	=back
989		1059
990	=head2 THE OpenCL::Context CLASS	1060	=head2 THE OpenCL::Context CLASS
		1061
		1062	An OpenCL::Context is basically a container, or manager, for a number of
		1063	devices of a platform. It is used to create all sorts of secondary objects
		1064	such as buffers, queues, programs and so on.
		1065
		1066	All context creation functions and methods take a list of properties
		1067	(type-value pairs). All property values can be specified as integers -
		1068	some additionally support other types:
		1069
		1070	=over 4
		1071
		1072	=item OpenCL::CONTEXT_PLATFORM
		1073
		1074	Also accepts OpenCL::Platform objects.
		1075
		1076	=item OpenCL::GLX_DISPLAY_KHR
		1077
		1078	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1079	to find the current glx display (see L<GLX SUPPORT>).
		1080
		1081	=item OpenCL::GL_CONTEXT_KHR
		1082
		1083	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1084	to find the current glx context (see L<GLX SUPPORT>).
		1085
		1086	=back
991		1087
992	=over 4	1088	=over 4
993		1089
994	=item $prog = $ctx->build_program ($program, $options = "")	1090	=item $prog = $ctx->build_program ($program, $options = "")
995		1091
…		…
1043	=item $buf = $ctx->buffer ($flags, $len)	1139	=item $buf = $ctx->buffer ($flags, $len)
1044		1140
1045	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1141	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1046	given flags and octet-size.	1142	given flags and octet-size.
1047		1143
		1144	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1145	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1146	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1147
1048	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1148	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1049		1149
1050	=item $buf = $ctx->buffer_sv ($flags, $data)	1150	=item $buf = $ctx->buffer_sv ($flags, $data)
1051		1151
1052	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1152	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
…		…
1055	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)	1155	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
1056		1156
1057	Creates a new OpenCL::Image object and optionally initialises it with	1157	Creates a new OpenCL::Image object and optionally initialises it with
1058	the given data values.	1158	the given data values.
1059		1159
		1160	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1161	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1162	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1163
		1164	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1165	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1166	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1167	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1168	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1169
		1170
		1171	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1172	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1173	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1174	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1175
1060	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1176	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1061		1177
1062	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1178	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1063		1179
1064	Creates a new OpenCL::Image2D object and optionally initialises it with	1180	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1076	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1192	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1077		1193
1078	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1194	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1079	OpenGL buffer object.	1195	OpenGL buffer object.
1080		1196
		1197	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1198
1081	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1199	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1082		1200
1083	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1201	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1084		1202
1085	Creates a new OpenCL::Image object that refers to the given OpenGL	1203	Creates a new OpenCL::Image object that refers to the given OpenGL
1086	texture object or buffer.	1204	texture object or buffer.
1087		1205
		1206	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1207	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1208	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1209	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1210	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1211	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1212
1088	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1213	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1089		1214
1090	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1215	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1091		1216
1092	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1217	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1117		1242
1118	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1243	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1119		1244
1120	Creates a new OpenCL::Sampler object.	1245	Creates a new OpenCL::Sampler object.
1121		1246
		1247	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1248	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1249
		1250	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1251
1122	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1252	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1123		1253
1124	=item $program = $ctx->program_with_source ($string)	1254	=item $program = $ctx->program_with_source ($string)
1125		1255
1126	Creates a new OpenCL::Program object from the given source code.	1256	Creates a new OpenCL::Program object from the given source code.
1127		1257
1128	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1258	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1129		1259
		1260	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1261
		1262	Creates a new OpenCL::Program object from the given binaries.
		1263
		1264	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1265
		1266	Example: clone an existing program object that contains a successfully
		1267	compiled program, no matter how useless this is.
		1268
		1269	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1270
		1271	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1272
		1273	Creates a new OpenCL::Program object from the given built-in kernel names.
		1274
		1275	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1276
		1277	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1278
		1279	Links all (already compiled) program objects specified in C<@programs>
		1280	together and returns a new OpenCL::Program object with the result.
		1281
		1282	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1283
1130	=item $packed_value = $ctx->info ($name)	1284	=item $packed_value = $ctx->info ($name)
1131		1285
1132	See C<< $platform->info >> for details.	1286	See C<< $platform->info >> for details.
1133		1287
1134	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1135		1289
1136	=for gengetinfo begin context	1290	=for gengetinfo begin context
1137		1291
1138	=item $uint = $context->reference_count	1292	=item $uint = $context->reference_count
1139		1293
1140	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1294	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1141		1295
1142	=item @devices = $context->devices	1296	=item @devices = $context->devices
1143		1297
1144	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1298	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1145		1299
1146	=item @property_ints = $context->properties	1300	=item @property_ints = $context->properties
1147		1301
1148	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1302	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1149		1303
1150	=item $uint = $context->num_devices	1304	=item $uint = $context->num_devices
1151		1305
1152	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1306	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1153		1307
1154	=for gengetinfo end context	1308	=for gengetinfo end context
1155		1309
1156	=back	1310	=back
1157		1311
…		…
1204		1358
1205	=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...)	1359	=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...)
1206		1360
1207	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1361	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1208		1362
		1363	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1364
		1365	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1366
1209	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1367	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1210		1368
1211	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1369	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1212		1370	module uses the image width (and height) to supply default values.
1213	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1214		1371
1215	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1372	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1216		1373
1217	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1374	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1218		1375
		1376	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1377	module uses the image width (and height) to supply default values.
1219	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1378	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1220		1379
1221	=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...)	1380	=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...)
1222		1381
1223	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1382	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
…		…
1268	reference to an array of local work sizes, with the same number of	1427	reference to an array of local work sizes, with the same number of
1269	elements as \@global_work_size.	1428	elements as \@global_work_size.
1270		1429
1271	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1430	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1272		1431
		1432	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1433
		1434	Migrates a number of OpenCL::Memory objects to or from the device.
		1435
		1436	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1437
		1438	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1439
1273	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1440	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1274		1441
1275	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1442	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1276	for subsequent OpenCL usage.	1443	for subsequent OpenCL usage.
1277		1444
…		…
1312		1479
1313	=for gengetinfo begin command_queue	1480	=for gengetinfo begin command_queue
1314		1481
1315	=item $ctx = $command_queue->context	1482	=item $ctx = $command_queue->context
1316		1483
1317	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1484	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1318		1485
1319	=item $device = $command_queue->device	1486	=item $device = $command_queue->device
1320		1487
1321	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1488	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1322		1489
1323	=item $uint = $command_queue->reference_count	1490	=item $uint = $command_queue->reference_count
1324		1491
1325	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1492	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1326		1493
1327	=item $command_queue_properties = $command_queue->properties	1494	=item $command_queue_properties = $command_queue->properties
1328		1495
1329	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1496	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1330		1497
1331	=for gengetinfo end command_queue	1498	=for gengetinfo end command_queue
		1499
		1500	=back
		1501
		1502	=head3 MEMORY MAPPED BUFFERS
		1503
		1504	OpenCL allows you to map buffers and images to host memory (read: perl
		1505	scalars). This is done much like reading or copying a buffer, by enqueuing
		1506	a map or unmap operation on the command queue.
		1507
		1508	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1509	OpenCL::Mapped CLASS> section for details on what to do with these
		1510	objects.
		1511
		1512	The object will be unmapped automatically when the mapped object is
		1513	destroyed (you can use a barrier to make sure the unmap has finished,
		1514	before using the buffer in a kernel), but you can also enqueue an unmap
		1515	operation manually.
		1516
		1517	=over 4
		1518
		1519	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1520
		1521	Maps the given buffer into host memory and returns an
		1522	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1523	the map will extend to the end of the buffer.
		1524
		1525	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1526
		1527	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1528
		1529	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1530
		1531	{
		1532	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1533	substr $$mapped, 0, 4, "abcd";
		1534	} # asynchronously unmap because $mapped is destroyed
		1535
		1536	=item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...)
		1537
		1538	Maps the given image area into host memory and return an
		1539	C<OpenCL::MappedImage> object.
		1540
		1541	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1542	will be replaced by the maximum possible value.
		1543
		1544	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1545
		1546	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1547	the first channel of the leftmost column to 5, then explicitly unmap
		1548	it. You are not necessarily meant to do it this way, this example just
		1549	shows you the accessors to use :)
		1550
		1551	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1552
		1553	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1554	for 0..$image->height;
		1555
		1556	$mapped->unmap;.
		1557	$mapped->wait; # only needed for out of order queues normally
		1558
		1559	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1560
		1561	Unmaps the data from host memory. You must not call any methods that
		1562	modify the data, or modify the data scalar directly, after calling this
		1563	method.
		1564
		1565	The mapped event object will always be passed as part of the
		1566	$wait_events. The mapped event object will be replaced by the new event
		1567	object that this request creates.
1332		1568
1333	=back	1569	=back
1334		1570
1335	=head2 THE OpenCL::Memory CLASS	1571	=head2 THE OpenCL::Memory CLASS
1336		1572
…		…
1347		1583
1348	=for gengetinfo begin mem	1584	=for gengetinfo begin mem
1349		1585
1350	=item $mem_object_type = $mem->type	1586	=item $mem_object_type = $mem->type
1351		1587
1352	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1588	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1353		1589
1354	=item $mem_flags = $mem->flags	1590	=item $mem_flags = $mem->flags
1355		1591
1356	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1592	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1357		1593
1358	=item $int = $mem->size	1594	=item $int = $mem->size
1359		1595
1360	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1596	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1361		1597
1362	=item $ptr_value = $mem->host_ptr	1598	=item $ptr_value = $mem->host_ptr
1363		1599
1364	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1600	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1365		1601
1366	=item $uint = $mem->map_count	1602	=item $uint = $mem->map_count
1367		1603
1368	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1604	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1369		1605
1370	=item $uint = $mem->reference_count	1606	=item $uint = $mem->reference_count
1371		1607
1372	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1608	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1373		1609
1374	=item $ctx = $mem->context	1610	=item $ctx = $mem->context
1375		1611
1376	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1612	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1377		1613
1378	=item $mem = $mem->associated_memobject	1614	=item $mem = $mem->associated_memobject
1379		1615
1380	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1616	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1381		1617
1382	=item $int = $mem->offset	1618	=item $int = $mem->offset
1383		1619
1384	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1620	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1385		1621
1386	=for gengetinfo end mem	1622	=for gengetinfo end mem
1387		1623
1388	=item ($type, $name) = $mem->gl_object_info	1624	=item ($type, $name) = $mem->gl_object_info
1389		1625
…		…
1441		1677
1442	=for gengetinfo begin image	1678	=for gengetinfo begin image
1443		1679
1444	=item $int = $image->element_size	1680	=item $int = $image->element_size
1445		1681
1446	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1682	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1447		1683
1448	=item $int = $image->row_pitch	1684	=item $int = $image->row_pitch
1449		1685
1450	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1686	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1451		1687
1452	=item $int = $image->slice_pitch	1688	=item $int = $image->slice_pitch
1453		1689
1454	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1690	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1455		1691
1456	=item $int = $image->width	1692	=item $int = $image->width
1457		1693
1458	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1694	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1459		1695
1460	=item $int = $image->height	1696	=item $int = $image->height
1461		1697
1462	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1698	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1463		1699
1464	=item $int = $image->depth	1700	=item $int = $image->depth
1465		1701
1466	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1702	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1467		1703
1468	=for gengetinfo end image	1704	=for gengetinfo end image
1469		1705
1470	=for gengetinfo begin gl_texture	1706	=for gengetinfo begin gl_texture
1471		1707
1472	=item $GLenum = $gl_texture->target	1708	=item $GLenum = $gl_texture->target
1473		1709
1474	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1710	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1475		1711
1476	=item $GLint = $gl_texture->gl_mipmap_level	1712	=item $GLint = $gl_texture->gl_mipmap_level
1477		1713
1478	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1714	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1479		1715
1480	=for gengetinfo end gl_texture	1716	=for gengetinfo end gl_texture
1481		1717
1482	=back	1718	=back
1483		1719
…		…
1493		1729
1494	=for gengetinfo begin sampler	1730	=for gengetinfo begin sampler
1495		1731
1496	=item $uint = $sampler->reference_count	1732	=item $uint = $sampler->reference_count
1497		1733
1498	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1734	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1499		1735
1500	=item $ctx = $sampler->context	1736	=item $ctx = $sampler->context
1501		1737
1502	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1738	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1503		1739
1504	=item $addressing_mode = $sampler->normalized_coords	1740	=item $addressing_mode = $sampler->normalized_coords
1505		1741
1506	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1742	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1507		1743
1508	=item $filter_mode = $sampler->addressing_mode	1744	=item $filter_mode = $sampler->addressing_mode
1509		1745
1510	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1746	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1511		1747
1512	=item $boolean = $sampler->filter_mode	1748	=item $boolean = $sampler->filter_mode
1513		1749
1514	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1750	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1515		1751
1516	=for gengetinfo end sampler	1752	=for gengetinfo end sampler
1517		1753
1518	=back	1754	=back
1519		1755
…		…
1537	not so. So best make sure you don't pass in invalid values.	1773	not so. So best make sure you don't pass in invalid values.
1538		1774
1539	Some implementations fail with C<OpenCL::INVALID_BINARY> when the	1775	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1540	compilation state is successful but some later stage fails.	1776	compilation state is successful but some later stage fails.
1541		1777
		1778	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1779	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1780	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1781	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1782	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1783	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1784	C<-create-library>, C<-enable-link-options>.
		1785
		1786	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1787	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1788
1542	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1789	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1543		1790
1544	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1791	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1545		1792
1546	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1793	Similar to C<< ->build >>, except it starts a thread, and never fails (you
1547	need to check the compilation status form the callback, or by polling).	1794	need to check the compilation status form the callback, or by polling).
1548		1795
		1796	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1797
		1798	Compiles the given program for the given devices (or all devices if
		1799	undef). If C<$headers> is given, it must be a hashref with include name =>
		1800	OpenCL::Program pairs.
		1801
		1802	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
		1803
1549	=item $packed_value = $program->build_info ($device, $name)	1804	=item $packed_value = $program->build_info ($device, $name)
1550		1805
1551	Similar to C<< $platform->info >>, but returns build info for a previous	1806	Similar to C<< $platform->info >>, but returns build info for a previous
1552	build attempt for the given device.	1807	build attempt for the given device.
1553		1808
…		…
1568		1823
1569	=for gengetinfo begin program_build	1824	=for gengetinfo begin program_build
1570		1825
1571	=item $build_status = $program->build_status ($device)	1826	=item $build_status = $program->build_status ($device)
1572		1827
1573	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1828	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1574		1829
1575	=item $string = $program->build_options ($device)	1830	=item $string = $program->build_options ($device)
1576		1831
1577	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1832	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1578		1833
1579	=item $string = $program->build_log ($device)	1834	=item $string = $program->build_log ($device)
1580		1835
1581	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1836	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
1582		1837
1583	=for gengetinfo end program_build	1838	=for gengetinfo end program_build
1584		1839
1585	=item $packed_value = $program->info ($name)	1840	=item $packed_value = $program->info ($name)
1586		1841
…		…
1590		1845
1591	=for gengetinfo begin program	1846	=for gengetinfo begin program
1592		1847
1593	=item $uint = $program->reference_count	1848	=item $uint = $program->reference_count
1594		1849
1595	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1850	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1596		1851
1597	=item $ctx = $program->context	1852	=item $ctx = $program->context
1598		1853
1599	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1854	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1600		1855
1601	=item $uint = $program->num_devices	1856	=item $uint = $program->num_devices
1602		1857
1603	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1858	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1604		1859
1605	=item @devices = $program->devices	1860	=item @devices = $program->devices
1606		1861
1607	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1862	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1608		1863
1609	=item $string = $program->source	1864	=item $string = $program->source
1610		1865
1611	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1866	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1612		1867
1613	=item @ints = $program->binary_sizes	1868	=item @ints = $program->binary_sizes
1614		1869
1615	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1870	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1616		1871
1617	=for gengetinfo end program	1872	=for gengetinfo end program
1618		1873
1619	=item @blobs = $program->binaries	1874	=item @blobs = $program->binaries
1620		1875
…		…
1641		1896
1642	=for gengetinfo begin kernel	1897	=for gengetinfo begin kernel
1643		1898
1644	=item $string = $kernel->function_name	1899	=item $string = $kernel->function_name
1645		1900
1646	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1901	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1647		1902
1648	=item $uint = $kernel->num_args	1903	=item $uint = $kernel->num_args
1649		1904
1650	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1905	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1651		1906
1652	=item $uint = $kernel->reference_count	1907	=item $uint = $kernel->reference_count
1653		1908
1654	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1909	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1655		1910
1656	=item $ctx = $kernel->context	1911	=item $ctx = $kernel->context
1657		1912
1658	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	1913	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1659		1914
1660	=item $program = $kernel->program	1915	=item $program = $kernel->program
1661		1916
1662	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	1917	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1663		1918
1664	=for gengetinfo end kernel	1919	=for gengetinfo end kernel
1665		1920
1666	=item $packed_value = $kernel->work_group_info ($device, $name)	1921	=item $packed_value = $kernel->work_group_info ($device, $name)
1667		1922
1668	See C<< $platform->info >> for details.	1923	See C<< $platform->info >> for details.
1669		1924
1670	The reason this method is not called C<info> is that there already is an
1671	C<< ->info >> method.
1672
1673	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1925	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1674		1926
1675	=for gengetinfo begin kernel_work_group	1927	=for gengetinfo begin kernel_work_group
1676		1928
1677	=item $int = $kernel->work_group_size ($device)	1929	=item $int = $kernel->work_group_size ($device)
1678		1930
1679	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	1931	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1680		1932
1681	=item @ints = $kernel->compile_work_group_size ($device)	1933	=item @ints = $kernel->compile_work_group_size ($device)
1682		1934
1683	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	1935	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1684		1936
1685	=item $ulong = $kernel->local_mem_size ($device)	1937	=item $ulong = $kernel->local_mem_size ($device)
1686		1938
1687	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	1939	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1688		1940
1689	=item $int = $kernel->preferred_work_group_size_multiple ($device)	1941	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1690		1942
1691	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	1943	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1692		1944
1693	=item $ulong = $kernel->private_mem_size ($device)	1945	=item $ulong = $kernel->private_mem_size ($device)
1694		1946
1695	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1947	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1696		1948
1697	=for gengetinfo end kernel_work_group	1949	=for gengetinfo end kernel_work_group
		1950
		1951	=item $packed_value = $kernel->arg_info ($idx, $name)
		1952
		1953	See C<< $platform->info >> for details.
		1954
		1955	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		1956
		1957	=for gengetinfo begin kernel_arg
		1958
		1959	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		1960
		1961	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		1962
		1963	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		1964
		1965	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		1966
		1967	=item $string = $kernel->arg_type_name ($idx)
		1968
		1969	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		1970
		1971	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		1972
		1973	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		1974
		1975	=item $string = $kernel->arg_name ($idx)
		1976
		1977	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		1978
		1979	=for gengetinfo end kernel_arg
1698		1980
1699	=item $kernel->setf ($format, ...)	1981	=item $kernel->setf ($format, ...)
1700		1982
1701	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic	1983	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
1702	way to set arguments (and with OpenCL 1.2 it might be rather slow), you	1984	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
…		…
1814		2096
1815	=for gengetinfo begin event	2097	=for gengetinfo begin event
1816		2098
1817	=item $queue = $event->command_queue	2099	=item $queue = $event->command_queue
1818		2100
1819	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2101	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1820		2102
1821	=item $command_type = $event->command_type	2103	=item $command_type = $event->command_type
1822		2104
1823	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2105	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1824		2106
1825	=item $uint = $event->reference_count	2107	=item $uint = $event->reference_count
1826		2108
1827	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2109	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1828		2110
1829	=item $uint = $event->command_execution_status	2111	=item $uint = $event->command_execution_status
1830		2112
1831	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2113	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1832		2114
1833	=item $ctx = $event->context	2115	=item $ctx = $event->context
1834		2116
1835	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2117	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1836		2118
1837	=for gengetinfo end event	2119	=for gengetinfo end event
1838		2120
1839	=item $packed_value = $ev->profiling_info ($name)	2121	=item $packed_value = $ev->profiling_info ($name)
1840		2122
…		…
1847		2129
1848	=for gengetinfo begin profiling	2130	=for gengetinfo begin profiling
1849		2131
1850	=item $ulong = $event->profiling_command_queued	2132	=item $ulong = $event->profiling_command_queued
1851		2133
1852	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2134	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1853		2135
1854	=item $ulong = $event->profiling_command_submit	2136	=item $ulong = $event->profiling_command_submit
1855		2137
1856	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2138	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1857		2139
1858	=item $ulong = $event->profiling_command_start	2140	=item $ulong = $event->profiling_command_start
1859		2141
1860	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2142	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1861		2143
1862	=item $ulong = $event->profiling_command_end	2144	=item $ulong = $event->profiling_command_end
1863		2145
1864	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2146	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1865		2147
1866	=for gengetinfo end profiling	2148	=for gengetinfo end profiling
1867		2149
1868	=back	2150	=back
1869		2151
…		…
1876	=item $ev->set_status ($execution_status)	2158	=item $ev->set_status ($execution_status)
1877		2159
1878	Sets the execution status of the user event. Can only be called once,	2160	Sets the execution status of the user event. Can only be called once,
1879	either with OpenCL::COMPLETE or a negative number as status.	2161	either with OpenCL::COMPLETE or a negative number as status.
1880		2162
		2163	execution_status: OpenCL::COMPLETE or a negative integer.
		2164
1881	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2165	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1882		2166
1883	=back	2167	=back
		2168
		2169	=head2 THE OpenCL::Mapped CLASS
		2170
		2171	This class represents objects mapped into host memory. They are
		2172	represented by a blessed string scalar. The string data is the mapped
		2173	memory area, that is, if you read or write it, then the mapped object is
		2174	accessed directly.
		2175
		2176	You must only ever use operations that modify the string in-place - for
		2177	example, a C<substr> that doesn't change the length, or maybe a regex that
		2178	doesn't change the length. Any other operation might cause the data to be
		2179	copied.
		2180
		2181	When the object is destroyed it will enqueue an implicit unmap operation
		2182	on the queue that was used to create it.
		2183
		2184	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2185	OpenCL sees the changes, even if some implementations don't need this
		2186	sometimes.
		2187
		2188	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2189
		2190	my $mapped = $queue->map_buffer ($buf, ...
		2191	$mapped->event->wait; # make sure it's there
		2192
		2193	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2194	# we blindly assume device endianness to equal host endianness
		2195	# (and of course, we assume iee 754 single precision floats :)
		2196	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2197
		2198	=over 4
		2199
		2200	=item $ev = $mapped->unmap ($wait_events...)
		2201
		2202	Unmaps the mapped memory object, using the queue originally used to create
		2203	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2204
		2205	=item $bool = $mapped->mapped
		2206
		2207	Returns whether the object is still mapped - true before an C<unmap> is
		2208	enqueued, false afterwards.
		2209
		2210	=item $ev = $mapped->event
		2211
		2212	Return the event object associated with the mapped object. Initially, this
		2213	will be the event object created when mapping the object, and after an
		2214	unmap, this will be the event object that the unmap operation created.
		2215
		2216	=item $mapped->wait
		2217
		2218	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2219	mapped object are outstanding.
		2220
		2221	=item $bytes = $mapped->size
		2222
		2223	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2224
		2225	=item $ptr = $mapped->ptr
		2226
		2227	Returns the raw memory address of the mapped area.
		2228
		2229	=item $mapped->set ($offset, $data)
		2230
		2231	Replaces the data at the given C<$offset> in the memory area by the new
		2232	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2233	because it does bounds-checking, but also slower.
		2234
		2235	=item $data = $mapped->get ($offset, $length)
		2236
		2237	Returns (without copying) a scalar representing the data at the given
		2238	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2239	the following substr, except much slower;
		2240
		2241	$data = substr $$mapped, $offset, $length
		2242
		2243	=cut
		2244
		2245	sub OpenCL::Mapped::get {
		2246	substr ${$_[0]}, $_[1], $_[2]
		2247	}
		2248
		2249	=back
		2250
		2251	=head2 THE OpenCL::MappedBuffer CLASS
		2252
		2253	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2254
		2255	=head2 THE OpenCL::MappedImage CLASS
		2256
		2257	This is a subclass of OpenCL::Mapped, representing mapped images.
		2258
		2259	=over 4
		2260
		2261	=item $bytes = $mapped->row_pitch
		2262
		2263	=item $bytes = $mapped->slice_pitch
		2264
		2265	Return the row or slice pitch of the image that has been mapped.
		2266
		2267	=back
		2268
1884		2269
1885	=cut	2270	=cut
1886		2271
1887	1;	2272	1;
1888		2273

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC vs. Revision 1.76 by root, Sat May 5 02:45:38 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC vs.
Revision 1.76 by root, Sat May 5 02:45:38 2012 UTC