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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs.
Revision 1.26 by root, Tue Nov 22 10:44:56 2011 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 = $device->context;
111	# do stuff	111	# do stuff
112	}	112	}
113	}	113	}
114		114
…		…
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 (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<< $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<$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-	238	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		239	function calls.
238		240
239	=item * Structures are often specified with their components, and returned	241	=item * Structures are often specified by flattening out their components
240	as arrayrefs.	242	as with short vectors, and returned as arrayrefs.
241
242	=item * Where possible, one of the pitch values is calculated from the
243	perl scalar length and need not be specified.
244		243
245	=item * When enqueuing commands, the wait list is specified by adding	244	=item * When enqueuing commands, the wait list is specified by adding
246	extra arguments to the function - anywhere a C<$wait_events...> argument	245	extra arguments to the function - anywhere a C<$wait_events...> argument
247	is documented this can be any number of event objects.	246	is documented this can be any number of event objects.
248		247
…		…
317		316
318	=head2 THE OpenCL::Platform CLASS	317	=head2 THE OpenCL::Platform CLASS
319		318
320	=over 4	319	=over 4
321		320
322	=item $packed_value = $platform->info ($name)
323
324	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
325	strings, this will be the string, for other values you probably need to
326	use the correct C<unpack>. This might get improved in the future. Hopefully.
327
328	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
329
330	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
331		322
332	Returns a list of matching OpenCL::Device objects.	323	Returns a list of matching OpenCL::Device objects.
333		324
334	=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)
335		326
336	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.
337		328
338	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>
339		330
340	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)
341		332
342	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
343	CL_CONTEXT_PLATFORM property is supplied automatically.	334	CL_CONTEXT_PLATFORM property is supplied automatically.
344		335
345	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>
346		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
347	=back	373	=back
348		374
349	=head2 THE OpenCL::Device CLASS	375	=head2 THE OpenCL::Device CLASS
350		376
351	=over 4	377	=over 4
…		…
354		380
355	See C<< $platform->info >> for details.	381	See C<< $platform->info >> for details.
356		382
357	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>
358		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
359	=back	653	=back
360		654
361	=head2 THE OpenCL::Context CLASS	655	=head2 THE OpenCL::Context CLASS
362		656
363	=over 4	657	=over 4
364
365	=item $packed_value = $ctx->info ($name)
366
367	See C<< $platform->info >> for details.
368
369	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
370		658
371	=item $queue = $ctx->queue ($device, $properties)	659	=item $queue = $ctx->queue ($device, $properties)
372		660
373	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.
374		662
…		…
418	=item $program = $ctx->program_with_source ($string)	706	=item $program = $ctx->program_with_source ($string)
419		707
420	Creates a new OpenCL::Program object from the given source code.	708	Creates a new OpenCL::Program object from the given source code.
421		709
422	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	710	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		711
		712	=item $packed_value = $ctx->info ($name)
		713
		714	See C<< $platform->info >> for details.
		715
		716	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		717
		718	=for gengetinfo begin context
		719
		720	=item $uint = $context->reference_count
		721
		722	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		723
		724	=item @devices = $context->devices
		725
		726	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		727
		728	=item @property_ints = $context->properties
		729
		730	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		731
		732	=item $uint = $context->num_devices
		733
		734	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		735
		736	=for gengetinfo end context
423		737
424	=back	738	=back
425		739
426	=head2 THE OpenCL::Queue CLASS	740	=head2 THE OpenCL::Queue CLASS
427		741
…		…
441	cases (i.e. you use only one queue) it's not necessary to wait for or	755	cases (i.e. you use only one queue) it's not necessary to wait for or
442	create event objects.	756	create event objects.
443		757
444	=over 4	758	=over 4
445		759
446	=item $packed_value = $ctx->info ($name)
447
448	See C<< $platform->info >> for details.
449
450	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
451
452	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	760	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
453		761
454	Reads data from buffer into the given string.	762	Reads data from buffer into the given string.
455		763
456	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	764	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
462	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	770	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
463		771
464	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	772	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
465		773
466	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	774	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
		775
		776	=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...)
		777
		778	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		779
		780	=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...)
		781
		782	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
467		783
468	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	784	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
469		785
470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	786	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
471		787
…		…
531		847
532	=item $queue->finish	848	=item $queue->finish
533		849
534	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	850	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
535		851
		852	=item $packed_value = $queue->info ($name)
		853
		854	See C<< $platform->info >> for details.
		855
		856	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		857
		858	=for gengetinfo begin command_queue
		859
		860	=item $ctx = $command_queue->context
		861
		862	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		863
		864	=item $device = $command_queue->device
		865
		866	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		867
		868	=item $uint = $command_queue->reference_count
		869
		870	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		871
		872	=item $command_queue_properties = $command_queue->properties
		873
		874	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		875
		876	=for gengetinfo end command_queue
		877
536	=back	878	=back
537		879
538	=head2 THE OpenCL::Memory CLASS	880	=head2 THE OpenCL::Memory CLASS
539		881
540	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	882	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
541	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	883	OpenCL::Image2D and OpenCL::Image3D.
542	currently only exist to allow type-checking.
543		884
544	=over 4	885	=over 4
545		886
546	=item $packed_value = $memory->info ($name)	887	=item $packed_value = $memory->info ($name)
547		888
548	See C<< $platform->info >> for details.	889	See C<< $platform->info >> for details.
549		890
550	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	891	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
551		892
		893	=for gengetinfo begin mem
		894
		895	=item $mem_object_type = $mem->type
		896
		897	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		898
		899	=item $mem_flags = $mem->flags
		900
		901	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		902
		903	=item $int = $mem->size
		904
		905	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		906
		907	=item $ptr_value = $mem->host_ptr
		908
		909	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		910
		911	=item $uint = $mem->map_count
		912
		913	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		914
		915	=item $uint = $mem->reference_count
		916
		917	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		918
		919	=item $ctx = $mem->context
		920
		921	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		922
		923	=item $mem = $mem->associated_memobject
		924
		925	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		926
		927	=item $int = $mem->offset
		928
		929	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		930
		931	=for gengetinfo end mem
		932
552	=back	933	=back
553		934
		935	=head2 THE OpenCL::Image CLASS
		936
		937	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		938
		939	=over 4
		940
		941	=item $packed_value = $ev->image_info ($name)
		942
		943	See C<< $platform->info >> for details.
		944
		945	The reason this method is not called C<info> is that there already is an
		946	C<< ->info >> method inherited from C<OpenCL::Memory>.
		947
		948	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		949
		950	=for gengetinfo begin image
		951
		952	=item $int = $image->element_size
		953
		954	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		955
		956	=item $int = $image->row_pitch
		957
		958	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		959
		960	=item $int = $image->slice_pitch
		961
		962	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		963
		964	=item $int = $image->width
		965
		966	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		967
		968	=item $int = $image->height
		969
		970	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		971
		972	=item $int = $image->depth
		973
		974	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		975
		976	=for gengetinfo end image
		977
		978	=back
		979
554	=head2 THE OpenCL::Sampler CLASS	980	=head2 THE OpenCL::Sampler CLASS
555		981
556	=over 4	982	=over 4
557		983
558	=item $packed_value = $sampler->info ($name)	984	=item $packed_value = $sampler->info ($name)
559		985
560	See C<< $platform->info >> for details.	986	See C<< $platform->info >> for details.
561		987
562	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	988	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
563		989
		990	=for gengetinfo begin sampler
		991
		992	=item $uint = $sampler->reference_count
		993
		994	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		995
		996	=item $ctx = $sampler->context
		997
		998	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		999
		1000	=item $addressing_mode = $sampler->normalized_coords
		1001
		1002	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1003
		1004	=item $filter_mode = $sampler->addressing_mode
		1005
		1006	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1007
		1008	=item $boolean = $sampler->filter_mode
		1009
		1010	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1011
		1012	=for gengetinfo end sampler
		1013
564	=back	1014	=back
565		1015
566	=head2 THE OpenCL::Program CLASS	1016	=head2 THE OpenCL::Program CLASS
567		1017
568	=over 4	1018	=over 4
569
570	=item $packed_value = $program->info ($name)
571
572	See C<< $platform->info >> for details.
573
574	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
575		1019
576	=item $program->build ($device, $options = "")	1020	=item $program->build ($device, $options = "")
577		1021
578	Tries to build the program with the givne options.	1022	Tries to build the program with the givne options.
579		1023
…		…
591	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1035	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
592	the program.	1036	the program.
593		1037
594	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1038	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
595		1039
		1040	=for gengetinfo begin program_build
		1041
		1042	=item $build_status = $program->build_status ($device)
		1043
		1044	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1045
		1046	=item $string = $program->build_options ($device)
		1047
		1048	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1049
		1050	=item $string = $program->build_log ($device)
		1051
		1052	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1053
		1054	=for gengetinfo end program_build
		1055
		1056	=item $packed_value = $program->info ($name)
		1057
		1058	See C<< $platform->info >> for details.
		1059
		1060	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1061
		1062	=for gengetinfo begin program
		1063
		1064	=item $uint = $program->reference_count
		1065
		1066	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1067
		1068	=item $ctx = $program->context
		1069
		1070	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1071
		1072	=item $uint = $program->num_devices
		1073
		1074	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1075
		1076	=item @devices = $program->devices
		1077
		1078	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1079
		1080	=item $string = $program->source
		1081
		1082	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1083
		1084	=item @ints = $program->binary_sizes
		1085
		1086	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1087
		1088	=for gengetinfo end program
		1089
		1090	=item @blobs = $program->binaries
		1091
		1092	Returns a string for the compiled binary for every device associated with
		1093	the program, empty strings indicate missing programs, and an empty result
		1094	means no program binaries are available.
		1095
		1096	These "binaries" are often, in fact, informative low-level assembly
		1097	sources.
		1098
		1099	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1100
596	=back	1101	=back
597		1102
598	=head2 THE OpenCL::Kernel CLASS	1103	=head2 THE OpenCL::Kernel CLASS
599		1104
600	=over 4	1105	=over 4
…		…
602	=item $packed_value = $kernel->info ($name)	1107	=item $packed_value = $kernel->info ($name)
603		1108
604	See C<< $platform->info >> for details.	1109	See C<< $platform->info >> for details.
605		1110
606	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1111	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1112
		1113	=for gengetinfo begin kernel
		1114
		1115	=item $string = $kernel->function_name
		1116
		1117	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1118
		1119	=item $uint = $kernel->num_args
		1120
		1121	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1122
		1123	=item $uint = $kernel->reference_count
		1124
		1125	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1126
		1127	=item $ctx = $kernel->context
		1128
		1129	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1130
		1131	=item $program = $kernel->program
		1132
		1133	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1134
		1135	=for gengetinfo end kernel
		1136
		1137	=item $packed_value = $kernel->work_group_info ($device, $name)
		1138
		1139	See C<< $platform->info >> for details.
		1140
		1141	The reason this method is not called C<info> is that there already is an
		1142	C<< ->info >> method.
		1143
		1144	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1145
		1146	=for gengetinfo begin kernel_work_group
		1147
		1148	=item $int = $kernel->work_group_size ($device)
		1149
		1150	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1151
		1152	=item @ints = $kernel->compile_work_group_size ($device)
		1153
		1154	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1155
		1156	=item $ulong = $kernel->local_mem_size ($device)
		1157
		1158	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1159
		1160	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1161
		1162	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1163
		1164	=item $ulong = $kernel->private_mem_size ($device)
		1165
		1166	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1167
		1168	=for gengetinfo end kernel_work_group
607		1169
608	=item $kernel->set_TYPE ($index, $value)	1170	=item $kernel->set_TYPE ($index, $value)
609		1171
610	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1172	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
611		1173
…		…
627	This is the superclass for all event objects (including OpenCL::UserEvent	1189	This is the superclass for all event objects (including OpenCL::UserEvent
628	objects).	1190	objects).
629		1191
630	=over 4	1192	=over 4
631		1193
		1194	=item $ev->wait
		1195
		1196	Waits for the event to complete.
		1197
		1198	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1199
632	=item $packed_value = $ev->info ($name)	1200	=item $packed_value = $ev->info ($name)
633		1201
634	See C<< $platform->info >> for details.	1202	See C<< $platform->info >> for details.
635		1203
636	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1204	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
637		1205
638	=item $ev->wait	1206	=for gengetinfo begin event
639		1207
640	Waits for the event to complete.	1208	=item $queue = $event->command_queue
641		1209
		1210	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1211
		1212	=item $command_type = $event->command_type
		1213
		1214	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1215
		1216	=item $uint = $event->reference_count
		1217
		1218	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1219
		1220	=item $uint = $event->command_execution_status
		1221
		1222	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1223
		1224	=item $ctx = $event->context
		1225
		1226	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1227
		1228	=for gengetinfo end event
		1229
		1230	=item $packed_value = $ev->profiling_info ($name)
		1231
		1232	See C<< $platform->info >> for details.
		1233
		1234	The reason this method is not called C<info> is that there already is an
		1235	C<< ->info >> method.
		1236
642	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1237	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1238
		1239	=for gengetinfo begin profiling
		1240
		1241	=item $ulong = $event->profiling_command_queued
		1242
		1243	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1244
		1245	=item $ulong = $event->profiling_command_submit
		1246
		1247	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1248
		1249	=item $ulong = $event->profiling_command_start
		1250
		1251	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1252
		1253	=item $ulong = $event->profiling_command_end
		1254
		1255	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1256
		1257	=for gengetinfo end profiling
643		1258
644	=back	1259	=back
645		1260
646	=head2 THE OpenCL::UserEvent CLASS	1261	=head2 THE OpenCL::UserEvent CLASS
647		1262
…		…
660	package OpenCL;	1275	package OpenCL;
661		1276
662	use common::sense;	1277	use common::sense;
663		1278
664	BEGIN {	1279	BEGIN {
665	our $VERSION = '0.15';	1280	our $VERSION = '0.59';
666		1281
667	require XSLoader;	1282	require XSLoader;
668	XSLoader::load (__PACKAGE__, $VERSION);	1283	XSLoader::load (__PACKAGE__, $VERSION);
669		1284
670	@OpenCL::Buffer::ISA =	1285	@OpenCL::Buffer::ISA =

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs. Revision 1.26 by root, Tue Nov 22 10:44:56 2011 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs.
Revision 1.26 by root, Tue Nov 22 10:44:56 2011 UTC