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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC vs.
Revision 1.60 by root, Wed Apr 25 21:48:44 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
…		…
552		555
553	Returns all available OpenCL::Platform objects.	556	Returns all available OpenCL::Platform objects.
554		557
555	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	558	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
556		559
557	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr	560	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
558		561
559	Tries to create a context from a default device and platform - never worked for me.	562	Tries to create a context from a default device and platform type - never worked for me.
560		563
561	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	564	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		565
		566	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		567
		568	Create a new OpenCL::Context object using the given device object(s). This
		569	function isn't implemented yet, use C<< $platform->context >> instead.
		570
		571	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
562		572
563	=item OpenCL::wait_for_events $wait_events...	573	=item OpenCL::wait_for_events $wait_events...
564		574
565	Waits for all events to complete.	575	Waits for all events to complete.
566		576
…		…
636		646
637	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	647	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
638		648
639	Returns a list of matching OpenCL::Device objects.	649	Returns a list of matching OpenCL::Device objects.
640		650
641	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr)	651	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
642		652
643	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	653	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
644		654
645	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	655	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
646		656
647	=item $ctx = $platform->context ($properties, @$devices, $notify = $print_stderr)	657	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
648		658
649	Create a new OpenCL::Context object using the given device object(s)- a	659	Create a new OpenCL::Context object using the given device object(s)- a
650	CL_CONTEXT_PLATFORM property is supplied automatically.	660	CL_CONTEXT_PLATFORM property is supplied automatically.
651		661
652	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	662	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
1035	=item $buf = $ctx->buffer_sv ($flags, $data)	1045	=item $buf = $ctx->buffer_sv ($flags, $data)
1036		1046
1037	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1047	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1038	initialise it with the given data values.	1048	initialise it with the given data values.
1039		1049
1040	=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)	1050	=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)
1041		1051
1042	Creates a new OpenCL::Image object and optionally initialises it with	1052	Creates a new OpenCL::Image object and optionally initialises it with
1043	the given data values.	1053	the given data values.
1044		1054
1045	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1055	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
…		…
1141	=back	1151	=back
1142		1152
1143	=head2 THE OpenCL::Queue CLASS	1153	=head2 THE OpenCL::Queue CLASS
1144		1154
1145	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1155	An OpenCL::Queue represents an execution queue for OpenCL. You execute
1146	requests by calling their respective C<enqueue_xxx> method and waitinf for	1156	requests by calling their respective method and waiting for it to complete
1147	it to complete in some way.	1157	in some way.
1148		1158
1149	All the enqueue methods return an event object that can be used to wait	1159	Most methods that enqueue some request return an event object that can
1150	for completion, unless the method is called in void context, in which case	1160	be used to wait for completion (optionally using a callback), unless
1151	no event object is created.	1161	the method is called in void context, in which case no event object is
		1162	created.
1152		1163
1153	They also allow you to specify any number of other event objects that this	1164	They also allow you to specify any number of other event objects that this
1154	request has to wait for before it starts executing, by simply passing the	1165	request has to wait for before it starts executing, by simply passing the
1155	event objects as extra parameters to the enqueue methods. To simplify	1166	event objects as extra parameters to the enqueue methods. To simplify
1156	program design, this module ignores any C<undef> values in the list of	1167	program design, this module ignores any C<undef> values in the list of
1157	events. This makes it possible to code operations such as this, without	1168	events. This makes it possible to code operations such as this, without
1158	having to put a valid event object into C<$event> first:	1169	having to put a valid event object into C<$event> first:
1159		1170
1160	$event = $queue->enqueue_xxx (..., $event);	1171	$event = $queue->xxx (..., $event);
1161		1172
1162	Queues execute in-order by default, without any parallelism, so in most	1173	Queues execute in-order by default, without any parallelism, so in most
1163	cases (i.e. you use only one queue) it's not necessary to wait for or	1174	cases (i.e. you use only one queue) it's not necessary to wait for or
1164	create event objects, althoguh an our of order queue is often a bit	1175	create event objects, althoguh an our of order queue is often a bit
1165	faster.	1176	faster.
1166		1177
1167	=over 4	1178	=over 4
1168		1179
1169	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1180	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
1170		1181
1171	Reads data from buffer into the given string.	1182	Reads data from buffer into the given string.
1172		1183
1173	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1184	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
1174		1185
1175	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1186	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1176		1187
1177	Writes data to buffer from the given string.	1188	Writes data to buffer from the given string.
1178		1189
1179	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1190	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
1180		1191
1181	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1192	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1182		1193
1183	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1194	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1184		1195
1185	=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...)	1196	=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...)
1186		1197
1187	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1198	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1188		1199
1189	=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...)	1200	=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...)
1190		1201
1191	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1202	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1192		1203
1193	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1204	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1194		1205
1195	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	1206	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1196		1207
1197	=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...)	1208	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
1198		1209
1199	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1210	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1200		1211
1201	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1212	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1202		1213
1203	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1214	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1204		1215
1205	=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...)	1216	=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...)
1206		1217
1207	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1218	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1208		1219
1209	=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...)	1220	=item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...)
1210		1221
1211	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1222	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1212		1223
1213	=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...)	1224	=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...)
1214		1225
1215	Yeah.	1226	Yeah.
1216		1227
1217	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1228	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1218		1229
1219	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1230	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1220		1231
1221	Fills the given buffer object with repeated applications of C<$pattern>,	1232	Fills the given buffer object with repeated applications of C<$pattern>,
1222	starting at C<$offset> for C<$size> octets.	1233	starting at C<$offset> for C<$size> octets.
1223		1234
1224	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>	1235	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1225		1236
1226	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)	1237	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1227		1238
1228	Fills the given image area with the given rgba colour components. The	1239	Fills the given image area with the given rgba colour components. The
1229	components are normally floating point values between C<0> and C<1>,	1240	components are normally floating point values between C<0> and C<1>,
1230	except when the image channel data type is a signe dor unsigned	1241	except when the image channel data type is a signe dor unsigned
1231	unnormalised format, in which case the range is determined by the format.	1242	unnormalised format, in which case the range is determined by the format.
1232		1243
1233	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>	1244	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1234		1245
1235	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1246	=item $ev = $queue->task ($kernel, $wait_events...)
1236		1247
1237	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1248	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1238		1249
1239	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1250	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1240		1251
1241	Enqueues a kernel execution.	1252	Enqueues a kernel execution.
1242		1253
1243	@$global_work_size must be specified as a reference to an array of	1254	\@global_work_size must be specified as a reference to an array of
1244	integers specifying the work sizes (element counts).	1255	integers specifying the work sizes (element counts).
1245		1256
1246	@$global_work_offset must be either C<undef> (in which case all offsets	1257	\@global_work_offset must be either C<undef> (in which case all offsets
1247	are C<0>), or a reference to an array of work offsets, with the same number	1258	are C<0>), or a reference to an array of work offsets, with the same number
1248	of elements as @$global_work_size.	1259	of elements as \@global_work_size.
1249		1260
1250	@$local_work_size must be either C<undef> (in which case the	1261	\@local_work_size must be either C<undef> (in which case the
1251	implementation is supposed to choose good local work sizes), or a	1262	implementation is supposed to choose good local work sizes), or a
1252	reference to an array of local work sizes, with the same number of	1263	reference to an array of local work sizes, with the same number of
1253	elements as @$global_work_size.	1264	elements as \@global_work_size.
1254		1265
1255	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1266	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1256		1267
1257	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1268	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1258		1269
1259	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1270	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1260	for subsequent OpenCL usage.	1271	for subsequent OpenCL usage.
1261		1272
1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1273	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1263		1274
1264	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1275	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1265		1276
1266	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1277	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1267	for subsequent OpenGL usage.	1278	for subsequent OpenGL usage.
1268		1279
1269	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1280	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1270		1281
1271	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1282	=item $ev = $queue->wait_for_events ($wait_events...)
1272		1283
1273	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1284	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1274		1285
1275	=item $ev = $queue->enqueue_marker ($wait_events...)	1286	=item $ev = $queue->marker ($wait_events...)
1276		1287
1277	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1288	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1278		1289
1279	=item $ev = $queue->enqueue_barrier ($wait_events...)	1290	=item $ev = $queue->barrier ($wait_events...)
1280		1291
1281	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1292	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1282		1293
1283	=item $queue->flush	1294	=item $queue->flush
1284		1295
…		…
1675		1686
1676	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1687	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1677		1688
1678	=for gengetinfo end kernel_work_group	1689	=for gengetinfo end kernel_work_group
1679		1690
		1691	=item $kernel->setf ($format, ...)
		1692
		1693	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1694	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1695	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1696	what type of argument it is.
		1697
		1698	The format arguments are single letters:
		1699
		1700	c char
		1701	C unsigned char
		1702	s short
		1703	S unsigned short
		1704	i int
		1705	I unsigned int
		1706	l long
		1707	L unsigned long
		1708
		1709	h half float (0..65535)
		1710	f float
		1711	d double
		1712
		1713	z local (octet size)
		1714
		1715	m memory object (buffer or image)
		1716	a sampler
		1717	e event
		1718
		1719	Space characters in the format string are ignored.
		1720
		1721	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1722
		1723	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1724
1680	=item $kernel->set_TYPE ($index, $value)	1725	=item $kernel->set_TYPE ($index, $value)
1681		1726
		1727	=item $kernel->set_char ($index, $value)
		1728
		1729	=item $kernel->set_uchar ($index, $value)
		1730
		1731	=item $kernel->set_short ($index, $value)
		1732
		1733	=item $kernel->set_ushort ($index, $value)
		1734
		1735	=item $kernel->set_int ($index, $value)
		1736
		1737	=item $kernel->set_uint ($index, $value)
		1738
		1739	=item $kernel->set_long ($index, $value)
		1740
		1741	=item $kernel->set_ulong ($index, $value)
		1742
		1743	=item $kernel->set_half ($index, $value)
		1744
		1745	=item $kernel->set_float ($index, $value)
		1746
		1747	=item $kernel->set_double ($index, $value)
		1748
		1749	=item $kernel->set_memory ($index, $value)
		1750
		1751	=item $kernel->set_buffer ($index, $value)
		1752
		1753	=item $kernel->set_image ($index, $value)
		1754
		1755	=item $kernel->set_sampler ($index, $value)
		1756
		1757	=item $kernel->set_local ($index, $value)
		1758
		1759	=item $kernel->set_event ($index, $value)
		1760
1682	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1761	This is a family of methods to set the kernel argument with the number
1683		1762	C<$index> to the give C<$value>.
1684	TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1685	C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1686	C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1687		1763
1688	Chars and integers (including the half type) are specified as integers,	1764	Chars and integers (including the half type) are specified as integers,
1689	float and double as floating point values, memory/buffer/image2d/image3d	1765	float and double as floating point values, memory/buffer/image must be
1690	must be an object of that type or C<undef>, local-memory arguments are	1766	an object of that type or C<undef>, local-memory arguments are set by
1691	set by specifying the size, and sampler and event must be objects of that	1767	specifying the size, and sampler and event must be objects of that type.
1692	type.	1768
		1769	Note that C<set_memory> works for all memory objects (all types of buffers
		1770	and images) - the main purpose of the more specific C<set_TYPE> functions
		1771	is type checking.
1693		1772
1694	Setting an argument for a kernel does NOT keep a reference to the object -	1773	Setting an argument for a kernel does NOT keep a reference to the object -
1695	for example, if you set an argument to some image object, free the image,	1774	for example, if you set an argument to some image object, free the image,
1696	and call the kernel, you will run into undefined behaviour.	1775	and call the kernel, you will run into undefined behaviour.
1697		1776

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC vs. Revision 1.60 by root, Wed Apr 25 21:48:44 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC vs.
Revision 1.60 by root, Wed Apr 25 21:48:44 2012 UTC