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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.20 by root, Sun Nov 20 01:09:48 2011 UTC vs.
Revision 1.36 by root, Thu Apr 19 14:34:56 2012 UTC

…		…
101		101
102	Best run this once to get a feel for the platforms and devices in your	102	Best run this once to get a feel for the platforms and devices in your
103	system.	103	system.
104		104
105	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
106	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
107	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
108	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
109	printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
110	my $ctx = $device->context;	110	my $ctx = $platform->context (undef, [$device]);
111	# do stuff	111	# do stuff
112	}	112	}
113	}	113	}
114		114
115	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
…		…
149		149
150	=head2 Create and build a program, then create a kernel out of one of its	150	=head2 Create and build a program, then create a kernel out of one of its
151	functions.	151	functions.
152		152
153	my $src = '	153	my $src = '
154	__kernel void	154	kernel void
155	squareit (__global float input, __global float output)	155	squareit (global float input, global float output)
156	{	156	{
157	$id = get_global_id (0);	157	$id = get_global_id (0);
158	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
159	}	159	}
160	';	160	';
161		161
162	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->program_with_source ($src);
163		163
164	# build croaks on compile errors, so catch it and print the compile errors	164	# build croaks on compile errors, so catch it and print the compile errors
165	eval { $prog->build ($dev); 1 }	165	eval { $prog->build ($dev); 1 }
166	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);	166	or die $prog->build_log;
167		167
168	my $kernel = $prog->kernel ("squareit");	168	my $kernel = $prog->kernel ("squareit");
169		169
170	=head2 Create some input and output float buffers, then call the	170	=head2 Create some input and output float buffers, then call the
171	'squareit' kernel on them.	171	'squareit' kernel on them.
…		…
271	ulong IV - Q	271	ulong IV - Q
272	float NV float f	272	float NV float f
273	half IV ushort S	273	half IV ushort S
274	double NV double d	274	double NV double d
275		275
		276	=head2 GLX SUPPORT
		277
		278	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		279	module, which has little to no documentation and has little to no support
		280	for glx), this module, as a special extension, treats context creation
		281	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		282	specially: If either or both of these are C<undef>, then the OpenCL
		283	module tries to dynamically resolve C<glxGetCurrentDisplay> and
		284	C<glxGetCurrentContext>, call these functions and use their return values
		285	instead.
		286
		287	For this to work, the OpenGL library must be loaded, a GLX context must
		288	have been created and be made current, and C<dlsym> must be available and
		289	capable of finding the function via C<RTLD_DEFAULT>.
		290
276	=head2 THE OpenCL PACKAGE	291	=head2 THE OpenCL PACKAGE
277		292
278	=over 4	293	=over 4
279		294
280	=item $int = OpenCL::errno	295	=item $int = OpenCL::errno
…		…
286		301
287	Comverts an error value into a human readable string.	302	Comverts an error value into a human readable string.
288		303
289	=item $str = OpenCL::enum2str $enum	304	=item $str = OpenCL::enum2str $enum
290		305
291	Converts most enum values (inof parameter names, image format constants,	306	Converts most enum values (of parameter names, image format constants,
292	object types, addressing and filter modes, command types etc.) into a	307	object types, addressing and filter modes, command types etc.) into a
293	human readbale string. When confronted with some random integer it can be	308	human readable string. When confronted with some random integer it can be
294	very helpful to pass it through this function to maybe get some readable	309	very helpful to pass it through this function to maybe get some readable
295	string out of it.	310	string out of it.
296		311
297	=item @platforms = OpenCL::platforms	312	=item @platforms = OpenCL::platforms
298		313
…		…
322		337
323	Returns a list of matching OpenCL::Device objects.	338	Returns a list of matching OpenCL::Device objects.
324		339
325	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	340	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
326		341
327	Tries to create a context. Never worked for me, and you need devices explitly anyway.	342	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328		343
329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	344	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330		345
331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	346	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
332		347
333	Create a new OpenCL::Context object using the given device object(s)- a	348	Create a new OpenCL::Context object using the given device object(s)- a
334	CL_CONTEXT_PLATFORM property is supplied automatically.	349	CL_CONTEXT_PLATFORM property is supplied automatically.
335		350
336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	351	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
337		352
338	=item $packed_value = $platform->info ($name)	353	=item $packed_value = $platform->info ($name)
339		354
340	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	355	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
341	strings, this will be the string, for other values you probably need to	356	strings, this will be the string (possibly including terminating \0), for
342	use the correct C<unpack>.	357	other values you probably need to use the correct C<unpack>.
343		358
344	It's best to avoid this method and use one of the predefined C<get_*>	359	It's best to avoid this method and use one of the following convenience
345	methods.	360	wrappers.
346		361
347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	362	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348		363
349	=for gengetinfo begin platform	364	=for gengetinfo begin platform
350		365
351
352	=item $string = $platform->profile	366	=item $string = $platform->profile
353		367
354	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s).	368	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
355		369
356	=item $string = $platform->version	370	=item $string = $platform->version
357		371
358	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s).	372	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
359		373
360	=item $string = $platform->name	374	=item $string = $platform->name
361		375
362	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s).	376	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
363		377
364	=item $string = $platform->vendor	378	=item $string = $platform->vendor
365		379
366	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s).	380	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
367		381
368	=item $string = $platform->extensions	382	=item $string = $platform->extensions
369		383
370	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s).	384	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		385
371	=for gengetinfo end platform	386	=for gengetinfo end platform
372		387
373	=back	388	=back
374		389
375	=head2 THE OpenCL::Device CLASS	390	=head2 THE OpenCL::Device CLASS
…		…
380		395
381	See C<< $platform->info >> for details.	396	See C<< $platform->info >> for details.
382		397
383	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	398	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
384		399
		400	=for gengetinfo begin device
		401
		402	=item $device_type = $device->type
		403
		404	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		405
		406	=item $uint = $device->vendor_id
		407
		408	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		409
		410	=item $uint = $device->max_compute_units
		411
		412	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		413
		414	=item $uint = $device->max_work_item_dimensions
		415
		416	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		417
		418	=item $int = $device->max_work_group_size
		419
		420	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		421
		422	=item @ints = $device->max_work_item_sizes
		423
		424	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		425
		426	=item $uint = $device->preferred_vector_width_char
		427
		428	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		429
		430	=item $uint = $device->preferred_vector_width_short
		431
		432	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		433
		434	=item $uint = $device->preferred_vector_width_int
		435
		436	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		437
		438	=item $uint = $device->preferred_vector_width_long
		439
		440	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		441
		442	=item $uint = $device->preferred_vector_width_float
		443
		444	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		445
		446	=item $uint = $device->preferred_vector_width_double
		447
		448	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		449
		450	=item $uint = $device->max_clock_frequency
		451
		452	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		453
		454	=item $bitfield = $device->address_bits
		455
		456	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		457
		458	=item $uint = $device->max_read_image_args
		459
		460	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		461
		462	=item $uint = $device->max_write_image_args
		463
		464	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		465
		466	=item $ulong = $device->max_mem_alloc_size
		467
		468	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		469
		470	=item $int = $device->image2d_max_width
		471
		472	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		473
		474	=item $int = $device->image2d_max_height
		475
		476	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		477
		478	=item $int = $device->image3d_max_width
		479
		480	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		481
		482	=item $int = $device->image3d_max_height
		483
		484	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		485
		486	=item $int = $device->image3d_max_depth
		487
		488	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		489
		490	=item $uint = $device->image_support
		491
		492	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		493
		494	=item $int = $device->max_parameter_size
		495
		496	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		497
		498	=item $uint = $device->max_samplers
		499
		500	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		501
		502	=item $uint = $device->mem_base_addr_align
		503
		504	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		505
		506	=item $uint = $device->min_data_type_align_size
		507
		508	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		509
		510	=item $device_fp_config = $device->single_fp_config
		511
		512	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		513
		514	=item $device_mem_cache_type = $device->global_mem_cache_type
		515
		516	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		517
		518	=item $uint = $device->global_mem_cacheline_size
		519
		520	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		521
		522	=item $ulong = $device->global_mem_cache_size
		523
		524	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		525
		526	=item $ulong = $device->global_mem_size
		527
		528	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		529
		530	=item $ulong = $device->max_constant_buffer_size
		531
		532	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		533
		534	=item $uint = $device->max_constant_args
		535
		536	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		537
		538	=item $device_local_mem_type = $device->local_mem_type
		539
		540	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		541
		542	=item $ulong = $device->local_mem_size
		543
		544	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		545
		546	=item $boolean = $device->error_correction_support
		547
		548	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		549
		550	=item $int = $device->profiling_timer_resolution
		551
		552	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		553
		554	=item $boolean = $device->endian_little
		555
		556	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		557
		558	=item $boolean = $device->available
		559
		560	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		561
		562	=item $boolean = $device->compiler_available
		563
		564	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		565
		566	=item $device_exec_capabilities = $device->execution_capabilities
		567
		568	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		569
		570	=item $command_queue_properties = $device->properties
		571
		572	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		573
		574	=item $ = $device->platform
		575
		576	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		577
		578	=item $string = $device->name
		579
		580	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		581
		582	=item $string = $device->vendor
		583
		584	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		585
		586	=item $string = $device->driver_version
		587
		588	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		589
		590	=item $string = $device->profile
		591
		592	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		593
		594	=item $string = $device->version
		595
		596	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		597
		598	=item $string = $device->extensions
		599
		600	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		601
		602	=item $uint = $device->preferred_vector_width_half
		603
		604	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		605
		606	=item $uint = $device->native_vector_width_char
		607
		608	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		609
		610	=item $uint = $device->native_vector_width_short
		611
		612	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		613
		614	=item $uint = $device->native_vector_width_int
		615
		616	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		617
		618	=item $uint = $device->native_vector_width_long
		619
		620	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		621
		622	=item $uint = $device->native_vector_width_float
		623
		624	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		625
		626	=item $uint = $device->native_vector_width_double
		627
		628	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		629
		630	=item $uint = $device->native_vector_width_half
		631
		632	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		633
		634	=item $device_fp_config = $device->double_fp_config
		635
		636	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		637
		638	=item $device_fp_config = $device->half_fp_config
		639
		640	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		641
		642	=item $boolean = $device->host_unified_memory
		643
		644	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		645
		646	=item $device = $device->parent_device_ext
		647
		648	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		649
		650	=item @device_partition_property_exts = $device->partition_types_ext
		651
		652	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		653
		654	=item @device_partition_property_exts = $device->affinity_domains_ext
		655
		656	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		657
		658	=item $uint = $device->reference_count_ext
		659
		660	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
		661
		662	=item @device_partition_property_exts = $device->partition_style_ext
		663
		664	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		665
		666	=for gengetinfo end device
		667
385	=back	668	=back
386		669
387	=head2 THE OpenCL::Context CLASS	670	=head2 THE OpenCL::Context CLASS
388		671
389	=over 4	672	=over 4
…		…
400		683
401	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	684	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
402		685
403	=item $buf = $ctx->buffer ($flags, $len)	686	=item $buf = $ctx->buffer ($flags, $len)
404		687
405	Creates a new OpenCL::Buffer object with the given flags and octet-size.	688	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		689	given flags and octet-size.
406		690
407	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	691	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
408		692
409	=item $buf = $ctx->buffer_sv ($flags, $data)	693	=item $buf = $ctx->buffer_sv ($flags, $data)
410		694
411	Creates a new OpenCL::Buffer object and initialise it with the given data values.	695	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		696	initialise it with the given data values.
412		697
413	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	698	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
414		699
415	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	700	Creates a new OpenCL::Image2D object and optionally initialises it with
		701	the given data values.
416		702
417	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	703	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
418		704
419	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)	705	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
420		706
421	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	707	Creates a new OpenCL::Image3D object and optionally initialises it with
		708	the given data values.
422		709
423	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	710	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		711
		712	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		713
		714	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		715	OpenGL buffer object.
		716
		717	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		718
		719	=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		720
		721	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		722	2D texture object.
		723
		724	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		725
		726	=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		727
		728	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		729	3D texture object.
		730
		731	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		732
		733	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		734
		735	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		736	render buffer.
		737
		738	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
424		739
425	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	740	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
426		741
427	Returns a list of matching image formats - each format is an arrayref with	742	Returns a list of matching image formats - each format is an arrayref with
428	two values, $channel_order and $channel_type, in it.	743	two values, $channel_order and $channel_type, in it.
…		…
446	See C<< $platform->info >> for details.	761	See C<< $platform->info >> for details.
447		762
448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	763	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
449		764
450	=for gengetinfo begin context	765	=for gengetinfo begin context
		766
		767	=item $uint = $context->reference_count
		768
		769	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		770
		771	=item @devices = $context->devices
		772
		773	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		774
		775	=item @property_ints = $context->properties
		776
		777	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		778
		779	=item $uint = $context->num_devices
		780
		781	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
451		782
452	=for gengetinfo end context	783	=for gengetinfo end context
453		784
454	=back	785	=back
455		786
…		…
471	cases (i.e. you use only one queue) it's not necessary to wait for or	802	cases (i.e. you use only one queue) it's not necessary to wait for or
472	create event objects.	803	create event objects.
473		804
474	=over 4	805	=over 4
475		806
476	=item $packed_value = $ctx->info ($name)
477
478	See C<< $platform->info >> for details.
479
480	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
481
482	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	807	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
483		808
484	Reads data from buffer into the given string.	809	Reads data from buffer into the given string.
485		810
486	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	811	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
493		818
494	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	819	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
495		820
496	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	821	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
497		822
		823	=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...)
		824
		825	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		826
		827	=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...)
		828
		829	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		830
498	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	831	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
499		832
		833	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		834
		835	=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		836
500	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	837	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
501		838
502	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	839	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
503		840
504	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	841	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
505		842
		843	=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		844
		845	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		846
		847	=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
		848
		849	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		850
506	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)	851	=item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
507		852
508	Yeah.	853	Yeah.
509		854
510	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
511
512	=item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
513
514	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	855	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
515
516	=item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
517
518	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
519
520	=item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
521
522	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
523		856
524	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	857	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
525		858
526	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	859	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
527		860
…		…
541	reference to an array of local work sizes, with the same number of	874	reference to an array of local work sizes, with the same number of
542	elements as @$global_work_size.	875	elements as @$global_work_size.
543		876
544	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	877	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
545		878
546	=item $ev = $queue->enqueue_marker	879	=item $ev = $queue->enqueue_marker ($wait_events...)
547		880
548	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	881	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
549		882
		883	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
		884
		885	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		886	for subsequent OpenCL usage.
		887
		888	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		889
		890	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		891
		892	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		893	for subsequent OpenGL usage.
		894
		895	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
		896
550	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	897	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
551		898
552	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	899	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
553		900
554	=item $queue->enqueue_barrier	901	=item $queue->enqueue_barrier
…		…
561		908
562	=item $queue->finish	909	=item $queue->finish
563		910
564	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	911	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
565		912
		913	=item $packed_value = $queue->info ($name)
		914
		915	See C<< $platform->info >> for details.
		916
		917	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		918
		919	=for gengetinfo begin command_queue
		920
		921	=item $ctx = $command_queue->context
		922
		923	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		924
		925	=item $device = $command_queue->device
		926
		927	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		928
		929	=item $uint = $command_queue->reference_count
		930
		931	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		932
		933	=item $command_queue_properties = $command_queue->properties
		934
		935	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		936
		937	=for gengetinfo end command_queue
		938
566	=back	939	=back
567		940
568	=head2 THE OpenCL::Memory CLASS	941	=head2 THE OpenCL::Memory CLASS
569		942
570	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	943	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
571	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	944	OpenCL::Image2D and OpenCL::Image3D.
572	currently only exist to allow type-checking.
573		945
574	=over 4	946	=over 4
575		947
576	=item $packed_value = $memory->info ($name)	948	=item $packed_value = $memory->info ($name)
577		949
578	See C<< $platform->info >> for details.	950	See C<< $platform->info >> for details.
579		951
580	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	952	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
		953
		954	=for gengetinfo begin mem
		955
		956	=item $mem_object_type = $mem->type
		957
		958	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		959
		960	=item $mem_flags = $mem->flags
		961
		962	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		963
		964	=item $int = $mem->size
		965
		966	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		967
		968	=item $ptr_value = $mem->host_ptr
		969
		970	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		971
		972	=item $uint = $mem->map_count
		973
		974	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		975
		976	=item $uint = $mem->reference_count
		977
		978	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		979
		980	=item $ctx = $mem->context
		981
		982	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		983
		984	=item $mem = $mem->associated_memobject
		985
		986	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		987
		988	=item $int = $mem->offset
		989
		990	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		991
		992	=for gengetinfo end mem
		993
		994	=item ($type, $name) = $mem->gl_object_info
		995
		996	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		997	object "name" (e.g. the texture name) used to create this memory object.
		998
		999	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1000
		1001	=back
		1002
		1003	=head2 THE OpenCL::Buffer CLASS
		1004
		1005	This is a subclass of OpenCL::Memory, and the superclass of
		1006	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1007	and sub-buffers.
		1008
		1009	=head2 THE OpenCL::BufferObj CLASS
		1010
		1011	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1012	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1013	sub buffers from these sub buffers.
		1014
		1015	=over 4
		1016
		1017	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1018
		1019	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1020	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1021
		1022	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
581		1023
582	=back	1024	=back
583		1025
584	=head2 THE OpenCL::Image CLASS	1026	=head2 THE OpenCL::Image CLASS
585		1027
…		…
594	The reason this method is not called C<info> is that there already is an	1036	The reason this method is not called C<info> is that there already is an
595	C<< ->info >> method inherited from C<OpenCL::Memory>.	1037	C<< ->info >> method inherited from C<OpenCL::Memory>.
596		1038
597	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1039	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
598		1040
		1041	=for gengetinfo begin image
		1042
		1043	=item $int = $image->element_size
		1044
		1045	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1046
		1047	=item $int = $image->row_pitch
		1048
		1049	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1050
		1051	=item $int = $image->slice_pitch
		1052
		1053	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1054
		1055	=item $int = $image->width
		1056
		1057	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1058
		1059	=item $int = $image->height
		1060
		1061	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1062
		1063	=item $int = $image->depth
		1064
		1065	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1066
		1067	=for gengetinfo end image
		1068
		1069	=for gengetinfo begin gl_texture
		1070
		1071	=item $GLenum = $gl_texture->target
		1072
		1073	Calls C<clGetGlTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1074
		1075	=item $GLint = $gl_texture->gl_mipmap_level
		1076
		1077	Calls C<clGetGlTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1078
		1079	=for gengetinfo end gl_texture
		1080
599	=back	1081	=back
600		1082
601	=head2 THE OpenCL::Sampler CLASS	1083	=head2 THE OpenCL::Sampler CLASS
602		1084
603	=over 4	1085	=over 4
…		…
606		1088
607	See C<< $platform->info >> for details.	1089	See C<< $platform->info >> for details.
608		1090
609	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1091	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
610		1092
		1093	=for gengetinfo begin sampler
		1094
		1095	=item $uint = $sampler->reference_count
		1096
		1097	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1098
		1099	=item $ctx = $sampler->context
		1100
		1101	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1102
		1103	=item $addressing_mode = $sampler->normalized_coords
		1104
		1105	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1106
		1107	=item $filter_mode = $sampler->addressing_mode
		1108
		1109	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1110
		1111	=item $boolean = $sampler->filter_mode
		1112
		1113	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1114
		1115	=for gengetinfo end sampler
		1116
611	=back	1117	=back
612		1118
613	=head2 THE OpenCL::Program CLASS	1119	=head2 THE OpenCL::Program CLASS
614		1120
615	=over 4	1121	=over 4
616
617	=item $packed_value = $program->info ($name)
618
619	See C<< $platform->info >> for details.
620
621	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
622		1122
623	=item $program->build ($device, $options = "")	1123	=item $program->build ($device, $options = "")
624		1124
625	Tries to build the program with the givne options.	1125	Tries to build the program with the givne options.
626		1126
…		…
638	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1138	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
639	the program.	1139	the program.
640		1140
641	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1141	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
642		1142
		1143	=for gengetinfo begin program_build
		1144
		1145	=item $build_status = $program->build_status ($device)
		1146
		1147	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1148
		1149	=item $string = $program->build_options ($device)
		1150
		1151	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1152
		1153	=item $string = $program->build_log ($device)
		1154
		1155	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1156
		1157	=for gengetinfo end program_build
		1158
		1159	=item $packed_value = $program->info ($name)
		1160
		1161	See C<< $platform->info >> for details.
		1162
		1163	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1164
		1165	=for gengetinfo begin program
		1166
		1167	=item $uint = $program->reference_count
		1168
		1169	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1170
		1171	=item $ctx = $program->context
		1172
		1173	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1174
		1175	=item $uint = $program->num_devices
		1176
		1177	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1178
		1179	=item @devices = $program->devices
		1180
		1181	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1182
		1183	=item $string = $program->source
		1184
		1185	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1186
		1187	=item @ints = $program->binary_sizes
		1188
		1189	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1190
		1191	=for gengetinfo end program
		1192
		1193	=item @blobs = $program->binaries
		1194
		1195	Returns a string for the compiled binary for every device associated with
		1196	the program, empty strings indicate missing programs, and an empty result
		1197	means no program binaries are available.
		1198
		1199	These "binaries" are often, in fact, informative low-level assembly
		1200	sources.
		1201
		1202	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1203
643	=back	1204	=back
644		1205
645	=head2 THE OpenCL::Kernel CLASS	1206	=head2 THE OpenCL::Kernel CLASS
646		1207
647	=over 4	1208	=over 4
…		…
649	=item $packed_value = $kernel->info ($name)	1210	=item $packed_value = $kernel->info ($name)
650		1211
651	See C<< $platform->info >> for details.	1212	See C<< $platform->info >> for details.
652		1213
653	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1215
		1216	=for gengetinfo begin kernel
		1217
		1218	=item $string = $kernel->function_name
		1219
		1220	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1221
		1222	=item $uint = $kernel->num_args
		1223
		1224	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1225
		1226	=item $uint = $kernel->reference_count
		1227
		1228	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1229
		1230	=item $ctx = $kernel->context
		1231
		1232	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1233
		1234	=item $program = $kernel->program
		1235
		1236	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1237
		1238	=for gengetinfo end kernel
654		1239
655	=item $packed_value = $kernel->work_group_info ($device, $name)	1240	=item $packed_value = $kernel->work_group_info ($device, $name)
656		1241
657	See C<< $platform->info >> for details.	1242	See C<< $platform->info >> for details.
658		1243
659	The reason this method is not called C<info> is that there already is an	1244	The reason this method is not called C<info> is that there already is an
660	C<< ->info >> method.	1245	C<< ->info >> method.
661		1246
662	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1247	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1248
		1249	=for gengetinfo begin kernel_work_group
		1250
		1251	=item $int = $kernel->work_group_size ($device)
		1252
		1253	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1254
		1255	=item @ints = $kernel->compile_work_group_size ($device)
		1256
		1257	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1258
		1259	=item $ulong = $kernel->local_mem_size ($device)
		1260
		1261	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1262
		1263	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1264
		1265	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1266
		1267	=item $ulong = $kernel->private_mem_size ($device)
		1268
		1269	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1270
		1271	=for gengetinfo end kernel_work_group
663		1272
664	=item $kernel->set_TYPE ($index, $value)	1273	=item $kernel->set_TYPE ($index, $value)
665		1274
666	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1275	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
667		1276
…		…
683	This is the superclass for all event objects (including OpenCL::UserEvent	1292	This is the superclass for all event objects (including OpenCL::UserEvent
684	objects).	1293	objects).
685		1294
686	=over 4	1295	=over 4
687		1296
		1297	=item $ev->wait
		1298
		1299	Waits for the event to complete.
		1300
		1301	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1302
688	=item $packed_value = $ev->info ($name)	1303	=item $packed_value = $ev->info ($name)
689		1304
690	See C<< $platform->info >> for details.	1305	See C<< $platform->info >> for details.
691		1306
692	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1307	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
		1308
		1309	=for gengetinfo begin event
		1310
		1311	=item $queue = $event->command_queue
		1312
		1313	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1314
		1315	=item $command_type = $event->command_type
		1316
		1317	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1318
		1319	=item $uint = $event->reference_count
		1320
		1321	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1322
		1323	=item $uint = $event->command_execution_status
		1324
		1325	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1326
		1327	=item $ctx = $event->context
		1328
		1329	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1330
		1331	=for gengetinfo end event
693		1332
694	=item $packed_value = $ev->profiling_info ($name)	1333	=item $packed_value = $ev->profiling_info ($name)
695		1334
696	See C<< $platform->info >> for details.	1335	See C<< $platform->info >> for details.
697		1336
698	The reason this method is not called C<info> is that there already is an	1337	The reason this method is not called C<info> is that there already is an
699	C<< ->info >> method.	1338	C<< ->info >> method.
700		1339
701	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>	1340	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
702		1341
703	=item $ev->wait	1342	=for gengetinfo begin profiling
704		1343
705	Waits for the event to complete.	1344	=item $ulong = $event->profiling_command_queued
706		1345
707	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1346	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1347
		1348	=item $ulong = $event->profiling_command_submit
		1349
		1350	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1351
		1352	=item $ulong = $event->profiling_command_start
		1353
		1354	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1355
		1356	=item $ulong = $event->profiling_command_end
		1357
		1358	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1359
		1360	=for gengetinfo end profiling
708		1361
709	=back	1362	=back
710		1363
711	=head2 THE OpenCL::UserEvent CLASS	1364	=head2 THE OpenCL::UserEvent CLASS
712		1365
…		…
725	package OpenCL;	1378	package OpenCL;
726		1379
727	use common::sense;	1380	use common::sense;
728		1381
729	BEGIN {	1382	BEGIN {
730	our $VERSION = '0.15';	1383	our $VERSION = '0.92';
731		1384
732	require XSLoader;	1385	require XSLoader;
733	XSLoader::load (__PACKAGE__, $VERSION);	1386	XSLoader::load (__PACKAGE__, $VERSION);
734		1387
735	@OpenCL::Buffer::ISA =	1388	@OpenCL::Buffer::ISA =
736	@OpenCL::Image::ISA = OpenCL::Memory::;	1389	@OpenCL::Image::ISA = OpenCL::Memory::;
737		1390
		1391	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1392
738	@OpenCL::Image2D::ISA =	1393	@OpenCL::Image2D::ISA =
739	@OpenCL::Image3D::ISA = OpenCL::Image::;	1394	@OpenCL::Image3D::ISA = OpenCL::Image::;
740		1395
741	@OpenCL::UserEvent::ISA = OpenCL::Event::;	1396	@OpenCL::UserEvent::ISA = OpenCL::Event::;
742	}	1397	}
743		1398
744	1;	1399	1;
745		1400
746	=head1 AUTHOR	1401	=head1 AUTHOR

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.20 by root, Sun Nov 20 01:09:48 2011 UTC vs. Revision 1.36 by root, Thu Apr 19 14:34:56 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.20 by root, Sun Nov 20 01:09:48 2011 UTC vs.
Revision 1.36 by root, Thu Apr 19 14:34:56 2012 UTC