[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.61 by root, Sat Apr 28 13:31:40 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
…		…
534	=item $int = OpenCL::errno	537	=item $int = OpenCL::errno
535		538
536	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
537	and before calling another OpenCL function.	540	and before calling another OpenCL function.
538		541
539	=item $str = OpenCL::err2str $errval	542	=item $str = OpenCL::err2str [$errval]
540		543
541	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).
542		546
543	=item $str = OpenCL::enum2str $enum	547	=item $str = OpenCL::enum2str $enum
544		548
545	Converts most enum values (of parameter names, image format constants,	549	Converts most enum values (of parameter names, image format constants,
546	object types, addressing and filter modes, command types etc.) into a	550	object types, addressing and filter modes, command types etc.) into a
…		…
552		556
553	Returns all available OpenCL::Platform objects.	557	Returns all available OpenCL::Platform objects.
554		558
555	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	559	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
556		560
557	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr	561	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
558		562
559	Tries to create a context from a default device and platform - never worked for me.	563	Tries to create a context from a default device and platform type - never worked for me.
560		564
561	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	565	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		566
		567	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		568
		569	Create a new OpenCL::Context object using the given device object(s). This
		570	function isn't implemented yet, use C<< $platform->context >> instead.
		571
		572	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
562		573
563	=item OpenCL::wait_for_events $wait_events...	574	=item OpenCL::wait_for_events $wait_events...
564		575
565	Waits for all events to complete.	576	Waits for all events to complete.
566		577
…		…
636		647
637	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	648	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
638		649
639	Returns a list of matching OpenCL::Device objects.	650	Returns a list of matching OpenCL::Device objects.
640		651
641	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr)	652	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
642		653
643	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	654	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
644		655
645	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	656	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
646		657
647	=item $ctx = $platform->context ($properties, @$devices, $notify = $print_stderr)	658	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
648		659
649	Create a new OpenCL::Context object using the given device object(s)- a	660	Create a new OpenCL::Context object using the given device object(s)- a
650	CL_CONTEXT_PLATFORM property is supplied automatically.	661	CL_CONTEXT_PLATFORM property is supplied automatically.
651		662
652	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	663	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
997	require Carp;	1008	require Carp;
998		1009
999	$prog = $self->program_with_source ($prog)	1010	$prog = $self->program_with_source ($prog)
1000	unless ref $prog;	1011	unless ref $prog;
1001		1012
1002	# 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
1003	for my $dev ($self->devices) {	1018	for my $dev ($self->devices) {
1004	eval { $prog->build ([$dev], $options); 1 }	1019	$prog->build_status ($dev) == BUILD_SUCCESS
1005	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"
1006	. $prog->build_log ($dev));	1021	. $prog->build_log ($dev));
1007	}	1022	}
1008		1023
1009	$prog	1024	$prog
…		…
1035	=item $buf = $ctx->buffer_sv ($flags, $data)	1050	=item $buf = $ctx->buffer_sv ($flags, $data)
1036		1051
1037	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1052	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1038	initialise it with the given data values.	1053	initialise it with the given data values.
1039		1054
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)	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)
1041		1056
1042	Creates a new OpenCL::Image object and optionally initialises it with	1057	Creates a new OpenCL::Image object and optionally initialises it with
1043	the given data values.	1058	the given data values.
1044		1059
1045	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>
…		…
1141	=back	1156	=back
1142		1157
1143	=head2 THE OpenCL::Queue CLASS	1158	=head2 THE OpenCL::Queue CLASS
1144		1159
1145	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1160	An OpenCL::Queue represents an execution queue for OpenCL. You execute
1146	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
1147	it to complete in some way.	1162	in some way.
1148		1163
1149	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
1150	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
1151	no event object is created.	1166	the method is called in void context, in which case no event object is
		1167	created.
1152		1168
1153	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
1154	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
1155	event objects as extra parameters to the enqueue methods. To simplify	1171	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	1172	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	1173	events. This makes it possible to code operations such as this, without
1158	having to put a valid event object into C<$event> first:	1174	having to put a valid event object into C<$event> first:
1159		1175
1160	$event = $queue->enqueue_xxx (..., $event);	1176	$event = $queue->xxx (..., $event);
1161		1177
1162	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
1163	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
1164	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
1165	faster.	1181	faster.
1166		1182
1167	=over 4	1183	=over 4
1168		1184
1169	=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...)
1170		1186
1171	Reads data from buffer into the given string.	1187	Reads data from buffer into the given string.
1172		1188
1173	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>
1174		1190
1175	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1191	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1176		1192
1177	Writes data to buffer from the given string.	1193	Writes data to buffer from the given string.
1178		1194
1179	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>
1180		1196
1181	=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...)
1182		1198
1183	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>
1184		1200
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...)	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...)
1186		1202
1187	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
1188		1204
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...)	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...)
1190		1206
1191	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
1192		1208
1193	=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...)
1194		1210
1195	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>
1196		1212
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...)	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...)
1198		1214
1199	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>
1200		1216
1201	=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...)
1202		1218
1203	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>
1204		1220
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...)	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...)
1206		1222
1207	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>
1208		1224
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...)	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...)
1210		1226
1211	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>
1212		1228
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...)	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...)
1214		1230
1215	Yeah.	1231	Yeah.
1216		1232
1217	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>.
1218		1234
1219	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1235	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1220		1236
1221	Fills the given buffer object with repeated applications of C<$pattern>,	1237	Fills the given buffer object with repeated applications of C<$pattern>,
1222	starting at C<$offset> for C<$size> octets.	1238	starting at C<$offset> for C<$size> octets.
1223		1239
1224	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>
1225		1241
1226	=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, ...)
1227		1243
1228	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
1229	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>,
1230	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
1231	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.
1232		1248
1233	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>
1234		1250
1235	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1251	=item $ev = $queue->task ($kernel, $wait_events...)
1236		1252
1237	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>
1238		1254
1239	=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...)
1240		1256
1241	Enqueues a kernel execution.	1257	Enqueues a kernel execution.
1242		1258
1243	@$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
1244	integers specifying the work sizes (element counts).	1260	integers specifying the work sizes (element counts).
1245		1261
1246	@$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
1247	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
1248	of elements as @$global_work_size.	1264	of elements as \@global_work_size.
1249		1265
1250	@$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
1251	implementation is supposed to choose good local work sizes), or a	1267	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	1268	reference to an array of local work sizes, with the same number of
1253	elements as @$global_work_size.	1269	elements as \@global_work_size.
1254		1270
1255	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>
1256		1272
1257	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1273	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1258		1274
1259	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
1260	for subsequent OpenCL usage.	1276	for subsequent OpenCL usage.
1261		1277
1262	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>
1263		1279
1264	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1280	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1265		1281
1266	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
1267	for subsequent OpenGL usage.	1283	for subsequent OpenGL usage.
1268		1284
1269	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>
1270		1286
1271	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1287	=item $ev = $queue->wait_for_events ($wait_events...)
1272		1288
1273	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>
1274		1290
1275	=item $ev = $queue->enqueue_marker ($wait_events...)	1291	=item $ev = $queue->marker ($wait_events...)
1276		1292
1277	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>
1278		1294
1279	=item $ev = $queue->enqueue_barrier ($wait_events...)	1295	=item $ev = $queue->barrier ($wait_events...)
1280		1296
1281	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>
1282		1298
1283	=item $queue->flush	1299	=item $queue->flush
1284		1300
…		…
1675		1691
1676	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.
1677		1693
1678	=for gengetinfo end kernel_work_group	1694	=for gengetinfo end kernel_work_group
1679		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
1680	=item $kernel->set_TYPE ($index, $value)	1730	=item $kernel->set_TYPE ($index, $value)
1681		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
1682	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
1683		1767	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		1768
1688	Chars and integers (including the half type) are specified as integers,	1769	Chars and integers (including the half type) are specified as integers,
1689	float and double as floating point values, memory/buffer/image2d/image3d	1770	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	1771	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	1772	specifying the size, and sampler and event must be objects of that type.
1692	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.
1693		1777
1694	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 -
1695	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,
1696	and call the kernel, you will run into undefined behaviour.	1780	and call the kernel, you will run into undefined behaviour.
1697		1781

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.61 by root, Sat Apr 28 13:31:40 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.61 by root, Sat Apr 28 13:31:40 2012 UTC