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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.15 by root, Thu Nov 17 03:05:56 2011 UTC vs.
Revision 1.35 by root, Thu Apr 19 13:18:31 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.
…		…
135		149
136	=head2 Create and build a program, then create a kernel out of one of its	150	=head2 Create and build a program, then create a kernel out of one of its
137	functions.	151	functions.
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	$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.
…		…
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<$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>
		696
		697	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		698
		699	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		700	OpenGL buffer object.
		701
		702	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		703
		704	=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		705
		706	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		707	2D texture object.
		708
		709	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		710
		711	=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		712
		713	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		714	3D texture object.
		715
		716	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		717
		718	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		719
		720	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		721	render buffer.
		722
		723	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
390		724
391	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	725	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
392		726
393	Returns a list of matching image formats - each format is an arrayref with	727	Returns a list of matching image formats - each format is an arrayref with
394	two values, $channel_order and $channel_type, in it.	728	two values, $channel_order and $channel_type, in it.
…		…
404	=item $program = $ctx->program_with_source ($string)	738	=item $program = $ctx->program_with_source ($string)
405		739
406	Creates a new OpenCL::Program object from the given source code.	740	Creates a new OpenCL::Program object from the given source code.
407		741
408	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	742	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		743
		744	=item $packed_value = $ctx->info ($name)
		745
		746	See C<< $platform->info >> for details.
		747
		748	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		749
		750	=for gengetinfo begin context
		751
		752	=item $uint = $context->reference_count
		753
		754	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		755
		756	=item @devices = $context->devices
		757
		758	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		759
		760	=item @property_ints = $context->properties
		761
		762	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		763
		764	=item $uint = $context->num_devices
		765
		766	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		767
		768	=for gengetinfo end context
409		769
410	=back	770	=back
411		771
412	=head2 THE OpenCL::Queue CLASS	772	=head2 THE OpenCL::Queue CLASS
413		773
…		…
427	cases (i.e. you use only one queue) it's not necessary to wait for or	787	cases (i.e. you use only one queue) it's not necessary to wait for or
428	create event objects.	788	create event objects.
429		789
430	=over 4	790	=over 4
431		791
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...)	792	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
439		793
440	Reads data from buffer into the given string.	794	Reads data from buffer into the given string.
441		795
442	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	796	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
449		803
450	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	804	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
451		805
452	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	806	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
453		807
		808	=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...)
		809
		810	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		811
		812	=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...)
		813
		814	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		815
454	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	816	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
455		817
		818	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		819
		820	=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...)
		821
456	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	822	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
457		823
458	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	824	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
459		825
460	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	826	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
461		827
		828	=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...)
		829
		830	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		831
		832	=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...)
		833
		834	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		835
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, $wait_event...)	836	=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		837
464	Yeah.	838	Yeah.
465		839
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 ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
469
470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	840	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
471
472	=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...)
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 ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
477
478	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
479		841
480	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	842	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
481		843
482	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	844	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
483		845
…		…
497	reference to an array of local work sizes, with the same number of	859	reference to an array of local work sizes, with the same number of
498	elements as @$global_work_size.	860	elements as @$global_work_size.
499		861
500	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	862	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
501		863
502	=item $ev = $queue->enqueue_marker	864	=item $ev = $queue->enqueue_marker ($wait_events...)
503		865
504	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	866	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
505		867
		868	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
		869
		870	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		871	for subsequent OpenCL usage.
		872
		873	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		874
		875	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		876
		877	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		878	for subsequent OpenGL usage.
		879
		880	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
		881
506	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	882	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
507		883
508	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	884	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
509		885
510	=item $queue->enqueue_barrier	886	=item $queue->enqueue_barrier
…		…
517		893
518	=item $queue->finish	894	=item $queue->finish
519		895
520	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	896	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
521		897
		898	=item $packed_value = $queue->info ($name)
		899
		900	See C<< $platform->info >> for details.
		901
		902	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		903
		904	=for gengetinfo begin command_queue
		905
		906	=item $ctx = $command_queue->context
		907
		908	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		909
		910	=item $device = $command_queue->device
		911
		912	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		913
		914	=item $uint = $command_queue->reference_count
		915
		916	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		917
		918	=item $command_queue_properties = $command_queue->properties
		919
		920	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		921
		922	=for gengetinfo end command_queue
		923
522	=back	924	=back
523		925
524	=head2 THE OpenCL::Memory CLASS	926	=head2 THE OpenCL::Memory CLASS
525		927
526	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	928	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
527	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	929	OpenCL::Image2D and OpenCL::Image3D.
528	currently only exist to allow type-checking.
529		930
530	=over 4	931	=over 4
531		932
532	=item $packed_value = $memory->info ($name)	933	=item $packed_value = $memory->info ($name)
533		934
534	See C<< $platform->info >> for details.	935	See C<< $platform->info >> for details.
535		936
536	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	937	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
537		938
		939	=for gengetinfo begin mem
		940
		941	=item $mem_object_type = $mem->type
		942
		943	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		944
		945	=item $mem_flags = $mem->flags
		946
		947	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		948
		949	=item $int = $mem->size
		950
		951	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		952
		953	=item $ptr_value = $mem->host_ptr
		954
		955	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		956
		957	=item $uint = $mem->map_count
		958
		959	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		960
		961	=item $uint = $mem->reference_count
		962
		963	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		964
		965	=item $ctx = $mem->context
		966
		967	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		968
		969	=item $mem = $mem->associated_memobject
		970
		971	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		972
		973	=item $int = $mem->offset
		974
		975	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		976
		977	=for gengetinfo end mem
		978
		979	=item ($type, $name) = $mem->gl_object_info
		980
		981	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		982	object "name" (e.g. the texture name) used to create this memory object.
		983
		984	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		985
538	=back	986	=back
539		987
		988	=head2 THE OpenCL::Buffer CLASS
		989
		990	This is a subclass of OpenCL::Memory, and the superclass of
		991	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		992	and sub-buffers.
		993
		994	=head2 THE OpenCL::BufferObj CLASS
		995
		996	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		997	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		998	sub buffers from these sub buffers.
		999
		1000	=over 4
		1001
		1002	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1003
		1004	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1005	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1006
		1007	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1008
		1009	=back
		1010
		1011	=head2 THE OpenCL::Image CLASS
		1012
		1013	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		1014
		1015	=over 4
		1016
		1017	=item $packed_value = $ev->image_info ($name)
		1018
		1019	See C<< $platform->info >> for details.
		1020
		1021	The reason this method is not called C<info> is that there already is an
		1022	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1023
		1024	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1025
		1026	=for gengetinfo begin image
		1027
		1028	=item $int = $image->element_size
		1029
		1030	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1031
		1032	=item $int = $image->row_pitch
		1033
		1034	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1035
		1036	=item $int = $image->slice_pitch
		1037
		1038	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1039
		1040	=item $int = $image->width
		1041
		1042	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1043
		1044	=item $int = $image->height
		1045
		1046	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1047
		1048	=item $int = $image->depth
		1049
		1050	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1051
		1052	=for gengetinfo end image
		1053
		1054	=for gengetinfo begin gl_texture
		1055
		1056	=item $GLenum = $gl_texture->target
		1057
		1058	Calls C<clGetGlTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1059
		1060	=item $GLint = $gl_texture->gl_mipmap_level
		1061
		1062	Calls C<clGetGlTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1063
		1064	=for gengetinfo end gl_texture
		1065
		1066	=back
		1067
540	=head2 THE OpenCL::Sampler CLASS	1068	=head2 THE OpenCL::Sampler CLASS
541		1069
542	=over 4	1070	=over 4
543		1071
544	=item $packed_value = $sampler->info ($name)	1072	=item $packed_value = $sampler->info ($name)
545		1073
546	See C<< $platform->info >> for details.	1074	See C<< $platform->info >> for details.
547		1075
548	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1076	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
549		1077
		1078	=for gengetinfo begin sampler
		1079
		1080	=item $uint = $sampler->reference_count
		1081
		1082	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1083
		1084	=item $ctx = $sampler->context
		1085
		1086	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1087
		1088	=item $addressing_mode = $sampler->normalized_coords
		1089
		1090	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1091
		1092	=item $filter_mode = $sampler->addressing_mode
		1093
		1094	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1095
		1096	=item $boolean = $sampler->filter_mode
		1097
		1098	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1099
		1100	=for gengetinfo end sampler
		1101
550	=back	1102	=back
551		1103
552	=head2 THE OpenCL::Program CLASS	1104	=head2 THE OpenCL::Program CLASS
553		1105
554	=over 4	1106	=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		1107
562	=item $program->build ($device, $options = "")	1108	=item $program->build ($device, $options = "")
563		1109
564	Tries to build the program with the givne options.	1110	Tries to build the program with the givne options.
565		1111
…		…
577	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1123	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
578	the program.	1124	the program.
579		1125
580	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1126	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
581		1127
		1128	=for gengetinfo begin program_build
		1129
		1130	=item $build_status = $program->build_status ($device)
		1131
		1132	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1133
		1134	=item $string = $program->build_options ($device)
		1135
		1136	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1137
		1138	=item $string = $program->build_log ($device)
		1139
		1140	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1141
		1142	=for gengetinfo end program_build
		1143
		1144	=item $packed_value = $program->info ($name)
		1145
		1146	See C<< $platform->info >> for details.
		1147
		1148	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1149
		1150	=for gengetinfo begin program
		1151
		1152	=item $uint = $program->reference_count
		1153
		1154	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1155
		1156	=item $ctx = $program->context
		1157
		1158	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1159
		1160	=item $uint = $program->num_devices
		1161
		1162	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1163
		1164	=item @devices = $program->devices
		1165
		1166	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1167
		1168	=item $string = $program->source
		1169
		1170	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1171
		1172	=item @ints = $program->binary_sizes
		1173
		1174	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1175
		1176	=for gengetinfo end program
		1177
		1178	=item @blobs = $program->binaries
		1179
		1180	Returns a string for the compiled binary for every device associated with
		1181	the program, empty strings indicate missing programs, and an empty result
		1182	means no program binaries are available.
		1183
		1184	These "binaries" are often, in fact, informative low-level assembly
		1185	sources.
		1186
		1187	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1188
582	=back	1189	=back
583		1190
584	=head2 THE OpenCL::Kernel CLASS	1191	=head2 THE OpenCL::Kernel CLASS
585		1192
586	=over 4	1193	=over 4
…		…
588	=item $packed_value = $kernel->info ($name)	1195	=item $packed_value = $kernel->info ($name)
589		1196
590	See C<< $platform->info >> for details.	1197	See C<< $platform->info >> for details.
591		1198
592	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1199	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1200
		1201	=for gengetinfo begin kernel
		1202
		1203	=item $string = $kernel->function_name
		1204
		1205	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1206
		1207	=item $uint = $kernel->num_args
		1208
		1209	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1210
		1211	=item $uint = $kernel->reference_count
		1212
		1213	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1214
		1215	=item $ctx = $kernel->context
		1216
		1217	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1218
		1219	=item $program = $kernel->program
		1220
		1221	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1222
		1223	=for gengetinfo end kernel
		1224
		1225	=item $packed_value = $kernel->work_group_info ($device, $name)
		1226
		1227	See C<< $platform->info >> for details.
		1228
		1229	The reason this method is not called C<info> is that there already is an
		1230	C<< ->info >> method.
		1231
		1232	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1233
		1234	=for gengetinfo begin kernel_work_group
		1235
		1236	=item $int = $kernel->work_group_size ($device)
		1237
		1238	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1239
		1240	=item @ints = $kernel->compile_work_group_size ($device)
		1241
		1242	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1243
		1244	=item $ulong = $kernel->local_mem_size ($device)
		1245
		1246	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1247
		1248	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1249
		1250	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1251
		1252	=item $ulong = $kernel->private_mem_size ($device)
		1253
		1254	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1255
		1256	=for gengetinfo end kernel_work_group
593		1257
594	=item $kernel->set_TYPE ($index, $value)	1258	=item $kernel->set_TYPE ($index, $value)
595		1259
596	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1260	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
597		1261
…		…
613	This is the superclass for all event objects (including OpenCL::UserEvent	1277	This is the superclass for all event objects (including OpenCL::UserEvent
614	objects).	1278	objects).
615		1279
616	=over 4	1280	=over 4
617		1281
		1282	=item $ev->wait
		1283
		1284	Waits for the event to complete.
		1285
		1286	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1287
618	=item $packed_value = $ev->info ($name)	1288	=item $packed_value = $ev->info ($name)
619		1289
620	See C<< $platform->info >> for details.	1290	See C<< $platform->info >> for details.
621		1291
622	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1292	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
623		1293
624	=item $ev->wait	1294	=for gengetinfo begin event
625		1295
626	Waits for the event to complete.	1296	=item $queue = $event->command_queue
627		1297
		1298	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1299
		1300	=item $command_type = $event->command_type
		1301
		1302	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1303
		1304	=item $uint = $event->reference_count
		1305
		1306	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1307
		1308	=item $uint = $event->command_execution_status
		1309
		1310	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1311
		1312	=item $ctx = $event->context
		1313
		1314	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1315
		1316	=for gengetinfo end event
		1317
		1318	=item $packed_value = $ev->profiling_info ($name)
		1319
		1320	See C<< $platform->info >> for details.
		1321
		1322	The reason this method is not called C<info> is that there already is an
		1323	C<< ->info >> method.
		1324
628	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1325	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1326
		1327	=for gengetinfo begin profiling
		1328
		1329	=item $ulong = $event->profiling_command_queued
		1330
		1331	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1332
		1333	=item $ulong = $event->profiling_command_submit
		1334
		1335	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1336
		1337	=item $ulong = $event->profiling_command_start
		1338
		1339	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1340
		1341	=item $ulong = $event->profiling_command_end
		1342
		1343	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1344
		1345	=for gengetinfo end profiling
629		1346
630	=back	1347	=back
631		1348
632	=head2 THE OpenCL::UserEvent CLASS	1349	=head2 THE OpenCL::UserEvent CLASS
633		1350
…		…
646	package OpenCL;	1363	package OpenCL;
647		1364
648	use common::sense;	1365	use common::sense;
649		1366
650	BEGIN {	1367	BEGIN {
651	our $VERSION = '0.14';	1368	our $VERSION = '0.92';
652		1369
653	require XSLoader;	1370	require XSLoader;
654	XSLoader::load (__PACKAGE__, $VERSION);	1371	XSLoader::load (__PACKAGE__, $VERSION);
655		1372
656	@OpenCL::Buffer::ISA =	1373	@OpenCL::Buffer::ISA =
657	@OpenCL::Image::ISA = OpenCL::Memory::;	1374	@OpenCL::Image::ISA = OpenCL::Memory::;
658		1375
		1376	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1377
659	@OpenCL::Image2D::ISA =	1378	@OpenCL::Image2D::ISA =
660	@OpenCL::Image3D::ISA = OpenCL::Image::;	1379	@OpenCL::Image3D::ISA = OpenCL::Image::;
661		1380
662	@OpenCL::UserEvent::ISA = OpenCL::Event::;	1381	@OpenCL::UserEvent::ISA = OpenCL::Event::;
663	}	1382	}
664		1383
665	1;	1384	1;
666		1385
667	=head1 AUTHOR	1386	=head1 AUTHOR

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.15 by root, Thu Nov 17 03:05:56 2011 UTC vs. Revision 1.35 by root, Thu Apr 19 13:18:31 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.15 by root, Thu Nov 17 03:05:56 2011 UTC vs.
Revision 1.35 by root, Thu Apr 19 13:18:31 2012 UTC