[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.69 by root, Thu May 3 23:30:08 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
212	set tunnel effect.	215	set tunnel effect.
213		216
214	This is quite a long example to get you going.	217	This is quite a long example to get you going - you can download it from
		218	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight>.
215		219
216	use OpenGL ":all";	220	use OpenGL ":all";
217	use OpenCL;	221	use OpenCL;
218		222
		223	my $S = $ARGV[0] \|\| 256; # window/texture size, smaller is faster
		224
219	# open a window and create a gl texture	225	# open a window and create a gl texture
220	OpenGL::glpOpenWindow width => 256, height => 256;	226	OpenGL::glpOpenWindow width => $S, height => $S;
221	my $texid = glGenTextures_p 1;	227	my $texid = glGenTextures_p 1;
222	glBindTexture GL_TEXTURE_2D, $texid;	228	glBindTexture GL_TEXTURE_2D, $texid;
223	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;	229	glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, $S, $S, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
224		230
225	# find and use the first opencl device that let's us get a shared opengl context	231	# find and use the first opencl device that let's us get a shared opengl context
226	my $platform;	232	my $platform;
227	my $dev;	233	my $dev;
228	my $ctx;	234	my $ctx;
…		…
247	# now the boring opencl code	253	# now the boring opencl code
248	my $src = <<EOF;	254	my $src = <<EOF;
249	kernel void	255	kernel void
250	juliatunnel (write_only image2d_t img, float time)	256	juliatunnel (write_only image2d_t img, float time)
251	{	257	{
252	float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;	258	int2 xy = (int2)(get_global_id (0), get_global_id (1));
		259	float2 p = convert_float2 (xy) / $S.f * 2.f - 1.f;
253		260
254	float2 m = (float2)(1.f, p.y) / fabs (p.x);	261	float2 m = (float2)(1.f, p.y) / fabs (p.x); // tunnel
255	m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;	262	m.x = fabs (fmod (m.x + time * 0.05f, 4.f) - 2.f);
256		263
257	float2 z = m;	264	float2 z = m;
258	float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));	265	float2 c = (float2)(sin (time * 0.01133f), cos (time * 0.02521f));
259		266
260	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)	267	for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) // standard julia
261	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;	268	z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
262		269
263	float3 colour = (float3)(z.x, z.y, z.x * z.y);	270	float3 colour = (float3)(z.x, z.y, atan2 (z.y, z.x));
264	write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));	271	write_imagef (img, xy, (float4)(colour * p.x * p.x, 1.));
265	}	272	}
266	EOF	273	EOF
267		274
268	my $prog = $ctx->build_program ($src);	275	my $prog = $ctx->build_program ($src);
269	my $kernel = $prog->kernel ("juliatunnel");	276	my $kernel = $prog->kernel ("juliatunnel");
270		277
271	# program compiled, kernel ready, now draw and loop	278	# program compiled, kernel ready, now draw and loop
272		279
273	for (my $time; ; ++$time) {	280	for (my $time; ; ++$time) {
274	# acquire objects from opengl	281	# acquire objects from opengl
275	$queue->enqueue_acquire_gl_objects ([$tex]);	282	$queue->acquire_gl_objects ([$tex]);
276		283
277	# configure and run our kernel	284	# configure and run our kernel
278	$kernel->set_image2d (0, $tex);	285	$kernel->setf ("mf", $tex, $time*2); # mf = memory object, float
279	$kernel->set_float (1, $time);
280	$queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);	286	$queue->nd_range_kernel ($kernel, undef, [$S, $S], undef);
281		287
282	# release objects to opengl again	288	# release objects to opengl again
283	$queue->enqueue_release_gl_objects ([$tex]);	289	$queue->release_gl_objects ([$tex]);
284		290
285	# wait	291	# wait
286	$queue->finish;	292	$queue->finish;
287		293
288	# now draw the texture, the defaults should be all right	294	# now draw the texture, the defaults should be all right
…		…
298		304
299	glXSwapBuffers;	305	glXSwapBuffers;
300		306
301	select undef, undef, undef, 1/60;	307	select undef, undef, undef, 1/60;
302	}	308	}
		309
		310	=head2 How to modify the previous example to not rely on GL sharing.
		311
		312	For those poor souls with only a sucky CPU OpenCL implementation, you
		313	currently have to read the image into some perl scalar, and then modify a
		314	texture or use glDrawPixels or so).
		315
		316	First, when you don't need gl sharing, you can create the context much simpler:
		317
		318	$ctx = $platform->context (undef, [$dev])
		319
		320	To use a texture, you would modify the above example by creating an
		321	OpenCL::Image manually instead of deriving it from a texture:
		322
		323	my $tex = $ctx->image2d (OpenCL::MEM_WRITE_ONLY, OpenCL::RGBA, OpenCL::UNORM_INT8, $S, $S);
		324
		325	And in the darw loop, intead of acquire_gl_objects/release_gl_objects, you
		326	would read the image2d after the kernel has written it:
		327
		328	$queue->read_image ($tex, 0, 0, 0, 0, $S, $S, 1, 0, 0, my $data);
		329
		330	And then you would upload the pixel data to the texture (or use glDrawPixels):
		331
		332	glTexSubImage2D_s GL_TEXTURE_2D, 0, 0, 0, $S, $S, GL_RGBA, GL_UNSIGNED_BYTE, $data;
		333
		334	The fully modified example can be found at
		335	L<http://cvs.schmorp.de/OpenCL/examples/juliaflight-nosharing>.
303		336
304	=head1 DOCUMENTATION	337	=head1 DOCUMENTATION
305		338
306	=head2 BASIC CONVENTIONS	339	=head2 BASIC CONVENTIONS
307		340
…		…
417	use AnyEvent;	450	use AnyEvent;
418		451
419	# initialise AnyEvent, by creating a watcher, or:	452	# initialise AnyEvent, by creating a watcher, or:
420	AnyEvent::detect;	453	AnyEvent::detect;
421		454
422	my $e = $queue->enqueue_marker;	455	my $e = $queue->marker;
423	$e->cb (sub {	456	$e->cb (sub {
424	warn "opencl is finished\n";	457	warn "opencl is finished\n";
425	})	458	})
426		459
427	main Gtk2;	460	main Gtk2;
…		…
444	Asynchronously means that perl might execute your callbacks at any	477	Asynchronously means that perl might execute your callbacks at any
445	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),	478	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	479	the C<until> loop following the marker call will be interrupted by the
447	callback:	480	callback:
448		481
449	my $e = $queue->enqueue_marker;	482	my $e = $queue->marker;
450	my $flag;	483	my $flag;
451	$e->cb (sub { $flag = 1 });	484	$e->cb (sub { $flag = 1 });
452	1 until $flag;	485	1 until $flag;
453	# $flag is now 1	486	# $flag is now 1
454		487
…		…
490	=cut	523	=cut
491		524
492	package OpenCL;	525	package OpenCL;
493		526
494	use common::sense;	527	use common::sense;
		528	use Carp ();
495	use Async::Interrupt ();	529	use Async::Interrupt ();
496		530
497	our $POLL_FUNC; # set by XS	531	our $POLL_FUNC; # set by XS
498		532
499	BEGIN {	533	BEGIN {
500	our $VERSION = '0.97';	534	our $VERSION = '0.98';
501		535
502	require XSLoader;	536	require XSLoader;
503	XSLoader::load (__PACKAGE__, $VERSION);	537	XSLoader::load (__PACKAGE__, $VERSION);
504		538
505	@OpenCL::Platform::ISA =	539	@OpenCL::Platform::ISA =
…		…
523	@OpenCL::Image1D::ISA =	557	@OpenCL::Image1D::ISA =
524	@OpenCL::Image1DArray::ISA =	558	@OpenCL::Image1DArray::ISA =
525	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;	559	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
526		560
527	@OpenCL::UserEvent::ISA = OpenCL::Event::;	561	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		562
		563	@OpenCL::MappedBuffer::ISA =
		564	@OpenCL::MappedImage::ISA = OpenCL::Mapped::;
528	}	565	}
529		566
530	=head2 THE OpenCL PACKAGE	567	=head2 THE OpenCL PACKAGE
531		568
532	=over 4	569	=over 4
…		…
534	=item $int = OpenCL::errno	571	=item $int = OpenCL::errno
535		572
536	The last error returned by a function - it's only valid after an error occured	573	The last error returned by a function - it's only valid after an error occured
537	and before calling another OpenCL function.	574	and before calling another OpenCL function.
538		575
539	=item $str = OpenCL::err2str $errval	576	=item $str = OpenCL::err2str [$errval]
540		577
541	Comverts an error value into a human readable string.	578	Converts an error value into a human readable string. IF no error value is
		579	given, then the last error will be used (as returned by OpenCL::errno).
542		580
543	=item $str = OpenCL::enum2str $enum	581	=item $str = OpenCL::enum2str $enum
544		582
545	Converts most enum values (of parameter names, image format constants,	583	Converts most enum values (of parameter names, image format constants,
546	object types, addressing and filter modes, command types etc.) into a	584	object types, addressing and filter modes, command types etc.) into a
…		…
552		590
553	Returns all available OpenCL::Platform objects.	591	Returns all available OpenCL::Platform objects.
554		592
555	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	593	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
556		594
557	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr	595	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr
558		596
559	Tries to create a context from a default device and platform - never worked for me.	597	Tries to create a context from a default device and platform type - never worked for me.
560		598
561	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	599	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
		600
		601	=item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr)
		602
		603	Create a new OpenCL::Context object using the given device object(s). This
		604	function isn't implemented yet, use C<< $platform->context >> instead.
		605
		606	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
562		607
563	=item OpenCL::wait_for_events $wait_events...	608	=item OpenCL::wait_for_events $wait_events...
564		609
565	Waits for all events to complete.	610	Waits for all events to complete.
566		611
…		…
636		681
637	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	682	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
638		683
639	Returns a list of matching OpenCL::Device objects.	684	Returns a list of matching OpenCL::Device objects.
640		685
641	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr)	686	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr)
642		687
643	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	688	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
644		689
645	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	690	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
646		691
647	=item $ctx = $platform->context ($properties, @$devices, $notify = $print_stderr)	692	=item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr)
648		693
649	Create a new OpenCL::Context object using the given device object(s)- a	694	Create a new OpenCL::Context object using the given device object(s)- a
650	CL_CONTEXT_PLATFORM property is supplied automatically.	695	CL_CONTEXT_PLATFORM property is supplied automatically.
651		696
652	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	697	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
992	=cut	1037	=cut
993		1038
994	sub OpenCL::Context::build_program {	1039	sub OpenCL::Context::build_program {
995	my ($self, $prog, $options) = @_;	1040	my ($self, $prog, $options) = @_;
996		1041
997	require Carp;
998
999	$prog = $self->program_with_source ($prog)	1042	$prog = $self->program_with_source ($prog)
1000	unless ref $prog;	1043	unless ref $prog;
1001		1044
1002	# we build separately per device so we instantly know which one failed	1045	eval { $prog->build (undef, $options); 1 }
		1046	or errno == BUILD_PROGRAM_FAILURE
		1047	or errno == INVALID_BINARY # workaround nvidia bug
		1048	or Carp::croak "OpenCL::Context->build_program: " . err2str;
		1049
		1050	# we check status for all devices
1003	for my $dev ($self->devices) {	1051	for my $dev ($self->devices) {
1004	eval { $prog->build ([$dev], $options); 1 }	1052	$prog->build_status ($dev) == BUILD_SUCCESS
1005	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"	1053	or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
1006	. $prog->build_log ($dev));	1054	. $prog->build_log ($dev);
1007	}	1055	}
1008		1056
1009	$prog	1057	$prog
1010	}	1058	}
1011		1059
…		…
1035	=item $buf = $ctx->buffer_sv ($flags, $data)	1083	=item $buf = $ctx->buffer_sv ($flags, $data)
1036		1084
1037	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and	1085	Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
1038	initialise it with the given data values.	1086	initialise it with the given data values.
1039		1087
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)	1088	=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		1089
1042	Creates a new OpenCL::Image object and optionally initialises it with	1090	Creates a new OpenCL::Image object and optionally initialises it with
1043	the given data values.	1091	the given data values.
1044		1092
1045	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>	1093	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
…		…
1110		1158
1111	Creates a new OpenCL::Program object from the given source code.	1159	Creates a new OpenCL::Program object from the given source code.
1112		1160
1113	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>	1161	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
1114		1162
		1163	=item ($program, \@status) = $ctx->program_with_binary (\@devices, \@binaries)
		1164
		1165	Creates a new OpenCL::Program object from the given binaries.
		1166
		1167	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithBinary.html>
		1168
		1169	Example: clone an existing program object that contains a successfully
		1170	compiled program, no matter how useless this is.
		1171
		1172	my $clone = $ctx->program_with_binary ([$prog->devices], [$prog->binaries]);
		1173
1115	=item $packed_value = $ctx->info ($name)	1174	=item $packed_value = $ctx->info ($name)
1116		1175
1117	See C<< $platform->info >> for details.	1176	See C<< $platform->info >> for details.
1118		1177
1119	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>	1178	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
…		…
1141	=back	1200	=back
1142		1201
1143	=head2 THE OpenCL::Queue CLASS	1202	=head2 THE OpenCL::Queue CLASS
1144		1203
1145	An OpenCL::Queue represents an execution queue for OpenCL. You execute	1204	An OpenCL::Queue represents an execution queue for OpenCL. You execute
1146	requests by calling their respective C<enqueue_xxx> method and waitinf for	1205	requests by calling their respective method and waiting for it to complete
1147	it to complete in some way.	1206	in some way.
1148		1207
1149	All the enqueue methods return an event object that can be used to wait	1208	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	1209	be used to wait for completion (optionally using a callback), unless
1151	no event object is created.	1210	the method is called in void context, in which case no event object is
		1211	created.
1152		1212
1153	They also allow you to specify any number of other event objects that this	1213	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	1214	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	1215	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	1216	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	1217	events. This makes it possible to code operations such as this, without
1158	having to put a valid event object into C<$event> first:	1218	having to put a valid event object into C<$event> first:
1159		1219
1160	$event = $queue->enqueue_xxx (..., $event);	1220	$event = $queue->xxx (..., $event);
1161		1221
1162	Queues execute in-order by default, without any parallelism, so in most	1222	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	1223	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	1224	create event objects, althoguh an our of order queue is often a bit
1165	faster.	1225	faster.
1166		1226
1167	=over 4	1227	=over 4
1168		1228
1169	=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)	1229	=item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
1170		1230
1171	Reads data from buffer into the given string.	1231	Reads data from buffer into the given string.
1172		1232
1173	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>	1233	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
1174		1234
1175	=item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)	1235	=item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...)
1176		1236
1177	Writes data to buffer from the given string.	1237	Writes data to buffer from the given string.
1178		1238
1179	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>	1239	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html>
1180		1240
1181	=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)	1241	=item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
1182		1242
1183	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>	1243	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
1184		1244
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...)	1245	=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		1246
1187	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html	1247	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
1188		1248
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...)	1249	=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		1250
1191	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html	1251	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
1192		1252
1193	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1194
1195	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
1196
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...)	1253	=item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...)
		1254
		1255	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>
		1256
		1257	=item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
		1258
		1259	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1260	module uses the image width (and height) to supply default values.
1198		1261
1199	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
1200		1263
1201	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	1264	=item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
1202		1265
		1266	C<$row_pitch> (and C<$slice_pitch>) can be C<0>, in which case the OpenCL
		1267	module uses the image width (and height) to supply default values.
1203	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	1268	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
1204		1269
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...)	1270	=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		1271
1207	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	1272	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
1208		1273
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...)	1274	=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		1275
1211	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	1276	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
1212		1277
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...)	1278	=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		1279
1215	Yeah.	1280	Yeah.
1216		1281
1217	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1282	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
1218		1283
1219	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)	1284	=item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...)
1220		1285
1221	Fills the given buffer object with repeated applications of C<$pattern>,	1286	Fills the given buffer object with repeated applications of C<$pattern>,
1222	starting at C<$offset> for C<$size> octets.	1287	starting at C<$offset> for C<$size> octets.
1223		1288
1224	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>	1289	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1225		1290
1226	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)	1291	=item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1227		1292
1228	Fills the given image area with the given rgba colour components. The	1293	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>,	1294	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	1295	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.	1296	unnormalised format, in which case the range is determined by the format.
1232		1297
1233	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>	1298	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1234		1299
1235	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1300	=item $ev = $queue->task ($kernel, $wait_events...)
1236		1301
1237	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1302	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
1238		1303
1239	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1304	=item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...)
1240		1305
1241	Enqueues a kernel execution.	1306	Enqueues a kernel execution.
1242		1307
1243	@$global_work_size must be specified as a reference to an array of	1308	\@global_work_size must be specified as a reference to an array of
1244	integers specifying the work sizes (element counts).	1309	integers specifying the work sizes (element counts).
1245		1310
1246	@$global_work_offset must be either C<undef> (in which case all offsets	1311	\@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	1312	are C<0>), or a reference to an array of work offsets, with the same number
1248	of elements as @$global_work_size.	1313	of elements as \@global_work_size.
1249		1314
1250	@$local_work_size must be either C<undef> (in which case the	1315	\@local_work_size must be either C<undef> (in which case the
1251	implementation is supposed to choose good local work sizes), or a	1316	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	1317	reference to an array of local work sizes, with the same number of
1253	elements as @$global_work_size.	1318	elements as \@global_work_size.
1254		1319
1255	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>	1320	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
1256		1321
1257	=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)	1322	=item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...)
1258		1323
1259	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired	1324	Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1260	for subsequent OpenCL usage.	1325	for subsequent OpenCL usage.
1261		1326
1262	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>	1327	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1263		1328
1264	=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)	1329	=item $ev = $queue->release_gl_objects ([object, ...], $wait_events...)
1265		1330
1266	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released	1331	Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1267	for subsequent OpenGL usage.	1332	for subsequent OpenGL usage.
1268		1333
1269	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>	1334	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
1270		1335
1271	=item $ev = $queue->enqueue_wait_for_events ($wait_events...)	1336	=item $ev = $queue->wait_for_events ($wait_events...)
1272		1337
1273	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>	1338	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
1274		1339
1275	=item $ev = $queue->enqueue_marker ($wait_events...)	1340	=item $ev = $queue->marker ($wait_events...)
1276		1341
1277	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>	1342	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1278		1343
1279	=item $ev = $queue->enqueue_barrier ($wait_events...)	1344	=item $ev = $queue->barrier ($wait_events...)
1280		1345
1281	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>	1346	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1282		1347
1283	=item $queue->flush	1348	=item $queue->flush
1284		1349
…		…
1311	=item $command_queue_properties = $command_queue->properties	1376	=item $command_queue_properties = $command_queue->properties
1312		1377
1313	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.	1378	Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1314		1379
1315	=for gengetinfo end command_queue	1380	=for gengetinfo end command_queue
		1381
		1382	=back
		1383
		1384	=head3 MEMORY MAPPED BUFFERS
		1385
		1386	OpenCL allows you to map buffers and images to host memory (read: perl
		1387	scalars). This is done much like reading or copying a buffer, by enqueuing
		1388	a map or unmap operation on the command queue.
		1389
		1390	The map operations return an C<OpenCL::Mapped> object - see L<THE
		1391	OpenCL::Mapped CLASS> section for details on what to do with these
		1392	objects.
		1393
		1394	The object will be unmapped automatically when the mapped object is
		1395	destroyed (you can use a barrier to make sure the unmap has finished,
		1396	before using the buffer in a kernel), but you can also enqueue an unmap
		1397	operation manually.
		1398
		1399	=over 4
		1400
		1401	=item $mapped_buffer = $queue->map_buffer ($buf, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $offset=0, $size=undef, $wait_events...)
		1402
		1403	Maps the given buffer into host memory and returns an
		1404	C<OpenCL::MappedBuffer> object. If C<$size> is specified as undef, then
		1405	the map will extend to the end of the buffer.
		1406
		1407	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapBuffer.html>
		1408
		1409	Example: map the buffer $buf fully and replace the first 4 bytes by "abcd", then unmap.
		1410
		1411	{
		1412	my $mapped = $queue->map_buffer ($buf, 1, OpenCL::MAP_WRITE);
		1413	substr $$mapped, 0, 4, "abcd";
		1414	} # asynchronously unmap because $mapped is destroyed
		1415
		1416	=item $mapped_image = $queue->map_image ($img, $blocking=1, $map_flags=OpenCL::MAP_READ\|OpenCL::MAP_WRITE, $x=0, $y=0, $z=0, $width=undef, $height=undef, $depth=undef, $wait_events...)
		1417
		1418	Maps the given image area into host memory and return an
		1419	C<OpenCL::MappedImage> object.
		1420
		1421	If any of C<$width>, C<$height> and/or C<$depth> are C<undef> then they
		1422	will be replaced by the maximum possible value.
		1423
		1424	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMapImage.html>
		1425
		1426	Example: map an image (with OpenCL::UNSIGNED_INT8 channel type) and set
		1427	the first channel of the leftmost column to 5, then explicitly unmap
		1428	it. You are not necessarily meant to do it this way, this example just
		1429	shows you the accessors to use :)
		1430
		1431	my $mapped = $queue->map_image ($image, 1, OpenCL::MAP_WRITE);
		1432
		1433	$mapped->set ($_ * $mapped->row_pitch, pack "C", 5)
		1434	for 0..$image->height;
		1435
		1436	$mapped->unmap;.
		1437	$mapped->wait; # only needed for out of order queues normally
		1438
		1439	=item $ev = $queue->unmap ($mapped, $wait_events...)
		1440
		1441	Unmaps the data from host memory. You must not call any methods that
		1442	modify the data, or modify the data scalar directly, after calling this
		1443	method.
		1444
		1445	The mapped event object will always be passed as part of the
		1446	$wait_events. The mapped event object will be replaced by the new event
		1447	object that this request creates.
1316		1448
1317	=back	1449	=back
1318		1450
1319	=head2 THE OpenCL::Memory CLASS	1451	=head2 THE OpenCL::Memory CLASS
1320		1452
…		…
1513	If a callback is specified, then it will be called when compilation is	1645	If a callback is specified, then it will be called when compilation is
1514	finished. Note that many OpenCL implementations block your program while	1646	finished. Note that many OpenCL implementations block your program while
1515	compiling whether you use a callback or not. See C<build_async> if you	1647	compiling whether you use a callback or not. See C<build_async> if you
1516	want to make sure the build is done in the background.	1648	want to make sure the build is done in the background.
1517		1649
1518	Note that some OpenCL implementations atc up badly, and don't call the	1650	Note that some OpenCL implementations act up badly, and don't call the
1519	callback in some error cases (but call it in others). This implementation	1651	callback in some error cases (but call it in others). This implementation
1520	assumes the callback will always be called, and leaks memory if this is	1652	assumes the callback will always be called, and leaks memory if this is
1521	not so. So best make sure you don't pass in invalid values.	1653	not so. So best make sure you don't pass in invalid values.
1522		1654
		1655	Some implementations fail with C<OpenCL::INVALID_BINARY> when the
		1656	compilation state is successful but some later stage fails.
		1657
1523	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1658	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1524		1659
1525	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)	1660	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
1526		1661
1527	Similar to C<< ->build >>, except it starts a thread, and never fails (you	1662	Similar to C<< ->build >>, except it starts a thread, and never fails (you
…		…
1675		1810
1676	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.	1811	Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1677		1812
1678	=for gengetinfo end kernel_work_group	1813	=for gengetinfo end kernel_work_group
1679		1814
		1815	=item $kernel->setf ($format, ...)
		1816
		1817	Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic
		1818	way to set arguments (and with OpenCL 1.2 it might be rather slow), you
		1819	need to specify a format argument, much as with C<printf>, to tell OpenCL
		1820	what type of argument it is.
		1821
		1822	The format arguments are single letters:
		1823
		1824	c char
		1825	C unsigned char
		1826	s short
		1827	S unsigned short
		1828	i int
		1829	I unsigned int
		1830	l long
		1831	L unsigned long
		1832
		1833	h half float (0..65535)
		1834	f float
		1835	d double
		1836
		1837	z local (octet size)
		1838
		1839	m memory object (buffer or image)
		1840	a sampler
		1841	e event
		1842
		1843	Space characters in the format string are ignored.
		1844
		1845	Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image.
		1846
		1847	$kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image);
		1848
1680	=item $kernel->set_TYPE ($index, $value)	1849	=item $kernel->set_TYPE ($index, $value)
1681		1850
		1851	=item $kernel->set_char ($index, $value)
		1852
		1853	=item $kernel->set_uchar ($index, $value)
		1854
		1855	=item $kernel->set_short ($index, $value)
		1856
		1857	=item $kernel->set_ushort ($index, $value)
		1858
		1859	=item $kernel->set_int ($index, $value)
		1860
		1861	=item $kernel->set_uint ($index, $value)
		1862
		1863	=item $kernel->set_long ($index, $value)
		1864
		1865	=item $kernel->set_ulong ($index, $value)
		1866
		1867	=item $kernel->set_half ($index, $value)
		1868
		1869	=item $kernel->set_float ($index, $value)
		1870
		1871	=item $kernel->set_double ($index, $value)
		1872
		1873	=item $kernel->set_memory ($index, $value)
		1874
		1875	=item $kernel->set_buffer ($index, $value)
		1876
		1877	=item $kernel->set_image ($index, $value)
		1878
		1879	=item $kernel->set_sampler ($index, $value)
		1880
		1881	=item $kernel->set_local ($index, $value)
		1882
		1883	=item $kernel->set_event ($index, $value)
		1884
1682	This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.	1885	This is a family of methods to set the kernel argument with the number
1683		1886	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		1887
1688	Chars and integers (including the half type) are specified as integers,	1888	Chars and integers (including the half type) are specified as integers,
1689	float and double as floating point values, memory/buffer/image2d/image3d	1889	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	1890	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	1891	specifying the size, and sampler and event must be objects of that type.
1692	type.	1892
		1893	Note that C<set_memory> works for all memory objects (all types of buffers
		1894	and images) - the main purpose of the more specific C<set_TYPE> functions
		1895	is type checking.
1693		1896
1694	Setting an argument for a kernel does NOT keep a reference to the object -	1897	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,	1898	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.	1899	and call the kernel, you will run into undefined behaviour.
1697		1900
…		…
1793		1996
1794	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1997	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1795		1998
1796	=back	1999	=back
1797		2000
		2001	=head2 THE OpenCL::Mapped CLASS
		2002
		2003	This class represents objects mapped into host memory. They are
		2004	represented by a blessed string scalar. The string data is the mapped
		2005	memory area, that is, if you read or write it, then the mapped object is
		2006	accessed directly.
		2007
		2008	You must only ever use operations that modify the string in-place - for
		2009	example, a C<substr> that doesn't change the length, or maybe a regex that
		2010	doesn't change the length. Any other operation might cause the data to be
		2011	copied.
		2012
		2013	When the object is destroyed it will enqueue an implicit unmap operation
		2014	on the queue that was used to create it.
		2015
		2016	Keep in mind that you I<need> to unmap (or destroy) mapped objects before
		2017	OpenCL sees the changes, even if some implementations don't need this
		2018	sometimes.
		2019
		2020	Example, replace the first two floats in the mapped buffer by 1 and 2.
		2021
		2022	my $mapped = $queue->map_buffer ($buf, ...
		2023	$mapped->event->wait; # make sure it's there
		2024
		2025	# now replace first 8 bytes by new data, which is exactly 8 bytes long
		2026	# we blindly assume device endianness to equal host endianness
		2027	# (and of course, we assume iee 754 single precision floats :)
		2028	substr $$mapped, 0, 8, pack "f*", 1, 2;
		2029
		2030	=over 4
		2031
		2032	=item $ev = $mapped->unmap ($wait_events...)
		2033
		2034	Unmaps the mapped memory object, using the queue originally used to create
		2035	it, quite similarly to C<< $queue->unmap ($mapped, ...) >>.
		2036
		2037	=item $bool = $mapped->mapped
		2038
		2039	Returns whether the object is still mapped - true before an C<unmap> is
		2040	enqueued, false afterwards.
		2041
		2042	=item $ev = $mapped->event
		2043
		2044	Return the event object associated with the mapped object. Initially, this
		2045	will be the event object created when mapping the object, and after an
		2046	unmap, this will be the event object that the unmap operation created.
		2047
		2048	=item $mapped->wait
		2049
		2050	Same as C<< $mapped->event->wait >> - makes sure no operations on this
		2051	mapped object are outstanding.
		2052
		2053	=item $bytes = $mapped->size
		2054
		2055	Returns the size of the mapped area, in bytes. Same as C<length $$mapped>.
		2056
		2057	=item $ptr = $mapped->ptr
		2058
		2059	Returns the raw memory address of the mapped area.
		2060
		2061	=item $mapped->set ($offset, $data)
		2062
		2063	Replaces the data at the given C<$offset> in the memory area by the new
		2064	C<$data>. This method is safer than direct manipulation of C<$mapped>
		2065	because it does bounds-checking, but also slower.
		2066
		2067	=item $data = $mapped->get ($offset, $length)
		2068
		2069	Returns (without copying) a scalar representing the data at the given
		2070	C<$offset> and C<$length> in the mapped memory area. This is the same as
		2071	the following substr, except much slower;
		2072
		2073	$data = substr $$mapped, $offset, $length
		2074
		2075	=cut
		2076
		2077	sub OpenCL::Mapped::get {
		2078	substr ${$_[0]}, $_[1], $_[2]
		2079	}
		2080
		2081	=back
		2082
		2083	=head2 THE OpenCL::MappedBuffer CLASS
		2084
		2085	This is a subclass of OpenCL::Mapped, representing mapped buffers.
		2086
		2087	=head2 THE OpenCL::MappedImage CLASS
		2088
		2089	This is a subclass of OpenCL::Mapped, representing mapped images.
		2090
		2091	=over 4
		2092
		2093	=item $bytes = $mapped->row_pitch
		2094
		2095	=item $bytes = $mapped->slice_pitch
		2096
		2097	Return the row or slice pitch of the image that has been mapped.
		2098
		2099	=back
		2100
		2101
1798	=cut	2102	=cut
1799		2103
1800	1;	2104	1;
1801		2105
1802	=head1 AUTHOR	2106	=head1 AUTHOR

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.69 by root, Thu May 3 23:30:08 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.69 by root, Thu May 3 23:30:08 2012 UTC