[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.44 by root, Sat Apr 21 17:47:23 2012 UTC

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