ViewVC Help

View File | Revision Log | Show Annotations | Download File

/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.83 by root, Sat May 5 15:11:19 2012 UTC

…		…
28	specific device ("compiling and linking"), also binary programs. For each	28	specific device ("compiling and linking"), also binary programs. For each
29	kernel function in a program you can then create an OpenCL::Kernel object	29	kernel function in a program you can then create an OpenCL::Kernel object
30	which represents basically a function call with argument values.	30	which represents basically a function call with argument values.
31		31
32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat	32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2D
34	or 3d array) for bulk data and input and output for kernels.	34	or 3D array) for bulk data and input and output for kernels.
35		35
36	OpenCL::Sampler objects, which are kind of like texture filter modes in	36	OpenCL::Sampler objects, which are kind of like texture filter modes in
37	OpenGL.	37	OpenGL.
38		38
39	OpenCL::Queue objects - command queues, which allow you to submit memory	39	OpenCL::Queue objects - command queues, which allow you to submit memory
…		…
43		43
44	OpenCL::Event objects are used to signal when something is complete.	44	OpenCL::Event objects are used to signal when something is complete.
45		45
46	=head2 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
47		47
48	The OpenCL specs used to develop this module:	48	The OpenCL specs used to develop this module - download these and keept
		49	hema round, they are required reference material:
49		50
50	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
51	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf	52	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
52	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf	53	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
53		54
…		…
210		211
211	# wait for the last event to complete	212	# wait for the last event to complete
212	$ev->wait;	213	$ev->wait;
213		214
214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia	215	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
215	set tunnel effect.	216	set flight effect.
216		217
217	This is quite a long example to get you going - you can download it from	218	This is quite a long example to get you going - you can also download it
218	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.	219	from L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
219		220
220	use OpenGL ":all";	221	use OpenGL ":all";
221	use OpenCL;	222	use OpenCL;
222		223
223	my $S = $ARGV[0] || 256; # window/texture size, smaller is faster	224	my $S = $ARGV[0] || 256; # window/texture size, smaller is faster
…		…
305	glXSwapBuffers;	306	glXSwapBuffers;
306		307
307	select undef, undef, undef, 1/60;	308	select undef, undef, undef, 1/60;
308	}	309	}
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>.
		354
310	=head1 DOCUMENTATION	355	=head1 DOCUMENTATION
311		356
312	=head2 BASIC CONVENTIONS	357	=head2 BASIC CONVENTIONS
313		358
314	This is not a one-to-one C-style translation of OpenCL to Perl - instead	359	This is not a one-to-one C-style translation of OpenCL to Perl - instead
…		…
343		388
344	=item * When enqueuing commands, if the enqueue method is called in void	389	=item * When enqueuing commands, if the enqueue method is called in void
345	context, no event is created. In all other contexts an event is returned	390	context, no event is created. In all other contexts an event is returned
346	by the method.	391	by the method.
347		392
348	=item * This module expects all functions to return C<CL_SUCCESS>. If any	393	=item * This module expects all functions to return C<OpenCL::SUCCESS>. If any
349	other status is returned the function will throw an exception, so you	394	other status is returned the function will throw an exception, so you
350	don't normally have to to any error checking.	395	don't normally have to to any error checking.
351		396
352	=back	397	=back
		398
		399	=head2 CONSTANTS
		400
		401	All C<CL_xxx> constants that this module supports are always available
		402	in the C<OpenCL> namespace as C<OpenCL::xxx> (i.e. without the C<CL_>
		403	prefix). Constants which are not defined in the header files used during
		404	compilation, or otherwise are not available, will have the value C<-1>.
		405
		406	The latest version of this module knows and exports the constants
		407	listed in L<http://cvs.schmorp.de/OpenCL/constiv.h>.
		408
		409	=head2 OPENCL 1.1 VS. OPENCL 1.2
		410
		411	This module supports both OpenCL version 1.1 and 1.2, although the OpenCL
		412	1.2 interface hasn't been tested much for lack of availability of an
		413	actual implementation.
		414
		415	Every function or method in this manual page that interfaces to a
		416	particular OpenCL function has a link to the its C manual page.
		417
		418	If the link contains a F<1.1>, then this function is an OpenCL 1.1
		419	function. Most but not all also exist in OpenCL 1.2, and this module
		420	tries to emulate the missing ones for you, when told to do so at
		421	compiletime. You can check whether a function was removed in OpenCL 1.2 by
		422	replacing the F<1.1> component in the URL by F<1.2>.
		423
		424	If the link contains a F<1.2>, then this is a OpenCL 1.2-only
		425	function. Even if the module was compiled with OpenCL 1.2 header files
		426	and has an 1.2 OpenCL library, calling such a function on a platform that
		427	doesn't implement 1.2 causes undefined behaviour, usually a crash (But
		428	this is not guaranteed).
		429
		430	You can find out whether this module was compiled to prefer 1.1
		431	functionality by ooking at C<OpenCL::PREFER_1_1> - if it is true, then
		432	1.1 functions generally are implemented using 1.1 OpenCL functions. If it
		433	is false, then 1.1 functions missing from 1.2 are emulated by calling 1.2
		434	fucntions.
		435
		436	This is a somewhat sorry state of affairs, but the Khronos group choose to
		437	make every release of OpenCL source and binary incompatible with previous
		438	releases.
353		439
354	=head2 PERL AND OPENCL TYPES	440	=head2 PERL AND OPENCL TYPES
355		441
356	This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack	442	This handy(?) table lists OpenCL types and their perl, PDL and pack/unpack
357	format equivalents:	443	format equivalents:
…		…
389	OpenCL can generate a number of (potentially) asynchronous events, for	475	OpenCL can generate a number of (potentially) asynchronous events, for
390	example, after compiling a program, to signal a context-related error or,	476	example, after compiling a program, to signal a context-related error or,
391	perhaps most important, to signal completion of queued jobs (by setting	477	perhaps most important, to signal completion of queued jobs (by setting
392	callbacks on OpenCL::Event objects).	478	callbacks on OpenCL::Event objects).
393		479
		480	The OpenCL module converts all these callbacks into events - you can
		481	still register callbacks, but they are not executed when your OpenCL
		482	implementation calls the actual callback, but only later. Therefore, none
		483	of the limitations of OpenCL callbacks apply to the perl implementation:
		484	it is perfectly safe to make blocking operations from event callbacks, and
		485	enqueued operations don't need to be flushed.
		486
394	To facilitate this, this module maintains an event queue - each	487	To facilitate this, this module maintains an event queue - each
395	time an asynchronous event happens, it is queued, and perl will be	488	time an asynchronous event happens, it is queued, and perl will be
396	interrupted. This is implemented via the L<Async::Interrupt> module. In	489	interrupted. This is implemented via the L<Async::Interrupt> module. In
397	addition, this module has L<AnyEvent> support, so it can seamlessly	490	addition, this module has L<AnyEvent> support, so it can seamlessly
398	integrate itself into many event loops.	491	integrate itself into many event loops.
399		492
400	Since this module is a bit hard to understand, here are some case examples:	493	Since L<Async::Interrupt> is a bit hard to understand, here are some case examples:
401		494
402	=head3 Don't use callbacks.	495	=head3 Don't use callbacks.
403		496
404	When your program never uses any callbacks, then there will never be any	497	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	498	notifications you need to take care of, and therefore no need to worry
…		…
502	use Async::Interrupt ();	595	use Async::Interrupt ();
503		596
504	our $POLL_FUNC; # set by XS	597	our $POLL_FUNC; # set by XS
505		598
506	BEGIN {	599	BEGIN {
507	our $VERSION = '0.98';	600	our $VERSION = '0.99';
508		601
509	require XSLoader;	602	require XSLoader;
510	XSLoader::load (__PACKAGE__, $VERSION);	603	XSLoader::load (__PACKAGE__, $VERSION);
511		604
512	@OpenCL::Platform::ISA =	605	@OpenCL::Platform::ISA =
…		…
517	@OpenCL::Sampler::ISA =	610	@OpenCL::Sampler::ISA =
518	@OpenCL::Program::ISA =	611	@OpenCL::Program::ISA =
519	@OpenCL::Kernel::ISA =	612	@OpenCL::Kernel::ISA =
520	@OpenCL::Event::ISA = OpenCL::Object::;	613	@OpenCL::Event::ISA = OpenCL::Object::;
521		614
		615	@OpenCL::SubDevice::ISA = OpenCL::Device::;
		616
522	@OpenCL::Buffer::ISA =	617	@OpenCL::Buffer::ISA =
523	@OpenCL::Image::ISA = OpenCL::Memory::;	618	@OpenCL::Image::ISA = OpenCL::Memory::;
524		619
525	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;	620	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
526		621
…		…
530	@OpenCL::Image1D::ISA =	625	@OpenCL::Image1D::ISA =
531	@OpenCL::Image1DArray::ISA =	626	@OpenCL::Image1DArray::ISA =
532	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	627	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
533		628
534	@OpenCL::UserEvent::ISA = OpenCL::Event::;	629	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		630
		631	@OpenCL::MappedBuffer::ISA =
		632	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
535	}	633	}
536		634
537	=head2 THE OpenCL PACKAGE	635	=head2 THE OpenCL PACKAGE
538		636
539	=over 4	637	=over 4
…		…
543	The last error returned by a function - it's only valid after an error occured	641	The last error returned by a function - it's only valid after an error occured
544	and before calling another OpenCL function.	642	and before calling another OpenCL function.
545		643
546	=item $str = OpenCL::err2str [$errval]	644	=item $str = OpenCL::err2str [$errval]
547		645
548	Converts an error value into a human readable string. IF no error value is	646	Converts an error value into a human readable string. If no error value is
549	given, then the last error will be used (as returned by OpenCL::errno).	647	given, then the last error will be used (as returned by OpenCL::errno).
		648
		649	The latest version of this module knows the error constants
		650	listed in L<http://cvs.schmorp.de/OpenCL/errstr.h>.
550		651
551	=item $str = OpenCL::enum2str $enum	652	=item $str = OpenCL::enum2str $enum
552		653
553	Converts most enum values (of parameter names, image format constants,	654	Converts most enum values (of parameter names, image format constants,
554	object types, addressing and filter modes, command types etc.) into a	655	object types, addressing and filter modes, command types etc.) into a
555	human readable string. When confronted with some random integer it can be	656	human readable string. When confronted with some random integer it can be
556	very helpful to pass it through this function to maybe get some readable	657	very helpful to pass it through this function to maybe get some readable
557	string out of it.	658	string out of it.
558		659
		660	The latest version of this module knows the enumaration constants
		661	listed in L<http://cvs.schmorp.de/OpenCL/enumstr.h>.
		662
559	=item @platforms = OpenCL::platforms	663	=item @platforms = OpenCL::platforms
560		664
561	Returns all available OpenCL::Platform objects.	665	Returns all available OpenCL::Platform objects.
562		666
563	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	667	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
564		668
565	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr	669	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
566		670
567	Tries to create a context from a default device and platform type - never worked for me.	671	Tries to create a context from a default device and platform type - never worked for me.
		672	Consider using C<< $platform->context_from_type >> instead.
		673
		674	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU, OpenCL::DEVICE_TYPE_GPU,
		675	OpenCL::DEVICE_TYPE_ACCELERATOR, OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
568		676
569	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	677	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
570		678
571	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)	679	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
572		680
573	Create a new OpenCL::Context object using the given device object(s). This	681	Create a new OpenCL::Context object using the given device object(s).
574	function isn't implemented yet, use C<< $platform->context >> instead.	682	Consider using C<< $platform->context >> instead.
575		683
576	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	684	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
577		685
578	=item OpenCL::wait_for_events $wait_events...	686	=item OpenCL::wait_for_events $wait_events...
579		687
…		…
660	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	768	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
661		769
662	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)	770	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
663		771
664	Create a new OpenCL::Context object using the given device object(s)- a	772	Create a new OpenCL::Context object using the given device object(s)- a
665	CL_CONTEXT_PLATFORM property is supplied automatically.	773	OpenCL::CONTEXT_PLATFORM property is supplied automatically.
666		774
667	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	775	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
668		776
669	=item $packed_value = $platform->info ($name)	777	=item $packed_value = $platform->info ($name)
670		778
…		…
686		794
687	=for gengetinfo begin platform	795	=for gengetinfo begin platform
688		796
689	=item $string = $platform->profile	797	=item $string = $platform->profile
690		798
691	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	799	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_PROFILE> and returns the result.
692		800
693	=item $string = $platform->version	801	=item $string = $platform->version
694		802
695	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.	803	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VERSION> and returns the result.
696		804
697	=item $string = $platform->name	805	=item $string = $platform->name
698		806
699	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.	807	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_NAME> and returns the result.
700		808
701	=item $string = $platform->vendor	809	=item $string = $platform->vendor
702		810
703	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.	811	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_VENDOR> and returns the result.
704		812
705	=item $string = $platform->extensions	813	=item $string = $platform->extensions
706		814
707	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.	815	Calls C<clGetPlatformInfo> with C<OpenCL::PLATFORM_EXTENSIONS> and returns the result.
708		816
709	=for gengetinfo end platform	817	=for gengetinfo end platform
710		818
711	=back	819	=back
712		820
…		…
716		824
717	=item $packed_value = $device->info ($name)	825	=item $packed_value = $device->info ($name)
718		826
719	See C<< $platform->info >> for details.	827	See C<< $platform->info >> for details.
720		828
		829	type: OpenCL::DEVICE_TYPE_DEFAULT, OpenCL::DEVICE_TYPE_CPU,
		830	OpenCL::DEVICE_TYPE_GPU, OpenCL::DEVICE_TYPE_ACCELERATOR,
		831	OpenCL::DEVICE_TYPE_CUSTOM, OpenCL::DEVICE_TYPE_ALL.
		832
		833	fp_config: OpenCL::FP_DENORM, OpenCL::FP_INF_NAN, OpenCL::FP_ROUND_TO_NEAREST,
		834	OpenCL::FP_ROUND_TO_ZERO, OpenCL::FP_ROUND_TO_INF, OpenCL::FP_FMA,
		835	OpenCL::FP_SOFT_FLOAT, OpenCL::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.
		836
		837	mem_cache_type: OpenCL::NONE, OpenCL::READ_ONLY_CACHE, OpenCL::READ_WRITE_CACHE.
		838
		839	local_mem_type: OpenCL::LOCAL, OpenCL::GLOBAL.
		840
		841	exec_capabilities: OpenCL::EXEC_KERNEL, OpenCL::EXEC_NATIVE_KERNEL.
		842
		843	command_queue_properties: OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE,
		844	OpenCL::QUEUE_PROFILING_ENABLE.
		845
		846	partition_properties: OpenCL::DEVICE_PARTITION_EQUALLY,
		847	OpenCL::DEVICE_PARTITION_BY_COUNTS, OpenCL::DEVICE_PARTITION_BY_COUNTS_LIST_END,
		848	OpenCL::DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
		849
		850	affinity_domain: OpenCL::DEVICE_AFFINITY_DOMAIN_NUMA,
		851	OpenCL::DEVICE_AFFINITY_DOMAIN_L4_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L3_CACHE,
		852	OpenCL::DEVICE_AFFINITY_DOMAIN_L2_CACHE, OpenCL::DEVICE_AFFINITY_DOMAIN_L1_CACHE,
		853	OpenCL::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.
		854
721	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	855	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
722		856
		857	=item @devices = $device->sub_devices (\@properties)
		858
		859	Creates OpencL::SubDevice objects by partitioning an existing device.
		860
		861	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubDevices.html>
		862
723	=for gengetinfo begin device	863	=for gengetinfo begin device
724		864
725	=item $device_type = $device->type	865	=item $device_type = $device->type
726		866
727	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.	867	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_TYPE> and returns the result.
728		868
729	=item $uint = $device->vendor_id	869	=item $uint = $device->vendor_id
730		870
731	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.	871	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR_ID> and returns the result.
732		872
733	=item $uint = $device->max_compute_units	873	=item $uint = $device->max_compute_units
734		874
735	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.	875	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_COMPUTE_UNITS> and returns the result.
736		876
737	=item $uint = $device->max_work_item_dimensions	877	=item $uint = $device->max_work_item_dimensions
738		878
739	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.	879	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
740		880
741	=item $int = $device->max_work_group_size	881	=item $int = $device->max_work_group_size
742		882
743	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.	883	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
744		884
745	=item @ints = $device->max_work_item_sizes	885	=item @ints = $device->max_work_item_sizes
746		886
747	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.	887	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
748		888
749	=item $uint = $device->preferred_vector_width_char	889	=item $uint = $device->preferred_vector_width_char
750		890
751	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.	891	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
752		892
753	=item $uint = $device->preferred_vector_width_short	893	=item $uint = $device->preferred_vector_width_short
754		894
755	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.	895	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
756		896
757	=item $uint = $device->preferred_vector_width_int	897	=item $uint = $device->preferred_vector_width_int
758		898
759	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.	899	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
760		900
761	=item $uint = $device->preferred_vector_width_long	901	=item $uint = $device->preferred_vector_width_long
762		902
763	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.	903	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
764		904
765	=item $uint = $device->preferred_vector_width_float	905	=item $uint = $device->preferred_vector_width_float
766		906
767	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.	907	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
768		908
769	=item $uint = $device->preferred_vector_width_double	909	=item $uint = $device->preferred_vector_width_double
770		910
771	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.	911	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
772		912
773	=item $uint = $device->max_clock_frequency	913	=item $uint = $device->max_clock_frequency
774		914
775	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.	915	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
776		916
777	=item $bitfield = $device->address_bits	917	=item $bitfield = $device->address_bits
778		918
779	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.	919	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ADDRESS_BITS> and returns the result.
780		920
781	=item $uint = $device->max_read_image_args	921	=item $uint = $device->max_read_image_args
782		922
783	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.	923	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
784		924
785	=item $uint = $device->max_write_image_args	925	=item $uint = $device->max_write_image_args
786		926
787	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.	927	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
788		928
789	=item $ulong = $device->max_mem_alloc_size	929	=item $ulong = $device->max_mem_alloc_size
790		930
791	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.	931	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
792		932
793	=item $int = $device->image2d_max_width	933	=item $int = $device->image2d_max_width
794		934
795	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.	935	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
796		936
797	=item $int = $device->image2d_max_height	937	=item $int = $device->image2d_max_height
798		938
799	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.	939	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
800		940
801	=item $int = $device->image3d_max_width	941	=item $int = $device->image3d_max_width
802		942
803	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.	943	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
804		944
805	=item $int = $device->image3d_max_height	945	=item $int = $device->image3d_max_height
806		946
807	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.	947	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
808		948
809	=item $int = $device->image3d_max_depth	949	=item $int = $device->image3d_max_depth
810		950
811	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.	951	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
812		952
813	=item $uint = $device->image_support	953	=item $uint = $device->image_support
814		954
815	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.	955	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_IMAGE_SUPPORT> and returns the result.
816		956
817	=item $int = $device->max_parameter_size	957	=item $int = $device->max_parameter_size
818		958
819	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.	959	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_PARAMETER_SIZE> and returns the result.
820		960
821	=item $uint = $device->max_samplers	961	=item $uint = $device->max_samplers
822		962
823	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.	963	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_SAMPLERS> and returns the result.
824		964
825	=item $uint = $device->mem_base_addr_align	965	=item $uint = $device->mem_base_addr_align
826		966
827	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.	967	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
828		968
829	=item $uint = $device->min_data_type_align_size	969	=item $uint = $device->min_data_type_align_size
830		970
831	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.	971	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
832		972
833	=item $device_fp_config = $device->single_fp_config	973	=item $device_fp_config = $device->single_fp_config
834		974
835	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.	975	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_SINGLE_FP_CONFIG> and returns the result.
836		976
837	=item $device_mem_cache_type = $device->global_mem_cache_type	977	=item $device_mem_cache_type = $device->global_mem_cache_type
838		978
839	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.	979	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
840		980
841	=item $uint = $device->global_mem_cacheline_size	981	=item $uint = $device->global_mem_cacheline_size
842		982
843	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.	983	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
844		984
845	=item $ulong = $device->global_mem_cache_size	985	=item $ulong = $device->global_mem_cache_size
846		986
847	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.	987	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
848		988
849	=item $ulong = $device->global_mem_size	989	=item $ulong = $device->global_mem_size
850		990
851	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.	991	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_GLOBAL_MEM_SIZE> and returns the result.
852		992
853	=item $ulong = $device->max_constant_buffer_size	993	=item $ulong = $device->max_constant_buffer_size
854		994
855	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.	995	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
856		996
857	=item $uint = $device->max_constant_args	997	=item $uint = $device->max_constant_args
858		998
859	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.	999	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_MAX_CONSTANT_ARGS> and returns the result.
860		1000
861	=item $device_local_mem_type = $device->local_mem_type	1001	=item $device_local_mem_type = $device->local_mem_type
862		1002
863	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.	1003	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_TYPE> and returns the result.
864		1004
865	=item $ulong = $device->local_mem_size	1005	=item $ulong = $device->local_mem_size
866		1006
867	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.	1007	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_LOCAL_MEM_SIZE> and returns the result.
868		1008
869	=item $boolean = $device->error_correction_support	1009	=item $boolean = $device->error_correction_support
870		1010
871	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.	1011	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
872		1012
873	=item $int = $device->profiling_timer_resolution	1013	=item $int = $device->profiling_timer_resolution
874		1014
875	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.	1015	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
876		1016
877	=item $boolean = $device->endian_little	1017	=item $boolean = $device->endian_little
878		1018
879	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.	1019	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_ENDIAN_LITTLE> and returns the result.
880		1020
881	=item $boolean = $device->available	1021	=item $boolean = $device->available
882		1022
883	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.	1023	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AVAILABLE> and returns the result.
884		1024
885	=item $boolean = $device->compiler_available	1025	=item $boolean = $device->compiler_available
886		1026
887	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.	1027	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_COMPILER_AVAILABLE> and returns the result.
888		1028
889	=item $device_exec_capabilities = $device->execution_capabilities	1029	=item $device_exec_capabilities = $device->execution_capabilities
890		1030
891	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.	1031	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXECUTION_CAPABILITIES> and returns the result.
892		1032
893	=item $command_queue_properties = $device->properties	1033	=item $command_queue_properties = $device->properties
894		1034
895	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.	1035	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_QUEUE_PROPERTIES> and returns the result.
896		1036
897	=item $ = $device->platform	1037	=item $ = $device->platform
898		1038
899	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.	1039	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PLATFORM> and returns the result.
900		1040
901	=item $string = $device->name	1041	=item $string = $device->name
902		1042
903	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.	1043	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NAME> and returns the result.
904		1044
905	=item $string = $device->vendor	1045	=item $string = $device->vendor
906		1046
907	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.	1047	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VENDOR> and returns the result.
908		1048
909	=item $string = $device->driver_version	1049	=item $string = $device->driver_version
910		1050
911	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.	1051	Calls C<clGetDeviceInfo> with C<OpenCL::DRIVER_VERSION> and returns the result.
912		1052
913	=item $string = $device->profile	1053	=item $string = $device->profile
914		1054
915	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.	1055	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PROFILE> and returns the result.
916		1056
917	=item $string = $device->version	1057	=item $string = $device->version
918		1058
919	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.	1059	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_VERSION> and returns the result.
920		1060
921	=item $string = $device->extensions	1061	=item $string = $device->extensions
922		1062
923	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.	1063	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_EXTENSIONS> and returns the result.
924		1064
925	=item $uint = $device->preferred_vector_width_half	1065	=item $uint = $device->preferred_vector_width_half
926		1066
927	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.	1067	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
928		1068
929	=item $uint = $device->native_vector_width_char	1069	=item $uint = $device->native_vector_width_char
930		1070
931	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.	1071	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
932		1072
933	=item $uint = $device->native_vector_width_short	1073	=item $uint = $device->native_vector_width_short
934		1074
935	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.	1075	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
936		1076
937	=item $uint = $device->native_vector_width_int	1077	=item $uint = $device->native_vector_width_int
938		1078
939	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.	1079	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
940		1080
941	=item $uint = $device->native_vector_width_long	1081	=item $uint = $device->native_vector_width_long
942		1082
943	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.	1083	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
944		1084
945	=item $uint = $device->native_vector_width_float	1085	=item $uint = $device->native_vector_width_float
946		1086
947	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.	1087	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
948		1088
949	=item $uint = $device->native_vector_width_double	1089	=item $uint = $device->native_vector_width_double
950		1090
951	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.	1091	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
952		1092
953	=item $uint = $device->native_vector_width_half	1093	=item $uint = $device->native_vector_width_half
954		1094
955	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.	1095	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
956		1096
957	=item $device_fp_config = $device->double_fp_config	1097	=item $device_fp_config = $device->double_fp_config
958		1098
959	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.	1099	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_DOUBLE_FP_CONFIG> and returns the result.
960		1100
961	=item $device_fp_config = $device->half_fp_config	1101	=item $device_fp_config = $device->half_fp_config
962		1102
963	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.	1103	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HALF_FP_CONFIG> and returns the result.
964		1104
965	=item $boolean = $device->host_unified_memory	1105	=item $boolean = $device->host_unified_memory
966		1106
967	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.	1107	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
968		1108
969	=item $device = $device->parent_device_ext	1109	=item $device = $device->parent_device_ext
970		1110
971	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.	1111	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARENT_DEVICE_EXT> and returns the result.
972		1112
973	=item @device_partition_property_exts = $device->partition_types_ext	1113	=item @device_partition_property_exts = $device->partition_types_ext
974		1114
975	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.	1115	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_TYPES_EXT> and returns the result.
976		1116
977	=item @device_partition_property_exts = $device->affinity_domains_ext	1117	=item @device_partition_property_exts = $device->affinity_domains_ext
978		1118
979	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	1119	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
980		1120
981	=item $uint = $device->reference_count_ext	1121	=item $uint = $device->reference_count_ext
982		1122
983	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.	1123	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_REFERENCE_COUNT_EXT> and returns the result.
984		1124
985	=item @device_partition_property_exts = $device->partition_style_ext	1125	=item @device_partition_property_exts = $device->partition_style_ext
986		1126
987	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	1127	Calls C<clGetDeviceInfo> with C<OpenCL::DEVICE_PARTITION_STYLE_EXT> and returns the result.
988		1128
989	=for gengetinfo end device	1129	=for gengetinfo end device
990		1130
991	=back	1131	=back
992		1132
993	=head2 THE OpenCL::Context CLASS	1133	=head2 THE OpenCL::Context CLASS
		1134
		1135	An OpenCL::Context is basically a container, or manager, for a number of
		1136	devices of a platform. It is used to create all sorts of secondary objects
		1137	such as buffers, queues, programs and so on.
		1138
		1139	All context creation functions and methods take a list of properties
		1140	(type-value pairs). All property values can be specified as integers -
		1141	some additionally support other types:
		1142
		1143	=over 4
		1144
		1145	=item OpenCL::CONTEXT_PLATFORM
		1146
		1147	Also accepts OpenCL::Platform objects.
		1148
		1149	=item OpenCL::GLX_DISPLAY_KHR
		1150
		1151	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1152	to find the current glx display (see L<GLX SUPPORT>).
		1153
		1154	=item OpenCL::GL_CONTEXT_KHR
		1155
		1156	Also accepts C<undef>, in which case a deep and troubling hack is engaged
		1157	to find the current glx context (see L<GLX SUPPORT>).
		1158
		1159	=back
994		1160
995	=over 4	1161	=over 4
996		1162
997	=item $prog = $ctx->build_program ($program, $options = "")	1163	=item $prog = $ctx->build_program ($program, $options = "")
998		1164
…		…
1046	=item $buf = $ctx->buffer ($flags, $len)	1212	=item $buf = $ctx->buffer ($flags, $len)
1047		1213
1048	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the	1214	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
1049	given flags and octet-size.	1215	given flags and octet-size.
1050		1216
		1217	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_WRITE_ONLY, OpenCL::MEM_READ_ONLY,
		1218	OpenCL::MEM_USE_HOST_PTR, OpenCL::MEM_ALLOC_HOST_PTR, OpenCL::MEM_COPY_HOST_PTR,
		1219	OpenCL::MEM_HOST_WRITE_ONLY, OpenCL::MEM_HOST_READ_ONLY, OpenCL::MEM_HOST_NO_ACCESS.
		1220
1051	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	1221	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
1052		1222
1053	=item $buf = $ctx->buffer_sv ($flags, $data)	1223	=item $buf = $ctx->buffer_sv ($flags, $data)
1054		1224
1055	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1225	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)	1228	=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		1229
1060	Creates a new OpenCL::Image object and optionally initialises it with	1230	Creates a new OpenCL::Image object and optionally initialises it with
1061	the given data values.	1231	the given data values.
1062		1232
		1233	channel_order: OpenCL::R, OpenCL::A, OpenCL::RG, OpenCL::RA, OpenCL::RGB,
		1234	OpenCL::RGBA, OpenCL::BGRA, OpenCL::ARGB, OpenCL::INTENSITY, OpenCL::LUMINANCE,
		1235	OpenCL::Rx, OpenCL::RGx, OpenCL::RGBx.
		1236
		1237	channel_type: OpenCL::SNORM_INT8, OpenCL::SNORM_INT16, OpenCL::UNORM_INT8,
		1238	OpenCL::UNORM_INT16, OpenCL::UNORM_SHORT_565, OpenCL::UNORM_SHORT_555,
		1239	OpenCL::UNORM_INT_101010, OpenCL::SIGNED_INT8, OpenCL::SIGNED_INT16,
		1240	OpenCL::SIGNED_INT32, OpenCL::UNSIGNED_INT8, OpenCL::UNSIGNED_INT16,
		1241	OpenCL::UNSIGNED_INT32, OpenCL::HALF_FLOAT, OpenCL::FLOAT.
		1242
		1243	type: OpenCL::MEM_OBJECT_BUFFER, OpenCL::MEM_OBJECT_IMAGE2D,
		1244	OpenCL::MEM_OBJECT_IMAGE3D, OpenCL::MEM_OBJECT_IMAGE2D_ARRAY,
		1245	OpenCL::MEM_OBJECT_IMAGE1D, OpenCL::MEM_OBJECT_IMAGE1D_ARRAY,
		1246	OpenCL::MEM_OBJECT_IMAGE1D_BUFFER.
		1247
1063	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1248	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
1064		1249
1065	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	1250	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
1066		1251
1067	Creates a new OpenCL::Image2D object and optionally initialises it with	1252	Creates a new OpenCL::Image2D object and optionally initialises it with
…		…
1079	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)	1264	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
1080		1265
1081	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given	1266	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
1082	OpenGL buffer object.	1267	OpenGL buffer object.
1083		1268
		1269	flags: OpenCL::MEM_READ_WRITE, OpenCL::MEM_READ_ONLY, OpenCL::MEM_WRITE_ONLY.
		1270
1084	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html	1271	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
1085		1272
1086	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)	1273	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
1087		1274
1088	Creates a new OpenCL::Image object that refers to the given OpenGL	1275	Creates a new OpenCL::Image object that refers to the given OpenGL
1089	texture object or buffer.	1276	texture object or buffer.
1090		1277
		1278	target: GL_TEXTURE_1D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_BUFFER,
		1279	GL_TEXTURE_2D, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D,
		1280	GL_TEXTURE_CUBE_MAP_POSITIVE_X, GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
		1281	GL_TEXTURE_CUBE_MAP_POSITIVE_Z, GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
		1282	GL_TEXTURE_CUBE_MAP_NEGATIVE_Y, GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
		1283	GL_TEXTURE_RECTANGLE/GL_TEXTURE_RECTANGLE_ARB.
		1284
1091	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html	1285	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
1092		1286
1093	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)	1287	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
1094		1288
1095	Creates a new OpenCL::Image2D object that refers to the given OpenGL	1289	Creates a new OpenCL::Image2D object that refers to the given OpenGL
…		…
1120		1314
1121	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)	1315	=item $sampler = $ctx->sampler ($normalized_coords, $addressing_mode, $filter_mode)
1122		1316
1123	Creates a new OpenCL::Sampler object.	1317	Creates a new OpenCL::Sampler object.
1124		1318
		1319	addressing_mode: OpenCL::ADDRESS_NONE, OpenCL::ADDRESS_CLAMP_TO_EDGE,
		1320	OpenCL::ADDRESS_CLAMP, OpenCL::ADDRESS_REPEAT, OpenCL::ADDRESS_MIRRORED_REPEAT.
		1321
		1322	filter_mode: OpenCL::FILTER_NEAREST, OpenCL::FILTER_LINEAR.
		1323
1125	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>	1324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSampler.html>
1126		1325
1127	=item $program = $ctx->program_with_source ($string)	1326	=item $program = $ctx->program_with_source ($string)
1128		1327
1129	Creates a new OpenCL::Program object from the given source code.	1328	Creates a new OpenCL::Program object from the given source code.
1130		1329
1131	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1330	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1132		1331
		1332	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1333
		1334	Creates a new OpenCL::Program object from the given binaries.
		1335
		1336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1337
		1338	Example: clone an existing program object that contains a successfully
		1339	compiled program, no matter how useless this is.
		1340
		1341	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1342
		1343	=item $program = $ctx->program_with_built_in_kernels (\@devices, $kernel_names)
		1344
		1345	Creates a new OpenCL::Program object from the given built-in kernel names.
		1346
		1347	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateProgramWithBuiltInKernels.html>
		1348
		1349	=item $program = $ctx->link_program (\@devices, $options, \@programs, $cb->($program) = undef)
		1350
		1351	Links all (already compiled) program objects specified in C<@programs>
		1352	together and returns a new OpenCL::Program object with the result.
		1353
		1354	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clLinkProgram.html>
		1355
1133	=item $packed_value = $ctx->info ($name)	1356	=item $packed_value = $ctx->info ($name)
1134		1357
1135	See C<< $platform->info >> for details.	1358	See C<< $platform->info >> for details.
1136		1359
1137	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1360	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
1138		1361
1139	=for gengetinfo begin context	1362	=for gengetinfo begin context
1140		1363
1141	=item $uint = $context->reference_count	1364	=item $uint = $context->reference_count
1142		1365
1143	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.	1366	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_REFERENCE_COUNT> and returns the result.
1144		1367
1145	=item @devices = $context->devices	1368	=item @devices = $context->devices
1146		1369
1147	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.	1370	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_DEVICES> and returns the result.
1148		1371
1149	=item @property_ints = $context->properties	1372	=item @property_ints = $context->properties
1150		1373
1151	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.	1374	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_PROPERTIES> and returns the result.
1152		1375
1153	=item $uint = $context->num_devices	1376	=item $uint = $context->num_devices
1154		1377
1155	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.	1378	Calls C<clGetContextInfo> with C<OpenCL::CONTEXT_NUM_DEVICES> and returns the result.
1156		1379
1157	=for gengetinfo end context	1380	=for gengetinfo end context
1158		1381
1159	=back	1382	=back
1160		1383
…		…
1199		1422
1200	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1423	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1201		1424
1202	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1425	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1203		1426
1204	=item $ev = $queue->read_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...)	1427	$eue->read_buffer_rect ($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...)
1205		1428
1206	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1429	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1207		1430
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...)	1431	=item $ev = $queue->write_buffer_rect ($buf, $blocking, $buf_y, $host_x, $host_z, $height, $buf_row_pitch, $host_row_pitch, $data, $wait_events...)
1209		1432
1210	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1433	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1211		1434
		1435	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1436
		1437	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1438
1212	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1439	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1213		1440
1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1441	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
1215		1442	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		1443
1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1444	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1219		1445
1220	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1446	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1221		1447
		1448	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1449	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>	1450	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1223		1451
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...)	1452	=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		1453
1226	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1454	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	1499	reference to an array of local work sizes, with the same number of
1272	elements as \@global_work_size.	1500	elements as \@global_work_size.
1273		1501
1274	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1502	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1275		1503
		1504	=item $ev = $queue->migrate_mem_objects (\@mem_objects, $flags, $wait_events...)
		1505
		1506	Migrates a number of OpenCL::Memory objects to or from the device.
		1507
		1508	flags: OpenCL::MIGRATE_MEM_OBJECT_HOST, OpenCL::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
		1509
		1510	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMigrateMemObjects.html>
		1511
1276	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)	1512	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1277		1513
1278	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1514	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1279	for subsequent OpenCL usage.	1515	for subsequent OpenCL usage.
1280		1516
…		…
1315		1551
1316	=for gengetinfo begin command_queue	1552	=for gengetinfo begin command_queue
1317		1553
1318	=item $ctx = $command_queue->context	1554	=item $ctx = $command_queue->context
1319		1555
1320	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.	1556	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_CONTEXT> and returns the result.
1321		1557
1322	=item $device = $command_queue->device	1558	=item $device = $command_queue->device
1323		1559
1324	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.	1560	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_DEVICE> and returns the result.
1325		1561
1326	=item $uint = $command_queue->reference_count	1562	=item $uint = $command_queue->reference_count
1327		1563
1328	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.	1564	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_REFERENCE_COUNT> and returns the result.
1329		1565
1330	=item $command_queue_properties = $command_queue->properties	1566	=item $command_queue_properties = $command_queue->properties
1331		1567
1332	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1568	Calls C<clGetCommandQueueInfo> with C<OpenCL::QUEUE_PROPERTIES> and returns the result.
1333		1569
1334	=for gengetinfo end command_queue	1570	=for gengetinfo end command_queue
		1571
		1572	=back
		1573
		1574	=head3 MEMORY MAPPED BUFFERS
		1575
		1576	OpenCL allows you to map buffers and images to host memory (read: perl
		1577	scalars). This is done much like reading or copying a buffer, by enqueuing
		1578	a map or unmap operation on the command queue.
		1579
		1580	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1581	OpenCL::Mapped CLASS> section for details on what to do with these
		1582	objects.
		1583
		1584	The object will be unmapped automatically when the mapped object is
		1585	destroyed (you can use a barrier to make sure the unmap has finished,
		1586	before using the buffer in a kernel), but you can also enqueue an unmap
		1587	operation manually.
		1588
		1589	=over 4
		1590
		1591	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1592
		1593	Maps the given buffer into host memory and returns an
		1594	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1595	the map will extend to the end of the buffer.
		1596
		1597	map_flags: OpenCL::MAP_READ, OpenCL::MAP_WRITE, OpenCL::MAP_WRITE_INVALIDATE_REGION.
		1598
		1599	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1600
		1601	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1602
		1603	{
		1604	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1605	substr $$mapped, 0, 4, "abcd";
		1606	} # asynchronously unmap because $mapped is destroyed
		1607
		1608	=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...)
		1609
		1610	Maps the given image area into host memory and return an
		1611	C<OpenCL::MappedImage> object.
		1612
		1613	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1614	will be replaced by the maximum possible value.
		1615
		1616	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1617
		1618	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1619	the first channel of the leftmost column to 5, then explicitly unmap
		1620	it. You are not necessarily meant to do it this way, this example just
		1621	shows you the accessors to use :)
		1622
		1623	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1624
		1625	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1626	for 0..$image->height;
		1627
		1628	$mapped->unmap;.
		1629	$mapped->wait; # only needed for out of order queues normally
		1630
		1631	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1632
		1633	Unmaps the data from host memory. You must not call any methods that
		1634	modify the data, or modify the data scalar directly, after calling this
		1635	method.
		1636
		1637	The mapped event object will always be passed as part of the
		1638	$wait_events. The mapped event object will be replaced by the new event
		1639	object that this request creates.
1335		1640
1336	=back	1641	=back
1337		1642
1338	=head2 THE OpenCL::Memory CLASS	1643	=head2 THE OpenCL::Memory CLASS
1339		1644
…		…
1346		1651
1347	See C<< $platform->info >> for details.	1652	See C<< $platform->info >> for details.
1348		1653
1349	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1654	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
1350		1655
		1656	=item $memory->destructor_callback ($cb->())
		1657
		1658	Sets a callback that will be invoked after the memory object is destructed.
		1659
		1660	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetMemObjectDestructorCallback.html>
		1661
1351	=for gengetinfo begin mem	1662	=for gengetinfo begin mem
1352		1663
1353	=item $mem_object_type = $mem->type	1664	=item $mem_object_type = $mem->type
1354		1665
1355	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.	1666	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_TYPE> and returns the result.
1356		1667
1357	=item $mem_flags = $mem->flags	1668	=item $mem_flags = $mem->flags
1358		1669
1359	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.	1670	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_FLAGS> and returns the result.
1360		1671
1361	=item $int = $mem->size	1672	=item $int = $mem->size
1362		1673
1363	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.	1674	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_SIZE> and returns the result.
1364		1675
1365	=item $ptr_value = $mem->host_ptr	1676	=item $ptr_value = $mem->host_ptr
1366		1677
1367	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.	1678	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_HOST_PTR> and returns the result.
1368		1679
1369	=item $uint = $mem->map_count	1680	=item $uint = $mem->map_count
1370		1681
1371	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.	1682	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_MAP_COUNT> and returns the result.
1372		1683
1373	=item $uint = $mem->reference_count	1684	=item $uint = $mem->reference_count
1374		1685
1375	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.	1686	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_REFERENCE_COUNT> and returns the result.
1376		1687
1377	=item $ctx = $mem->context	1688	=item $ctx = $mem->context
1378		1689
1379	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.	1690	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_CONTEXT> and returns the result.
1380		1691
1381	=item $mem = $mem->associated_memobject	1692	=item $mem = $mem->associated_memobject
1382		1693
1383	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.	1694	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1384		1695
1385	=item $int = $mem->offset	1696	=item $int = $mem->offset
1386		1697
1387	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1698	Calls C<clGetMemObjectInfo> with C<OpenCL::MEM_OFFSET> and returns the result.
1388		1699
1389	=for gengetinfo end mem	1700	=for gengetinfo end mem
1390		1701
1391	=item ($type, $name) = $mem->gl_object_info	1702	=item ($type, $name) = $mem->gl_object_info
1392		1703
…		…
1412	=over 4	1723	=over 4
1413		1724
1414	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)	1725	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1415		1726
1416	Creates an OpenCL::Buffer objects from this buffer and returns it. The	1727	Creates an OpenCL::Buffer objects from this buffer and returns it. The
1417	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.	1728	C<buffer_create_type> is assumed to be C<OpenCL::BUFFER_CREATE_TYPE_REGION>.
1418		1729
1419	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>	1730	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1420		1731
1421	=back	1732	=back
1422		1733
…		…
1438	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1749	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1439		1750
1440	=item ($channel_order, $channel_data_type) = $image->format	1751	=item ($channel_order, $channel_data_type) = $image->format
1441		1752
1442	Returns the channel order and type used to create the image by calling	1753	Returns the channel order and type used to create the image by calling
1443	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.	1754	C<clGetImageInfo> with C<OpenCL::IMAGE_FORMAT>.
1444		1755
1445	=for gengetinfo begin image	1756	=for gengetinfo begin image
1446		1757
1447	=item $int = $image->element_size	1758	=item $int = $image->element_size
1448		1759
1449	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1760	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ELEMENT_SIZE> and returns the result.
1450		1761
1451	=item $int = $image->row_pitch	1762	=item $int = $image->row_pitch
1452		1763
1453	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.	1764	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_ROW_PITCH> and returns the result.
1454		1765
1455	=item $int = $image->slice_pitch	1766	=item $int = $image->slice_pitch
1456		1767
1457	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.	1768	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_SLICE_PITCH> and returns the result.
1458		1769
1459	=item $int = $image->width	1770	=item $int = $image->width
1460		1771
1461	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.	1772	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_WIDTH> and returns the result.
1462		1773
1463	=item $int = $image->height	1774	=item $int = $image->height
1464		1775
1465	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.	1776	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_HEIGHT> and returns the result.
1466		1777
1467	=item $int = $image->depth	1778	=item $int = $image->depth
1468		1779
1469	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1780	Calls C<clGetImageInfo> with C<OpenCL::IMAGE_DEPTH> and returns the result.
1470		1781
1471	=for gengetinfo end image	1782	=for gengetinfo end image
1472		1783
1473	=for gengetinfo begin gl_texture	1784	=for gengetinfo begin gl_texture
1474		1785
1475	=item $GLenum = $gl_texture->target	1786	=item $GLenum = $gl_texture->target
1476		1787
1477	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.	1788	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_TEXTURE_TARGET> and returns the result.
1478		1789
1479	=item $GLint = $gl_texture->gl_mipmap_level	1790	=item $GLint = $gl_texture->gl_mipmap_level
1480		1791
1481	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.	1792	Calls C<clGetGLTextureInfo> with C<OpenCL::GL_MIPMAP_LEVEL> and returns the result.
1482		1793
1483	=for gengetinfo end gl_texture	1794	=for gengetinfo end gl_texture
1484		1795
1485	=back	1796	=back
1486		1797
…		…
1496		1807
1497	=for gengetinfo begin sampler	1808	=for gengetinfo begin sampler
1498		1809
1499	=item $uint = $sampler->reference_count	1810	=item $uint = $sampler->reference_count
1500		1811
1501	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.	1812	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_REFERENCE_COUNT> and returns the result.
1502		1813
1503	=item $ctx = $sampler->context	1814	=item $ctx = $sampler->context
1504		1815
1505	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.	1816	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_CONTEXT> and returns the result.
1506		1817
1507	=item $addressing_mode = $sampler->normalized_coords	1818	=item $addressing_mode = $sampler->normalized_coords
1508		1819
1509	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.	1820	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_NORMALIZED_COORDS> and returns the result.
1510		1821
1511	=item $filter_mode = $sampler->addressing_mode	1822	=item $filter_mode = $sampler->addressing_mode
1512		1823
1513	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.	1824	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_ADDRESSING_MODE> and returns the result.
1514		1825
1515	=item $boolean = $sampler->filter_mode	1826	=item $boolean = $sampler->filter_mode
1516		1827
1517	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.	1828	Calls C<clGetSamplerInfo> with C<OpenCL::SAMPLER_FILTER_MODE> and returns the result.
1518		1829
1519	=for gengetinfo end sampler	1830	=for gengetinfo end sampler
1520		1831
1521	=back	1832	=back
1522		1833
…		…
1540	not so. So best make sure you don't pass in invalid values.	1851	not so. So best make sure you don't pass in invalid values.
1541		1852
1542	Some implementations fail with C<OpenCL::INVALID_BINARY> when the	1853	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
1543	compilation state is successful but some later stage fails.	1854	compilation state is successful but some later stage fails.
1544		1855
		1856	options: C<-D name>, C<-D name=definition>, C<-I dir>,
		1857	C<-cl-single-precision-constant>, C<-cl-denorms-are-zero>,
		1858	C<-cl-fp32-correctly-rounded-divide-sqrt>, C<-cl-opt-disable>,
		1859	C<-cl-mad-enable>, C<-cl-no-signed-zeros>, C<-cl-unsafe-math-optimizations>,
		1860	C<-cl-finite-math-only>, C<-cl-fast-relaxed-math>,
		1861	C<-w>, C<-Werror>, C<-cl-std=CL1.1/CL1.2>, C<-cl-kernel-arg-info>,
		1862	C<-create-library>, C<-enable-link-options>.
		1863
		1864	build_status: OpenCL::BUILD_SUCCESS, OpenCL::BUILD_NONE,
		1865	OpenCL::BUILD_ERROR, OpenCL::BUILD_IN_PROGRESS.
		1866
1545	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1867	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1546		1868
1547	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1869	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1548		1870
1549	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1871	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).	1872	need to check the compilation status form the callback, or by polling).
1551		1873
		1874	=item $program->compile (\@devices = undef, $options = "", \%headers = undef, $cb->($program) = undef)
		1875
		1876	Compiles the given program for the given devices (or all devices if
		1877	undef). If C<$headers> is given, it must be a hashref with include name =>
		1878	OpenCL::Program pairs.
		1879
		1880	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCompileProgram.html>
		1881
1552	=item $packed_value = $program->build_info ($device, $name)	1882	=item $packed_value = $program->build_info ($device, $name)
1553		1883
1554	Similar to C<< $platform->info >>, but returns build info for a previous	1884	Similar to C<< $platform->info >>, but returns build info for a previous
1555	build attempt for the given device.	1885	build attempt for the given device.
1556		1886
		1887	binary_type: OpenCL::PROGRAM_BINARY_TYPE_NONE,
		1888	OpenCL::PROGRAM_BINARY_TYPE_COMPILED_OBJECT,
		1889	OpenCL::PROGRAM_BINARY_TYPE_LIBRARY,
		1890	OpenCL::PROGRAM_BINARY_TYPE_EXECUTABLE.
		1891
1557	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>	1892	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetBuildInfo.html>
1558		1893
1559	=item $kernel = $program->kernel ($function_name)	1894	=item $kernel = $program->kernel ($function_name)
1560		1895
1561	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1896	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
…		…
1571		1906
1572	=for gengetinfo begin program_build	1907	=for gengetinfo begin program_build
1573		1908
1574	=item $build_status = $program->build_status ($device)	1909	=item $build_status = $program->build_status ($device)
1575		1910
1576	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.	1911	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_STATUS> and returns the result.
1577		1912
1578	=item $string = $program->build_options ($device)	1913	=item $string = $program->build_options ($device)
1579		1914
1580	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.	1915	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_OPTIONS> and returns the result.
1581		1916
1582	=item $string = $program->build_log ($device)	1917	=item $string = $program->build_log ($device)
1583		1918
1584	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.	1919	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BUILD_LOG> and returns the result.
		1920
		1921	=item $binary_type = $program->binary_type ($device)
		1922
		1923	Calls C<clGetProgramBuildInfo> with C<OpenCL::PROGRAM_BINARY_TYPE> and returns the result.
1585		1924
1586	=for gengetinfo end program_build	1925	=for gengetinfo end program_build
1587		1926
1588	=item $packed_value = $program->info ($name)	1927	=item $packed_value = $program->info ($name)
1589		1928
…		…
1593		1932
1594	=for gengetinfo begin program	1933	=for gengetinfo begin program
1595		1934
1596	=item $uint = $program->reference_count	1935	=item $uint = $program->reference_count
1597		1936
1598	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.	1937	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_REFERENCE_COUNT> and returns the result.
1599		1938
1600	=item $ctx = $program->context	1939	=item $ctx = $program->context
1601		1940
1602	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.	1941	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_CONTEXT> and returns the result.
1603		1942
1604	=item $uint = $program->num_devices	1943	=item $uint = $program->num_devices
1605		1944
1606	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.	1945	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_NUM_DEVICES> and returns the result.
1607		1946
1608	=item @devices = $program->devices	1947	=item @devices = $program->devices
1609		1948
1610	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.	1949	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_DEVICES> and returns the result.
1611		1950
1612	=item $string = $program->source	1951	=item $string = $program->source
1613		1952
1614	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.	1953	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_SOURCE> and returns the result.
1615		1954
1616	=item @ints = $program->binary_sizes	1955	=item @ints = $program->binary_sizes
1617		1956
1618	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.	1957	Calls C<clGetProgramInfo> with C<OpenCL::PROGRAM_BINARY_SIZES> and returns the result.
1619		1958
1620	=for gengetinfo end program	1959	=for gengetinfo end program
1621		1960
1622	=item @blobs = $program->binaries	1961	=item @blobs = $program->binaries
1623		1962
…		…
1644		1983
1645	=for gengetinfo begin kernel	1984	=for gengetinfo begin kernel
1646		1985
1647	=item $string = $kernel->function_name	1986	=item $string = $kernel->function_name
1648		1987
1649	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.	1988	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_FUNCTION_NAME> and returns the result.
1650		1989
1651	=item $uint = $kernel->num_args	1990	=item $uint = $kernel->num_args
1652		1991
1653	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.	1992	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_NUM_ARGS> and returns the result.
1654		1993
1655	=item $uint = $kernel->reference_count	1994	=item $uint = $kernel->reference_count
1656		1995
1657	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.	1996	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_REFERENCE_COUNT> and returns the result.
1658		1997
1659	=item $ctx = $kernel->context	1998	=item $ctx = $kernel->context
1660		1999
1661	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.	2000	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_CONTEXT> and returns the result.
1662		2001
1663	=item $program = $kernel->program	2002	=item $program = $kernel->program
1664		2003
1665	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.	2004	Calls C<clGetKernelInfo> with C<OpenCL::KERNEL_PROGRAM> and returns the result.
1666		2005
1667	=for gengetinfo end kernel	2006	=for gengetinfo end kernel
1668		2007
1669	=item $packed_value = $kernel->work_group_info ($device, $name)	2008	=item $packed_value = $kernel->work_group_info ($device, $name)
1670		2009
1671	See C<< $platform->info >> for details.	2010	See C<< $platform->info >> for details.
1672		2011
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>	2012	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1677		2013
1678	=for gengetinfo begin kernel_work_group	2014	=for gengetinfo begin kernel_work_group
1679		2015
1680	=item $int = $kernel->work_group_size ($device)	2016	=item $int = $kernel->work_group_size ($device)
1681		2017
1682	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.	2018	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_WORK_GROUP_SIZE> and returns the result.
1683		2019
1684	=item @ints = $kernel->compile_work_group_size ($device)	2020	=item @ints = $kernel->compile_work_group_size ($device)
1685		2021
1686	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.	2022	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1687		2023
1688	=item $ulong = $kernel->local_mem_size ($device)	2024	=item $ulong = $kernel->local_mem_size ($device)
1689		2025
1690	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.	2026	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_LOCAL_MEM_SIZE> and returns the result.
1691		2027
1692	=item $int = $kernel->preferred_work_group_size_multiple ($device)	2028	=item $int = $kernel->preferred_work_group_size_multiple ($device)
1693		2029
1694	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.	2030	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1695		2031
1696	=item $ulong = $kernel->private_mem_size ($device)	2032	=item $ulong = $kernel->private_mem_size ($device)
1697		2033
1698	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	2034	Calls C<clGetKernelWorkGroupInfo> with C<OpenCL::KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1699		2035
1700	=for gengetinfo end kernel_work_group	2036	=for gengetinfo end kernel_work_group
		2037
		2038	=item $packed_value = $kernel->arg_info ($idx, $name)
		2039
		2040	See C<< $platform->info >> for details.
		2041
		2042	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetKernelArgInfo.html>
		2043
		2044	=for gengetinfo begin kernel_arg
		2045
		2046	=item $kernel_arg_address_qualifier = $kernel->arg_address_qualifier ($idx)
		2047
		2048	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ADDRESS_QUALIFIER> and returns the result.
		2049
		2050	=item $kernel_arg_access_qualifier = $kernel->arg_access_qualifier ($idx)
		2051
		2052	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_ACCESS_QUALIFIER> and returns the result.
		2053
		2054	=item $string = $kernel->arg_type_name ($idx)
		2055
		2056	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_NAME> and returns the result.
		2057
		2058	=item $kernel_arg_type_qualifier = $kernel->arg_type_qualifier ($idx)
		2059
		2060	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_TYPE_QUALIFIER> and returns the result.
		2061
		2062	=item $string = $kernel->arg_name ($idx)
		2063
		2064	Calls C<clGetKernelArgInfo> with C<OpenCL::KERNEL_ARG_NAME> and returns the result.
		2065
		2066	=for gengetinfo end kernel_arg
1701		2067
1702	=item $kernel->setf ($format, ...)	2068	=item $kernel->setf ($format, ...)
1703		2069
1704	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic	2070	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	2071	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
…		…
1817		2183
1818	=for gengetinfo begin event	2184	=for gengetinfo begin event
1819		2185
1820	=item $queue = $event->command_queue	2186	=item $queue = $event->command_queue
1821		2187
1822	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.	2188	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_QUEUE> and returns the result.
1823		2189
1824	=item $command_type = $event->command_type	2190	=item $command_type = $event->command_type
1825		2191
1826	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.	2192	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_TYPE> and returns the result.
1827		2193
1828	=item $uint = $event->reference_count	2194	=item $uint = $event->reference_count
1829		2195
1830	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.	2196	Calls C<clGetEventInfo> with C<OpenCL::EVENT_REFERENCE_COUNT> and returns the result.
1831		2197
1832	=item $uint = $event->command_execution_status	2198	=item $uint = $event->command_execution_status
1833		2199
1834	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.	2200	Calls C<clGetEventInfo> with C<OpenCL::EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1835		2201
1836	=item $ctx = $event->context	2202	=item $ctx = $event->context
1837		2203
1838	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.	2204	Calls C<clGetEventInfo> with C<OpenCL::EVENT_CONTEXT> and returns the result.
1839		2205
1840	=for gengetinfo end event	2206	=for gengetinfo end event
1841		2207
1842	=item $packed_value = $ev->profiling_info ($name)	2208	=item $packed_value = $ev->profiling_info ($name)
1843		2209
…		…
1850		2216
1851	=for gengetinfo begin profiling	2217	=for gengetinfo begin profiling
1852		2218
1853	=item $ulong = $event->profiling_command_queued	2219	=item $ulong = $event->profiling_command_queued
1854		2220
1855	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.	2221	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_QUEUED> and returns the result.
1856		2222
1857	=item $ulong = $event->profiling_command_submit	2223	=item $ulong = $event->profiling_command_submit
1858		2224
1859	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.	2225	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_SUBMIT> and returns the result.
1860		2226
1861	=item $ulong = $event->profiling_command_start	2227	=item $ulong = $event->profiling_command_start
1862		2228
1863	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.	2229	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_START> and returns the result.
1864		2230
1865	=item $ulong = $event->profiling_command_end	2231	=item $ulong = $event->profiling_command_end
1866		2232
1867	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.	2233	Calls C<clGetEventProfilingInfo> with C<OpenCL::PROFILING_COMMAND_END> and returns the result.
1868		2234
1869	=for gengetinfo end profiling	2235	=for gengetinfo end profiling
1870		2236
1871	=back	2237	=back
1872		2238
…		…
1879	=item $ev->set_status ($execution_status)	2245	=item $ev->set_status ($execution_status)
1880		2246
1881	Sets the execution status of the user event. Can only be called once,	2247	Sets the execution status of the user event. Can only be called once,
1882	either with OpenCL::COMPLETE or a negative number as status.	2248	either with OpenCL::COMPLETE or a negative number as status.
1883		2249
		2250	execution_status: OpenCL::COMPLETE or a negative integer.
		2251
1884	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	2252	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1885		2253
1886	=back	2254	=back
		2255
		2256	=head2 THE OpenCL::Mapped CLASS
		2257
		2258	This class represents objects mapped into host memory. They are
		2259	represented by a blessed string scalar. The string data is the mapped
		2260	memory area, that is, if you read or write it, then the mapped object is
		2261	accessed directly.
		2262
		2263	You must only ever use operations that modify the string in-place - for
		2264	example, a C<substr> that doesn't change the length, or maybe a regex that
		2265	doesn't change the length. Any other operation might cause the data to be
		2266	copied.
		2267
		2268	When the object is destroyed it will enqueue an implicit unmap operation
		2269	on the queue that was used to create it.
		2270
		2271	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2272	OpenCL sees the changes, even if some implementations don't need this
		2273	sometimes.
		2274
		2275	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2276
		2277	my $mapped = $queue->map_buffer ($buf, ...
		2278	$mapped->event->wait; # make sure it's there
		2279
		2280	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2281	# we blindly assume device endianness to equal host endianness
		2282	# (and of course, we assume iee 754 single precision floats :)
		2283	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2284
		2285	=over 4
		2286
		2287	=item $ev = $mapped->unmap ($wait_events...)
		2288
		2289	Unmaps the mapped memory object, using the queue originally used to create
		2290	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2291
		2292	=item $bool = $mapped->mapped
		2293
		2294	Returns whether the object is still mapped - true before an C<unmap> is
		2295	enqueued, false afterwards.
		2296
		2297	=item $ev = $mapped->event
		2298
		2299	Return the event object associated with the mapped object. Initially, this
		2300	will be the event object created when mapping the object, and after an
		2301	unmap, this will be the event object that the unmap operation created.
		2302
		2303	=item $mapped->wait
		2304
		2305	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2306	mapped object are outstanding.
		2307
		2308	=item $bytes = $mapped->size
		2309
		2310	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2311
		2312	=item $ptr = $mapped->ptr
		2313
		2314	Returns the raw memory address of the mapped area.
		2315
		2316	=item $mapped->set ($offset, $data)
		2317
		2318	Replaces the data at the given C<$offset> in the memory area by the new
		2319	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2320	because it does bounds-checking, but also slower.
		2321
		2322	=item $data = $mapped->get ($offset, $length)
		2323
		2324	Returns (without copying) a scalar representing the data at the given
		2325	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2326	the following substr, except much slower;
		2327
		2328	$data = substr $$mapped, $offset, $length
		2329
		2330	=cut
		2331
		2332	sub OpenCL::Mapped::get {
		2333	substr ${$_[0]}, $_[1], $_[2]
		2334	}
		2335
		2336	=back
		2337
		2338	=head2 THE OpenCL::MappedBuffer CLASS
		2339
		2340	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2341
		2342	=head2 THE OpenCL::MappedImage CLASS
		2343
		2344	This is a subclass of OpenCL::Mapped, representing mapped images.
		2345
		2346	=over 4
		2347
		2348	=item $bytes = $mapped->row_pitch
		2349
		2350	=item $bytes = $mapped->slice_pitch
		2351
		2352	Return the row or slice pitch of the image that has been mapped.
		2353
		2354	=back
		2355
1887		2356
1888	=cut	2357	=cut
1889		2358
1890	1;	2359	1;
1891		2360

Diff Legend

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