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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.25 by root, Tue Nov 22 10:39:47 2011 UTC vs.
Revision 1.54 by root, Tue Apr 24 14:57:06 2012 UTC

…		…
105	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
106	printf "platform: %s\n", $platform->name;	106	printf "platform: %s\n", $platform->name;
107	printf "extensions: %s\n", $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->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_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
		381	=cut
		382
		383	package OpenCL;
		384
		385	use common::sense;
		386
		387	BEGIN {
		388	our $VERSION = '0.97';
		389
		390	require XSLoader;
		391	XSLoader::load (__PACKAGE__, $VERSION);
		392
		393	@OpenCL::Platform::ISA =
		394	@OpenCL::Device::ISA =
		395	@OpenCL::Context::ISA =
		396	@OpenCL::Queue::ISA =
		397	@OpenCL::Memory::ISA =
		398	@OpenCL::Sampler::ISA =
		399	@OpenCL::Program::ISA =
		400	@OpenCL::Kernel::ISA =
		401	@OpenCL::Event::ISA = OpenCL::Object::;
		402
		403	@OpenCL::Buffer::ISA =
		404	@OpenCL::Image::ISA = OpenCL::Memory::;
		405
		406	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		407
		408	@OpenCL::Image2D::ISA =
		409	@OpenCL::Image3D::ISA =
		410	@OpenCL::Image2DArray::ISA =
		411	@OpenCL::Image1D::ISA =
		412	@OpenCL::Image1DArray::ISA =
		413	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		414
		415	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		416	}
		417
276	=head2 THE OpenCL PACKAGE	418	=head2 THE OpenCL PACKAGE
277		419
278	=over 4	420	=over 4
279		421
280	=item $int = OpenCL::errno	422	=item $int = OpenCL::errno
…		…
286		428
287	Comverts an error value into a human readable string.	429	Comverts an error value into a human readable string.
288		430
289	=item $str = OpenCL::enum2str $enum	431	=item $str = OpenCL::enum2str $enum
290		432
291	Converts most enum values (inof parameter names, image format constants,	433	Converts most enum values (of parameter names, image format constants,
292	object types, addressing and filter modes, command types etc.) into a	434	object types, addressing and filter modes, command types etc.) into a
293	human readbale string. When confronted with some random integer it can be	435	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	436	very helpful to pass it through this function to maybe get some readable
295	string out of it.	437	string out of it.
296		438
297	=item @platforms = OpenCL::platforms	439	=item @platforms = OpenCL::platforms
298		440
…		…
312		454
313	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	455	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
314		456
315	=back	457	=back
316		458
		459	=head2 THE OpenCL::Object CLASS
		460
		461	This is the base class for all objects in the OpenCL module. The only
		462	method it implements is the C<id> method, which is only useful if you want
		463	to interface to OpenCL on the C level.
		464
		465	=over 4
		466
		467	=item $iv = $obj->id
		468
		469	OpenCL objects are represented by pointers or integers on the C level. If
		470	you want to interface to an OpenCL object directly on the C level, then
		471	you need this value, which is returned by this method. You should use an
		472	C<IV> type in your code and cast that to the correct type.
		473
		474	=cut
		475
		476	sub OpenCL::Object::id {
		477	${$_[0]}
		478	}
		479
		480	=back
		481
317	=head2 THE OpenCL::Platform CLASS	482	=head2 THE OpenCL::Platform CLASS
318		483
319	=over 4	484	=over 4
320		485
321	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	486	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
…		…
326		491
327	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	492	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328		493
329	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	494	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330		495
331	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)	496	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
332		497
333	Create a new OpenCL::Context object using the given device object(s)- a	498	Create a new OpenCL::Context object using the given device object(s)- a
334	CL_CONTEXT_PLATFORM property is supplied automatically.	499	CL_CONTEXT_PLATFORM property is supplied automatically.
335		500
336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	501	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
344	It's best to avoid this method and use one of the following convenience	509	It's best to avoid this method and use one of the following convenience
345	wrappers.	510	wrappers.
346		511
347	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>	512	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348		513
		514	=item $platform->unload_compiler
		515
		516	Attempts to unload the compiler for this platform, for endless
		517	profit. Does nothing on OpenCL 1.1.
		518
		519	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
		520
349	=for gengetinfo begin platform	521	=for gengetinfo begin platform
350		522
351	=item $string = $platform->profile	523	=item $string = $platform->profile
352		524
353	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.	525	Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
…		…
638		810
639	=item @device_partition_property_exts = $device->affinity_domains_ext	811	=item @device_partition_property_exts = $device->affinity_domains_ext
640		812
641	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.	813	Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
642		814
643	=item $uint = $device->reference_count_ext	815	=item $uint = $device->reference_count_ext
644		816
645	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.	817	Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
646		818
647	=item @device_partition_property_exts = $device->partition_style_ext	819	=item @device_partition_property_exts = $device->partition_style_ext
648		820
649	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.	821	Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
650		822
…		…
654		826
655	=head2 THE OpenCL::Context CLASS	827	=head2 THE OpenCL::Context CLASS
656		828
657	=over 4	829	=over 4
658		830
		831	=item $prog = $ctx->build_program ($program, $options = "")
		832
		833	This convenience function tries to build the program on all devices in
		834	the context. If the build fails, then the function will C<croak> with the
		835	build log. Otherwise ti returns the program object.
		836
		837	The C<$program> can either be a C<OpenCL::Program> object or a string
		838	containing the program. In the latter case, a program objetc will be
		839	created automatically.
		840
		841	=cut
		842
		843	sub OpenCL::Context::build_program {
		844	my ($self, $prog, $options) = @_;
		845
		846	require Carp;
		847
		848	$prog = $self->program_with_source ($prog)
		849	unless ref $prog;
		850
		851	for my $dev ($self->devices) {
		852	eval { $prog->build ($dev, $options); 1 }
		853	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
		854	. $prog->build_log ($dev));
		855	}
		856
		857	$prog
		858	}
		859
659	=item $queue = $ctx->queue ($device, $properties)	860	=item $queue = $ctx->queue ($device, $properties)
660		861
661	Create a new OpenCL::Queue object from the context and the given device.	862	Create a new OpenCL::Queue object from the context and the given device.
662		863
663	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>	864	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
664		865
		866	Example: create an out-of-order queue.
		867
		868	$queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
		869
665	=item $ev = $ctx->user_event	870	=item $ev = $ctx->user_event
666		871
667	Creates a new OpenCL::UserEvent object.	872	Creates a new OpenCL::UserEvent object.
668		873
669	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>	874	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
670		875
671	=item $buf = $ctx->buffer ($flags, $len)	876	=item $buf = $ctx->buffer ($flags, $len)
672		877
673	Creates a new OpenCL::Buffer object with the given flags and octet-size.	878	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
		879	given flags and octet-size.
674		880
675	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>	881	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
676		882
677	=item $buf = $ctx->buffer_sv ($flags, $data)	883	=item $buf = $ctx->buffer_sv ($flags, $data)
678		884
679	Creates a new OpenCL::Buffer object and initialise it with the given data values.	885	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
		886	initialise it with the given data values.
		887
		888	=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)
		889
		890	Creates a new OpenCL::Image object and optionally initialises it with
		891	the given data values.
		892
		893	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
680		894
681	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)	895	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
682		896
683	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	897	Creates a new OpenCL::Image2D object and optionally initialises it with
		898	the given data values.
684		899
685	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	900	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
686		901
687	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)	902	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
688		903
689	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	904	Creates a new OpenCL::Image3D object and optionally initialises it with
		905	the given data values.
690		906
691	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	907	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
		908
		909	=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
		910
		911	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
		912	OpenGL buffer object.
		913
		914	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
		915
		916	=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
		917
		918	Creates a new OpenCL::Image object that refers to the given OpenGL
		919	texture object or buffer.
		920
		921	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
		922
		923	=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
		924
		925	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		926	2D texture object.
		927
		928	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
		929
		930	=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
		931
		932	Creates a new OpenCL::Image3D object that refers to the given OpenGL
		933	3D texture object.
		934
		935	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
		936
		937	=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
		938
		939	Creates a new OpenCL::Image2D object that refers to the given OpenGL
		940	render buffer.
		941
		942	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
692		943
693	=item @formats = $ctx->supported_image_formats ($flags, $image_type)	944	=item @formats = $ctx->supported_image_formats ($flags, $image_type)
694		945
695	Returns a list of matching image formats - each format is an arrayref with	946	Returns a list of matching image formats - each format is an arrayref with
696	two values, $channel_order and $channel_type, in it.	947	two values, $channel_order and $channel_type, in it.
…		…
747	for completion, unless the method is called in void context, in which case	998	for completion, unless the method is called in void context, in which case
748	no event object is created.	999	no event object is created.
749		1000
750	They also allow you to specify any number of other event objects that this	1001	They also allow you to specify any number of other event objects that this
751	request has to wait for before it starts executing, by simply passing the	1002	request has to wait for before it starts executing, by simply passing the
752	event objects as extra parameters to the enqueue methods.	1003	event objects as extra parameters to the enqueue methods. To simplify
		1004	program design, this module ignores any C<undef> values in the list of
		1005	events. This makes it possible to code operations such as this, without
		1006	having to put a valid event object into C<$event> first:
		1007
		1008	$event = $queue->enqueue_xxx (..., $event);
753		1009
754	Queues execute in-order by default, without any parallelism, so in most	1010	Queues execute in-order by default, without any parallelism, so in most
755	cases (i.e. you use only one queue) it's not necessary to wait for or	1011	cases (i.e. you use only one queue) it's not necessary to wait for or
756	create event objects.	1012	create event objects, althoguh an our of order queue is often a bit
		1013	faster.
757		1014
758	=over 4	1015	=over 4
759		1016
760	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1017	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
761		1018
…		…
781		1038
782	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1039	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
783		1040
784	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1041	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
785		1042
		1043	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
		1044
		1045	=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...)
		1046
786	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1047	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
787		1048
788	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1049	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
789		1050
790	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1051	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
791		1052
		1053	=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...)
		1054
		1055	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
		1056
		1057	=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...)
		1058
		1059	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
		1060
792	=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...)	1061	=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...)
793		1062
794	Yeah.	1063	Yeah.
795		1064
796	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
797
798	=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...)
799
800	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1065	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
801		1066
802	=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...)	1067	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
803		1068
		1069	Fills the given buffer object with repeated applications of C<$pattern>,
		1070	starting at C<$offset> for C<$size> octets.
		1071
		1072	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1073
		1074	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1075
		1076	Fills the given image area with the given rgba colour components. The
		1077	components are normally floating point values between C<0> and C<1>,
		1078	except when the image channel data type is a signe dor unsigned
		1079	unnormalised format, in which case the range is determined by the format.
		1080
804	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1081	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
805
806	=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...)
807
808	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
809		1082
810	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1083	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
811		1084
812	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1085	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
813		1086
…		…
827	reference to an array of local work sizes, with the same number of	1100	reference to an array of local work sizes, with the same number of
828	elements as @$global_work_size.	1101	elements as @$global_work_size.
829		1102
830	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1103	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
831		1104
832	=item $ev = $queue->enqueue_marker	1105	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
833		1106
		1107	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
		1108	for subsequent OpenCL usage.
		1109
834	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>	1110	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
		1111
		1112	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
		1113
		1114	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
		1115	for subsequent OpenGL usage.
		1116
		1117	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
835		1118
836	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1119	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
837		1120
838	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1121	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
839		1122
840	=item $queue->enqueue_barrier	1123	=item $ev = $queue->enqueue_marker ($wait_events...)
841		1124
		1125	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
		1126
		1127	=item $ev = $queue->enqueue_barrier ($wait_events...)
		1128
842	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html>	1129	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
843		1130
844	=item $queue->flush	1131	=item $queue->flush
845		1132
846	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>	1133	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
847		1134
…		…
928		1215
929	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.	1216	Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
930		1217
931	=for gengetinfo end mem	1218	=for gengetinfo end mem
932		1219
		1220	=item ($type, $name) = $mem->gl_object_info
		1221
		1222	Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
		1223	object "name" (e.g. the texture name) used to create this memory object.
		1224
		1225	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
		1226
933	=back	1227	=back
934		1228
		1229	=head2 THE OpenCL::Buffer CLASS
		1230
		1231	This is a subclass of OpenCL::Memory, and the superclass of
		1232	OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
		1233	and sub-buffers.
		1234
		1235	=head2 THE OpenCL::BufferObj CLASS
		1236
		1237	This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
		1238	because one cna create sub buffers of OpenLC::BufferObj objects, but not
		1239	sub buffers from these sub buffers.
		1240
		1241	=over 4
		1242
		1243	=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
		1244
		1245	Creates an OpenCL::Buffer objects from this buffer and returns it. The
		1246	C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
		1247
		1248	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
		1249
		1250	=back
		1251
935	=head2 THE OpenCL::Image CLASS	1252	=head2 THE OpenCL::Image CLASS
936		1253
937	This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.	1254	This is the superclass of all image objects - OpenCL::Image1D,
		1255	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
		1256	OpenCL::Image2DArray and OpenCL::Image3D.
938		1257
939	=over 4	1258	=over 4
940		1259
941	=item $packed_value = $ev->image_info ($name)	1260	=item $packed_value = $image->image_info ($name)
942		1261
943	See C<< $platform->info >> for details.	1262	See C<< $platform->info >> for details.
944		1263
945	The reason this method is not called C<info> is that there already is an	1264	The reason this method is not called C<info> is that there already is an
946	C<< ->info >> method inherited from C<OpenCL::Memory>.	1265	C<< ->info >> method inherited from C<OpenCL::Memory>.
947		1266
948	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1267	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
949		1268
		1269	=item ($channel_order, $channel_data_type) = $image->format
		1270
		1271	Returns the channel order and type used to create the image by calling
		1272	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1273
950	=for gengetinfo begin image	1274	=for gengetinfo begin image
951		1275
952	=item $int = $image->element_size	1276	=item $int = $image->element_size
953		1277
954	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1278	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
…		…
973		1297
974	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.	1298	Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
975		1299
976	=for gengetinfo end image	1300	=for gengetinfo end image
977		1301
		1302	=for gengetinfo begin gl_texture
		1303
		1304	=item $GLenum = $gl_texture->target
		1305
		1306	Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
		1307
		1308	=item $GLint = $gl_texture->gl_mipmap_level
		1309
		1310	Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
		1311
		1312	=for gengetinfo end gl_texture
		1313
978	=back	1314	=back
979		1315
980	=head2 THE OpenCL::Sampler CLASS	1316	=head2 THE OpenCL::Sampler CLASS
981		1317
982	=over 4	1318	=over 4
…		…
1017		1353
1018	=over 4	1354	=over 4
1019		1355
1020	=item $program->build ($device, $options = "")	1356	=item $program->build ($device, $options = "")
1021		1357
1022	Tries to build the program with the givne options.	1358	Tries to build the program with the given options. See also the
		1359	C<$ctx->build> convenience function.
1023		1360
1024	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1361	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1025		1362
1026	=item $packed_value = $program->build_info ($device, $name)	1363	=item $packed_value = $program->build_info ($device, $name)
1027		1364
…		…
1034		1371
1035	Creates an OpenCL::Kernel object out of the named C<__kernel> function in	1372	Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1036	the program.	1373	the program.
1037		1374
1038	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>	1375	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
		1376
		1377	=item @kernels = $program->kernels_in_program
		1378
		1379	Returns all kernels successfully compiled for all devices in program.
		1380
		1381	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1039		1382
1040	=for gengetinfo begin program_build	1383	=for gengetinfo begin program_build
1041		1384
1042	=item $build_status = $program->build_status ($device)	1385	=item $build_status = $program->build_status ($device)
1043		1386
…		…
1171		1514
1172	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1515	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1173		1516
1174	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,	1517	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1175	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,	1518	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1176	C<image2d>, C<image3d>, C<sampler> or C<event>.	1519	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1177		1520
1178	Chars and integers (including the half type) are specified as integers,	1521	Chars and integers (including the half type) are specified as integers,
1179	float and double as floating point values, memory/buffer/image2d/image3d	1522	float and double as floating point values, memory/buffer/image2d/image3d
1180	must be an object of that type or C<undef>, and sampler and event must be	1523	must be an object of that type or C<undef>, local-memory arguments are
1181	objects of that type.	1524	set by specifying the size, and sampler and event must be objects of that
		1525	type.
		1526
		1527	Setting an argument for a kernel does NOT keep a reference to the object -
		1528	for example, if you set an argument to some image object, free the image,
		1529	and call the kernel, you will run into undefined behaviour.
1182		1530
1183	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>	1531	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1184		1532
1185	=back	1533	=back
1186		1534
…		…
1270		1618
1271	=back	1619	=back
1272		1620
1273	=cut	1621	=cut
1274		1622
1275	package OpenCL;
1276
1277	use common::sense;
1278
1279	BEGIN {
1280	our $VERSION = '0.55';
1281
1282	require XSLoader;
1283	XSLoader::load (__PACKAGE__, $VERSION);
1284
1285	@OpenCL::Buffer::ISA =
1286	@OpenCL::Image::ISA = OpenCL::Memory::;
1287
1288	@OpenCL::Image2D::ISA =
1289	@OpenCL::Image3D::ISA = OpenCL::Image::;
1290
1291	@OpenCL::UserEvent::ISA = OpenCL::Event::;
1292	}
1293
1294	1;	1623	1;
1295		1624
1296	=head1 AUTHOR	1625	=head1 AUTHOR
1297		1626
1298	Marc Lehmann <schmorp@schmorp.de>	1627	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.25 by root, Tue Nov 22 10:39:47 2011 UTC vs. Revision 1.54 by root, Tue Apr 24 14:57:06 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.25 by root, Tue Nov 22 10:39:47 2011 UTC vs.
Revision 1.54 by root, Tue Apr 24 14:57:06 2012 UTC