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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC vs.
Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC

…		…
43		43
44	OpenCL::Event objects are used to signal when something is complete.	44	OpenCL::Event objects are used to signal when something is complete.
45		45
46	=head2 HELPFUL RESOURCES	46	=head2 HELPFUL RESOURCES
47		47
48	The OpenCL spec used to develop this module (1.2 spec was available, but	48	The OpenCL specs used to develop this module:
49	no implementation was available to me :).
50		49
51	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf	50	http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf
		51	http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf
		52	http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf
52		53
53	OpenCL manpages:	54	OpenCL manpages:
54		55
55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	56	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
		57	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
56		58
57	If you are into UML class diagrams, the following diagram might help - if	59	If you are into UML class diagrams, the following diagram might help - if
58	not, it will be mildly cobfusing:	60	not, it will be mildly confusing (also, the class hierarchy of this module
		61	is much more fine-grained):
59		62
60	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html	63	http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/classDiagram.html
61		64
62	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it	65	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
63	is, but at least it's free of charge:	66	is, but at least it's free of charge:
64		67
65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf	68	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
…		…
138	=head2 Create a buffer with some predefined data, read it back synchronously,	141	=head2 Create a buffer with some predefined data, read it back synchronously,
139	then asynchronously.	142	then asynchronously.
140		143
141	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	144	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
142		145
143	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	146	$queue->read_buffer ($buf, 1, 1, 3, my $data);
144	print "$data\n";	147	print "$data\n";
145		148
146	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	149	my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
147	$ev->wait;	150	$ev->wait;
148	print "$data\n"; # prints "elm"	151	print "$data\n"; # prints "elm"
149		152
150	=head2 Create and build a program, then create a kernel out of one of its	153	=head2 Create and build a program, then create a kernel out of one of its
151	functions.	154	functions.
…		…
171	# set buffer	174	# set buffer
172	$kernel->set_buffer (0, $input);	175	$kernel->set_buffer (0, $input);
173	$kernel->set_buffer (1, $output);	176	$kernel->set_buffer (1, $output);
174		177
175	# execute it for all 4 numbers	178	# execute it for all 4 numbers
176	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	179	$queue->nd_range_kernel ($kernel, undef, [4], undef);
177		180
178	# enqueue a synchronous read	181	# enqueue a synchronous read
179	$queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	182	$queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
180		183
181	# print the results:	184	# print the results:
182	printf "%s\n", join ", ", unpack "f*", $data;	185	printf "%s\n", join ", ", unpack "f*", $data;
183		186
184	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	187	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
185	showing off barriers.	188	showing off barriers.
186		189
187	# execute it for all 4 numbers	190	# execute it for all 4 numbers
188	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	191	$queue->nd_range_kernel ($kernel, undef, [4], undef);
189		192
190	# enqueue a barrier to ensure in-order execution	193	# enqueue a barrier to ensure in-order execution
191	$queue->enqueue_barrier;	194	$queue->barrier;
192		195
193	# enqueue an async read	196	# enqueue an async read
194	$queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);	197	$queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data);
195		198
196	# wait for all requests to finish	199	# wait for all requests to finish
197	$queue->finish;	200	$queue->finish;
198		201
199	=head2 The same enqueue operations as before, but assuming an out-of-order queue,	202	=head2 The same enqueue operations as before, but assuming an out-of-order queue,
200	showing off event objects and wait lists.	203	showing off event objects and wait lists.
201		204
202	# execute it for all 4 numbers	205	# execute it for all 4 numbers
203	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	206	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
204		207
205	# enqueue an async read	208	# enqueue an async read
206	$ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);	209	$ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
207		210
208	# wait for the last event to complete	211	# wait for the last event to complete
209	$ev->wait;	212	$ev->wait;
210		213
211	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia	214	=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
…		…
270		273
271	# program compiled, kernel ready, now draw and loop	274	# program compiled, kernel ready, now draw and loop
272		275
273	for (my $time; ; ++$time) {	276	for (my $time; ; ++$time) {
274	# acquire objects from opengl	277	# acquire objects from opengl
275	$queue->enqueue_acquire_gl_objects ([$tex]);	278	$queue->acquire_gl_objects ([$tex]);
276		279
277	# configure and run our kernel	280	# configure and run our kernel
278	$kernel->set_image2d (0, $tex);	281	$kernel->set_image2d (0, $tex);
279	$kernel->set_float (1, $time);	282	$kernel->set_float (1, $time);
280	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);	283	$queue->nd_range_kernel ($kernel, undef, [256, 256], undef);
281		284
282	# release objects to opengl again	285	# release objects to opengl again
283	$queue->enqueue_release_gl_objects ([$tex]);	286	$queue->release_gl_objects ([$tex]);
284		287
285	# wait	288	# wait
286	$queue->finish;	289	$queue->finish;
287		290
288	# now draw the texture, the defaults should be all right	291	# now draw the texture, the defaults should be all right
…		…
417	use AnyEvent;	420	use AnyEvent;
418		421
419	# initialise AnyEvent, by creating a watcher, or:	422	# initialise AnyEvent, by creating a watcher, or:
420	AnyEvent::detect;	423	AnyEvent::detect;
421		424
422	my $e = $queue->enqueue_marker;	425	my $e = $queue->marker;
423	$e->cb (sub {	426	$e->cb (sub {
424	warn "opencl is finished\n";	427	warn "opencl is finished\n";
425	})	428	})
426		429
427	main Gtk2;	430	main Gtk2;
…		…
444	Asynchronously means that perl might execute your callbacks at any	447	Asynchronously means that perl might execute your callbacks at any
445	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),	448	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
446	the C<until> loop following the marker call will be interrupted by the	449	the C<until> loop following the marker call will be interrupted by the
447	callback:	450	callback:
448		451
449	my $e = $queue->enqueue_marker;	452	my $e = $queue->marker;
450	my $flag;	453	my $flag;
451	$e->cb (sub { $flag = 1 });	454	$e->cb (sub { $flag = 1 });
452	1 until $flag;	455	1 until $flag;
453	# $flag is now 1	456	# $flag is now 1
454		457
…		…
490	=cut	493	=cut
491		494
492	package OpenCL;	495	package OpenCL;
493		496
494	use common::sense;	497	use common::sense;
		498	use Carp ();
495	use Async::Interrupt ();	499	use Async::Interrupt ();
496		500
497	our $POLL_FUNC; # set by XS	501	our $POLL_FUNC; # set by XS
498		502
499	BEGIN {	503	BEGIN {
500	our $VERSION = '0.97';	504	our $VERSION = '0.98';
501		505
502	require XSLoader;	506	require XSLoader;
503	XSLoader::load (__PACKAGE__, $VERSION);	507	XSLoader::load (__PACKAGE__, $VERSION);
504		508
505	@OpenCL::Platform::ISA =	509	@OpenCL::Platform::ISA =
…		…
534	=item $int = OpenCL::errno	538	=item $int = OpenCL::errno
535		539
536	The last error returned by a function - it's only valid after an error occured	540	The last error returned by a function - it's only valid after an error occured
537	and before calling another OpenCL function.	541	and before calling another OpenCL function.
538		542
539	=item $str = OpenCL::err2str $errval	543	=item $str = OpenCL::err2str [$errval]
540		544
541	Comverts an error value into a human readable string.	545	Converts an error value into a human readable string. IF no error value is
		546	given, then the last error will be used (as returned by OpenCL::errno).
542		547
543	=item $str = OpenCL::enum2str $enum	548	=item $str = OpenCL::enum2str $enum
544		549
545	Converts most enum values (of parameter names, image format constants,	550	Converts most enum values (of parameter names, image format constants,
546	object types, addressing and filter modes, command types etc.) into a	551	object types, addressing and filter modes, command types etc.) into a
…		…
999	=cut	1004	=cut
1000		1005
1001	sub OpenCL::Context::build_program {	1006	sub OpenCL::Context::build_program {
1002	my ($self, $prog, $options) = @_;	1007	my ($self, $prog, $options) = @_;
1003		1008
1004	require Carp;
1005
1006	$prog = $self->program_with_source ($prog)	1009	$prog = $self->program_with_source ($prog)
1007	unless ref $prog;	1010	unless ref $prog;
1008		1011
1009	# we build separately per device so we instantly know which one failed	1012	eval { $prog->build (undef, $options); 1 }
		1013	or errno == BUILD_PROGRAM_FAILURE
		1014	or errno == INVALID_BINARY # workaround nvidia bug
		1015	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1016
		1017	# we check status for all devices
1010	for my $dev ($self->devices) {	1018	for my $dev ($self->devices) {
1011	eval { $prog->build ([$dev], $options); 1 }	1019	$prog->build_status ($dev) == BUILD_SUCCESS
1012	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"	1020	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1013	. $prog->build_log ($dev));	1021	. $prog->build_log ($dev);
1014	}	1022	}
1015		1023
1016	$prog	1024	$prog
1017	}	1025	}
1018		1026
…		…
1042	=item $buf = $ctx->buffer_sv ($flags, $data)	1050	=item $buf = $ctx->buffer_sv ($flags, $data)
1043		1051
1044	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1052	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1045	initialise it with the given data values.	1053	initialise it with the given data values.
1046		1054
1047	=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)	1055	=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
1048		1056
1049	Creates a new OpenCL::Image object and optionally initialises it with	1057	Creates a new OpenCL::Image object and optionally initialises it with
1050	the given data values.	1058	the given data values.
1051		1059
1052	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1060	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
…		…
1148	=back	1156	=back
1149		1157
1150	=head2 THE OpenCL::Queue CLASS	1158	=head2 THE OpenCL::Queue CLASS
1151		1159
1152	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1160	An OpenCL::Queue represents an execution queue for OpenCL. You execute
1153	requests by calling their respective C<enqueue_xxx> method and waitinf for	1161	requests by calling their respective method and waiting for it to complete
1154	it to complete in some way.	1162	in some way.
1155		1163
1156	All the enqueue methods return an event object that can be used to wait	1164	Most methods that enqueue some request return an event object that can
1157	for completion, unless the method is called in void context, in which case	1165	be used to wait for completion (optionally using a callback), unless
1158	no event object is created.	1166	the method is called in void context, in which case no event object is
		1167	created.
1159		1168
1160	They also allow you to specify any number of other event objects that this	1169	They also allow you to specify any number of other event objects that this
1161	request has to wait for before it starts executing, by simply passing the	1170	request has to wait for before it starts executing, by simply passing the
1162	event objects as extra parameters to the enqueue methods. To simplify	1171	event objects as extra parameters to the enqueue methods. To simplify
1163	program design, this module ignores any C<undef> values in the list of	1172	program design, this module ignores any C<undef> values in the list of
1164	events. This makes it possible to code operations such as this, without	1173	events. This makes it possible to code operations such as this, without
1165	having to put a valid event object into C<$event> first:	1174	having to put a valid event object into C<$event> first:
1166		1175
1167	$event = $queue->enqueue_xxx (..., $event);	1176	$event = $queue->xxx (..., $event);
1168		1177
1169	Queues execute in-order by default, without any parallelism, so in most	1178	Queues execute in-order by default, without any parallelism, so in most
1170	cases (i.e. you use only one queue) it's not necessary to wait for or	1179	cases (i.e. you use only one queue) it's not necessary to wait for or
1171	create event objects, althoguh an our of order queue is often a bit	1180	create event objects, althoguh an our of order queue is often a bit
1172	faster.	1181	faster.
1173		1182
1174	=over 4	1183	=over 4
1175		1184
1176	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1185	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
1177		1186
1178	Reads data from buffer into the given string.	1187	Reads data from buffer into the given string.
1179		1188
1180	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1189	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
1181		1190
1182	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1191	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1183		1192
1184	Writes data to buffer from the given string.	1193	Writes data to buffer from the given string.
1185		1194
1186	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1195	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
1187		1196
1188	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1197	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1189		1198
1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1199	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1191		1200
1192	=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...)	1201	=item $ev = $queue->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...)
1193		1202
1194	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1203	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1195		1204
1196	=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...)	1205	=item $ev = $queue->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...)
1197		1206
1198	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1207	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1199		1208
1200	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1209	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1201		1210
1202	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1211	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1203		1212
1204	=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...)	1213	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1205		1214
1206	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1215	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1207		1216
1208	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1217	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1209		1218
1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1219	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1211		1220
1212	=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...)	1221	=item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1213		1222
1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1223	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1215		1224
1216	=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...)	1225	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1217		1226
1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1227	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1219		1228
1220	=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...)	1229	=item $ev = $queue->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...)
1221		1230
1222	Yeah.	1231	Yeah.
1223		1232
1224	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1233	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1225		1234
1226	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1235	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1227		1236
1228	Fills the given buffer object with repeated applications of C<$pattern>,	1237	Fills the given buffer object with repeated applications of C<$pattern>,
1229	starting at C<$offset> for C<$size> octets.	1238	starting at C<$offset> for C<$size> octets.
1230		1239
1231	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>	1240	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1232		1241
1233	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)	1242	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1234		1243
1235	Fills the given image area with the given rgba colour components. The	1244	Fills the given image area with the given rgba colour components. The
1236	components are normally floating point values between C<0> and C<1>,	1245	components are normally floating point values between C<0> and C<1>,
1237	except when the image channel data type is a signe dor unsigned	1246	except when the image channel data type is a signe dor unsigned
1238	unnormalised format, in which case the range is determined by the format.	1247	unnormalised format, in which case the range is determined by the format.
1239		1248
1240	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>	1249	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1241		1250
1242	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1251	=item $ev = $queue->task ($kernel, $wait_events...)
1243		1252
1244	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1253	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1245		1254
1246	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1255	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1247		1256
1248	Enqueues a kernel execution.	1257	Enqueues a kernel execution.
1249		1258
1250	@$global_work_size must be specified as a reference to an array of	1259	\@global_work_size must be specified as a reference to an array of
1251	integers specifying the work sizes (element counts).	1260	integers specifying the work sizes (element counts).
1252		1261
1253	@$global_work_offset must be either C<undef> (in which case all offsets	1262	\@global_work_offset must be either C<undef> (in which case all offsets
1254	are C<0>), or a reference to an array of work offsets, with the same number	1263	are C<0>), or a reference to an array of work offsets, with the same number
1255	of elements as @$global_work_size.	1264	of elements as \@global_work_size.
1256		1265
1257	@$local_work_size must be either C<undef> (in which case the	1266	\@local_work_size must be either C<undef> (in which case the
1258	implementation is supposed to choose good local work sizes), or a	1267	implementation is supposed to choose good local work sizes), or a
1259	reference to an array of local work sizes, with the same number of	1268	reference to an array of local work sizes, with the same number of
1260	elements as @$global_work_size.	1269	elements as \@global_work_size.
1261		1270
1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1271	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1263		1272
1264	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1273	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1265		1274
1266	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1275	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1267	for subsequent OpenCL usage.	1276	for subsequent OpenCL usage.
1268		1277
1269	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1278	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1270		1279
1271	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1280	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1272		1281
1273	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1282	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1274	for subsequent OpenGL usage.	1283	for subsequent OpenGL usage.
1275		1284
1276	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1285	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1277		1286
1278	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1287	=item $ev = $queue->wait_for_events ($wait_events...)
1279		1288
1280	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1289	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1281		1290
1282	=item $ev = $queue->enqueue_marker ($wait_events...)	1291	=item $ev = $queue->marker ($wait_events...)
1283		1292
1284	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1293	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1285		1294
1286	=item $ev = $queue->enqueue_barrier ($wait_events...)	1295	=item $ev = $queue->barrier ($wait_events...)
1287		1296
1288	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1297	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1289		1298
1290	=item $queue->flush	1299	=item $queue->flush
1291		1300
…		…
1520	If a callback is specified, then it will be called when compilation is	1529	If a callback is specified, then it will be called when compilation is
1521	finished. Note that many OpenCL implementations block your program while	1530	finished. Note that many OpenCL implementations block your program while
1522	compiling whether you use a callback or not. See C<build_async> if you	1531	compiling whether you use a callback or not. See C<build_async> if you
1523	want to make sure the build is done in the background.	1532	want to make sure the build is done in the background.
1524		1533
1525	Note that some OpenCL implementations atc up badly, and don't call the	1534	Note that some OpenCL implementations act up badly, and don't call the
1526	callback in some error cases (but call it in others). This implementation	1535	callback in some error cases (but call it in others). This implementation
1527	assumes the callback will always be called, and leaks memory if this is	1536	assumes the callback will always be called, and leaks memory if this is
1528	not so. So best make sure you don't pass in invalid values.	1537	not so. So best make sure you don't pass in invalid values.
1529		1538
		1539	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1540	compilation state is successful but some later stage fails.
		1541
1530	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1542	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1531		1543
1532	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1544	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1533		1545
1534	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1546	Similar to C<< ->build >>, except it starts a thread, and never fails (you
…		…
1682		1694
1683	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1695	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1684		1696
1685	=for gengetinfo end kernel_work_group	1697	=for gengetinfo end kernel_work_group
1686		1698
		1699	=item $kernel->setf ($format, ...)
		1700
		1701	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1702	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1703	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1704	what type of argument it is.
		1705
		1706	The format arguments are single letters:
		1707
		1708	c char
		1709	C unsigned char
		1710	s short
		1711	S unsigned short
		1712	i int
		1713	I unsigned int
		1714	l long
		1715	L unsigned long
		1716
		1717	h half float (0..65535)
		1718	f float
		1719	d double
		1720
		1721	z local (octet size)
		1722
		1723	m memory object (buffer or image)
		1724	a sampler
		1725	e event
		1726
		1727	Space characters in the format string are ignored.
		1728
		1729	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1730
		1731	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1732
1687	=item $kernel->set_TYPE ($index, $value)	1733	=item $kernel->set_TYPE ($index, $value)
1688		1734
		1735	=item $kernel->set_char ($index, $value)
		1736
		1737	=item $kernel->set_uchar ($index, $value)
		1738
		1739	=item $kernel->set_short ($index, $value)
		1740
		1741	=item $kernel->set_ushort ($index, $value)
		1742
		1743	=item $kernel->set_int ($index, $value)
		1744
		1745	=item $kernel->set_uint ($index, $value)
		1746
		1747	=item $kernel->set_long ($index, $value)
		1748
		1749	=item $kernel->set_ulong ($index, $value)
		1750
		1751	=item $kernel->set_half ($index, $value)
		1752
		1753	=item $kernel->set_float ($index, $value)
		1754
		1755	=item $kernel->set_double ($index, $value)
		1756
		1757	=item $kernel->set_memory ($index, $value)
		1758
		1759	=item $kernel->set_buffer ($index, $value)
		1760
		1761	=item $kernel->set_image ($index, $value)
		1762
		1763	=item $kernel->set_sampler ($index, $value)
		1764
		1765	=item $kernel->set_local ($index, $value)
		1766
		1767	=item $kernel->set_event ($index, $value)
		1768
1689	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1769	This is a family of methods to set the kernel argument with the number
1690		1770	C<$index> to the give C<$value>.
1691	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1692	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1693	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1694		1771
1695	Chars and integers (including the half type) are specified as integers,	1772	Chars and integers (including the half type) are specified as integers,
1696	float and double as floating point values, memory/buffer/image2d/image3d	1773	float and double as floating point values, memory/buffer/image must be
1697	must be an object of that type or C<undef>, local-memory arguments are	1774	an object of that type or C<undef>, local-memory arguments are set by
1698	set by specifying the size, and sampler and event must be objects of that	1775	specifying the size, and sampler and event must be objects of that type.
1699	type.	1776
		1777	Note that C<set_memory> works for all memory objects (all types of buffers
		1778	and images) - the main purpose of the more specific C<set_TYPE> functions
		1779	is type checking.
1700		1780
1701	Setting an argument for a kernel does NOT keep a reference to the object -	1781	Setting an argument for a kernel does NOT keep a reference to the object -
1702	for example, if you set an argument to some image object, free the image,	1782	for example, if you set an argument to some image object, free the image,
1703	and call the kernel, you will run into undefined behaviour.	1783	and call the kernel, you will run into undefined behaviour.
1704		1784

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC vs. Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.56 by root, Tue Apr 24 23:53:12 2012 UTC vs.
Revision 1.63 by root, Sun Apr 29 18:24:35 2012 UTC