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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.19 by root, Sat Nov 19 19:54:04 2011 UTC vs.
Revision 1.33 by root, Thu Apr 19 12:55:30 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 arrays or structs) and OpenCL::Image objects (think 2d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34	or 3d array) for bulk data and input and output for kernels.	34	or 3d array) for bulk data and input and output for kernels.
35		35
36	OpenCL::Sampler objects, which are kind of like texture filter modes in	36	OpenCL::Sampler objects, which are kind of like texture filter modes in
37	OpenGL.	37	OpenGL.
…		…
101		101
102	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
103	system.	103	system.
104		104
105	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
106	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
107	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
108	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
109	printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
110	my $ctx = $device->context;	110	my $ctx = $platform->context (undef, [$device]);
111	# do stuff	111	# do stuff
112	}	112	}
113	}	113	}
114		114
115	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
…		…
149		149
150	=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
151	functions.	151	functions.
152		152
153	my $src = '	153	my $src = '
154	__kernel void	154	kernel void
155	squareit (__global float input, __global float output)	155	squareit (global float input, global float output)
156	{	156	{
157	$id = get_global_id (0);	157	$id = get_global_id (0);
158	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
159	}	159	}
160	';	160	';
161		161
162	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->program_with_source ($src);
163		163
164	# 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
165	eval { $prog->build ($dev); 1 }	165	eval { $prog->build ($dev); 1 }
166	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);	166	or die $prog->build_log;
167		167
168	my $kernel = $prog->kernel ("squareit");	168	my $kernel = $prog->kernel ("squareit");
169		169
170	=head2 Create some input and output float buffers, then call the	170	=head2 Create some input and output float buffers, then call the
171	'squareit' kernel on them.	171	'squareit' kernel on them.
…		…
226		226
227	=item * Object lifetime managament is automatic - there is no need	227	=item * Object lifetime managament is automatic - there is no need
228	to free objects explicitly (C<clReleaseXXX>), the release function	228	to free objects explicitly (C<clReleaseXXX>), the release function
229	is called automatically once all Perl references to it go away.	229	is called automatically once all Perl references to it go away.
230		230
231	=item * OpenCL uses CamelCase for function names (e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>),	231	=item * OpenCL uses CamelCase for function names
		232	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
232	while this module uses underscores as word separator and often leaves out	233	uses underscores as word separator and often leaves out prefixes
233	prefixes (C<OpenCL::platforms>, C<< $platform->info >>).	234	(C<OpenCL::platforms>, C<< $platform->info >>).
234		235
235	=item * OpenCL often specifies fixed vector function arguments as short	236	=item * OpenCL often specifies fixed vector function arguments as short
236	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
237	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in	238	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
238	function calls.	239	function calls.
…		…
285		286
286	Comverts an error value into a human readable string.	287	Comverts an error value into a human readable string.
287		288
288	=item $str = OpenCL::enum2str $enum	289	=item $str = OpenCL::enum2str $enum
289		290
290	Converts most enum values (inof parameter names, image format constants,	291	Converts most enum values (of parameter names, image format constants,
291	object types, addressing and filter modes, command types etc.) into a	292	object types, addressing and filter modes, command types etc.) into a
292	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
293	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
294	string out of it.	295	string out of it.
295		296
296	=item @platforms = OpenCL::platforms	297	=item @platforms = OpenCL::platforms
297		298
…		…
315		316
316	=head2 THE OpenCL::Platform CLASS	317	=head2 THE OpenCL::Platform CLASS
317		318
318	=over 4	319	=over 4
319		320
320	=item $packed_value = $platform->info ($name)
321
322	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
323	strings, this will be the string, for other values you probably need to
324	use the correct C<unpack>. This might get improved in the future. Hopefully.
325
326	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
327
328	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
329		322
330	Returns a list of matching OpenCL::Device objects.	323	Returns a list of matching OpenCL::Device objects.
331		324
332	=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)
333		326
334	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.
335		328
336	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>
337		330
338	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	331	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
339		332
340	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
341	CL_CONTEXT_PLATFORM property is supplied automatically.	334	CL_CONTEXT_PLATFORM property is supplied automatically.
342		335
343	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>
344		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
345	=back	373	=back
346		374
347	=head2 THE OpenCL::Device CLASS	375	=head2 THE OpenCL::Device CLASS
348		376
349	=over 4	377	=over 4
…		…
352		380
353	See C<< $platform->info >> for details.	381	See C<< $platform->info >> for details.
354		382
355	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>
356		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
357	=back	653	=back
358		654
359	=head2 THE OpenCL::Context CLASS	655	=head2 THE OpenCL::Context CLASS
360		656
361	=over 4	657	=over 4
362		658
363	=item $packed_value = $ctx->info ($name)
364
365	See C<< $platform->info >> for details.
366
367	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
368
369	=item $queue = $ctx->queue ($device, $properties)	659	=item $queue = $ctx->queue ($device, $properties)
370		660
371	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.
372		662
373	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>
…		…
378		668
379	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>
380		670
381	=item $buf = $ctx->buffer ($flags, $len)	671	=item $buf = $ctx->buffer ($flags, $len)
382		672
383	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.
384		675
385	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>
386		677
387	=item $buf = $ctx->buffer_sv ($flags, $data)	678	=item $buf = $ctx->buffer_sv ($flags, $data)
388		679
389	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.
390		682
391	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	683	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
392		684
393	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.
394		687
395	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>
396		689
397	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)	690	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
398		691
399	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.
400		694
401	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
402		724
403	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	725	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
404		726
405	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
406	two values, $channel_order and $channel_type, in it.	728	two values, $channel_order and $channel_type, in it.
…		…
416	=item $program = $ctx->program_with_source ($string)	738	=item $program = $ctx->program_with_source ($string)
417		739
418	Creates a new OpenCL::Program object from the given source code.	740	Creates a new OpenCL::Program object from the given source code.
419		741
420	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
421		769
422	=back	770	=back
423		771
424	=head2 THE OpenCL::Queue CLASS	772	=head2 THE OpenCL::Queue CLASS
425		773
…		…
439	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
440	create event objects.	788	create event objects.
441		789
442	=over 4	790	=over 4
443		791
444	=item $packed_value = $ctx->info ($name)
445
446	See C<< $platform->info >> for details.
447
448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
449
450	=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...)
451		793
452	Reads data from buffer into the given string.	794	Reads data from buffer into the given string.
453		795
454	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>
…		…
461		803
462	=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...)
463		805
464	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>
465		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
466	=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...)
467		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
468	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>
469		823
470	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_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...)
471		825
472	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>
473		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
474	=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...)	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...)
475		837
476	Yeah.	838	Yeah.
477		839
478	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
479
480	=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...)
481
482	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>.
483
484	=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...)
485
486	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
487
488	=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...)
489
490	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
491		841
492	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	842	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
493		843
494	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>
495		845
…		…
529		879
530	=item $queue->finish	880	=item $queue->finish
531		881
532	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	882	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
533		883
		884	=item $packed_value = $queue->info ($name)
		885
		886	See C<< $platform->info >> for details.
		887
		888	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		889
		890	=for gengetinfo begin command_queue
		891
		892	=item $ctx = $command_queue->context
		893
		894	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		895
		896	=item $device = $command_queue->device
		897
		898	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		899
		900	=item $uint = $command_queue->reference_count
		901
		902	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		903
		904	=item $command_queue_properties = $command_queue->properties
		905
		906	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		907
		908	=for gengetinfo end command_queue
		909
534	=back	910	=back
535		911
536	=head2 THE OpenCL::Memory CLASS	912	=head2 THE OpenCL::Memory CLASS
537		913
538	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	914	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
539	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	915	OpenCL::Image2D and OpenCL::Image3D.
540	currently only exist to allow type-checking.
541		916
542	=over 4	917	=over 4
543		918
544	=item $packed_value = $memory->info ($name)	919	=item $packed_value = $memory->info ($name)
545		920
546	See C<< $platform->info >> for details.	921	See C<< $platform->info >> for details.
547		922
548	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	923	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
549		924
		925	=for gengetinfo begin mem
		926
		927	=item $mem_object_type = $mem->type
		928
		929	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		930
		931	=item $mem_flags = $mem->flags
		932
		933	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		934
		935	=item $int = $mem->size
		936
		937	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		938
		939	=item $ptr_value = $mem->host_ptr
		940
		941	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		942
		943	=item $uint = $mem->map_count
		944
		945	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		946
		947	=item $uint = $mem->reference_count
		948
		949	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		950
		951	=item $ctx = $mem->context
		952
		953	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		954
		955	=item $mem = $mem->associated_memobject
		956
		957	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		958
		959	=item $int = $mem->offset
		960
		961	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		962
		963	=for gengetinfo end mem
		964
550	=back	965	=back
551		966
		967	=head2 THE OpenCL::Buffer CLASS
		968
		969	This is a subclass of OpenCL::Memory, and the superclass of
		970	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		971	and sub-buffers.
		972
		973	=head2 THE OpenCL::BufferObj CLASS
		974
		975	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		976	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		977	sub buffers from these sub buffers.
		978
		979	=over 4
		980
		981	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		982
		983	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		984	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		985
		986	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		987
		988	=back
		989
		990	=head2 THE OpenCL::Image CLASS
		991
		992	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		993
		994	=over 4
		995
		996	=item $packed_value = $ev->image_info ($name)
		997
		998	See C<< $platform->info >> for details.
		999
		1000	The reason this method is not called C<info> is that there already is an
		1001	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1002
		1003	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1004
		1005	=for gengetinfo begin image
		1006
		1007	=item $int = $image->element_size
		1008
		1009	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1010
		1011	=item $int = $image->row_pitch
		1012
		1013	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1014
		1015	=item $int = $image->slice_pitch
		1016
		1017	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1018
		1019	=item $int = $image->width
		1020
		1021	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1022
		1023	=item $int = $image->height
		1024
		1025	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1026
		1027	=item $int = $image->depth
		1028
		1029	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1030
		1031	=for gengetinfo end image
		1032
		1033	=back
		1034
552	=head2 THE OpenCL::Sampler CLASS	1035	=head2 THE OpenCL::Sampler CLASS
553		1036
554	=over 4	1037	=over 4
555		1038
556	=item $packed_value = $sampler->info ($name)	1039	=item $packed_value = $sampler->info ($name)
557		1040
558	See C<< $platform->info >> for details.	1041	See C<< $platform->info >> for details.
559		1042
560	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
561		1044
		1045	=for gengetinfo begin sampler
		1046
		1047	=item $uint = $sampler->reference_count
		1048
		1049	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1050
		1051	=item $ctx = $sampler->context
		1052
		1053	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1054
		1055	=item $addressing_mode = $sampler->normalized_coords
		1056
		1057	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1058
		1059	=item $filter_mode = $sampler->addressing_mode
		1060
		1061	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1062
		1063	=item $boolean = $sampler->filter_mode
		1064
		1065	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1066
		1067	=for gengetinfo end sampler
		1068
562	=back	1069	=back
563		1070
564	=head2 THE OpenCL::Program CLASS	1071	=head2 THE OpenCL::Program CLASS
565		1072
566	=over 4	1073	=over 4
567
568	=item $packed_value = $program->info ($name)
569
570	See C<< $platform->info >> for details.
571
572	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
573		1074
574	=item $program->build ($device, $options = "")	1075	=item $program->build ($device, $options = "")
575		1076
576	Tries to build the program with the givne options.	1077	Tries to build the program with the givne options.
577		1078
…		…
589	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1090	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
590	the program.	1091	the program.
591		1092
592	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1093	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
593		1094
		1095	=for gengetinfo begin program_build
		1096
		1097	=item $build_status = $program->build_status ($device)
		1098
		1099	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1100
		1101	=item $string = $program->build_options ($device)
		1102
		1103	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1104
		1105	=item $string = $program->build_log ($device)
		1106
		1107	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1108
		1109	=for gengetinfo end program_build
		1110
		1111	=item $packed_value = $program->info ($name)
		1112
		1113	See C<< $platform->info >> for details.
		1114
		1115	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1116
		1117	=for gengetinfo begin program
		1118
		1119	=item $uint = $program->reference_count
		1120
		1121	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1122
		1123	=item $ctx = $program->context
		1124
		1125	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1126
		1127	=item $uint = $program->num_devices
		1128
		1129	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1130
		1131	=item @devices = $program->devices
		1132
		1133	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1134
		1135	=item $string = $program->source
		1136
		1137	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1138
		1139	=item @ints = $program->binary_sizes
		1140
		1141	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1142
		1143	=for gengetinfo end program
		1144
		1145	=item @blobs = $program->binaries
		1146
		1147	Returns a string for the compiled binary for every device associated with
		1148	the program, empty strings indicate missing programs, and an empty result
		1149	means no program binaries are available.
		1150
		1151	These "binaries" are often, in fact, informative low-level assembly
		1152	sources.
		1153
		1154	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1155
594	=back	1156	=back
595		1157
596	=head2 THE OpenCL::Kernel CLASS	1158	=head2 THE OpenCL::Kernel CLASS
597		1159
598	=over 4	1160	=over 4
…		…
600	=item $packed_value = $kernel->info ($name)	1162	=item $packed_value = $kernel->info ($name)
601		1163
602	See C<< $platform->info >> for details.	1164	See C<< $platform->info >> for details.
603		1165
604	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1166	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1167
		1168	=for gengetinfo begin kernel
		1169
		1170	=item $string = $kernel->function_name
		1171
		1172	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1173
		1174	=item $uint = $kernel->num_args
		1175
		1176	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1177
		1178	=item $uint = $kernel->reference_count
		1179
		1180	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1181
		1182	=item $ctx = $kernel->context
		1183
		1184	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1185
		1186	=item $program = $kernel->program
		1187
		1188	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1189
		1190	=for gengetinfo end kernel
		1191
		1192	=item $packed_value = $kernel->work_group_info ($device, $name)
		1193
		1194	See C<< $platform->info >> for details.
		1195
		1196	The reason this method is not called C<info> is that there already is an
		1197	C<< ->info >> method.
		1198
		1199	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1200
		1201	=for gengetinfo begin kernel_work_group
		1202
		1203	=item $int = $kernel->work_group_size ($device)
		1204
		1205	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1206
		1207	=item @ints = $kernel->compile_work_group_size ($device)
		1208
		1209	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1210
		1211	=item $ulong = $kernel->local_mem_size ($device)
		1212
		1213	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1214
		1215	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1216
		1217	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1218
		1219	=item $ulong = $kernel->private_mem_size ($device)
		1220
		1221	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1222
		1223	=for gengetinfo end kernel_work_group
605		1224
606	=item $kernel->set_TYPE ($index, $value)	1225	=item $kernel->set_TYPE ($index, $value)
607		1226
608	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1227	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
609		1228
…		…
625	This is the superclass for all event objects (including OpenCL::UserEvent	1244	This is the superclass for all event objects (including OpenCL::UserEvent
626	objects).	1245	objects).
627		1246
628	=over 4	1247	=over 4
629		1248
		1249	=item $ev->wait
		1250
		1251	Waits for the event to complete.
		1252
		1253	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1254
630	=item $packed_value = $ev->info ($name)	1255	=item $packed_value = $ev->info ($name)
631		1256
632	See C<< $platform->info >> for details.	1257	See C<< $platform->info >> for details.
633		1258
634	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1259	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
635		1260
636	=item $ev->wait	1261	=for gengetinfo begin event
637		1262
638	Waits for the event to complete.	1263	=item $queue = $event->command_queue
639		1264
		1265	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1266
		1267	=item $command_type = $event->command_type
		1268
		1269	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1270
		1271	=item $uint = $event->reference_count
		1272
		1273	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1274
		1275	=item $uint = $event->command_execution_status
		1276
		1277	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1278
		1279	=item $ctx = $event->context
		1280
		1281	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1282
		1283	=for gengetinfo end event
		1284
		1285	=item $packed_value = $ev->profiling_info ($name)
		1286
		1287	See C<< $platform->info >> for details.
		1288
		1289	The reason this method is not called C<info> is that there already is an
		1290	C<< ->info >> method.
		1291
640	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1292	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1293
		1294	=for gengetinfo begin profiling
		1295
		1296	=item $ulong = $event->profiling_command_queued
		1297
		1298	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1299
		1300	=item $ulong = $event->profiling_command_submit
		1301
		1302	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1303
		1304	=item $ulong = $event->profiling_command_start
		1305
		1306	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1307
		1308	=item $ulong = $event->profiling_command_end
		1309
		1310	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1311
		1312	=for gengetinfo end profiling
641		1313
642	=back	1314	=back
643		1315
644	=head2 THE OpenCL::UserEvent CLASS	1316	=head2 THE OpenCL::UserEvent CLASS
645		1317
…		…
658	package OpenCL;	1330	package OpenCL;
659		1331
660	use common::sense;	1332	use common::sense;
661		1333
662	BEGIN {	1334	BEGIN {
663	our $VERSION = '0.15';	1335	our $VERSION = '0.92';
664		1336
665	require XSLoader;	1337	require XSLoader;
666	XSLoader::load (__PACKAGE__, $VERSION);	1338	XSLoader::load (__PACKAGE__, $VERSION);
667		1339
668	@OpenCL::Buffer::ISA =	1340	@OpenCL::Buffer::ISA =
669	@OpenCL::Image::ISA = OpenCL::Memory::;	1341	@OpenCL::Image::ISA = OpenCL::Memory::;
670		1342
		1343	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1344
671	@OpenCL::Image2D::ISA =	1345	@OpenCL::Image2D::ISA =
672	@OpenCL::Image3D::ISA = OpenCL::Image::;	1346	@OpenCL::Image3D::ISA = OpenCL::Image::;
673		1347
674	@OpenCL::UserEvent::ISA = OpenCL::Event::;	1348	@OpenCL::UserEvent::ISA = OpenCL::Event::;
675	}	1349	}
676		1350
677	1;	1351	1;
678		1352
679	=head1 AUTHOR	1353	=head1 AUTHOR

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.19 by root, Sat Nov 19 19:54:04 2011 UTC vs. Revision 1.33 by root, Thu Apr 19 12:55:30 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.19 by root, Sat Nov 19 19:54:04 2011 UTC vs.
Revision 1.33 by root, Thu Apr 19 12:55:30 2012 UTC