[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.50 by root, Tue Apr 24 13:30:49 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, "-cl-fast-relaxed-math"); 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.
…		…
210	# enqueue an async read	210	# enqueue an async read
211	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	211	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212		212
213	# wait for the last event to complete	213	# wait for the last event to complete
214	$ev->wait;	214	$ev->wait;
		215
		216	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
		217	set tunnel effect.
		218
		219	This is quite a long example to get you going.
		220
		221	use OpenGL ":all";
		222	use OpenCL;
		223
		224	# open a window and create a gl texture
		225	OpenGL::glpOpenWindow width => 256, height => 256;
		226	my $texid = glGenTextures_p 1;
		227	glBindTexture GL_TEXTURE_2D, $texid;
		228	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
		229
		230	# find and use the first opencl device that let's us get a shared opengl context
		231	my $platform;
		232	my $dev;
		233	my $ctx;
		234
		235	for (OpenCL::platforms) {
		236	$platform = $_;
		237	for ($platform->devices) {
		238	$dev = $_;
		239	$ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
		240	and last;
		241	}
		242	}
		243
		244	$ctx
		245	or die "cannot find suitable OpenCL device\n";
		246
		247	my $queue = $ctx->queue ($dev);
		248
		249	# now attach an opencl image2d object to the opengl texture
		250	my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
		251
		252	# now the boring opencl code
		253	my $src = <<EOF;
		254	kernel void
		255	juliatunnel (write_only image2d_t img, float time)
		256	{
		257	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
		258
		259	float2 m = (float2)(1.f, p.y) / fabs (p.x);
		260	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
		261
		262	float2 z = m;
		263	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
		264
		265	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
		266	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
		267
		268	float3 colour = (float3)(z.x, z.y, z.x * z.y);
		269	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
		270	}
		271	EOF
		272	my $prog = $ctx->program_with_source ($src);
		273	eval { $prog->build ($dev); 1 }
		274	or die $prog->build_log ($dev);
		275
		276	my $kernel = $prog->kernel ("juliatunnel");
		277
		278	# program compiled, kernel ready, now draw and loop
		279
		280	for (my $time; ; ++$time) {
		281	# acquire objects from opengl
		282	$queue->enqueue_acquire_gl_objects ([$tex]);
		283
		284	# configure and run our kernel
		285	$kernel->set_image2d (0, $tex);
		286	$kernel->set_float (1, $time);
		287	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
		288
		289	# release objects to opengl again
		290	$queue->enqueue_release_gl_objects ([$tex]);
		291
		292	# wait
		293	$queue->finish;
		294
		295	# now draw the texture, the defaults should be all right
		296	glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
		297
		298	glEnable GL_TEXTURE_2D;
		299	glBegin GL_QUADS;
		300	glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
		301	glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
		302	glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
		303	glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
		304	glEnd;
		305
		306	glXSwapBuffers;
		307
		308	select undef, undef, undef, 1/60;
		309	}
215		310
216	=head1 DOCUMENTATION	311	=head1 DOCUMENTATION
217		312
218	=head2 BASIC CONVENTIONS	313	=head2 BASIC CONVENTIONS
219		314
…		…
241	=item * Structures are often specified by flattening out their components	336	=item * Structures are often specified by flattening out their components
242	as with short vectors, and returned as arrayrefs.	337	as with short vectors, and returned as arrayrefs.
243		338
244	=item * When enqueuing commands, the wait list is specified by adding	339	=item * When enqueuing commands, the wait list is specified by adding
245	extra arguments to the function - anywhere a C<$wait_events...> argument	340	extra arguments to the function - anywhere a C<$wait_events...> argument
246	is documented this can be any number of event objects.	341	is documented this can be any number of event objects. As an extsnion
		342	implemented by this module, C<undef> values will be ignored in the event
		343	list.
247		344
248	=item * When enqueuing commands, if the enqueue method is called in void	345	=item * When enqueuing commands, if the enqueue method is called in void
249	context, no event is created. In all other contexts an event is returned	346	context, no event is created. In all other contexts an event is returned
250	by the method.	347	by the method.
251		348
…		…
271	ulong IV - Q	368	ulong IV - Q
272	float NV float f	369	float NV float f
273	half IV ushort S	370	half IV ushort S
274	double NV double d	371	double NV double d
275		372
		373	=head2 GLX SUPPORT
		374
		375	Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
		376	module, which has little to no documentation and has little to no support
		377	for glX), this module, as a special extension, treats context creation
		378	properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
		379	specially: If either or both of these are C<undef>, then the OpenCL
		380	module tries to dynamically resolve C<glXGetCurrentDisplay> and
		381	C<glXGetCurrentContext>, call these functions and use their return values
		382	instead.
		383
		384	For this to work, the OpenGL library must be loaded, a GLX context must
		385	have been created and be made current, and C<dlsym> must be available and
		386	capable of finding the function via C<RTLD_DEFAULT>.
		387
276	=head2 THE OpenCL PACKAGE	388	=head2 THE OpenCL PACKAGE
277		389
278	=over 4	390	=over 4
279		391
280	=item $int = OpenCL::errno	392	=item $int = OpenCL::errno
…		…
286		398
287	Comverts an error value into a human readable string.	399	Comverts an error value into a human readable string.
288		400
289	=item $str = OpenCL::enum2str $enum	401	=item $str = OpenCL::enum2str $enum
290		402
291	Converts most enum values (inof parameter names, image format constants,	403	Converts most enum values (of parameter names, image format constants,
292	object types, addressing and filter modes, command types etc.) into a	404	object types, addressing and filter modes, command types etc.) into a
293	human readbale string. When confronted with some random integer it can be	405	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	406	very helpful to pass it through this function to maybe get some readable
295	string out of it.	407	string out of it.
296		408
297	=item @platforms = OpenCL::platforms	409	=item @platforms = OpenCL::platforms
298		410
…		…
322		434
323	Returns a list of matching OpenCL::Device objects.	435	Returns a list of matching OpenCL::Device objects.
324		436
325	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	437	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
326		438
327	Tries to create a context. Never worked for me, and you need devices explitly anyway.	439	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328		440
329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	441	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330		442
331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	443	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
332		444
333	Create a new OpenCL::Context object using the given device object(s)- a	445	Create a new OpenCL::Context object using the given device object(s)- a
334	CL_CONTEXT_PLATFORM property is supplied automatically.	446	CL_CONTEXT_PLATFORM property is supplied automatically.
335		447
336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
337		449
338	=item $packed_value = $platform->info ($name)	450	=item $packed_value = $platform->info ($name)
339		451
340	Calls C<clGetPlatformInfo> and returns the packed, raw value - for	452	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
341	strings, this will be the string, for other values you probably need to	453	strings, this will be the string (possibly including terminating \0), for
342	use the correct C<unpack>.	454	other values you probably need to use the correct C<unpack>.
343		455
344	It's best to avoid this method and use one of the predefined C<get_*>	456	It's best to avoid this method and use one of the following convenience
345	methods.	457	wrappers.
346		458
347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	459	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348		460
		461	=item $platform->unload_compiler
		462
		463	Attempts to unload the compiler for this platform, for endless
		464	profit. Does nothing on OpenCL 1.1.
		465
		466	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		467
349	=for gengetinfo begin platform	468	=for gengetinfo begin platform
350		469
351
352	=item $string = $platform->profile	470	=item $string = $platform->profile
353		471
354	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result(s).	472	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
355		473
356	=item $string = $platform->version	474	=item $string = $platform->version
357		475
358	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result(s).	476	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
359		477
360	=item $string = $platform->name	478	=item $string = $platform->name
361		479
362	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result(s).	480	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
363		481
364	=item $string = $platform->vendor	482	=item $string = $platform->vendor
365		483
366	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result(s).	484	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
367		485
368	=item $string = $platform->extensions	486	=item $string = $platform->extensions
369		487
370	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result(s).	488	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		489
371	=for gengetinfo end platform	490	=for gengetinfo end platform
372		491
373	=back	492	=back
374		493
375	=head2 THE OpenCL::Device CLASS	494	=head2 THE OpenCL::Device CLASS
…		…
380		499
381	See C<< $platform->info >> for details.	500	See C<< $platform->info >> for details.
382		501
383	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	502	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
384		503
		504	=for gengetinfo begin device
		505
		506	=item $device_type = $device->type
		507
		508	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		509
		510	=item $uint = $device->vendor_id
		511
		512	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		513
		514	=item $uint = $device->max_compute_units
		515
		516	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		517
		518	=item $uint = $device->max_work_item_dimensions
		519
		520	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		521
		522	=item $int = $device->max_work_group_size
		523
		524	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		525
		526	=item @ints = $device->max_work_item_sizes
		527
		528	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		529
		530	=item $uint = $device->preferred_vector_width_char
		531
		532	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		533
		534	=item $uint = $device->preferred_vector_width_short
		535
		536	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		537
		538	=item $uint = $device->preferred_vector_width_int
		539
		540	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		541
		542	=item $uint = $device->preferred_vector_width_long
		543
		544	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		545
		546	=item $uint = $device->preferred_vector_width_float
		547
		548	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		549
		550	=item $uint = $device->preferred_vector_width_double
		551
		552	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		553
		554	=item $uint = $device->max_clock_frequency
		555
		556	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		557
		558	=item $bitfield = $device->address_bits
		559
		560	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		561
		562	=item $uint = $device->max_read_image_args
		563
		564	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		565
		566	=item $uint = $device->max_write_image_args
		567
		568	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		569
		570	=item $ulong = $device->max_mem_alloc_size
		571
		572	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		573
		574	=item $int = $device->image2d_max_width
		575
		576	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		577
		578	=item $int = $device->image2d_max_height
		579
		580	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		581
		582	=item $int = $device->image3d_max_width
		583
		584	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		585
		586	=item $int = $device->image3d_max_height
		587
		588	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		589
		590	=item $int = $device->image3d_max_depth
		591
		592	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		593
		594	=item $uint = $device->image_support
		595
		596	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		597
		598	=item $int = $device->max_parameter_size
		599
		600	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		601
		602	=item $uint = $device->max_samplers
		603
		604	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		605
		606	=item $uint = $device->mem_base_addr_align
		607
		608	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		609
		610	=item $uint = $device->min_data_type_align_size
		611
		612	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		613
		614	=item $device_fp_config = $device->single_fp_config
		615
		616	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		617
		618	=item $device_mem_cache_type = $device->global_mem_cache_type
		619
		620	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		621
		622	=item $uint = $device->global_mem_cacheline_size
		623
		624	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		625
		626	=item $ulong = $device->global_mem_cache_size
		627
		628	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		629
		630	=item $ulong = $device->global_mem_size
		631
		632	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		633
		634	=item $ulong = $device->max_constant_buffer_size
		635
		636	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		637
		638	=item $uint = $device->max_constant_args
		639
		640	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		641
		642	=item $device_local_mem_type = $device->local_mem_type
		643
		644	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		645
		646	=item $ulong = $device->local_mem_size
		647
		648	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		649
		650	=item $boolean = $device->error_correction_support
		651
		652	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		653
		654	=item $int = $device->profiling_timer_resolution
		655
		656	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		657
		658	=item $boolean = $device->endian_little
		659
		660	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		661
		662	=item $boolean = $device->available
		663
		664	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		665
		666	=item $boolean = $device->compiler_available
		667
		668	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		669
		670	=item $device_exec_capabilities = $device->execution_capabilities
		671
		672	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		673
		674	=item $command_queue_properties = $device->properties
		675
		676	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		677
		678	=item $ = $device->platform
		679
		680	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		681
		682	=item $string = $device->name
		683
		684	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		685
		686	=item $string = $device->vendor
		687
		688	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		689
		690	=item $string = $device->driver_version
		691
		692	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		693
		694	=item $string = $device->profile
		695
		696	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		697
		698	=item $string = $device->version
		699
		700	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		701
		702	=item $string = $device->extensions
		703
		704	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		705
		706	=item $uint = $device->preferred_vector_width_half
		707
		708	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		709
		710	=item $uint = $device->native_vector_width_char
		711
		712	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		713
		714	=item $uint = $device->native_vector_width_short
		715
		716	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		717
		718	=item $uint = $device->native_vector_width_int
		719
		720	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		721
		722	=item $uint = $device->native_vector_width_long
		723
		724	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		725
		726	=item $uint = $device->native_vector_width_float
		727
		728	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		729
		730	=item $uint = $device->native_vector_width_double
		731
		732	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		733
		734	=item $uint = $device->native_vector_width_half
		735
		736	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		737
		738	=item $device_fp_config = $device->double_fp_config
		739
		740	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		741
		742	=item $device_fp_config = $device->half_fp_config
		743
		744	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		745
		746	=item $boolean = $device->host_unified_memory
		747
		748	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		749
		750	=item $device = $device->parent_device_ext
		751
		752	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		753
		754	=item @device_partition_property_exts = $device->partition_types_ext
		755
		756	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		757
		758	=item @device_partition_property_exts = $device->affinity_domains_ext
		759
		760	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		761
		762	=item $uint = $device->reference_count_ext
		763
		764	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
		765
		766	=item @device_partition_property_exts = $device->partition_style_ext
		767
		768	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		769
		770	=for gengetinfo end device
		771
385	=back	772	=back
386		773
387	=head2 THE OpenCL::Context CLASS	774	=head2 THE OpenCL::Context CLASS
388		775
389	=over 4	776	=over 4
…		…
392		779
393	Create a new OpenCL::Queue object from the context and the given device.	780	Create a new OpenCL::Queue object from the context and the given device.
394		781
395	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	782	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
396		783
		784	Example: create an out-of-order queue.
		785
		786	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		787
397	=item $ev = $ctx->user_event	788	=item $ev = $ctx->user_event
398		789
399	Creates a new OpenCL::UserEvent object.	790	Creates a new OpenCL::UserEvent object.
400		791
401	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	792	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
402		793
403	=item $buf = $ctx->buffer ($flags, $len)	794	=item $buf = $ctx->buffer ($flags, $len)
404		795
405	Creates a new OpenCL::Buffer object with the given flags and octet-size.	796	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		797	given flags and octet-size.
406		798
407	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	799	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
408		800
409	=item $buf = $ctx->buffer_sv ($flags, $data)	801	=item $buf = $ctx->buffer_sv ($flags, $data)
410		802
411	Creates a new OpenCL::Buffer object and initialise it with the given data values.	803	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		804	initialise it with the given data values.
		805
		806	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
		807
		808	Creates a new OpenCL::Image object and optionally initialises it with
		809	the given data values.
		810
		811	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
412		812
413	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	813	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
414		814
415	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	815	Creates a new OpenCL::Image2D object and optionally initialises it with
		816	the given data values.
416		817
417	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	818	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
418		819
419	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)	820	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
420		821
421	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	822	Creates a new OpenCL::Image3D object and optionally initialises it with
		823	the given data values.
422		824
423	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	825	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		826
		827	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		828
		829	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		830	OpenGL buffer object.
		831
		832	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		833
		834	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		835
		836	Creates a new OpenCL::Image object that refers to the given OpenGL
		837	texture object or buffer.
		838
		839	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		840
		841	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		842
		843	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		844	2D texture object.
		845
		846	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		847
		848	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		849
		850	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		851	3D texture object.
		852
		853	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		854
		855	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		856
		857	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		858	render buffer.
		859
		860	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
424		861
425	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	862	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
426		863
427	Returns a list of matching image formats - each format is an arrayref with	864	Returns a list of matching image formats - each format is an arrayref with
428	two values, $channel_order and $channel_type, in it.	865	two values, $channel_order and $channel_type, in it.
…		…
446	See C<< $platform->info >> for details.	883	See C<< $platform->info >> for details.
447		884
448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	885	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
449		886
450	=for gengetinfo begin context	887	=for gengetinfo begin context
		888
		889	=item $uint = $context->reference_count
		890
		891	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		892
		893	=item @devices = $context->devices
		894
		895	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		896
		897	=item @property_ints = $context->properties
		898
		899	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		900
		901	=item $uint = $context->num_devices
		902
		903	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
451		904
452	=for gengetinfo end context	905	=for gengetinfo end context
453		906
454	=back	907	=back
455		908
…		…
463	for completion, unless the method is called in void context, in which case	916	for completion, unless the method is called in void context, in which case
464	no event object is created.	917	no event object is created.
465		918
466	They also allow you to specify any number of other event objects that this	919	They also allow you to specify any number of other event objects that this
467	request has to wait for before it starts executing, by simply passing the	920	request has to wait for before it starts executing, by simply passing the
468	event objects as extra parameters to the enqueue methods.	921	event objects as extra parameters to the enqueue methods. To simplify
		922	program design, this module ignores any C<undef> values in the list of
		923	events. This makes it possible to code operations such as this, without
		924	having to put a valid event object into C<$event> first:
		925
		926	$event = $queue->enqueue_xxx (..., $event);
469		927
470	Queues execute in-order by default, without any parallelism, so in most	928	Queues execute in-order by default, without any parallelism, so in most
471	cases (i.e. you use only one queue) it's not necessary to wait for or	929	cases (i.e. you use only one queue) it's not necessary to wait for or
472	create event objects.	930	create event objects, althoguh an our of order queue is often a bit
		931	faster.
473		932
474	=over 4	933	=over 4
475		934
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...)	935	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
483		936
484	Reads data from buffer into the given string.	937	Reads data from buffer into the given string.
485		938
486	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	939	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
493		946
494	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	947	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
495		948
496	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	949	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
497		950
		951	=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...)
		952
		953	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		954
		955	=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...)
		956
		957	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		958
498	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	959	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
499		960
		961	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		962
		963	=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...)
		964
500	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	965	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
501		966
502	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	967	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
503		968
504	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	969	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
505		970
		971	=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...)
		972
		973	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		974
		975	=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...)
		976
		977	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		978
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...)	979	=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		980
508	Yeah.	981	Yeah.
509		982
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>.	983	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		984
524	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	985	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
525		986
526	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	987	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
527		988
…		…
541	reference to an array of local work sizes, with the same number of	1002	reference to an array of local work sizes, with the same number of
542	elements as @$global_work_size.	1003	elements as @$global_work_size.
543		1004
544	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1005	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
545		1006
546	=item $ev = $queue->enqueue_marker	1007	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
547		1008
		1009	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1010	for subsequent OpenCL usage.
		1011
548	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1012	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		1013
		1014	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		1015
		1016	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1017	for subsequent OpenGL usage.
		1018
		1019	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
549		1020
550	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1021	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
551		1022
552	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1023	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
553		1024
554	=item $queue->enqueue_barrier	1025	=item $ev = $queue->enqueue_marker ($wait_events...)
555		1026
		1027	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1028
		1029	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1030
556	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1031	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
557		1032
558	=item $queue->flush	1033	=item $queue->flush
559		1034
560	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1035	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
561		1036
562	=item $queue->finish	1037	=item $queue->finish
563		1038
564	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	1039	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
565		1040
		1041	=item $packed_value = $queue->info ($name)
		1042
		1043	See C<< $platform->info >> for details.
		1044
		1045	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1046
		1047	=for gengetinfo begin command_queue
		1048
		1049	=item $ctx = $command_queue->context
		1050
		1051	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1052
		1053	=item $device = $command_queue->device
		1054
		1055	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1056
		1057	=item $uint = $command_queue->reference_count
		1058
		1059	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1060
		1061	=item $command_queue_properties = $command_queue->properties
		1062
		1063	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1064
		1065	=for gengetinfo end command_queue
		1066
566	=back	1067	=back
567		1068
568	=head2 THE OpenCL::Memory CLASS	1069	=head2 THE OpenCL::Memory CLASS
569		1070
570	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	1071	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
571	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	1072	OpenCL::Image2D and OpenCL::Image3D.
572	currently only exist to allow type-checking.
573		1073
574	=over 4	1074	=over 4
575		1075
576	=item $packed_value = $memory->info ($name)	1076	=item $packed_value = $memory->info ($name)
577		1077
578	See C<< $platform->info >> for details.	1078	See C<< $platform->info >> for details.
579		1079
580	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1080	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
581		1081
		1082	=for gengetinfo begin mem
		1083
		1084	=item $mem_object_type = $mem->type
		1085
		1086	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1087
		1088	=item $mem_flags = $mem->flags
		1089
		1090	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1091
		1092	=item $int = $mem->size
		1093
		1094	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1095
		1096	=item $ptr_value = $mem->host_ptr
		1097
		1098	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1099
		1100	=item $uint = $mem->map_count
		1101
		1102	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1103
		1104	=item $uint = $mem->reference_count
		1105
		1106	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1107
		1108	=item $ctx = $mem->context
		1109
		1110	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1111
		1112	=item $mem = $mem->associated_memobject
		1113
		1114	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1115
		1116	=item $int = $mem->offset
		1117
		1118	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1119
		1120	=for gengetinfo end mem
		1121
		1122	=item ($type, $name) = $mem->gl_object_info
		1123
		1124	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1125	object "name" (e.g. the texture name) used to create this memory object.
		1126
		1127	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1128
582	=back	1129	=back
583		1130
		1131	=head2 THE OpenCL::Buffer CLASS
		1132
		1133	This is a subclass of OpenCL::Memory, and the superclass of
		1134	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1135	and sub-buffers.
		1136
		1137	=head2 THE OpenCL::BufferObj CLASS
		1138
		1139	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1140	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1141	sub buffers from these sub buffers.
		1142
		1143	=over 4
		1144
		1145	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1146
		1147	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1148	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1149
		1150	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1151
		1152	=back
		1153
584	=head2 THE OpenCL::Image CLASS	1154	=head2 THE OpenCL::Image CLASS
585		1155
586	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.	1156	This is the superclass of all image objects - OpenCL::Image1D,
		1157	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1158	OpenCL::Image2DArray and OpenCL::Image3D.
587		1159
588	=over 4	1160	=over 4
589		1161
590	=item $packed_value = $ev->image_info ($name)	1162	=item $packed_value = $ev->image_info ($name)
591		1163
…		…
594	The reason this method is not called C<info> is that there already is an	1166	The reason this method is not called C<info> is that there already is an
595	C<< ->info >> method inherited from C<OpenCL::Memory>.	1167	C<< ->info >> method inherited from C<OpenCL::Memory>.
596		1168
597	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1169	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
598		1170
		1171	=for gengetinfo begin image
		1172
		1173	=item $int = $image->element_size
		1174
		1175	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1176
		1177	=item $int = $image->row_pitch
		1178
		1179	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1180
		1181	=item $int = $image->slice_pitch
		1182
		1183	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1184
		1185	=item $int = $image->width
		1186
		1187	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1188
		1189	=item $int = $image->height
		1190
		1191	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1192
		1193	=item $int = $image->depth
		1194
		1195	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1196
		1197	=for gengetinfo end image
		1198
		1199	=for gengetinfo begin gl_texture
		1200
		1201	=item $GLenum = $gl_texture->target
		1202
		1203	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1204
		1205	=item $GLint = $gl_texture->gl_mipmap_level
		1206
		1207	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1208
		1209	=for gengetinfo end gl_texture
		1210
599	=back	1211	=back
600		1212
601	=head2 THE OpenCL::Sampler CLASS	1213	=head2 THE OpenCL::Sampler CLASS
602		1214
603	=over 4	1215	=over 4
…		…
606		1218
607	See C<< $platform->info >> for details.	1219	See C<< $platform->info >> for details.
608		1220
609	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1221	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
610		1222
		1223	=for gengetinfo begin sampler
		1224
		1225	=item $uint = $sampler->reference_count
		1226
		1227	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1228
		1229	=item $ctx = $sampler->context
		1230
		1231	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1232
		1233	=item $addressing_mode = $sampler->normalized_coords
		1234
		1235	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1236
		1237	=item $filter_mode = $sampler->addressing_mode
		1238
		1239	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1240
		1241	=item $boolean = $sampler->filter_mode
		1242
		1243	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1244
		1245	=for gengetinfo end sampler
		1246
611	=back	1247	=back
612		1248
613	=head2 THE OpenCL::Program CLASS	1249	=head2 THE OpenCL::Program CLASS
614		1250
615	=over 4	1251	=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		1252
623	=item $program->build ($device, $options = "")	1253	=item $program->build ($device, $options = "")
624		1254
625	Tries to build the program with the givne options.	1255	Tries to build the program with the givne options.
626		1256
…		…
638	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1268	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
639	the program.	1269	the program.
640		1270
641	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1271	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
642		1272
		1273	=item @kernels = $program->kernels_in_program
		1274
		1275	Returns all kernels successfully compiled for all devices in program.
		1276
		1277	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
		1278
		1279	=for gengetinfo begin program_build
		1280
		1281	=item $build_status = $program->build_status ($device)
		1282
		1283	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1284
		1285	=item $string = $program->build_options ($device)
		1286
		1287	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1288
		1289	=item $string = $program->build_log ($device)
		1290
		1291	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1292
		1293	=for gengetinfo end program_build
		1294
		1295	=item $packed_value = $program->info ($name)
		1296
		1297	See C<< $platform->info >> for details.
		1298
		1299	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1300
		1301	=for gengetinfo begin program
		1302
		1303	=item $uint = $program->reference_count
		1304
		1305	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1306
		1307	=item $ctx = $program->context
		1308
		1309	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1310
		1311	=item $uint = $program->num_devices
		1312
		1313	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1314
		1315	=item @devices = $program->devices
		1316
		1317	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1318
		1319	=item $string = $program->source
		1320
		1321	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1322
		1323	=item @ints = $program->binary_sizes
		1324
		1325	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1326
		1327	=for gengetinfo end program
		1328
		1329	=item @blobs = $program->binaries
		1330
		1331	Returns a string for the compiled binary for every device associated with
		1332	the program, empty strings indicate missing programs, and an empty result
		1333	means no program binaries are available.
		1334
		1335	These "binaries" are often, in fact, informative low-level assembly
		1336	sources.
		1337
		1338	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1339
643	=back	1340	=back
644		1341
645	=head2 THE OpenCL::Kernel CLASS	1342	=head2 THE OpenCL::Kernel CLASS
646		1343
647	=over 4	1344	=over 4
…		…
649	=item $packed_value = $kernel->info ($name)	1346	=item $packed_value = $kernel->info ($name)
650		1347
651	See C<< $platform->info >> for details.	1348	See C<< $platform->info >> for details.
652		1349
653	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1350	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1351
		1352	=for gengetinfo begin kernel
		1353
		1354	=item $string = $kernel->function_name
		1355
		1356	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1357
		1358	=item $uint = $kernel->num_args
		1359
		1360	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1361
		1362	=item $uint = $kernel->reference_count
		1363
		1364	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1365
		1366	=item $ctx = $kernel->context
		1367
		1368	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1369
		1370	=item $program = $kernel->program
		1371
		1372	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1373
		1374	=for gengetinfo end kernel
654		1375
655	=item $packed_value = $kernel->work_group_info ($device, $name)	1376	=item $packed_value = $kernel->work_group_info ($device, $name)
656		1377
657	See C<< $platform->info >> for details.	1378	See C<< $platform->info >> for details.
658		1379
659	The reason this method is not called C<info> is that there already is an	1380	The reason this method is not called C<info> is that there already is an
660	C<< ->info >> method.	1381	C<< ->info >> method.
661		1382
662	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>	1383	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
663		1384
		1385	=for gengetinfo begin kernel_work_group
		1386
		1387	=item $int = $kernel->work_group_size ($device)
		1388
		1389	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1390
		1391	=item @ints = $kernel->compile_work_group_size ($device)
		1392
		1393	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1394
		1395	=item $ulong = $kernel->local_mem_size ($device)
		1396
		1397	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1398
		1399	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1400
		1401	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1402
		1403	=item $ulong = $kernel->private_mem_size ($device)
		1404
		1405	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1406
		1407	=for gengetinfo end kernel_work_group
		1408
664	=item $kernel->set_TYPE ($index, $value)	1409	=item $kernel->set_TYPE ($index, $value)
665		1410
666	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1411	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
667		1412
668	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,	1413	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
669	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,	1414	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
670	C<image2d>, C<image3d>, C<sampler> or C<event>.	1415	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
671		1416
672	Chars and integers (including the half type) are specified as integers,	1417	Chars and integers (including the half type) are specified as integers,
673	float and double as floating point values, memory/buffer/image2d/image3d	1418	float and double as floating point values, memory/buffer/image2d/image3d
674	must be an object of that type or C<undef>, and sampler and event must be	1419	must be an object of that type or C<undef>, local-memory arguments are
675	objects of that type.	1420	set by specifying the size, and sampler and event must be objects of that
		1421	type.
		1422
		1423	Setting an argument for a kernel does NOT keep a reference to the object -
		1424	for example, if you set an argument to some image object, free the image,
		1425	and call the kernel, you will run into undefined behaviour.
676		1426
677	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1427	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
678		1428
679	=back	1429	=back
680		1430
…		…
683	This is the superclass for all event objects (including OpenCL::UserEvent	1433	This is the superclass for all event objects (including OpenCL::UserEvent
684	objects).	1434	objects).
685		1435
686	=over 4	1436	=over 4
687		1437
		1438	=item $ev->wait
		1439
		1440	Waits for the event to complete.
		1441
		1442	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1443
688	=item $packed_value = $ev->info ($name)	1444	=item $packed_value = $ev->info ($name)
689		1445
690	See C<< $platform->info >> for details.	1446	See C<< $platform->info >> for details.
691		1447
692	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
		1449
		1450	=for gengetinfo begin event
		1451
		1452	=item $queue = $event->command_queue
		1453
		1454	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1455
		1456	=item $command_type = $event->command_type
		1457
		1458	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1459
		1460	=item $uint = $event->reference_count
		1461
		1462	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1463
		1464	=item $uint = $event->command_execution_status
		1465
		1466	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1467
		1468	=item $ctx = $event->context
		1469
		1470	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1471
		1472	=for gengetinfo end event
693		1473
694	=item $packed_value = $ev->profiling_info ($name)	1474	=item $packed_value = $ev->profiling_info ($name)
695		1475
696	See C<< $platform->info >> for details.	1476	See C<< $platform->info >> for details.
697		1477
698	The reason this method is not called C<info> is that there already is an	1478	The reason this method is not called C<info> is that there already is an
699	C<< ->info >> method.	1479	C<< ->info >> method.
700		1480
701	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>	1481	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
702		1482
703	=item $ev->wait	1483	=for gengetinfo begin profiling
704		1484
705	Waits for the event to complete.	1485	=item $ulong = $event->profiling_command_queued
706		1486
707	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1487	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1488
		1489	=item $ulong = $event->profiling_command_submit
		1490
		1491	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1492
		1493	=item $ulong = $event->profiling_command_start
		1494
		1495	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1496
		1497	=item $ulong = $event->profiling_command_end
		1498
		1499	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1500
		1501	=for gengetinfo end profiling
708		1502
709	=back	1503	=back
710		1504
711	=head2 THE OpenCL::UserEvent CLASS	1505	=head2 THE OpenCL::UserEvent CLASS
712		1506
…		…
725	package OpenCL;	1519	package OpenCL;
726		1520
727	use common::sense;	1521	use common::sense;
728		1522
729	BEGIN {	1523	BEGIN {
730	our $VERSION = '0.15';	1524	our $VERSION = '0.96';
731		1525
732	require XSLoader;	1526	require XSLoader;
733	XSLoader::load (__PACKAGE__, $VERSION);	1527	XSLoader::load (__PACKAGE__, $VERSION);
734		1528
735	@OpenCL::Buffer::ISA =	1529	@OpenCL::Buffer::ISA =
736	@OpenCL::Image::ISA = OpenCL::Memory::;	1530	@OpenCL::Image::ISA = OpenCL::Memory::;
737		1531
		1532	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1533
738	@OpenCL::Image2D::ISA =	1534	@OpenCL::Image2D::ISA =
		1535	@OpenCL::Image3D::ISA =
		1536	@OpenCL::Image2DArray::ISA =
		1537	@OpenCL::Image1D::ISA =
		1538	@OpenCL::Image1DArray::ISA =
739	@OpenCL::Image3D::ISA = OpenCL::Image::;	1539	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
740		1540
741	@OpenCL::UserEvent::ISA = OpenCL::Event::;	1541	@OpenCL::UserEvent::ISA = OpenCL::Event::;
742	}	1542	}
743		1543
744	1;	1544	1;
745		1545
746	=head1 AUTHOR	1546	=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.50 by root, Tue Apr 24 13:30:49 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.50 by root, Tue Apr 24 13:30:49 2012 UTC