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