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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.13 by root, Thu Nov 17 03:01:35 2011 UTC vs.
Revision 1.30 by root, Thu Apr 5 10:08:59 2012 UTC

…		…
27	OpenCL::Program objects, which store source code and, after building for a	27	OpenCL::Program objects, which store source code and, after building for a
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::Buffers objects (flat	32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33	memory areas, think array) and OpenCL::Image objects (think 2d or 3d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34	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
…		…
52		52
53	OpenCL manpages:	53	OpenCL manpages:
54		54
55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
56		56
		57	If you are into UML class diagrams, the following diagram might help - if
		58	not, it will be mildly cobfusing:
		59
		60	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html
		61
		62	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
		63	is, but at least it's free of charge:
		64
		65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
		66
		67	And here's NVIDIA's OpenCL Best Practises Guide:
		68
		69	http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
		70
57	=head1 BASIC WORKFLOW	71	=head1 BASIC WORKFLOW
58		72
59	To get something done, you basically have to do this once (refer to the	73	To get something done, you basically have to do this once (refer to the
60	examples below for actual code, this is just a high-level description):	74	examples below for actual code, this is just a high-level description):
61		75
…		…
87		101
88	Best run this once to get a feel for the platforms and devices in your	102	Best run this once to get a feel for the platforms and devices in your
89	system.	103	system.
90		104
91	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
92	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
93	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
94	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
95	printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
96	my $ctx = $device->context;	110	my $ctx = $platform->context (undef, [$device]);
97	# do stuff	111	# do stuff
98	}	112	}
99	}	113	}
100		114
101	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
…		…
138		152
139	my $src = '	153	my $src = '
140	__kernel void	154	__kernel void
141	squareit (__global float input, __global float output)	155	squareit (__global float input, __global float output)
142	{	156	{
143	size_t id = get_global_id (0);	157	$id = get_global_id (0);
144	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
145	}	159	}
146	';	160	';
147		161
148	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->program_with_source ($src);
149		163
150	# build croaks on compile errors, so catch it and print the compile errors	164	# build croaks on compile errors, so catch it and print the compile errors
151	eval { $prog->build ($dev); 1 }	165	eval { $prog->build ($dev); 1 }
152	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);	166	or die $prog->build_log;
153		167
154	my $kernel = $prog->kernel ("squareit");	168	my $kernel = $prog->kernel ("squareit");
155		169
156	=head2 Create some input and output float buffers, then call the	170	=head2 Create some input and output float buffers, then call the
157	'squareit' kernel on them.	171	'squareit' kernel on them.
…		…
201		215
202	=head1 DOCUMENTATION	216	=head1 DOCUMENTATION
203		217
204	=head2 BASIC CONVENTIONS	218	=head2 BASIC CONVENTIONS
205		219
206	This is not a 1:1 C-style translation of OpenCL to Perl - instead I	220	This is not a one-to-one C-style translation of OpenCL to Perl - instead
207	attempted to make the interface as type-safe as possible and introducing	221	I attempted to make the interface as type-safe as possible by introducing
208	object syntax where it makes sense. There are a number of important	222	object syntax where it makes sense. There are a number of important
209	differences between the OpenCL C API and this module:	223	differences between the OpenCL C API and this module:
210		224
211	=over 4	225	=over 4
212		226
213	=item * Object lifetime managament is automatic - there is no need	227	=item * Object lifetime managament is automatic - there is no need
214	to free objects explicitly (C<clReleaseXXX>), the release function	228	to free objects explicitly (C<clReleaseXXX>), the release function
215	is called automatically once all Perl references to it go away.	229	is called automatically once all Perl references to it go away.
216		230
217	=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>),	231	=item * OpenCL uses CamelCase for function names
		232	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
218	while this module uses underscores as word separator and often leaves out	233	uses underscores as word separator and often leaves out prefixes
219	prefixes (C<< $platform->info >>).	234	(C<OpenCL::platforms>, C<< $platform->info >>).
220		235
221	=item * OpenCL often specifies fixed vector function arguments as short	236	=item * OpenCL often specifies fixed vector function arguments as short
222	arrays (C<size_t origin[3]>), while this module explicitly expects the	237	arrays (C<size_t origin[3]>), while this module explicitly expects the
223	components as separate arguments-	238	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		239	function calls.
224		240
225	=item * Structures are often specified with their components, and returned	241	=item * Structures are often specified by flattening out their components
226	as arrayrefs.	242	as with short vectors, and returned as arrayrefs.
227
228	=item * Where possible, one of the pitch values is calculated from the
229	perl scalar length and need not be specified.
230		243
231	=item * When enqueuing commands, the wait list is specified by adding	244	=item * When enqueuing commands, the wait list is specified by adding
232	extra arguments to the function - anywhere a C<$wait_events...> argument	245	extra arguments to the function - anywhere a C<$wait_events...> argument
233	is documented this can be any number of event objects.	246	is documented this can be any number of event objects.
234		247
…		…
273		286
274	Comverts an error value into a human readable string.	287	Comverts an error value into a human readable string.
275		288
276	=item $str = OpenCL::enum2str $enum	289	=item $str = OpenCL::enum2str $enum
277		290
278	Converts most enum values (inof parameter names, image format constants,	291	Converts most enum values (of parameter names, image format constants,
279	object types, addressing and filter modes, command types etc.) into a	292	object types, addressing and filter modes, command types etc.) into a
280	human readbale string. When confronted with some random integer it can be	293	human readable string. When confronted with some random integer it can be
281	very helpful to pass it through this function to maybe get some readable	294	very helpful to pass it through this function to maybe get some readable
282	string out of it.	295	string out of it.
283		296
284	=item @platforms = OpenCL::platforms	297	=item @platforms = OpenCL::platforms
285		298
…		…
303		316
304	=head2 THE OpenCL::Platform CLASS	317	=head2 THE OpenCL::Platform CLASS
305		318
306	=over 4	319	=over 4
307		320
308	=item $packed_value = $platform->info ($name)
309
310	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
311	strings, this will be the string, for other values you probably need to
312	use the correct C<unpack>. This might get improved in the future. Hopefully.
313
314	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
315
316	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
317		322
318	Returns a list of matching OpenCL::Device objects.	323	Returns a list of matching OpenCL::Device objects.
319		324
320	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	325	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
321		326
322	Tries to create a context. Never worked for me, and you need devices explitly anyway.	327	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
323		328
324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
325		330
326	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	331	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
327		332
328	Create a new OpenCL::Context object using the given device object(s)- a	333	Create a new OpenCL::Context object using the given device object(s)- a
329	CL_CONTEXT_PLATFORM property is supplied automatically.	334	CL_CONTEXT_PLATFORM property is supplied automatically.
330		335
331	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
332		337
		338	=item $packed_value = $platform->info ($name)
		339
		340	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
		341	strings, this will be the string (possibly including terminating \0), for
		342	other values you probably need to use the correct C<unpack>.
		343
		344	It's best to avoid this method and use one of the following convenience
		345	wrappers.
		346
		347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
		348
		349	=for gengetinfo begin platform
		350
		351	=item $string = $platform->profile
		352
		353	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
		354
		355	=item $string = $platform->version
		356
		357	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
		358
		359	=item $string = $platform->name
		360
		361	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
		362
		363	=item $string = $platform->vendor
		364
		365	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
		366
		367	=item $string = $platform->extensions
		368
		369	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		370
		371	=for gengetinfo end platform
		372
333	=back	373	=back
334		374
335	=head2 THE OpenCL::Device CLASS	375	=head2 THE OpenCL::Device CLASS
336		376
337	=over 4	377	=over 4
…		…
340		380
341	See C<< $platform->info >> for details.	381	See C<< $platform->info >> for details.
342		382
343	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	383	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
344		384
		385	=for gengetinfo begin device
		386
		387	=item $device_type = $device->type
		388
		389	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		390
		391	=item $uint = $device->vendor_id
		392
		393	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		394
		395	=item $uint = $device->max_compute_units
		396
		397	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		398
		399	=item $uint = $device->max_work_item_dimensions
		400
		401	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		402
		403	=item $int = $device->max_work_group_size
		404
		405	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		406
		407	=item @ints = $device->max_work_item_sizes
		408
		409	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		410
		411	=item $uint = $device->preferred_vector_width_char
		412
		413	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		414
		415	=item $uint = $device->preferred_vector_width_short
		416
		417	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		418
		419	=item $uint = $device->preferred_vector_width_int
		420
		421	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		422
		423	=item $uint = $device->preferred_vector_width_long
		424
		425	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		426
		427	=item $uint = $device->preferred_vector_width_float
		428
		429	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		430
		431	=item $uint = $device->preferred_vector_width_double
		432
		433	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		434
		435	=item $uint = $device->max_clock_frequency
		436
		437	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		438
		439	=item $bitfield = $device->address_bits
		440
		441	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		442
		443	=item $uint = $device->max_read_image_args
		444
		445	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		446
		447	=item $uint = $device->max_write_image_args
		448
		449	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		450
		451	=item $ulong = $device->max_mem_alloc_size
		452
		453	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		454
		455	=item $int = $device->image2d_max_width
		456
		457	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		458
		459	=item $int = $device->image2d_max_height
		460
		461	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		462
		463	=item $int = $device->image3d_max_width
		464
		465	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		466
		467	=item $int = $device->image3d_max_height
		468
		469	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		470
		471	=item $int = $device->image3d_max_depth
		472
		473	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		474
		475	=item $uint = $device->image_support
		476
		477	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		478
		479	=item $int = $device->max_parameter_size
		480
		481	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		482
		483	=item $uint = $device->max_samplers
		484
		485	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		486
		487	=item $uint = $device->mem_base_addr_align
		488
		489	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		490
		491	=item $uint = $device->min_data_type_align_size
		492
		493	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		494
		495	=item $device_fp_config = $device->single_fp_config
		496
		497	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		498
		499	=item $device_mem_cache_type = $device->global_mem_cache_type
		500
		501	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		502
		503	=item $uint = $device->global_mem_cacheline_size
		504
		505	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		506
		507	=item $ulong = $device->global_mem_cache_size
		508
		509	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		510
		511	=item $ulong = $device->global_mem_size
		512
		513	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		514
		515	=item $ulong = $device->max_constant_buffer_size
		516
		517	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		518
		519	=item $uint = $device->max_constant_args
		520
		521	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		522
		523	=item $device_local_mem_type = $device->local_mem_type
		524
		525	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		526
		527	=item $ulong = $device->local_mem_size
		528
		529	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		530
		531	=item $boolean = $device->error_correction_support
		532
		533	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		534
		535	=item $int = $device->profiling_timer_resolution
		536
		537	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		538
		539	=item $boolean = $device->endian_little
		540
		541	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		542
		543	=item $boolean = $device->available
		544
		545	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		546
		547	=item $boolean = $device->compiler_available
		548
		549	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		550
		551	=item $device_exec_capabilities = $device->execution_capabilities
		552
		553	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		554
		555	=item $command_queue_properties = $device->properties
		556
		557	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		558
		559	=item $ = $device->platform
		560
		561	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		562
		563	=item $string = $device->name
		564
		565	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		566
		567	=item $string = $device->vendor
		568
		569	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		570
		571	=item $string = $device->driver_version
		572
		573	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		574
		575	=item $string = $device->profile
		576
		577	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		578
		579	=item $string = $device->version
		580
		581	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		582
		583	=item $string = $device->extensions
		584
		585	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		586
		587	=item $uint = $device->preferred_vector_width_half
		588
		589	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		590
		591	=item $uint = $device->native_vector_width_char
		592
		593	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		594
		595	=item $uint = $device->native_vector_width_short
		596
		597	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		598
		599	=item $uint = $device->native_vector_width_int
		600
		601	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		602
		603	=item $uint = $device->native_vector_width_long
		604
		605	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		606
		607	=item $uint = $device->native_vector_width_float
		608
		609	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		610
		611	=item $uint = $device->native_vector_width_double
		612
		613	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		614
		615	=item $uint = $device->native_vector_width_half
		616
		617	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		618
		619	=item $device_fp_config = $device->double_fp_config
		620
		621	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		622
		623	=item $device_fp_config = $device->half_fp_config
		624
		625	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		626
		627	=item $boolean = $device->host_unified_memory
		628
		629	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		630
		631	=item $device = $device->parent_device_ext
		632
		633	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		634
		635	=item @device_partition_property_exts = $device->partition_types_ext
		636
		637	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		638
		639	=item @device_partition_property_exts = $device->affinity_domains_ext
		640
		641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		642
		643	=item $uint = $device->reference_count_ext
		644
		645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
		646
		647	=item @device_partition_property_exts = $device->partition_style_ext
		648
		649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		650
		651	=for gengetinfo end device
		652
345	=back	653	=back
346		654
347	=head2 THE OpenCL::Context CLASS	655	=head2 THE OpenCL::Context CLASS
348		656
349	=over 4	657	=over 4
350		658
351	=item $packed_value = $ctx->info ($name)
352
353	See C<< $platform->info >> for details.
354
355	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
356
357	=item $queue = $ctx->queue ($device, $properties)	659	=item $queue = $ctx->queue ($device, $properties)
358		660
359	Create a new OpenCL::Queue object from the context and the given device.	661	Create a new OpenCL::Queue object from the context and the given device.
360		662
361	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	663	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
…		…
366		668
367	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	669	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
368		670
369	=item $buf = $ctx->buffer ($flags, $len)	671	=item $buf = $ctx->buffer ($flags, $len)
370		672
371	Creates a new OpenCL::Buffer object with the given flags and octet-size.	673	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		674	given flags and octet-size.
372		675
373	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	676	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
374		677
375	=item $buf = $ctx->buffer_sv ($flags, $data)	678	=item $buf = $ctx->buffer_sv ($flags, $data)
376		679
377	Creates a new OpenCL::Buffer object and initialise it with the given data values.	680	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		681	initialise it with the given data values.
378		682
379	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	683	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
380		684
381	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	685	Creates a new OpenCL::Image2D object and optionally initialises it with
		686	the given data values.
382		687
383	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	688	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
384		689
385	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	690	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
386		691
387	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	692	Creates a new OpenCL::Image3D object and optionally initialises it with
		693	the given data values.
388		694
389	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	695	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
390		696
391	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	697	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
392		698
…		…
404	=item $program = $ctx->program_with_source ($string)	710	=item $program = $ctx->program_with_source ($string)
405		711
406	Creates a new OpenCL::Program object from the given source code.	712	Creates a new OpenCL::Program object from the given source code.
407		713
408	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	714	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		715
		716	=item $packed_value = $ctx->info ($name)
		717
		718	See C<< $platform->info >> for details.
		719
		720	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		721
		722	=for gengetinfo begin context
		723
		724	=item $uint = $context->reference_count
		725
		726	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		727
		728	=item @devices = $context->devices
		729
		730	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		731
		732	=item @property_ints = $context->properties
		733
		734	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		735
		736	=item $uint = $context->num_devices
		737
		738	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		739
		740	=for gengetinfo end context
409		741
410	=back	742	=back
411		743
412	=head2 THE OpenCL::Queue CLASS	744	=head2 THE OpenCL::Queue CLASS
413		745
…		…
427	cases (i.e. you use only one queue) it's not necessary to wait for or	759	cases (i.e. you use only one queue) it's not necessary to wait for or
428	create event objects.	760	create event objects.
429		761
430	=over 4	762	=over 4
431		763
432	=item $packed_value = $ctx->info ($name)
433
434	See C<< $platform->info >> for details.
435
436	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
437
438	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	764	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
439		765
440	Reads data from buffer into the given string.	766	Reads data from buffer into the given string.
441		767
442	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	768	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
449		775
450	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	776	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
451		777
452	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	778	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
453		779
		780	=item $ev = $queue->enqueue_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...)
		781
		782	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		783
		784	=item $ev = $queue->enqueue_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...)
		785
		786	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		787
454	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	788	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
455		789
		790	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		791
		792	=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		793
456	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	794	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
457		795
458	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	796	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
459		797
460	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	798	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
461		799
		800	=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		801
		802	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		803
		804	=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
		805
		806	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		807
462	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, 4dst_row_pitch, $dst_slice_pitch, $ait_event...)	808	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
463		809
464	Yeah.	810	Yeah.
465		811
466	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
467
468	=item $ev = $queue->enqueue_copy_buffer_to_image (OpenCL::Buffer src, OpenCL::Image dst, size_t src_offset, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
469
470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	812	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
471
472	=item $ev = $queue->enqueue_copy_image (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
473
474	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
475
476	=item $ev = $queue->enqueue_copy_image_to_buffer (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t width, size_t height, size_t depth, size_t dst_offset, ...)
477
478	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
479		813
480	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	814	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
481		815
482	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	816	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
483		817
…		…
517		851
518	=item $queue->finish	852	=item $queue->finish
519		853
520	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	854	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
521		855
		856	=item $packed_value = $queue->info ($name)
		857
		858	See C<< $platform->info >> for details.
		859
		860	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		861
		862	=for gengetinfo begin command_queue
		863
		864	=item $ctx = $command_queue->context
		865
		866	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		867
		868	=item $device = $command_queue->device
		869
		870	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		871
		872	=item $uint = $command_queue->reference_count
		873
		874	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		875
		876	=item $command_queue_properties = $command_queue->properties
		877
		878	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		879
		880	=for gengetinfo end command_queue
		881
522	=back	882	=back
523		883
524	=head2 THE OpenCL::Memory CLASS	884	=head2 THE OpenCL::Memory CLASS
525		885
526	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	886	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
527	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	887	OpenCL::Image2D and OpenCL::Image3D.
528	currently only exist to allow type-checking.
529		888
530	=over 4	889	=over 4
531		890
532	=item $packed_value = $memory->info ($name)	891	=item $packed_value = $memory->info ($name)
533		892
534	See C<< $platform->info >> for details.	893	See C<< $platform->info >> for details.
535		894
536	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	895	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
537		896
		897	=for gengetinfo begin mem
		898
		899	=item $mem_object_type = $mem->type
		900
		901	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		902
		903	=item $mem_flags = $mem->flags
		904
		905	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		906
		907	=item $int = $mem->size
		908
		909	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		910
		911	=item $ptr_value = $mem->host_ptr
		912
		913	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		914
		915	=item $uint = $mem->map_count
		916
		917	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		918
		919	=item $uint = $mem->reference_count
		920
		921	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		922
		923	=item $ctx = $mem->context
		924
		925	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		926
		927	=item $mem = $mem->associated_memobject
		928
		929	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		930
		931	=item $int = $mem->offset
		932
		933	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		934
		935	=for gengetinfo end mem
		936
538	=back	937	=back
539		938
		939	=head2 THE OpenCL::Buffer CLASS
		940
		941	This is a subclass of OpenCL::Memory, and the superclass of
		942	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		943	and sub-buffers.
		944
		945	=head2 THE OpenCL::BufferObj CLASS
		946
		947	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		948	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		949	sub buffers from these sub buffers.
		950
		951	=over 4
		952
		953	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		954
		955	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		956	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		957
		958	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		959
		960	=back
		961
		962	=head2 THE OpenCL::Image CLASS
		963
		964	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		965
		966	=over 4
		967
		968	=item $packed_value = $ev->image_info ($name)
		969
		970	See C<< $platform->info >> for details.
		971
		972	The reason this method is not called C<info> is that there already is an
		973	C<< ->info >> method inherited from C<OpenCL::Memory>.
		974
		975	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		976
		977	=for gengetinfo begin image
		978
		979	=item $int = $image->element_size
		980
		981	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		982
		983	=item $int = $image->row_pitch
		984
		985	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		986
		987	=item $int = $image->slice_pitch
		988
		989	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		990
		991	=item $int = $image->width
		992
		993	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		994
		995	=item $int = $image->height
		996
		997	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		998
		999	=item $int = $image->depth
		1000
		1001	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1002
		1003	=for gengetinfo end image
		1004
		1005	=back
		1006
540	=head2 THE OpenCL::Sampler CLASS	1007	=head2 THE OpenCL::Sampler CLASS
541		1008
542	=over 4	1009	=over 4
543		1010
544	=item $packed_value = $sampler->info ($name)	1011	=item $packed_value = $sampler->info ($name)
545		1012
546	See C<< $platform->info >> for details.	1013	See C<< $platform->info >> for details.
547		1014
548	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1015	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
549		1016
		1017	=for gengetinfo begin sampler
		1018
		1019	=item $uint = $sampler->reference_count
		1020
		1021	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1022
		1023	=item $ctx = $sampler->context
		1024
		1025	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1026
		1027	=item $addressing_mode = $sampler->normalized_coords
		1028
		1029	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1030
		1031	=item $filter_mode = $sampler->addressing_mode
		1032
		1033	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1034
		1035	=item $boolean = $sampler->filter_mode
		1036
		1037	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1038
		1039	=for gengetinfo end sampler
		1040
550	=back	1041	=back
551		1042
552	=head2 THE OpenCL::Program CLASS	1043	=head2 THE OpenCL::Program CLASS
553		1044
554	=over 4	1045	=over 4
555
556	=item $packed_value = $program->info ($name)
557
558	See C<< $platform->info >> for details.
559
560	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
561		1046
562	=item $program->build ($device, $options = "")	1047	=item $program->build ($device, $options = "")
563		1048
564	Tries to build the program with the givne options.	1049	Tries to build the program with the givne options.
565		1050
…		…
577	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1062	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
578	the program.	1063	the program.
579		1064
580	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1065	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
581		1066
		1067	=for gengetinfo begin program_build
		1068
		1069	=item $build_status = $program->build_status ($device)
		1070
		1071	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1072
		1073	=item $string = $program->build_options ($device)
		1074
		1075	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1076
		1077	=item $string = $program->build_log ($device)
		1078
		1079	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1080
		1081	=for gengetinfo end program_build
		1082
		1083	=item $packed_value = $program->info ($name)
		1084
		1085	See C<< $platform->info >> for details.
		1086
		1087	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1088
		1089	=for gengetinfo begin program
		1090
		1091	=item $uint = $program->reference_count
		1092
		1093	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1094
		1095	=item $ctx = $program->context
		1096
		1097	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1098
		1099	=item $uint = $program->num_devices
		1100
		1101	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1102
		1103	=item @devices = $program->devices
		1104
		1105	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1106
		1107	=item $string = $program->source
		1108
		1109	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1110
		1111	=item @ints = $program->binary_sizes
		1112
		1113	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1114
		1115	=for gengetinfo end program
		1116
		1117	=item @blobs = $program->binaries
		1118
		1119	Returns a string for the compiled binary for every device associated with
		1120	the program, empty strings indicate missing programs, and an empty result
		1121	means no program binaries are available.
		1122
		1123	These "binaries" are often, in fact, informative low-level assembly
		1124	sources.
		1125
		1126	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1127
582	=back	1128	=back
583		1129
584	=head2 THE OpenCL::Kernel CLASS	1130	=head2 THE OpenCL::Kernel CLASS
585		1131
586	=over 4	1132	=over 4
…		…
588	=item $packed_value = $kernel->info ($name)	1134	=item $packed_value = $kernel->info ($name)
589		1135
590	See C<< $platform->info >> for details.	1136	See C<< $platform->info >> for details.
591		1137
592	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1138	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1139
		1140	=for gengetinfo begin kernel
		1141
		1142	=item $string = $kernel->function_name
		1143
		1144	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1145
		1146	=item $uint = $kernel->num_args
		1147
		1148	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1149
		1150	=item $uint = $kernel->reference_count
		1151
		1152	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1153
		1154	=item $ctx = $kernel->context
		1155
		1156	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1157
		1158	=item $program = $kernel->program
		1159
		1160	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1161
		1162	=for gengetinfo end kernel
		1163
		1164	=item $packed_value = $kernel->work_group_info ($device, $name)
		1165
		1166	See C<< $platform->info >> for details.
		1167
		1168	The reason this method is not called C<info> is that there already is an
		1169	C<< ->info >> method.
		1170
		1171	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1172
		1173	=for gengetinfo begin kernel_work_group
		1174
		1175	=item $int = $kernel->work_group_size ($device)
		1176
		1177	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1178
		1179	=item @ints = $kernel->compile_work_group_size ($device)
		1180
		1181	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1182
		1183	=item $ulong = $kernel->local_mem_size ($device)
		1184
		1185	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1186
		1187	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1188
		1189	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1190
		1191	=item $ulong = $kernel->private_mem_size ($device)
		1192
		1193	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1194
		1195	=for gengetinfo end kernel_work_group
593		1196
594	=item $kernel->set_TYPE ($index, $value)	1197	=item $kernel->set_TYPE ($index, $value)
595		1198
596	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1199	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
597		1200
…		…
613	This is the superclass for all event objects (including OpenCL::UserEvent	1216	This is the superclass for all event objects (including OpenCL::UserEvent
614	objects).	1217	objects).
615		1218
616	=over 4	1219	=over 4
617		1220
		1221	=item $ev->wait
		1222
		1223	Waits for the event to complete.
		1224
		1225	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1226
618	=item $packed_value = $ev->info ($name)	1227	=item $packed_value = $ev->info ($name)
619		1228
620	See C<< $platform->info >> for details.	1229	See C<< $platform->info >> for details.
621		1230
622	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1231	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
623		1232
624	=item $ev->wait	1233	=for gengetinfo begin event
625		1234
626	Waits for the event to complete.	1235	=item $queue = $event->command_queue
627		1236
		1237	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1238
		1239	=item $command_type = $event->command_type
		1240
		1241	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1242
		1243	=item $uint = $event->reference_count
		1244
		1245	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1246
		1247	=item $uint = $event->command_execution_status
		1248
		1249	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1250
		1251	=item $ctx = $event->context
		1252
		1253	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1254
		1255	=for gengetinfo end event
		1256
		1257	=item $packed_value = $ev->profiling_info ($name)
		1258
		1259	See C<< $platform->info >> for details.
		1260
		1261	The reason this method is not called C<info> is that there already is an
		1262	C<< ->info >> method.
		1263
628	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1264	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1265
		1266	=for gengetinfo begin profiling
		1267
		1268	=item $ulong = $event->profiling_command_queued
		1269
		1270	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1271
		1272	=item $ulong = $event->profiling_command_submit
		1273
		1274	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1275
		1276	=item $ulong = $event->profiling_command_start
		1277
		1278	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1279
		1280	=item $ulong = $event->profiling_command_end
		1281
		1282	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1283
		1284	=for gengetinfo end profiling
629		1285
630	=back	1286	=back
631		1287
632	=head2 THE OpenCL::UserEvent CLASS	1288	=head2 THE OpenCL::UserEvent CLASS
633		1289
…		…
646	package OpenCL;	1302	package OpenCL;
647		1303
648	use common::sense;	1304	use common::sense;
649		1305
650	BEGIN {	1306	BEGIN {
651	our $VERSION = '0.14';	1307	our $VERSION = '0.91';
652		1308
653	require XSLoader;	1309	require XSLoader;
654	XSLoader::load (__PACKAGE__, $VERSION);	1310	XSLoader::load (__PACKAGE__, $VERSION);
655		1311
656	@OpenCL::Buffer::ISA =	1312	@OpenCL::Buffer::ISA =
657	@OpenCL::Image::ISA = OpenCL::Memory::;	1313	@OpenCL::Image::ISA = OpenCL::Memory::;
658		1314
		1315	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1316
659	@OpenCL::Image2D::ISA =	1317	@OpenCL::Image2D::ISA =
660	@OpenCL::Image3D::ISA = OpenCL::Image::;	1318	@OpenCL::Image3D::ISA = OpenCL::Image::;
661		1319
662	@OpenCL::UserEvent::ISA = OpenCL::Event::;	1320	@OpenCL::UserEvent::ISA = OpenCL::Event::;
663	}	1321	}
664		1322
665	1;	1323	1;
666		1324
667	=head1 AUTHOR	1325	=head1 AUTHOR

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.13 by root, Thu Nov 17 03:01:35 2011 UTC vs. Revision 1.30 by root, Thu Apr 5 10:08:59 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.13 by root, Thu Nov 17 03:01:35 2011 UTC vs.
Revision 1.30 by root, Thu Apr 5 10:08:59 2012 UTC