[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.21 by root, Sun Nov 20 10:21:27 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
		321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
		322
		323	Returns a list of matching OpenCL::Device objects.
		324
		325	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
		326
		327	Tries to create a context. Never worked for me, and you need devices explitly anyway.
		328
		329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		330
		331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)
		332
		333	Create a new OpenCL::Context object using the given device object(s)- a
		334	CL_CONTEXT_PLATFORM property is supplied automatically.
		335
		336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		337
318	=item $packed_value = $platform->info ($name)	338	=item $packed_value = $platform->info ($name)
319		339
320	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	340	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
321	strings, this will be the string, for other values you probably need to	341	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.	342	use the correct C<unpack>.
		343
		344	It's best to avoid this method and use one of the predefined C<get_*>
		345	methods.
323		346
324	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
325		348
326	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	349	=for gengetinfo begin platform
327		350
328	Returns a list of matching OpenCL::Device objects.
329		351
330	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	352	=item $string = $platform->profile
331		353
332	Tries to create a context. Never worked for me, and you need devices explitly anyway.	354	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s).
333		355
334	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	356	=item $string = $platform->version
335		357
336	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	358	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s).
337		359
338	Create a new OpenCL::Context object using the given device object(s)- a	360	=item $string = $platform->name
339	CL_CONTEXT_PLATFORM property is supplied automatically.
340		361
341	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	362	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s).
		363
		364	=item $string = $platform->vendor
		365
		366	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s).
		367
		368	=item $string = $platform->extensions
		369
		370	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s).
		371
		372	=for gengetinfo end platform
342		373
343	=back	374	=back
344		375
345	=head2 THE OpenCL::Device CLASS	376	=head2 THE OpenCL::Device CLASS
346		377
…		…
350		381
351	See C<< $platform->info >> for details.	382	See C<< $platform->info >> for details.
352		383
353	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	384	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
354		385
		386	=for gengetinfo begin device
		387
		388
		389	=item $device_type = $device->type
		390
		391	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result(s).
		392
		393	=item $uint = $device->vendor_id
		394
		395	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result(s).
		396
		397	=item $uint = $device->max_compute_units
		398
		399	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result(s).
		400
		401	=item $uint = $device->max_work_item_dimensions
		402
		403	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result(s).
		404
		405	=item $int = $device->max_work_group_size
		406
		407	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result(s).
		408
		409	=item @ints = $device->max_work_item_sizes
		410
		411	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result(s).
		412
		413	=item $uint = $device->preferred_vector_width_char
		414
		415	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result(s).
		416
		417	=item $uint = $device->preferred_vector_width_short
		418
		419	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result(s).
		420
		421	=item $uint = $device->preferred_vector_width_int
		422
		423	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result(s).
		424
		425	=item $uint = $device->preferred_vector_width_long
		426
		427	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result(s).
		428
		429	=item $uint = $device->preferred_vector_width_float
		430
		431	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result(s).
		432
		433	=item $uint = $device->preferred_vector_width_double
		434
		435	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result(s).
		436
		437	=item $uint = $device->max_clock_frequency
		438
		439	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result(s).
		440
		441	=item $bitfield = $device->address_bits
		442
		443	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result(s).
		444
		445	=item $uint = $device->max_read_image_args
		446
		447	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result(s).
		448
		449	=item $uint = $device->max_write_image_args
		450
		451	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result(s).
		452
		453	=item $ulong = $device->max_mem_alloc_size
		454
		455	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result(s).
		456
		457	=item $int = $device->image2d_max_width
		458
		459	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result(s).
		460
		461	=item $int = $device->image2d_max_height
		462
		463	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result(s).
		464
		465	=item $int = $device->image3d_max_width
		466
		467	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result(s).
		468
		469	=item $int = $device->image3d_max_height
		470
		471	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result(s).
		472
		473	=item $int = $device->image3d_max_depth
		474
		475	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result(s).
		476
		477	=item $uint = $device->image_support
		478
		479	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result(s).
		480
		481	=item $int = $device->max_parameter_size
		482
		483	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result(s).
		484
		485	=item $uint = $device->max_samplers
		486
		487	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result(s).
		488
		489	=item $uint = $device->mem_base_addr_align
		490
		491	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result(s).
		492
		493	=item $uint = $device->min_data_type_align_size
		494
		495	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result(s).
		496
		497	=item $device_fp_config = $device->single_fp_config
		498
		499	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result(s).
		500
		501	=item $device_mem_cache_type = $device->global_mem_cache_type
		502
		503	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result(s).
		504
		505	=item $uint = $device->global_mem_cacheline_size
		506
		507	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result(s).
		508
		509	=item $ulong = $device->global_mem_cache_size
		510
		511	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result(s).
		512
		513	=item $ulong = $device->global_mem_size
		514
		515	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result(s).
		516
		517	=item $ulong = $device->max_constant_buffer_size
		518
		519	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result(s).
		520
		521	=item $uint = $device->max_constant_args
		522
		523	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result(s).
		524
		525	=item $device_local_mem_type = $device->local_mem_type
		526
		527	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result(s).
		528
		529	=item $ulong = $device->local_mem_size
		530
		531	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result(s).
		532
		533	=item $boolean = $device->error_correction_support
		534
		535	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result(s).
		536
		537	=item $int = $device->profiling_timer_resolution
		538
		539	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result(s).
		540
		541	=item $boolean = $device->endian_little
		542
		543	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result(s).
		544
		545	=item $boolean = $device->available
		546
		547	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result(s).
		548
		549	=item $boolean = $device->compiler_available
		550
		551	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result(s).
		552
		553	=item $device_exec_capabilities = $device->execution_capabilities
		554
		555	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result(s).
		556
		557	=item $command_queue_properties = $device->properties
		558
		559	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result(s).
		560
		561	=item $ = $device->platform
		562
		563	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result(s).
		564
		565	=item $string = $device->name
		566
		567	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result(s).
		568
		569	=item $string = $device->vendor
		570
		571	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result(s).
		572
		573	=item $string = $device->driver_version
		574
		575	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result(s).
		576
		577	=item $string = $device->profile
		578
		579	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result(s).
		580
		581	=item $string = $device->version
		582
		583	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result(s).
		584
		585	=item $string = $device->extensions
		586
		587	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result(s).
		588
		589	=item $uint = $device->preferred_vector_width_half
		590
		591	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result(s).
		592
		593	=item $uint = $device->native_vector_width_char
		594
		595	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result(s).
		596
		597	=item $uint = $device->native_vector_width_short
		598
		599	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result(s).
		600
		601	=item $uint = $device->native_vector_width_int
		602
		603	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result(s).
		604
		605	=item $uint = $device->native_vector_width_long
		606
		607	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result(s).
		608
		609	=item $uint = $device->native_vector_width_float
		610
		611	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result(s).
		612
		613	=item $uint = $device->native_vector_width_double
		614
		615	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result(s).
		616
		617	=item $uint = $device->native_vector_width_half
		618
		619	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result(s).
		620
		621	=item $device_fp_config = $device->double_fp_config
		622
		623	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result(s).
		624
		625	=item $device_fp_config = $device->half_fp_config
		626
		627	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result(s).
		628
		629	=item $boolean = $device->host_unified_memory
		630
		631	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result(s).
		632
		633	=item $device = $device->parent_device_ext
		634
		635	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result(s).
		636
		637	=item @device_partition_property_exts = $device->partition_types_ext
		638
		639	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result(s).
		640
		641	=item @device_partition_property_exts = $device->affinity_domains_ext
		642
		643	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result(s).
		644
		645	=item $uint = $device->reference_count_ext
		646
		647	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result(s).
		648
		649	=item @device_partition_property_exts = $device->partition_style_ext
		650
		651	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result(s).
		652
		653	=for gengetinfo end device
		654
355	=back	655	=back
356		656
357	=head2 THE OpenCL::Context CLASS	657	=head2 THE OpenCL::Context CLASS
358		658
359	=over 4	659	=over 4
360		660
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)	661	=item $queue = $ctx->queue ($device, $properties)
368		662
369	Create a new OpenCL::Queue object from the context and the given device.	663	Create a new OpenCL::Queue object from the context and the given device.
370		664
371	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	665	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
…		…
384		678
385	=item $buf = $ctx->buffer_sv ($flags, $data)	679	=item $buf = $ctx->buffer_sv ($flags, $data)
386		680
387	Creates a new OpenCL::Buffer object and initialise it with the given data values.	681	Creates a new OpenCL::Buffer object and initialise it with the given data values.
388		682
389	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	683	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
390		684
391	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 the given data values.
392		686
393	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	687	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
394		688
395	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	689	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
396		690
397	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	691	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.
398		692
399	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	693	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
400		694
…		…
414	=item $program = $ctx->program_with_source ($string)	708	=item $program = $ctx->program_with_source ($string)
415		709
416	Creates a new OpenCL::Program object from the given source code.	710	Creates a new OpenCL::Program object from the given source code.
417		711
418	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	712	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		713
		714	=item $packed_value = $ctx->info ($name)
		715
		716	See C<< $platform->info >> for details.
		717
		718	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		719
		720	=for gengetinfo begin context
		721
		722
		723	=item $uint = $context->reference_count
		724
		725	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result(s).
		726
		727	=item @devices = $context->devices
		728
		729	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result(s).
		730
		731	=item @property_ints = $context->properties
		732
		733	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result(s).
		734
		735	=item $uint = $context->num_devices
		736
		737	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result(s).
		738
		739	=for gengetinfo end context
419		740
420	=back	741	=back
421		742
422	=head2 THE OpenCL::Queue CLASS	743	=head2 THE OpenCL::Queue CLASS
423		744
…		…
436	Queues execute in-order by default, without any parallelism, so in most	757	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	758	cases (i.e. you use only one queue) it's not necessary to wait for or
438	create event objects.	759	create event objects.
439		760
440	=over 4	761	=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		762
448	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	763	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
449		764
450	Reads data from buffer into the given string.	765	Reads data from buffer into the given string.
451		766
…		…
527		842
528	=item $queue->finish	843	=item $queue->finish
529		844
530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	845	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
531		846
		847	=item $packed_value = $queue->info ($name)
		848
		849	See C<< $platform->info >> for details.
		850
		851	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		852
		853	=for gengetinfo begin command_queue
		854
		855
		856	=item $ctx = $command_queue->context
		857
		858	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result(s).
		859
		860	=item $device = $command_queue->device
		861
		862	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result(s).
		863
		864	=item $uint = $command_queue->reference_count
		865
		866	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result(s).
		867
		868	=item $command_queue_properties = $command_queue->properties
		869
		870	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result(s).
		871
		872	=for gengetinfo end command_queue
		873
532	=back	874	=back
533		875
534	=head2 THE OpenCL::Memory CLASS	876	=head2 THE OpenCL::Memory CLASS
535		877
536	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	878	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
537	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	879	OpenCL::Image2D and OpenCL::Image3D.
538	currently only exist to allow type-checking.
539		880
540	=over 4	881	=over 4
541		882
542	=item $packed_value = $memory->info ($name)	883	=item $packed_value = $memory->info ($name)
543		884
544	See C<< $platform->info >> for details.	885	See C<< $platform->info >> for details.
545		886
546	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	887	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
547		888
		889	=for gengetinfo begin mem
		890
		891
		892	=item $mem_object_type = $mem->type
		893
		894	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result(s).
		895
		896	=item $mem_flags = $mem->flags
		897
		898	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result(s).
		899
		900	=item $int = $mem->size
		901
		902	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result(s).
		903
		904	=item $ptr_value = $mem->host_ptr
		905
		906	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result(s).
		907
		908	=item $uint = $mem->map_count
		909
		910	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result(s).
		911
		912	=item $uint = $mem->reference_count
		913
		914	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result(s).
		915
		916	=item $ctx = $mem->context
		917
		918	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result(s).
		919
		920	=item $mem = $mem->associated_memobject
		921
		922	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result(s).
		923
		924	=item $int = $mem->offset
		925
		926	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result(s).
		927
		928	=for gengetinfo end mem
		929
548	=back	930	=back
549		931
		932	=head2 THE OpenCL::Image CLASS
		933
		934	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
		935
		936	=over 4
		937
		938	=item $packed_value = $ev->image_info ($name)
		939
		940	See C<< $platform->info >> for details.
		941
		942	The reason this method is not called C<info> is that there already is an
		943	C<< ->info >> method inherited from C<OpenCL::Memory>.
		944
		945	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		946
		947	=for gengetinfo begin image
		948
		949
		950	=item $int = $image->element_size
		951
		952	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result(s).
		953
		954	=item $int = $image->row_pitch
		955
		956	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result(s).
		957
		958	=item $int = $image->slice_pitch
		959
		960	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result(s).
		961
		962	=item $int = $image->width
		963
		964	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result(s).
		965
		966	=item $int = $image->height
		967
		968	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result(s).
		969
		970	=item $int = $image->depth
		971
		972	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result(s).
		973
		974	=for gengetinfo end image
		975
		976	=back
		977
550	=head2 THE OpenCL::Sampler CLASS	978	=head2 THE OpenCL::Sampler CLASS
551		979
552	=over 4	980	=over 4
553		981
554	=item $packed_value = $sampler->info ($name)	982	=item $packed_value = $sampler->info ($name)
555		983
556	See C<< $platform->info >> for details.	984	See C<< $platform->info >> for details.
557		985
558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	986	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
559		987
		988	=for gengetinfo begin sampler
		989
		990
		991	=item $uint = $sampler->reference_count
		992
		993	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result(s).
		994
		995	=item $ctx = $sampler->context
		996
		997	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result(s).
		998
		999	=item $addressing_mode = $sampler->normalized_coords
		1000
		1001	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result(s).
		1002
		1003	=item $filter_mode = $sampler->addressing_mode
		1004
		1005	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result(s).
		1006
		1007	=item $boolean = $sampler->filter_mode
		1008
		1009	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result(s).
		1010
		1011	=for gengetinfo end sampler
		1012
560	=back	1013	=back
561		1014
562	=head2 THE OpenCL::Program CLASS	1015	=head2 THE OpenCL::Program CLASS
563		1016
564	=over 4	1017	=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		1018
572	=item $program->build ($device, $options = "")	1019	=item $program->build ($device, $options = "")
573		1020
574	Tries to build the program with the givne options.	1021	Tries to build the program with the givne options.
575		1022
…		…
587	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1034	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
588	the program.	1035	the program.
589		1036
590	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1037	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
591		1038
		1039	=for gengetinfo begin program_build
		1040
		1041
		1042	=item $build_status = $program->build_status ($device)
		1043
		1044	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result(s).
		1045
		1046	=item $string = $program->build_options ($device)
		1047
		1048	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result(s).
		1049
		1050	=item $string = $program->build_log ($device)
		1051
		1052	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result(s).
		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
		1065	=item $uint = $program->reference_count
		1066
		1067	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result(s).
		1068
		1069	=item $ctx = $program->context
		1070
		1071	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result(s).
		1072
		1073	=item $uint = $program->num_devices
		1074
		1075	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result(s).
		1076
		1077	=item @devices = $program->devices
		1078
		1079	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result(s).
		1080
		1081	=item $string = $program->source
		1082
		1083	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result(s).
		1084
		1085	=item @ints = $program->binary_sizes
		1086
		1087	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result(s).
		1088
		1089	=for gengetinfo end program
		1090
592	=back	1091	=back
593		1092
594	=head2 THE OpenCL::Kernel CLASS	1093	=head2 THE OpenCL::Kernel CLASS
595		1094
596	=over 4	1095	=over 4
…		…
598	=item $packed_value = $kernel->info ($name)	1097	=item $packed_value = $kernel->info ($name)
599		1098
600	See C<< $platform->info >> for details.	1099	See C<< $platform->info >> for details.
601		1100
602	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1101	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1102
		1103	=for gengetinfo begin kernel
		1104
		1105
		1106	=item $string = $kernel->function_name
		1107
		1108	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result(s).
		1109
		1110	=item $uint = $kernel->num_args
		1111
		1112	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result(s).
		1113
		1114	=item $uint = $kernel->reference_count
		1115
		1116	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result(s).
		1117
		1118	=item $ctx = $kernel->context
		1119
		1120	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result(s).
		1121
		1122	=item $program = $kernel->program
		1123
		1124	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result(s).
		1125
		1126	=for gengetinfo end kernel
		1127
		1128	=item $packed_value = $kernel->work_group_info ($device, $name)
		1129
		1130	See C<< $platform->info >> for details.
		1131
		1132	The reason this method is not called C<info> is that there already is an
		1133	C<< ->info >> method.
		1134
		1135	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1136
		1137	=for gengetinfo begin kernel_work_group
		1138
		1139
		1140	=item $int = $kernel->work_group_size ($device)
		1141
		1142	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result(s).
		1143
		1144	=item @ints = $kernel->compile_work_group_size ($device)
		1145
		1146	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result(s).
		1147
		1148	=item $ulong = $kernel->local_mem_size ($device)
		1149
		1150	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result(s).
		1151
		1152	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1153
		1154	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result(s).
		1155
		1156	=item $ulong = $kernel->private_mem_size ($device)
		1157
		1158	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result(s).
		1159
		1160	=for gengetinfo end kernel_work_group
603		1161
604	=item $kernel->set_TYPE ($index, $value)	1162	=item $kernel->set_TYPE ($index, $value)
605		1163
606	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1164	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
607		1165
…		…
623	This is the superclass for all event objects (including OpenCL::UserEvent	1181	This is the superclass for all event objects (including OpenCL::UserEvent
624	objects).	1182	objects).
625		1183
626	=over 4	1184	=over 4
627		1185
		1186	=item $ev->wait
		1187
		1188	Waits for the event to complete.
		1189
		1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1191
628	=item $packed_value = $ev->info ($name)	1192	=item $packed_value = $ev->info ($name)
629		1193
630	See C<< $platform->info >> for details.	1194	See C<< $platform->info >> for details.
631		1195
632	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1196	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
633		1197
634	=item $ev->wait	1198	=for gengetinfo begin event
635		1199
636	Waits for the event to complete.
637		1200
		1201	=item $queue = $event->command_queue
		1202
		1203	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result(s).
		1204
		1205	=item $command_type = $event->command_type
		1206
		1207	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result(s).
		1208
		1209	=item $uint = $event->reference_count
		1210
		1211	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result(s).
		1212
		1213	=item $uint = $event->command_execution_status
		1214
		1215	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result(s).
		1216
		1217	=item $ctx = $event->context
		1218
		1219	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result(s).
		1220
		1221	=for gengetinfo end event
		1222
		1223	=item $packed_value = $ev->profiling_info ($name)
		1224
		1225	See C<< $platform->info >> for details.
		1226
		1227	The reason this method is not called C<info> is that there already is an
		1228	C<< ->info >> method.
		1229
638	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1230	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1231
		1232	=for gengetinfo begin profiling
		1233
		1234
		1235	=item $ulong = $event->profiling_command_queued
		1236
		1237	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result(s).
		1238
		1239	=item $ulong = $event->profiling_command_submit
		1240
		1241	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result(s).
		1242
		1243	=item $ulong = $event->profiling_command_start
		1244
		1245	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result(s).
		1246
		1247	=item $ulong = $event->profiling_command_end
		1248
		1249	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result(s).
		1250
		1251	=for gengetinfo end profiling
639		1252
640	=back	1253	=back
641		1254
642	=head2 THE OpenCL::UserEvent CLASS	1255	=head2 THE OpenCL::UserEvent CLASS
643		1256
…		…
656	package OpenCL;	1269	package OpenCL;
657		1270
658	use common::sense;	1271	use common::sense;
659		1272
660	BEGIN {	1273	BEGIN {
661	our $VERSION = '0.14';	1274	our $VERSION = '0.55';
662		1275
663	require XSLoader;	1276	require XSLoader;
664	XSLoader::load (__PACKAGE__, $VERSION);	1277	XSLoader::load (__PACKAGE__, $VERSION);
665		1278
666	@OpenCL::Buffer::ISA =	1279	@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.21 by root, Sun Nov 20 10:21:27 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.21 by root, Sun Nov 20 10:21:27 2011 UTC