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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs.
Revision 1.47 by root, Sat Apr 21 19:48:58 2012 UTC

…		…
27	OpenCL::Program objects, which store source code and, after building for a	27	OpenCL::Program objects, which store source code and, after building for a
28	specific device ("compiling and linking"), also binary programs. For each	28	specific device ("compiling and linking"), also binary programs. For each
29	kernel function in a program you can then create an OpenCL::Kernel object	29	kernel function in a program you can then create an OpenCL::Kernel object
30	which represents basically a function call with argument values.	30	which represents basically a function call with argument values.
31		31
32	OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat	32	OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34	or 3d array) for bulk data and input and output for kernels.	34	or 3d array) for bulk data and input and output for kernels.
35		35
36	OpenCL::Sampler objects, which are kind of like texture filter modes in	36	OpenCL::Sampler objects, which are kind of like texture filter modes in
37	OpenGL.	37	OpenGL.
…		…
101		101
102	Best run this once to get a feel for the platforms and devices in your	102	Best run this once to get a feel for the platforms and devices in your
103	system.	103	system.
104		104
105	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
106	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->name;
107	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->extensions;
108	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
109	printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME);	109	printf "+ device: %s\n", $device->name;
110	my $ctx = $device->context;	110	my $ctx = $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
…		…
226		321
227	=item * Object lifetime managament is automatic - there is no need	322	=item * Object lifetime managament is automatic - there is no need
228	to free objects explicitly (C<clReleaseXXX>), the release function	323	to free objects explicitly (C<clReleaseXXX>), the release function
229	is called automatically once all Perl references to it go away.	324	is called automatically once all Perl references to it go away.
230		325
231	=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>),	326	=item * OpenCL uses CamelCase for function names
		327	(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
232	while this module uses underscores as word separator and often leaves out	328	uses underscores as word separator and often leaves out prefixes
233	prefixes (C<< $platform->info >>).	329	(C<OpenCL::platforms>, C<< $platform->info >>).
234		330
235	=item * OpenCL often specifies fixed vector function arguments as short	331	=item * OpenCL often specifies fixed vector function arguments as short
236	arrays (C<$origin[3]>), while this module explicitly expects the	332	arrays (C<size_t origin[3]>), while this module explicitly expects the
237	components as separate arguments-	333	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		334	function calls.
238		335
239	=item * Structures are often specified with their components, and returned	336	=item * Structures are often specified by flattening out their components
240	as arrayrefs.	337	as with short vectors, and returned as arrayrefs.
241
242	=item * Where possible, one of the pitch values is calculated from the
243	perl scalar length and need not be specified.
244		338
245	=item * When enqueuing commands, the wait list is specified by adding	339	=item * When enqueuing commands, the wait list is specified by adding
246	extra arguments to the function - anywhere a C<$wait_events...> argument	340	extra arguments to the function - anywhere a C<$wait_events...> argument
247	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.
248		344
249	=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
250	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
251	by the method.	347	by the method.
252		348
…		…
272	ulong IV - Q	368	ulong IV - Q
273	float NV float f	369	float NV float f
274	half IV ushort S	370	half IV ushort S
275	double NV double d	371	double NV double d
276		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
277	=head2 THE OpenCL PACKAGE	388	=head2 THE OpenCL PACKAGE
278		389
279	=over 4	390	=over 4
280		391
281	=item $int = OpenCL::errno	392	=item $int = OpenCL::errno
…		…
287		398
288	Comverts an error value into a human readable string.	399	Comverts an error value into a human readable string.
289		400
290	=item $str = OpenCL::enum2str $enum	401	=item $str = OpenCL::enum2str $enum
291		402
292	Converts most enum values (inof parameter names, image format constants,	403	Converts most enum values (of parameter names, image format constants,
293	object types, addressing and filter modes, command types etc.) into a	404	object types, addressing and filter modes, command types etc.) into a
294	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
295	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
296	string out of it.	407	string out of it.
297		408
298	=item @platforms = OpenCL::platforms	409	=item @platforms = OpenCL::platforms
299		410
…		…
317		428
318	=head2 THE OpenCL::Platform CLASS	429	=head2 THE OpenCL::Platform CLASS
319		430
320	=over 4	431	=over 4
321		432
322	=item $packed_value = $platform->info ($name)
323
324	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
325	strings, this will be the string, for other values you probably need to
326	use the correct C<unpack>. This might get improved in the future. Hopefully.
327
328	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
329
330	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	433	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
331		434
332	Returns a list of matching OpenCL::Device objects.	435	Returns a list of matching OpenCL::Device objects.
333		436
334	=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)
335		438
336	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.
337		440
338	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>
339		442
340	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	443	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
341		444
342	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
343	CL_CONTEXT_PLATFORM property is supplied automatically.	446	CL_CONTEXT_PLATFORM property is supplied automatically.
344		447
345	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>
346		449
		450	=item $packed_value = $platform->info ($name)
		451
		452	Calls C<clGetPlatformInfo> and returns the packed, raw value - for
		453	strings, this will be the string (possibly including terminating \0), for
		454	other values you probably need to use the correct C<unpack>.
		455
		456	It's best to avoid this method and use one of the following convenience
		457	wrappers.
		458
		459	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
		460
		461	=for gengetinfo begin platform
		462
		463	=item $string = $platform->profile
		464
		465	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
		466
		467	=item $string = $platform->version
		468
		469	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
		470
		471	=item $string = $platform->name
		472
		473	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
		474
		475	=item $string = $platform->vendor
		476
		477	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
		478
		479	=item $string = $platform->extensions
		480
		481	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
		482
		483	=for gengetinfo end platform
		484
347	=back	485	=back
348		486
349	=head2 THE OpenCL::Device CLASS	487	=head2 THE OpenCL::Device CLASS
350		488
351	=over 4	489	=over 4
…		…
354		492
355	See C<< $platform->info >> for details.	493	See C<< $platform->info >> for details.
356		494
357	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	495	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
358		496
		497	=for gengetinfo begin device
		498
		499	=item $device_type = $device->type
		500
		501	Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
		502
		503	=item $uint = $device->vendor_id
		504
		505	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
		506
		507	=item $uint = $device->max_compute_units
		508
		509	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
		510
		511	=item $uint = $device->max_work_item_dimensions
		512
		513	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
		514
		515	=item $int = $device->max_work_group_size
		516
		517	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
		518
		519	=item @ints = $device->max_work_item_sizes
		520
		521	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
		522
		523	=item $uint = $device->preferred_vector_width_char
		524
		525	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
		526
		527	=item $uint = $device->preferred_vector_width_short
		528
		529	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
		530
		531	=item $uint = $device->preferred_vector_width_int
		532
		533	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
		534
		535	=item $uint = $device->preferred_vector_width_long
		536
		537	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
		538
		539	=item $uint = $device->preferred_vector_width_float
		540
		541	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
		542
		543	=item $uint = $device->preferred_vector_width_double
		544
		545	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
		546
		547	=item $uint = $device->max_clock_frequency
		548
		549	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
		550
		551	=item $bitfield = $device->address_bits
		552
		553	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
		554
		555	=item $uint = $device->max_read_image_args
		556
		557	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
		558
		559	=item $uint = $device->max_write_image_args
		560
		561	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
		562
		563	=item $ulong = $device->max_mem_alloc_size
		564
		565	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
		566
		567	=item $int = $device->image2d_max_width
		568
		569	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
		570
		571	=item $int = $device->image2d_max_height
		572
		573	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
		574
		575	=item $int = $device->image3d_max_width
		576
		577	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
		578
		579	=item $int = $device->image3d_max_height
		580
		581	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
		582
		583	=item $int = $device->image3d_max_depth
		584
		585	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
		586
		587	=item $uint = $device->image_support
		588
		589	Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
		590
		591	=item $int = $device->max_parameter_size
		592
		593	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
		594
		595	=item $uint = $device->max_samplers
		596
		597	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
		598
		599	=item $uint = $device->mem_base_addr_align
		600
		601	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
		602
		603	=item $uint = $device->min_data_type_align_size
		604
		605	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
		606
		607	=item $device_fp_config = $device->single_fp_config
		608
		609	Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
		610
		611	=item $device_mem_cache_type = $device->global_mem_cache_type
		612
		613	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
		614
		615	=item $uint = $device->global_mem_cacheline_size
		616
		617	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
		618
		619	=item $ulong = $device->global_mem_cache_size
		620
		621	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
		622
		623	=item $ulong = $device->global_mem_size
		624
		625	Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
		626
		627	=item $ulong = $device->max_constant_buffer_size
		628
		629	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
		630
		631	=item $uint = $device->max_constant_args
		632
		633	Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
		634
		635	=item $device_local_mem_type = $device->local_mem_type
		636
		637	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
		638
		639	=item $ulong = $device->local_mem_size
		640
		641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
		642
		643	=item $boolean = $device->error_correction_support
		644
		645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
		646
		647	=item $int = $device->profiling_timer_resolution
		648
		649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
		650
		651	=item $boolean = $device->endian_little
		652
		653	Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
		654
		655	=item $boolean = $device->available
		656
		657	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
		658
		659	=item $boolean = $device->compiler_available
		660
		661	Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
		662
		663	=item $device_exec_capabilities = $device->execution_capabilities
		664
		665	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
		666
		667	=item $command_queue_properties = $device->properties
		668
		669	Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
		670
		671	=item $ = $device->platform
		672
		673	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
		674
		675	=item $string = $device->name
		676
		677	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
		678
		679	=item $string = $device->vendor
		680
		681	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
		682
		683	=item $string = $device->driver_version
		684
		685	Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
		686
		687	=item $string = $device->profile
		688
		689	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
		690
		691	=item $string = $device->version
		692
		693	Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
		694
		695	=item $string = $device->extensions
		696
		697	Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
		698
		699	=item $uint = $device->preferred_vector_width_half
		700
		701	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
		702
		703	=item $uint = $device->native_vector_width_char
		704
		705	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
		706
		707	=item $uint = $device->native_vector_width_short
		708
		709	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
		710
		711	=item $uint = $device->native_vector_width_int
		712
		713	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
		714
		715	=item $uint = $device->native_vector_width_long
		716
		717	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
		718
		719	=item $uint = $device->native_vector_width_float
		720
		721	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
		722
		723	=item $uint = $device->native_vector_width_double
		724
		725	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
		726
		727	=item $uint = $device->native_vector_width_half
		728
		729	Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
		730
		731	=item $device_fp_config = $device->double_fp_config
		732
		733	Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
		734
		735	=item $device_fp_config = $device->half_fp_config
		736
		737	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
		738
		739	=item $boolean = $device->host_unified_memory
		740
		741	Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
		742
		743	=item $device = $device->parent_device_ext
		744
		745	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
		746
		747	=item @device_partition_property_exts = $device->partition_types_ext
		748
		749	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
		750
		751	=item @device_partition_property_exts = $device->affinity_domains_ext
		752
		753	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
		754
		755	=item $uint = $device->reference_count_ext
		756
		757	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
		758
		759	=item @device_partition_property_exts = $device->partition_style_ext
		760
		761	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
		762
		763	=for gengetinfo end device
		764
359	=back	765	=back
360		766
361	=head2 THE OpenCL::Context CLASS	767	=head2 THE OpenCL::Context CLASS
362		768
363	=over 4	769	=over 4
364		770
365	=item $packed_value = $ctx->info ($name)
366
367	See C<< $platform->info >> for details.
368
369	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
370
371	=item $queue = $ctx->queue ($device, $properties)	771	=item $queue = $ctx->queue ($device, $properties)
372		772
373	Create a new OpenCL::Queue object from the context and the given device.	773	Create a new OpenCL::Queue object from the context and the given device.
374		774
375	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	775	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
376		776
		777	Example: create an out-of-order queue.
		778
		779	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		780
377	=item $ev = $ctx->user_event	781	=item $ev = $ctx->user_event
378		782
379	Creates a new OpenCL::UserEvent object.	783	Creates a new OpenCL::UserEvent object.
380		784
381	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	785	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
382		786
383	=item $buf = $ctx->buffer ($flags, $len)	787	=item $buf = $ctx->buffer ($flags, $len)
384		788
385	Creates a new OpenCL::Buffer object with the given flags and octet-size.	789	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		790	given flags and octet-size.
386		791
387	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	792	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
388		793
389	=item $buf = $ctx->buffer_sv ($flags, $data)	794	=item $buf = $ctx->buffer_sv ($flags, $data)
390		795
391	Creates a new OpenCL::Buffer object and initialise it with the given data values.	796	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		797	initialise it with the given data values.
392		798
393	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	799	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
394		800
395	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	801	Creates a new OpenCL::Image2D object and optionally initialises it with
		802	the given data values.
396		803
397	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
398		805
399	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)	806	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
400		807
401	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	808	Creates a new OpenCL::Image3D object and optionally initialises it with
		809	the given data values.
402		810
403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	811	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		812
		813	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		814
		815	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		816	OpenGL buffer object.
		817
		818	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		819
		820	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		821
		822	Creates a new OpenCL::Image object that refers to the given OpenGL
		823	texture object or buffer.
		824
		825	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		826
		827	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		828
		829	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		830	2D texture object.
		831
		832	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		833
		834	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		835
		836	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		837	3D texture object.
		838
		839	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		840
		841	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		842
		843	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		844	render buffer.
		845
		846	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
404		847
405	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	848	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
406		849
407	Returns a list of matching image formats - each format is an arrayref with	850	Returns a list of matching image formats - each format is an arrayref with
408	two values, $channel_order and $channel_type, in it.	851	two values, $channel_order and $channel_type, in it.
…		…
418	=item $program = $ctx->program_with_source ($string)	861	=item $program = $ctx->program_with_source ($string)
419		862
420	Creates a new OpenCL::Program object from the given source code.	863	Creates a new OpenCL::Program object from the given source code.
421		864
422	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	865	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
		866
		867	=item $packed_value = $ctx->info ($name)
		868
		869	See C<< $platform->info >> for details.
		870
		871	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
		872
		873	=for gengetinfo begin context
		874
		875	=item $uint = $context->reference_count
		876
		877	Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
		878
		879	=item @devices = $context->devices
		880
		881	Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
		882
		883	=item @property_ints = $context->properties
		884
		885	Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
		886
		887	=item $uint = $context->num_devices
		888
		889	Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
		890
		891	=for gengetinfo end context
423		892
424	=back	893	=back
425		894
426	=head2 THE OpenCL::Queue CLASS	895	=head2 THE OpenCL::Queue CLASS
427		896
…		…
433	for completion, unless the method is called in void context, in which case	902	for completion, unless the method is called in void context, in which case
434	no event object is created.	903	no event object is created.
435		904
436	They also allow you to specify any number of other event objects that this	905	They also allow you to specify any number of other event objects that this
437	request has to wait for before it starts executing, by simply passing the	906	request has to wait for before it starts executing, by simply passing the
438	event objects as extra parameters to the enqueue methods.	907	event objects as extra parameters to the enqueue methods. To simplify
		908	program design, this module ignores any C<undef> values in the list of
		909	events. This makes it possible to code operations such as this, without
		910	having to put a valid event object into C<$event> first:
		911
		912	$event = $queue->enqueue_xxx (..., $event);
439		913
440	Queues execute in-order by default, without any parallelism, so in most	914	Queues execute in-order by default, without any parallelism, so in most
441	cases (i.e. you use only one queue) it's not necessary to wait for or	915	cases (i.e. you use only one queue) it's not necessary to wait for or
442	create event objects.	916	create event objects, althoguh an our of order queue is often a bit
		917	faster.
443		918
444	=over 4	919	=over 4
445		920
446	=item $packed_value = $ctx->info ($name)
447
448	See C<< $platform->info >> for details.
449
450	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
451
452	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	921	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
453		922
454	Reads data from buffer into the given string.	923	Reads data from buffer into the given string.
455		924
456	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	925	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
…		…
463		932
464	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	933	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
465		934
466	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	935	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
467		936
		937	=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...)
		938
		939	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
		940
		941	=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...)
		942
		943	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
		944
468	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	945	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
469		946
		947	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		948
		949	=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...)
		950
470	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	951	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
471		952
472	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	953	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
473		954
474	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	955	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
475		956
		957	=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...)
		958
		959	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		960
		961	=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...)
		962
		963	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		964
476	=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...)	965	=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...)
477		966
478	Yeah.	967	Yeah.
479		968
480	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
481
482	=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...)
483
484	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	969	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
485
486	=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...)
487
488	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
489
490	=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...)
491
492	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
493		970
494	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	971	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
495		972
496	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	973	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
497		974
…		…
511	reference to an array of local work sizes, with the same number of	988	reference to an array of local work sizes, with the same number of
512	elements as @$global_work_size.	989	elements as @$global_work_size.
513		990
514	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	991	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
515		992
516	=item $ev = $queue->enqueue_marker	993	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
517		994
		995	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		996	for subsequent OpenCL usage.
		997
518	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	998	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		999
		1000	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		1001
		1002	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1003	for subsequent OpenGL usage.
		1004
		1005	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
519		1006
520	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1007	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
521		1008
522	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1009	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
523		1010
524	=item $queue->enqueue_barrier	1011	=item $ev = $queue->enqueue_marker ($wait_events...)
525		1012
		1013	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1014
		1015	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1016
526	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1017	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
527		1018
528	=item $queue->flush	1019	=item $queue->flush
529		1020
530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1021	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
531		1022
532	=item $queue->finish	1023	=item $queue->finish
533		1024
534	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>	1025	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
535		1026
		1027	=item $packed_value = $queue->info ($name)
		1028
		1029	See C<< $platform->info >> for details.
		1030
		1031	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
		1032
		1033	=for gengetinfo begin command_queue
		1034
		1035	=item $ctx = $command_queue->context
		1036
		1037	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
		1038
		1039	=item $device = $command_queue->device
		1040
		1041	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
		1042
		1043	=item $uint = $command_queue->reference_count
		1044
		1045	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
		1046
		1047	=item $command_queue_properties = $command_queue->properties
		1048
		1049	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
		1050
		1051	=for gengetinfo end command_queue
		1052
536	=back	1053	=back
537		1054
538	=head2 THE OpenCL::Memory CLASS	1055	=head2 THE OpenCL::Memory CLASS
539		1056
540	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,	1057	This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
541	OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class	1058	OpenCL::Image2D and OpenCL::Image3D.
542	currently only exist to allow type-checking.
543		1059
544	=over 4	1060	=over 4
545		1061
546	=item $packed_value = $memory->info ($name)	1062	=item $packed_value = $memory->info ($name)
547		1063
548	See C<< $platform->info >> for details.	1064	See C<< $platform->info >> for details.
549		1065
550	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>	1066	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
551		1067
		1068	=for gengetinfo begin mem
		1069
		1070	=item $mem_object_type = $mem->type
		1071
		1072	Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
		1073
		1074	=item $mem_flags = $mem->flags
		1075
		1076	Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
		1077
		1078	=item $int = $mem->size
		1079
		1080	Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
		1081
		1082	=item $ptr_value = $mem->host_ptr
		1083
		1084	Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
		1085
		1086	=item $uint = $mem->map_count
		1087
		1088	Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
		1089
		1090	=item $uint = $mem->reference_count
		1091
		1092	Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
		1093
		1094	=item $ctx = $mem->context
		1095
		1096	Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
		1097
		1098	=item $mem = $mem->associated_memobject
		1099
		1100	Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
		1101
		1102	=item $int = $mem->offset
		1103
		1104	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
		1105
		1106	=for gengetinfo end mem
		1107
		1108	=item ($type, $name) = $mem->gl_object_info
		1109
		1110	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1111	object "name" (e.g. the texture name) used to create this memory object.
		1112
		1113	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1114
552	=back	1115	=back
553		1116
		1117	=head2 THE OpenCL::Buffer CLASS
		1118
		1119	This is a subclass of OpenCL::Memory, and the superclass of
		1120	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1121	and sub-buffers.
		1122
		1123	=head2 THE OpenCL::BufferObj CLASS
		1124
		1125	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1126	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1127	sub buffers from these sub buffers.
		1128
		1129	=over 4
		1130
		1131	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1132
		1133	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1134	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1135
		1136	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1137
		1138	=back
		1139
		1140	=head2 THE OpenCL::Image CLASS
		1141
		1142	This is the superclass of all image objects - OpenCL::Image1D,
		1143	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1144	OpenCL::Image2DArray and OpenCL::Image3D.
		1145
		1146	=over 4
		1147
		1148	=item $packed_value = $ev->image_info ($name)
		1149
		1150	See C<< $platform->info >> for details.
		1151
		1152	The reason this method is not called C<info> is that there already is an
		1153	C<< ->info >> method inherited from C<OpenCL::Memory>.
		1154
		1155	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
		1156
		1157	=for gengetinfo begin image
		1158
		1159	=item $int = $image->element_size
		1160
		1161	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
		1162
		1163	=item $int = $image->row_pitch
		1164
		1165	Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
		1166
		1167	=item $int = $image->slice_pitch
		1168
		1169	Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
		1170
		1171	=item $int = $image->width
		1172
		1173	Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
		1174
		1175	=item $int = $image->height
		1176
		1177	Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
		1178
		1179	=item $int = $image->depth
		1180
		1181	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
		1182
		1183	=for gengetinfo end image
		1184
		1185	=for gengetinfo begin gl_texture
		1186
		1187	=item $GLenum = $gl_texture->target
		1188
		1189	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1190
		1191	=item $GLint = $gl_texture->gl_mipmap_level
		1192
		1193	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1194
		1195	=for gengetinfo end gl_texture
		1196
		1197	=back
		1198
554	=head2 THE OpenCL::Sampler CLASS	1199	=head2 THE OpenCL::Sampler CLASS
555		1200
556	=over 4	1201	=over 4
557		1202
558	=item $packed_value = $sampler->info ($name)	1203	=item $packed_value = $sampler->info ($name)
559		1204
560	See C<< $platform->info >> for details.	1205	See C<< $platform->info >> for details.
561		1206
562	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>	1207	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
563		1208
		1209	=for gengetinfo begin sampler
		1210
		1211	=item $uint = $sampler->reference_count
		1212
		1213	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
		1214
		1215	=item $ctx = $sampler->context
		1216
		1217	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
		1218
		1219	=item $addressing_mode = $sampler->normalized_coords
		1220
		1221	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
		1222
		1223	=item $filter_mode = $sampler->addressing_mode
		1224
		1225	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
		1226
		1227	=item $boolean = $sampler->filter_mode
		1228
		1229	Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
		1230
		1231	=for gengetinfo end sampler
		1232
564	=back	1233	=back
565		1234
566	=head2 THE OpenCL::Program CLASS	1235	=head2 THE OpenCL::Program CLASS
567		1236
568	=over 4	1237	=over 4
569
570	=item $packed_value = $program->info ($name)
571
572	See C<< $platform->info >> for details.
573
574	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
575		1238
576	=item $program->build ($device, $options = "")	1239	=item $program->build ($device, $options = "")
577		1240
578	Tries to build the program with the givne options.	1241	Tries to build the program with the givne options.
579		1242
…		…
591	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1254	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
592	the program.	1255	the program.
593		1256
594	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1257	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
595		1258
		1259	=for gengetinfo begin program_build
		1260
		1261	=item $build_status = $program->build_status ($device)
		1262
		1263	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
		1264
		1265	=item $string = $program->build_options ($device)
		1266
		1267	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
		1268
		1269	=item $string = $program->build_log ($device)
		1270
		1271	Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
		1272
		1273	=for gengetinfo end program_build
		1274
		1275	=item $packed_value = $program->info ($name)
		1276
		1277	See C<< $platform->info >> for details.
		1278
		1279	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1280
		1281	=for gengetinfo begin program
		1282
		1283	=item $uint = $program->reference_count
		1284
		1285	Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
		1286
		1287	=item $ctx = $program->context
		1288
		1289	Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
		1290
		1291	=item $uint = $program->num_devices
		1292
		1293	Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
		1294
		1295	=item @devices = $program->devices
		1296
		1297	Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
		1298
		1299	=item $string = $program->source
		1300
		1301	Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
		1302
		1303	=item @ints = $program->binary_sizes
		1304
		1305	Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
		1306
		1307	=for gengetinfo end program
		1308
		1309	=item @blobs = $program->binaries
		1310
		1311	Returns a string for the compiled binary for every device associated with
		1312	the program, empty strings indicate missing programs, and an empty result
		1313	means no program binaries are available.
		1314
		1315	These "binaries" are often, in fact, informative low-level assembly
		1316	sources.
		1317
		1318	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
		1319
596	=back	1320	=back
597		1321
598	=head2 THE OpenCL::Kernel CLASS	1322	=head2 THE OpenCL::Kernel CLASS
599		1323
600	=over 4	1324	=over 4
…		…
602	=item $packed_value = $kernel->info ($name)	1326	=item $packed_value = $kernel->info ($name)
603		1327
604	See C<< $platform->info >> for details.	1328	See C<< $platform->info >> for details.
605		1329
606	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>	1330	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
		1331
		1332	=for gengetinfo begin kernel
		1333
		1334	=item $string = $kernel->function_name
		1335
		1336	Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
		1337
		1338	=item $uint = $kernel->num_args
		1339
		1340	Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
		1341
		1342	=item $uint = $kernel->reference_count
		1343
		1344	Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
		1345
		1346	=item $ctx = $kernel->context
		1347
		1348	Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
		1349
		1350	=item $program = $kernel->program
		1351
		1352	Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
		1353
		1354	=for gengetinfo end kernel
		1355
		1356	=item $packed_value = $kernel->work_group_info ($device, $name)
		1357
		1358	See C<< $platform->info >> for details.
		1359
		1360	The reason this method is not called C<info> is that there already is an
		1361	C<< ->info >> method.
		1362
		1363	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
		1364
		1365	=for gengetinfo begin kernel_work_group
		1366
		1367	=item $int = $kernel->work_group_size ($device)
		1368
		1369	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
		1370
		1371	=item @ints = $kernel->compile_work_group_size ($device)
		1372
		1373	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
		1374
		1375	=item $ulong = $kernel->local_mem_size ($device)
		1376
		1377	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
		1378
		1379	=item $int = $kernel->preferred_work_group_size_multiple ($device)
		1380
		1381	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
		1382
		1383	=item $ulong = $kernel->private_mem_size ($device)
		1384
		1385	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
		1386
		1387	=for gengetinfo end kernel_work_group
607		1388
608	=item $kernel->set_TYPE ($index, $value)	1389	=item $kernel->set_TYPE ($index, $value)
609		1390
610	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1391	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
611		1392
612	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,	1393	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
613	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,	1394	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
614	C<image2d>, C<image3d>, C<sampler> or C<event>.	1395	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
615		1396
616	Chars and integers (including the half type) are specified as integers,	1397	Chars and integers (including the half type) are specified as integers,
617	float and double as floating point values, memory/buffer/image2d/image3d	1398	float and double as floating point values, memory/buffer/image2d/image3d
618	must be an object of that type or C<undef>, and sampler and event must be	1399	must be an object of that type or C<undef>, local-memory arguments are
619	objects of that type.	1400	set by specifying the size, and sampler and event must be objects of that
		1401	type.
620		1402
621	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1403	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
622		1404
623	=back	1405	=back
624		1406
…		…
627	This is the superclass for all event objects (including OpenCL::UserEvent	1409	This is the superclass for all event objects (including OpenCL::UserEvent
628	objects).	1410	objects).
629		1411
630	=over 4	1412	=over 4
631		1413
		1414	=item $ev->wait
		1415
		1416	Waits for the event to complete.
		1417
		1418	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
		1419
632	=item $packed_value = $ev->info ($name)	1420	=item $packed_value = $ev->info ($name)
633		1421
634	See C<< $platform->info >> for details.	1422	See C<< $platform->info >> for details.
635		1423
636	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1424	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
637		1425
638	=item $ev->wait	1426	=for gengetinfo begin event
639		1427
640	Waits for the event to complete.	1428	=item $queue = $event->command_queue
641		1429
		1430	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
		1431
		1432	=item $command_type = $event->command_type
		1433
		1434	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
		1435
		1436	=item $uint = $event->reference_count
		1437
		1438	Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
		1439
		1440	=item $uint = $event->command_execution_status
		1441
		1442	Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
		1443
		1444	=item $ctx = $event->context
		1445
		1446	Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
		1447
		1448	=for gengetinfo end event
		1449
		1450	=item $packed_value = $ev->profiling_info ($name)
		1451
		1452	See C<< $platform->info >> for details.
		1453
		1454	The reason this method is not called C<info> is that there already is an
		1455	C<< ->info >> method.
		1456
642	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1457	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
		1458
		1459	=for gengetinfo begin profiling
		1460
		1461	=item $ulong = $event->profiling_command_queued
		1462
		1463	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
		1464
		1465	=item $ulong = $event->profiling_command_submit
		1466
		1467	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
		1468
		1469	=item $ulong = $event->profiling_command_start
		1470
		1471	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
		1472
		1473	=item $ulong = $event->profiling_command_end
		1474
		1475	Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
		1476
		1477	=for gengetinfo end profiling
643		1478
644	=back	1479	=back
645		1480
646	=head2 THE OpenCL::UserEvent CLASS	1481	=head2 THE OpenCL::UserEvent CLASS
647		1482
…		…
660	package OpenCL;	1495	package OpenCL;
661		1496
662	use common::sense;	1497	use common::sense;
663		1498
664	BEGIN {	1499	BEGIN {
665	our $VERSION = '0.15';	1500	our $VERSION = '0.96';
666		1501
667	require XSLoader;	1502	require XSLoader;
668	XSLoader::load (__PACKAGE__, $VERSION);	1503	XSLoader::load (__PACKAGE__, $VERSION);
669		1504
670	@OpenCL::Buffer::ISA =	1505	@OpenCL::Buffer::ISA =
671	@OpenCL::Image::ISA = OpenCL::Memory::;	1506	@OpenCL::Image::ISA = OpenCL::Memory::;
672		1507
		1508	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		1509
673	@OpenCL::Image2D::ISA =	1510	@OpenCL::Image2D::ISA =
		1511	@OpenCL::Image3D::ISA =
		1512	@OpenCL::Image2DArray::ISA =
		1513	@OpenCL::Image1D::ISA =
		1514	@OpenCL::Image1DArray::ISA =
674	@OpenCL::Image3D::ISA = OpenCL::Image::;	1515	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
675		1516
676	@OpenCL::UserEvent::ISA = OpenCL::Event::;	1517	@OpenCL::UserEvent::ISA = OpenCL::Event::;
677	}	1518	}
678		1519
679	1;	1520	1;
680		1521
681	=head1 AUTHOR	1522	=head1 AUTHOR

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs. Revision 1.47 by root, Sat Apr 21 19:48:58 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.18 by root, Thu Nov 17 06:22:29 2011 UTC vs.
Revision 1.47 by root, Sat Apr 21 19:48:58 2012 UTC