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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.17 by root, Thu Nov 17 03:56:07 2011 UTC vs.
Revision 1.22 by root, Sun Nov 20 10:25:17 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.
…		…
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
57	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it	62	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
58	is, but at least it's free of charge:	63	is, but at least it's free of charge:
59		64
60	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf	65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
61		66
62	If you are into UML class diagrams, the following diagram might help - if	67	And here's NVIDIA's OpenCL Best Practises Guide:
63	not, it will be mildly cofusing:
64		68
65	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html	69	http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
66		70
67	=head1 BASIC WORKFLOW	71	=head1 BASIC WORKFLOW
68		72
69	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
70	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):
…		…
222		226
223	=item * Object lifetime managament is automatic - there is no need	227	=item * Object lifetime managament is automatic - there is no need
224	to free objects explicitly (C<clReleaseXXX>), the release function	228	to free objects explicitly (C<clReleaseXXX>), the release function
225	is called automatically once all Perl references to it go away.	229	is called automatically once all Perl references to it go away.
226		230
227	=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
228	while this module uses underscores as word separator and often leaves out	233	uses underscores as word separator and often leaves out prefixes
229	prefixes (C<< $platform->info >>).	234	(C<OpenCL::platforms>, C<< $platform->info >>).
230		235
231	=item * OpenCL often specifies fixed vector function arguments as short	236	=item * OpenCL often specifies fixed vector function arguments as short
232	arrays (C<$origin[3]>), while this module explicitly expects the	237	arrays (C<size_t origin[3]>), while this module explicitly expects the
233	components as separate arguments-	238	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		239	function calls.
234		240
235	=item * Structures are often specified with their components, and returned	241	=item * Structures are often specified by flattening out their components
236	as arrayrefs.	242	as with short vectors, and returned as arrayrefs.
237
238	=item * Where possible, one of the pitch values is calculated from the
239	perl scalar length and need not be specified.
240		243
241	=item * When enqueuing commands, the wait list is specified by adding	244	=item * When enqueuing commands, the wait list is specified by adding
242	extra arguments to the function - anywhere a C<$wait_events...> argument	245	extra arguments to the function - anywhere a C<$wait_events...> argument
243	is documented this can be any number of event objects.	246	is documented this can be any number of event objects.
244		247
…		…
313		316
314	=head2 THE OpenCL::Platform CLASS	317	=head2 THE OpenCL::Platform CLASS
315		318
316	=over 4	319	=over 4
317		320
318	=item $packed_value = $platform->info ($name)
319
320	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
321	strings, this will be the string, for other values you probably need to
322	use the correct C<unpack>. This might get improved in the future. Hopefully.
323
324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
325
326	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
327		322
328	Returns a list of matching OpenCL::Device objects.	323	Returns a list of matching OpenCL::Device objects.
329		324
330	=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)
331		326
332	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.
333		328
334	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>
335		330
336	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)
337		332
338	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
339	CL_CONTEXT_PLATFORM property is supplied automatically.	334	CL_CONTEXT_PLATFORM property is supplied automatically.
340		335
341	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>
342		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(s).
		354
		355	=item $string = $platform->version
		356
		357	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s).
		358
		359	=item $string = $platform->name
		360
		361	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s).
		362
		363	=item $string = $platform->vendor
		364
		365	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s).
		366
		367	=item $string = $platform->extensions
		368
		369	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s).
		370
		371	=for gengetinfo end platform
		372
343	=back	373	=back
344		374
345	=head2 THE OpenCL::Device CLASS	375	=head2 THE OpenCL::Device CLASS
346		376
347	=over 4	377	=over 4
…		…
350		380
351	See C<< $platform->info >> for details.	381	See C<< $platform->info >> for details.
352		382
353	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>
354		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(s).
		390
		391	=item $uint = $device->vendor_id
		392
		393	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s).
		394
		395	=item $uint = $device->max_compute_units
		396
		397	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		434
		435	=item $uint = $device->max_clock_frequency
		436
		437	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s).
		438
		439	=item $bitfield = $device->address_bits
		440
		441	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s).
		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(s).
		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(s).
		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(s).
		454
		455	=item $int = $device->image2d_max_width
		456
		457	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s).
		458
		459	=item $int = $device->image2d_max_height
		460
		461	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s).
		462
		463	=item $int = $device->image3d_max_width
		464
		465	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s).
		466
		467	=item $int = $device->image3d_max_height
		468
		469	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s).
		470
		471	=item $int = $device->image3d_max_depth
		472
		473	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s).
		474
		475	=item $uint = $device->image_support
		476
		477	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s).
		478
		479	=item $int = $device->max_parameter_size
		480
		481	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s).
		482
		483	=item $uint = $device->max_samplers
		484
		485	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		510
		511	=item $ulong = $device->global_mem_size
		512
		513	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s).
		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(s).
		518
		519	=item $uint = $device->max_constant_args
		520
		521	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s).
		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(s).
		526
		527	=item $ulong = $device->local_mem_size
		528
		529	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s).
		530
		531	=item $boolean = $device->error_correction_support
		532
		533	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s).
		534
		535	=item $int = $device->profiling_timer_resolution
		536
		537	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s).
		538
		539	=item $boolean = $device->endian_little
		540
		541	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s).
		542
		543	=item $boolean = $device->available
		544
		545	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s).
		546
		547	=item $boolean = $device->compiler_available
		548
		549	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s).
		550
		551	=item $device_exec_capabilities = $device->execution_capabilities
		552
		553	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s).
		554
		555	=item $command_queue_properties = $device->properties
		556
		557	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s).
		558
		559	=item $ = $device->platform
		560
		561	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s).
		562
		563	=item $string = $device->name
		564
		565	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s).
		566
		567	=item $string = $device->vendor
		568
		569	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s).
		570
		571	=item $string = $device->driver_version
		572
		573	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s).
		574
		575	=item $string = $device->profile
		576
		577	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s).
		578
		579	=item $string = $device->version
		580
		581	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s).
		582
		583	=item $string = $device->extensions
		584
		585	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		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(s).
		626
		627	=item $boolean = $device->host_unified_memory
		628
		629	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s).
		630
		631	=item $device = $device->parent_device_ext
		632
		633	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s).
		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(s).
		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(s).
		642
		643	=item $uint = $device->reference_count_ext
		644
		645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s).
		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(s).
		650
		651	=for gengetinfo end device
		652
355	=back	653	=back
356		654
357	=head2 THE OpenCL::Context CLASS	655	=head2 THE OpenCL::Context CLASS
358		656
359	=over 4	657	=over 4
360		658
361	=item $packed_value = $ctx->info ($name)
362
363	See C<< $platform->info >> for details.
364
365	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
366
367	=item $queue = $ctx->queue ($device, $properties)	659	=item $queue = $ctx->queue ($device, $properties)
368		660
369	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.
370		662
371	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>
…		…
384		676
385	=item $buf = $ctx->buffer_sv ($flags, $data)	677	=item $buf = $ctx->buffer_sv ($flags, $data)
386		678
387	Creates a new OpenCL::Buffer object and initialise it with the given data values.	679	Creates a new OpenCL::Buffer object and initialise it with the given data values.
388		680
389	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	681	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
390		682
391	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	683	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.
392		684
393	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	685	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
394		686
395	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	687	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
396		688
397	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	689	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.
398		690
399	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	691	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
400		692
…		…
414	=item $program = $ctx->program_with_source ($string)	706	=item $program = $ctx->program_with_source ($string)
415		707
416	Creates a new OpenCL::Program object from the given source code.	708	Creates a new OpenCL::Program object from the given source code.
417		709
418	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(s).
		723
		724	=item @devices = $context->devices
		725
		726	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s).
		727
		728	=item @property_ints = $context->properties
		729
		730	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s).
		731
		732	=item $uint = $context->num_devices
		733
		734	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s).
		735
		736	=for gengetinfo end context
419		737
420	=back	738	=back
421		739
422	=head2 THE OpenCL::Queue CLASS	740	=head2 THE OpenCL::Queue CLASS
423		741
…		…
436	Queues execute in-order by default, without any parallelism, so in most	754	Queues execute in-order by default, without any parallelism, so in most
437	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
438	create event objects.	756	create event objects.
439		757
440	=over 4	758	=over 4
441
442	=item $packed_value = $ctx->info ($name)
443
444	See C<< $platform->info >> for details.
445
446	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
447		759
448	=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...)
449		761
450	Reads data from buffer into the given string.	762	Reads data from buffer into the given string.
451		763
…		…
527		839
528	=item $queue->finish	840	=item $queue->finish
529		841
530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	842	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
531		843
		844	=item $packed_value = $queue->info ($name)
		845
		846	See C<< $platform->info >> for details.
		847
		848	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		849
		850	=for gengetinfo begin command_queue
		851
		852	=item $ctx = $command_queue->context
		853
		854	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s).
		855
		856	=item $device = $command_queue->device
		857
		858	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s).
		859
		860	=item $uint = $command_queue->reference_count
		861
		862	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s).
		863
		864	=item $command_queue_properties = $command_queue->properties
		865
		866	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s).
		867
		868	=for gengetinfo end command_queue
		869
532	=back	870	=back
533		871
534	=head2 THE OpenCL::Memory CLASS	872	=head2 THE OpenCL::Memory CLASS
535		873
536	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	874	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
537	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	875	OpenCL::Image2D and OpenCL::Image3D.
538	currently only exist to allow type-checking.
539		876
540	=over 4	877	=over 4
541		878
542	=item $packed_value = $memory->info ($name)	879	=item $packed_value = $memory->info ($name)
543		880
544	See C<< $platform->info >> for details.	881	See C<< $platform->info >> for details.
545		882
546	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	883	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
547		884
		885	=for gengetinfo begin mem
		886
		887	=item $mem_object_type = $mem->type
		888
		889	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s).
		890
		891	=item $mem_flags = $mem->flags
		892
		893	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s).
		894
		895	=item $int = $mem->size
		896
		897	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s).
		898
		899	=item $ptr_value = $mem->host_ptr
		900
		901	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s).
		902
		903	=item $uint = $mem->map_count
		904
		905	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s).
		906
		907	=item $uint = $mem->reference_count
		908
		909	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s).
		910
		911	=item $ctx = $mem->context
		912
		913	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s).
		914
		915	=item $mem = $mem->associated_memobject
		916
		917	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s).
		918
		919	=item $int = $mem->offset
		920
		921	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s).
		922
		923	=for gengetinfo end mem
		924
548	=back	925	=back
549		926
		927	=head2 THE OpenCL::Image CLASS
		928
		929	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		930
		931	=over 4
		932
		933	=item $packed_value = $ev->image_info ($name)
		934
		935	See C<< $platform->info >> for details.
		936
		937	The reason this method is not called C<info> is that there already is an
		938	C<< ->info >> method inherited from C<OpenCL::Memory>.
		939
		940	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		941
		942	=for gengetinfo begin image
		943
		944	=item $int = $image->element_size
		945
		946	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s).
		947
		948	=item $int = $image->row_pitch
		949
		950	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s).
		951
		952	=item $int = $image->slice_pitch
		953
		954	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s).
		955
		956	=item $int = $image->width
		957
		958	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s).
		959
		960	=item $int = $image->height
		961
		962	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s).
		963
		964	=item $int = $image->depth
		965
		966	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s).
		967
		968	=for gengetinfo end image
		969
		970	=back
		971
550	=head2 THE OpenCL::Sampler CLASS	972	=head2 THE OpenCL::Sampler CLASS
551		973
552	=over 4	974	=over 4
553		975
554	=item $packed_value = $sampler->info ($name)	976	=item $packed_value = $sampler->info ($name)
555		977
556	See C<< $platform->info >> for details.	978	See C<< $platform->info >> for details.
557		979
558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	980	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
559		981
		982	=for gengetinfo begin sampler
		983
		984	=item $uint = $sampler->reference_count
		985
		986	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s).
		987
		988	=item $ctx = $sampler->context
		989
		990	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s).
		991
		992	=item $addressing_mode = $sampler->normalized_coords
		993
		994	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s).
		995
		996	=item $filter_mode = $sampler->addressing_mode
		997
		998	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s).
		999
		1000	=item $boolean = $sampler->filter_mode
		1001
		1002	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s).
		1003
		1004	=for gengetinfo end sampler
		1005
560	=back	1006	=back
561		1007
562	=head2 THE OpenCL::Program CLASS	1008	=head2 THE OpenCL::Program CLASS
563		1009
564	=over 4	1010	=over 4
565
566	=item $packed_value = $program->info ($name)
567
568	See C<< $platform->info >> for details.
569
570	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
571		1011
572	=item $program->build ($device, $options = "")	1012	=item $program->build ($device, $options = "")
573		1013
574	Tries to build the program with the givne options.	1014	Tries to build the program with the givne options.
575		1015
…		…
587	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1027	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
588	the program.	1028	the program.
589		1029
590	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1030	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
591		1031
		1032	=for gengetinfo begin program_build
		1033
		1034	=item $build_status = $program->build_status ($device)
		1035
		1036	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s).
		1037
		1038	=item $string = $program->build_options ($device)
		1039
		1040	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s).
		1041
		1042	=item $string = $program->build_log ($device)
		1043
		1044	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s).
		1045
		1046	=for gengetinfo end program_build
		1047
		1048	=item $packed_value = $program->info ($name)
		1049
		1050	See C<< $platform->info >> for details.
		1051
		1052	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1053
		1054	=for gengetinfo begin program
		1055
		1056	=item $uint = $program->reference_count
		1057
		1058	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s).
		1059
		1060	=item $ctx = $program->context
		1061
		1062	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s).
		1063
		1064	=item $uint = $program->num_devices
		1065
		1066	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s).
		1067
		1068	=item @devices = $program->devices
		1069
		1070	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s).
		1071
		1072	=item $string = $program->source
		1073
		1074	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s).
		1075
		1076	=item @ints = $program->binary_sizes
		1077
		1078	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s).
		1079
		1080	=for gengetinfo end program
		1081
592	=back	1082	=back
593		1083
594	=head2 THE OpenCL::Kernel CLASS	1084	=head2 THE OpenCL::Kernel CLASS
595		1085
596	=over 4	1086	=over 4
…		…
598	=item $packed_value = $kernel->info ($name)	1088	=item $packed_value = $kernel->info ($name)
599		1089
600	See C<< $platform->info >> for details.	1090	See C<< $platform->info >> for details.
601		1091
602	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1092	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1093
		1094	=for gengetinfo begin kernel
		1095
		1096	=item $string = $kernel->function_name
		1097
		1098	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s).
		1099
		1100	=item $uint = $kernel->num_args
		1101
		1102	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s).
		1103
		1104	=item $uint = $kernel->reference_count
		1105
		1106	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s).
		1107
		1108	=item $ctx = $kernel->context
		1109
		1110	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s).
		1111
		1112	=item $program = $kernel->program
		1113
		1114	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s).
		1115
		1116	=for gengetinfo end kernel
		1117
		1118	=item $packed_value = $kernel->work_group_info ($device, $name)
		1119
		1120	See C<< $platform->info >> for details.
		1121
		1122	The reason this method is not called C<info> is that there already is an
		1123	C<< ->info >> method.
		1124
		1125	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1126
		1127	=for gengetinfo begin kernel_work_group
		1128
		1129	=item $int = $kernel->work_group_size ($device)
		1130
		1131	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s).
		1132
		1133	=item @ints = $kernel->compile_work_group_size ($device)
		1134
		1135	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s).
		1136
		1137	=item $ulong = $kernel->local_mem_size ($device)
		1138
		1139	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s).
		1140
		1141	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1142
		1143	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s).
		1144
		1145	=item $ulong = $kernel->private_mem_size ($device)
		1146
		1147	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s).
		1148
		1149	=for gengetinfo end kernel_work_group
603		1150
604	=item $kernel->set_TYPE ($index, $value)	1151	=item $kernel->set_TYPE ($index, $value)
605		1152
606	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1153	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
607		1154
…		…
623	This is the superclass for all event objects (including OpenCL::UserEvent	1170	This is the superclass for all event objects (including OpenCL::UserEvent
624	objects).	1171	objects).
625		1172
626	=over 4	1173	=over 4
627		1174
		1175	=item $ev->wait
		1176
		1177	Waits for the event to complete.
		1178
		1179	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1180
628	=item $packed_value = $ev->info ($name)	1181	=item $packed_value = $ev->info ($name)
629		1182
630	See C<< $platform->info >> for details.	1183	See C<< $platform->info >> for details.
631		1184
632	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1185	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
633		1186
634	=item $ev->wait	1187	=for gengetinfo begin event
635		1188
636	Waits for the event to complete.	1189	=item $queue = $event->command_queue
637		1190
		1191	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s).
		1192
		1193	=item $command_type = $event->command_type
		1194
		1195	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s).
		1196
		1197	=item $uint = $event->reference_count
		1198
		1199	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s).
		1200
		1201	=item $uint = $event->command_execution_status
		1202
		1203	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s).
		1204
		1205	=item $ctx = $event->context
		1206
		1207	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s).
		1208
		1209	=for gengetinfo end event
		1210
		1211	=item $packed_value = $ev->profiling_info ($name)
		1212
		1213	See C<< $platform->info >> for details.
		1214
		1215	The reason this method is not called C<info> is that there already is an
		1216	C<< ->info >> method.
		1217
638	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1219
		1220	=for gengetinfo begin profiling
		1221
		1222	=item $ulong = $event->profiling_command_queued
		1223
		1224	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s).
		1225
		1226	=item $ulong = $event->profiling_command_submit
		1227
		1228	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s).
		1229
		1230	=item $ulong = $event->profiling_command_start
		1231
		1232	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s).
		1233
		1234	=item $ulong = $event->profiling_command_end
		1235
		1236	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s).
		1237
		1238	=for gengetinfo end profiling
639		1239
640	=back	1240	=back
641		1241
642	=head2 THE OpenCL::UserEvent CLASS	1242	=head2 THE OpenCL::UserEvent CLASS
643		1243
…		…
656	package OpenCL;	1256	package OpenCL;
657		1257
658	use common::sense;	1258	use common::sense;
659		1259
660	BEGIN {	1260	BEGIN {
661	our $VERSION = '0.14';	1261	our $VERSION = '0.55';
662		1262
663	require XSLoader;	1263	require XSLoader;
664	XSLoader::load (__PACKAGE__, $VERSION);	1264	XSLoader::load (__PACKAGE__, $VERSION);
665		1265
666	@OpenCL::Buffer::ISA =	1266	@OpenCL::Buffer::ISA =

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.17 by root, Thu Nov 17 03:56:07 2011 UTC vs. Revision 1.22 by root, Sun Nov 20 10:25:17 2011 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.17 by root, Thu Nov 17 03:56:07 2011 UTC vs.
Revision 1.22 by root, Sun Nov 20 10:25:17 2011 UTC