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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.57 by root, Tue Apr 24 23:58:34 2012 UTC vs.
Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC

…		…
141	=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,
142	then asynchronously.	142	then asynchronously.
143		143
144	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");	144	my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut");
145		145
146	$queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data);	146	$queue->read_buffer ($buf, 1, 1, 3, my $data);
147	print "$data\n";	147	print "$data\n";
148		148
149	my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data);	149	my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data);
150	$ev->wait;	150	$ev->wait;
151	print "$data\n"; # prints "elm"	151	print "$data\n"; # prints "elm"
152		152
153	=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
154	functions.	154	functions.
…		…
174	# set buffer	174	# set buffer
175	$kernel->set_buffer (0, $input);	175	$kernel->set_buffer (0, $input);
176	$kernel->set_buffer (1, $output);	176	$kernel->set_buffer (1, $output);
177		177
178	# execute it for all 4 numbers	178	# execute it for all 4 numbers
179	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	179	$queue->nd_range_kernel ($kernel, undef, [4], undef);
180		180
181	# enqueue a synchronous read	181	# enqueue a synchronous read
182	$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);
183		183
184	# print the results:	184	# print the results:
185	printf "%s\n", join ", ", unpack "f*", $data;	185	printf "%s\n", join ", ", unpack "f*", $data;
186		186
187	=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,
188	showing off barriers.	188	showing off barriers.
189		189
190	# execute it for all 4 numbers	190	# execute it for all 4 numbers
191	$queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	191	$queue->nd_range_kernel ($kernel, undef, [4], undef);
192		192
193	# enqueue a barrier to ensure in-order execution	193	# enqueue a barrier to ensure in-order execution
194	$queue->enqueue_barrier;	194	$queue->barrier;
195		195
196	# enqueue an async read	196	# enqueue an async read
197	$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);
198		198
199	# wait for all requests to finish	199	# wait for all requests to finish
200	$queue->finish;	200	$queue->finish;
201		201
202	=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,
203	showing off event objects and wait lists.	203	showing off event objects and wait lists.
204		204
205	# execute it for all 4 numbers	205	# execute it for all 4 numbers
206	my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef);	206	my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef);
207		207
208	# enqueue an async read	208	# enqueue an async read
209	$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);
210		210
211	# wait for the last event to complete	211	# wait for the last event to complete
212	$ev->wait;	212	$ev->wait;
213		213
214	=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
…		…
273		273
274	# program compiled, kernel ready, now draw and loop	274	# program compiled, kernel ready, now draw and loop
275		275
276	for (my $time; ; ++$time) {	276	for (my $time; ; ++$time) {
277	# acquire objects from opengl	277	# acquire objects from opengl
278	$queue->enqueue_acquire_gl_objects ([$tex]);	278	$queue->acquire_gl_objects ([$tex]);
279		279
280	# configure and run our kernel	280	# configure and run our kernel
281	$kernel->set_image2d (0, $tex);	281	$kernel->set_image2d (0, $tex);
282	$kernel->set_float (1, $time);	282	$kernel->set_float (1, $time);
283	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);	283	$queue->nd_range_kernel ($kernel, undef, [256, 256], undef);
284		284
285	# release objects to opengl again	285	# release objects to opengl again
286	$queue->enqueue_release_gl_objects ([$tex]);	286	$queue->release_gl_objects ([$tex]);
287		287
288	# wait	288	# wait
289	$queue->finish;	289	$queue->finish;
290		290
291	# now draw the texture, the defaults should be all right	291	# now draw the texture, the defaults should be all right
…		…
420	use AnyEvent;	420	use AnyEvent;
421		421
422	# initialise AnyEvent, by creating a watcher, or:	422	# initialise AnyEvent, by creating a watcher, or:
423	AnyEvent::detect;	423	AnyEvent::detect;
424		424
425	my $e = $queue->enqueue_marker;	425	my $e = $queue->marker;
426	$e->cb (sub {	426	$e->cb (sub {
427	warn "opencl is finished\n";	427	warn "opencl is finished\n";
428	})	428	})
429		429
430	main Gtk2;	430	main Gtk2;
…		…
447	Asynchronously means that perl might execute your callbacks at any	447	Asynchronously means that perl might execute your callbacks at any
448	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>),
449	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
450	callback:	450	callback:
451		451
452	my $e = $queue->enqueue_marker;	452	my $e = $queue->marker;
453	my $flag;	453	my $flag;
454	$e->cb (sub { $flag = 1 });	454	$e->cb (sub { $flag = 1 });
455	1 until $flag;	455	1 until $flag;
456	# $flag is now 1	456	# $flag is now 1
457		457
…		…
537	=item $int = OpenCL::errno	537	=item $int = OpenCL::errno
538		538
539	The last error returned by a function - it's only valid after an error occured	539	The last error returned by a function - it's only valid after an error occured
540	and before calling another OpenCL function.	540	and before calling another OpenCL function.
541		541
542	=item $str = OpenCL::err2str $errval	542	=item $str = OpenCL::err2str [$errval]
543		543
544	Comverts an error value into a human readable string.	544	Converts an error value into a human readable string. IF no error value is
		545	given, then the last error will be used (as returned by OpenCL::errno).
545		546
546	=item $str = OpenCL::enum2str $enum	547	=item $str = OpenCL::enum2str $enum
547		548
548	Converts most enum values (of parameter names, image format constants,	549	Converts most enum values (of parameter names, image format constants,
549	object types, addressing and filter modes, command types etc.) into a	550	object types, addressing and filter modes, command types etc.) into a
…		…
1007	require Carp;	1008	require Carp;
1008		1009
1009	$prog = $self->program_with_source ($prog)	1010	$prog = $self->program_with_source ($prog)
1010	unless ref $prog;	1011	unless ref $prog;
1011		1012
1012	# we build separately per device so we instantly know which one failed	1013	eval { $prog->build (undef, $options); 1 }
		1014	or errno == BUILD_PROGRAM_FAILURE
		1015	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1016
		1017	# we check status for all devices
1013	for my $dev ($self->devices) {	1018	for my $dev ($self->devices) {
1014	eval { $prog->build ([$dev], $options); 1 }	1019	$prog->build_status ($dev) == BUILD_SUCCESS
1015	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"
1016	. $prog->build_log ($dev));	1021	. $prog->build_log ($dev));
1017	}	1022	}
1018		1023
1019	$prog	1024	$prog
…		…
1045	=item $buf = $ctx->buffer_sv ($flags, $data)	1050	=item $buf = $ctx->buffer_sv ($flags, $data)
1046		1051
1047	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1052	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1048	initialise it with the given data values.	1053	initialise it with the given data values.
1049		1054
1050	=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)
1051		1056
1052	Creates a new OpenCL::Image object and optionally initialises it with	1057	Creates a new OpenCL::Image object and optionally initialises it with
1053	the given data values.	1058	the given data values.
1054		1059
1055	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>
…		…
1151	=back	1156	=back
1152		1157
1153	=head2 THE OpenCL::Queue CLASS	1158	=head2 THE OpenCL::Queue CLASS
1154		1159
1155	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1160	An OpenCL::Queue represents an execution queue for OpenCL. You execute
1156	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
1157	it to complete in some way.	1162	in some way.
1158		1163
1159	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
1160	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
1161	no event object is created.	1166	the method is called in void context, in which case no event object is
		1167	created.
1162		1168
1163	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
1164	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
1165	event objects as extra parameters to the enqueue methods. To simplify	1171	event objects as extra parameters to the enqueue methods. To simplify
1166	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
1167	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
1168	having to put a valid event object into C<$event> first:	1174	having to put a valid event object into C<$event> first:
1169		1175
1170	$event = $queue->enqueue_xxx (..., $event);	1176	$event = $queue->xxx (..., $event);
1171		1177
1172	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
1173	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
1174	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
1175	faster.	1181	faster.
1176		1182
1177	=over 4	1183	=over 4
1178		1184
1179	=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...)
1180		1186
1181	Reads data from buffer into the given string.	1187	Reads data from buffer into the given string.
1182		1188
1183	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>
1184		1190
1185	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1191	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1186		1192
1187	Writes data to buffer from the given string.	1193	Writes data to buffer from the given string.
1188		1194
1189	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>
1190		1196
1191	=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...)
1192		1198
1193	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>
1194		1200
1195	=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...)
1196		1202
1197	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
1198		1204
1199	=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...)
1200		1206
1201	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
1202		1208
1203	=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...)
1204		1210
1205	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>
1206		1212
1207	=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...)
1208		1214
1209	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>
1210		1216
1211	=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...)
1212		1218
1213	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>
1214		1220
1215	=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...)
1216		1222
1217	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>
1218		1224
1219	=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...)
1220		1226
1221	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>
1222		1228
1223	=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...)
1224		1230
1225	Yeah.	1231	Yeah.
1226		1232
1227	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>.
1228		1234
1229	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1235	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1230		1236
1231	Fills the given buffer object with repeated applications of C<$pattern>,	1237	Fills the given buffer object with repeated applications of C<$pattern>,
1232	starting at C<$offset> for C<$size> octets.	1238	starting at C<$offset> for C<$size> octets.
1233		1239
1234	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>
1235		1241
1236	=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, ...)
1237		1243
1238	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
1239	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>,
1240	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
1241	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.
1242		1248
1243	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>
1244		1250
1245	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1251	=item $ev = $queue->task ($kernel, $wait_events...)
1246		1252
1247	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>
1248		1254
1249	=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...)
1250		1256
1251	Enqueues a kernel execution.	1257	Enqueues a kernel execution.
1252		1258
1253	\@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
1254	integers specifying the work sizes (element counts).	1260	integers specifying the work sizes (element counts).
…		…
1262	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
1263	elements as \@global_work_size.	1269	elements as \@global_work_size.
1264		1270
1265	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>
1266		1272
1267	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1273	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1268		1274
1269	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
1270	for subsequent OpenCL usage.	1276	for subsequent OpenCL usage.
1271		1277
1272	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>
1273		1279
1274	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1280	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1275		1281
1276	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
1277	for subsequent OpenGL usage.	1283	for subsequent OpenGL usage.
1278		1284
1279	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>
1280		1286
1281	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1287	=item $ev = $queue->wait_for_events ($wait_events...)
1282		1288
1283	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>
1284		1290
1285	=item $ev = $queue->enqueue_marker ($wait_events...)	1291	=item $ev = $queue->marker ($wait_events...)
1286		1292
1287	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>
1288		1294
1289	=item $ev = $queue->enqueue_barrier ($wait_events...)	1295	=item $ev = $queue->barrier ($wait_events...)
1290		1296
1291	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>
1292		1298
1293	=item $queue->flush	1299	=item $queue->flush
1294		1300
…		…
1685		1691
1686	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1692	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1687		1693
1688	=for gengetinfo end kernel_work_group	1694	=for gengetinfo end kernel_work_group
1689		1695
		1696	=item $kernel->setf ($format, ...)
		1697
		1698	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1699	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1700	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1701	what type of argument it is.
		1702
		1703	The format arguments are single letters:
		1704
		1705	c char
		1706	C unsigned char
		1707	s short
		1708	S unsigned short
		1709	i int
		1710	I unsigned int
		1711	l long
		1712	L unsigned long
		1713
		1714	h half float (0..65535)
		1715	f float
		1716	d double
		1717
		1718	z local (octet size)
		1719
		1720	m memory object (buffer or image)
		1721	a sampler
		1722	e event
		1723
		1724	Space characters in the format string are ignored.
		1725
		1726	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1727
		1728	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1729
1690	=item $kernel->set_TYPE ($index, $value)	1730	=item $kernel->set_TYPE ($index, $value)
1691		1731
		1732	=item $kernel->set_char ($index, $value)
		1733
		1734	=item $kernel->set_uchar ($index, $value)
		1735
		1736	=item $kernel->set_short ($index, $value)
		1737
		1738	=item $kernel->set_ushort ($index, $value)
		1739
		1740	=item $kernel->set_int ($index, $value)
		1741
		1742	=item $kernel->set_uint ($index, $value)
		1743
		1744	=item $kernel->set_long ($index, $value)
		1745
		1746	=item $kernel->set_ulong ($index, $value)
		1747
		1748	=item $kernel->set_half ($index, $value)
		1749
		1750	=item $kernel->set_float ($index, $value)
		1751
		1752	=item $kernel->set_double ($index, $value)
		1753
		1754	=item $kernel->set_memory ($index, $value)
		1755
		1756	=item $kernel->set_buffer ($index, $value)
		1757
		1758	=item $kernel->set_image ($index, $value)
		1759
		1760	=item $kernel->set_sampler ($index, $value)
		1761
		1762	=item $kernel->set_local ($index, $value)
		1763
		1764	=item $kernel->set_event ($index, $value)
		1765
1692	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1766	This is a family of methods to set the kernel argument with the number
1693		1767	C<$index> to the give C<$value>.
1694	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1695	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1696	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1697		1768
1698	Chars and integers (including the half type) are specified as integers,	1769	Chars and integers (including the half type) are specified as integers,
1699	float and double as floating point values, memory/buffer/image2d/image3d	1770	float and double as floating point values, memory/buffer/image must be
1700	must be an object of that type or C<undef>, local-memory arguments are	1771	an object of that type or C<undef>, local-memory arguments are set by
1701	set by specifying the size, and sampler and event must be objects of that	1772	specifying the size, and sampler and event must be objects of that type.
1702	type.	1773
		1774	Note that C<set_memory> works for all memory objects (all types of buffers
		1775	and images) - the main purpose of the more specific C<set_TYPE> functions
		1776	is type checking.
1703		1777
1704	Setting an argument for a kernel does NOT keep a reference to the object -	1778	Setting an argument for a kernel does NOT keep a reference to the object -
1705	for example, if you set an argument to some image object, free the image,	1779	for example, if you set an argument to some image object, free the image,
1706	and call the kernel, you will run into undefined behaviour.	1780	and call the kernel, you will run into undefined behaviour.
1707		1781

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.57 by root, Tue Apr 24 23:58:34 2012 UTC vs. Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.57 by root, Tue Apr 24 23:58:34 2012 UTC vs.
Revision 1.61 by root, Sat Apr 28 13:31:40 2012 UTC