ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/OpenCL/OpenCL.pm
(Generate patch)

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.25 by root, Tue Nov 22 10:39:47 2011 UTC vs.
Revision 1.51 by root, Tue Apr 24 13:45:58 2012 UTC

… …
105 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
106 printf "platform: %s\n", $platform->name; 106 printf "platform: %s\n", $platform->name;
107 printf "extensions: %s\n", $platform->extensions; 107 printf "extensions: %s\n", $platform->extensions;
108 for my $device ($platform->devices) { 108 for my $device ($platform->devices) {
109 printf "+ device: %s\n", $device->name; 109 printf "+ device: %s\n", $device->name;
110 my $ctx = $device->context; 110 my $ctx = $platform->context (undef, [$device]);
111 # do stuff 111 # do stuff
112 } 112 }
113 } 113 }
114 114
115=head2 Get a useful context and a command queue. 115=head2 Get a useful context and a command queue.
… …
149 149
150=head2 Create and build a program, then create a kernel out of one of its 150=head2 Create and build a program, then create a kernel out of one of its
151functions. 151functions.
152 152
153 my $src = ' 153 my $src = '
154 __kernel void 154 kernel void
155 squareit (__global float *input, __global float *output) 155 squareit (global float *input, global float *output)
156 { 156 {
157 $id = get_global_id (0); 157 $id = get_global_id (0);
158 output [id] = input [id] * input [id]; 158 output [id] = input [id] * input [id];
159 } 159 }
160 '; 160 ';
161 161
162 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->build_program ($src);
163
164 # build croaks on compile errors, so catch it and print the compile errors
165 eval { $prog->build ($dev); 1 }
166 or die $prog->build_log;
167
168 my $kernel = $prog->kernel ("squareit"); 163 my $kernel = $prog->kernel ("squareit");
169 164
170=head2 Create some input and output float buffers, then call the 165=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them. 166'squareit' kernel on them.
172 167
… …
210 # enqueue an async read 205 # enqueue an async read
211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 206 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212 207
213 # wait for the last event to complete 208 # wait for the last event to complete
214 $ev->wait; 209 $ev->wait;
210
211=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
212set tunnel effect.
213
214This is quite a long example to get you going.
215
216 use OpenGL ":all";
217 use OpenCL;
218
219 # open a window and create a gl texture
220 OpenGL::glpOpenWindow width => 256, height => 256;
221 my $texid = glGenTextures_p 1;
222 glBindTexture GL_TEXTURE_2D, $texid;
223 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
224
225 # find and use the first opencl device that let's us get a shared opengl context
226 my $platform;
227 my $dev;
228 my $ctx;
229
230 for (OpenCL::platforms) {
231 $platform = $_;
232 for ($platform->devices) {
233 $dev = $_;
234 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
235 and last;
236 }
237 }
238
239 $ctx
240 or die "cannot find suitable OpenCL device\n";
241
242 my $queue = $ctx->queue ($dev);
243
244 # now attach an opencl image2d object to the opengl texture
245 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
246
247 # now the boring opencl code
248 my $src = <<EOF;
249 kernel void
250 juliatunnel (write_only image2d_t img, float time)
251 {
252 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
253
254 float2 m = (float2)(1.f, p.y) / fabs (p.x);
255 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
256
257 float2 z = m;
258 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
259
260 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
261 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
262
263 float3 colour = (float3)(z.x, z.y, z.x * z.y);
264 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
265 }
266 EOF
267
268 my $prog = $ctx->build_program ($src);
269 my $kernel = $prog->kernel ("juliatunnel");
270
271 # program compiled, kernel ready, now draw and loop
272
273 for (my $time; ; ++$time) {
274 # acquire objects from opengl
275 $queue->enqueue_acquire_gl_objects ([$tex]);
276
277 # configure and run our kernel
278 $kernel->set_image2d (0, $tex);
279 $kernel->set_float (1, $time);
280 $queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
281
282 # release objects to opengl again
283 $queue->enqueue_release_gl_objects ([$tex]);
284
285 # wait
286 $queue->finish;
287
288 # now draw the texture, the defaults should be all right
289 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
290
291 glEnable GL_TEXTURE_2D;
292 glBegin GL_QUADS;
293 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
294 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
295 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
296 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
297 glEnd;
298
299 glXSwapBuffers;
300
301 select undef, undef, undef, 1/60;
302 }
215 303
216=head1 DOCUMENTATION 304=head1 DOCUMENTATION
217 305
218=head2 BASIC CONVENTIONS 306=head2 BASIC CONVENTIONS
219 307
… …
241=item * Structures are often specified by flattening out their components 329=item * Structures are often specified by flattening out their components
242as with short vectors, and returned as arrayrefs. 330as with short vectors, and returned as arrayrefs.
243 331
244=item * When enqueuing commands, the wait list is specified by adding 332=item * When enqueuing commands, the wait list is specified by adding
245extra arguments to the function - anywhere a C<$wait_events...> argument 333extra arguments to the function - anywhere a C<$wait_events...> argument
246is documented this can be any number of event objects. 334is documented this can be any number of event objects. As an extsnion
335implemented by this module, C<undef> values will be ignored in the event
336list.
247 337
248=item * When enqueuing commands, if the enqueue method is called in void 338=item * When enqueuing commands, if the enqueue method is called in void
249context, no event is created. In all other contexts an event is returned 339context, no event is created. In all other contexts an event is returned
250by the method. 340by the method.
251 341
… …
271 ulong IV - Q 361 ulong IV - Q
272 float NV float f 362 float NV float f
273 half IV ushort S 363 half IV ushort S
274 double NV double d 364 double NV double d
275 365
366=head2 GLX SUPPORT
367
368Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
369module, which has little to no documentation and has little to no support
370for glX), this module, as a special extension, treats context creation
371properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
372specially: If either or both of these are C<undef>, then the OpenCL
373module tries to dynamically resolve C<glXGetCurrentDisplay> and
374C<glXGetCurrentContext>, call these functions and use their return values
375instead.
376
377For this to work, the OpenGL library must be loaded, a GLX context must
378have been created and be made current, and C<dlsym> must be available and
379capable of finding the function via C<RTLD_DEFAULT>.
380
276=head2 THE OpenCL PACKAGE 381=head2 THE OpenCL PACKAGE
277 382
278=over 4 383=over 4
279 384
280=item $int = OpenCL::errno 385=item $int = OpenCL::errno
… …
286 391
287Comverts an error value into a human readable string. 392Comverts an error value into a human readable string.
288 393
289=item $str = OpenCL::enum2str $enum 394=item $str = OpenCL::enum2str $enum
290 395
291Converts most enum values (inof parameter names, image format constants, 396Converts most enum values (of parameter names, image format constants,
292object types, addressing and filter modes, command types etc.) into a 397object types, addressing and filter modes, command types etc.) into a
293human readbale string. When confronted with some random integer it can be 398human readable string. When confronted with some random integer it can be
294very helpful to pass it through this function to maybe get some readable 399very helpful to pass it through this function to maybe get some readable
295string out of it. 400string out of it.
296 401
297=item @platforms = OpenCL::platforms 402=item @platforms = OpenCL::platforms
298 403
… …
326 431
327Tries to create a context. Never worked for me, and you need devices explicitly anyway. 432Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 433
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 434L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 435
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 436=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
332 437
333Create a new OpenCL::Context object using the given device object(s)- a 438Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 439CL_CONTEXT_PLATFORM property is supplied automatically.
335 440
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 441L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
… …
344It's best to avoid this method and use one of the following convenience 449It's best to avoid this method and use one of the following convenience
345wrappers. 450wrappers.
346 451
347L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 452L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
348 453
454=item $platform->unload_compiler
455
456Attempts to unload the compiler for this platform, for endless
457profit. Does nothing on OpenCL 1.1.
458
459L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
460
349=for gengetinfo begin platform 461=for gengetinfo begin platform
350 462
351=item $string = $platform->profile 463=item $string = $platform->profile
352 464
353Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 465Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
… …
638 750
639=item @device_partition_property_exts = $device->affinity_domains_ext 751=item @device_partition_property_exts = $device->affinity_domains_ext
640 752
641Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 753Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
642 754
643=item $uint = $device->reference_count_ext 755=item $uint = $device->reference_count_ext
644 756
645Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result. 757Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
646 758
647=item @device_partition_property_exts = $device->partition_style_ext 759=item @device_partition_property_exts = $device->partition_style_ext
648 760
649Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 761Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
650 762
… …
654 766
655=head2 THE OpenCL::Context CLASS 767=head2 THE OpenCL::Context CLASS
656 768
657=over 4 769=over 4
658 770
771=item $prog = $ctx->build_program ($program, $options = "")
772
773This convenience function tries to build the program on all devices in
774the context. If the build fails, then the function will C<croak> with the
775build log. Otherwise ti returns the program object.
776
777The C<$program> can either be a C<OpenCL::Program> object or a string
778containing the program. In the latter case, a program objetc will be
779created automatically.
780
781=cut
782
783sub OpenCL::Context::build_program {
784 my ($self, $prog, $options) = @_;
785
786 $prog = $self->program_with_source ($prog)
787 unless ref $prog;
788
789 for my $dev ($self->devices) {
790 eval { $prog->build ($dev, $options); 1 }
791 or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
792 . $prog->build_log ($dev);
793 }
794
795 $prog
796}
797
659=item $queue = $ctx->queue ($device, $properties) 798=item $queue = $ctx->queue ($device, $properties)
660 799
661Create a new OpenCL::Queue object from the context and the given device. 800Create a new OpenCL::Queue object from the context and the given device.
662 801
663L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 802L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
664 803
804Example: create an out-of-order queue.
805
806 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
807
665=item $ev = $ctx->user_event 808=item $ev = $ctx->user_event
666 809
667Creates a new OpenCL::UserEvent object. 810Creates a new OpenCL::UserEvent object.
668 811
669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 812L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
670 813
671=item $buf = $ctx->buffer ($flags, $len) 814=item $buf = $ctx->buffer ($flags, $len)
672 815
673Creates a new OpenCL::Buffer object with the given flags and octet-size. 816Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
817given flags and octet-size.
674 818
675L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 819L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
676 820
677=item $buf = $ctx->buffer_sv ($flags, $data) 821=item $buf = $ctx->buffer_sv ($flags, $data)
678 822
679Creates a new OpenCL::Buffer object and initialise it with the given data values. 823Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
824initialise it with the given data values.
825
826=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)
827
828Creates a new OpenCL::Image object and optionally initialises it with
829the given data values.
830
831L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
680 832
681=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 833=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
682 834
683Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 835Creates a new OpenCL::Image2D object and optionally initialises it with
836the given data values.
684 837
685L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 838L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
686 839
687=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 840=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
688 841
689Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 842Creates a new OpenCL::Image3D object and optionally initialises it with
843the given data values.
690 844
691L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 845L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
846
847=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
848
849Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
850OpenGL buffer object.
851
852http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
853
854=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
855
856Creates a new OpenCL::Image object that refers to the given OpenGL
857texture object or buffer.
858
859http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
860
861=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
862
863Creates a new OpenCL::Image2D object that refers to the given OpenGL
8642D texture object.
865
866http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
867
868=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
869
870Creates a new OpenCL::Image3D object that refers to the given OpenGL
8713D texture object.
872
873http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
874
875=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
876
877Creates a new OpenCL::Image2D object that refers to the given OpenGL
878render buffer.
879
880http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
692 881
693=item @formats = $ctx->supported_image_formats ($flags, $image_type) 882=item @formats = $ctx->supported_image_formats ($flags, $image_type)
694 883
695Returns a list of matching image formats - each format is an arrayref with 884Returns a list of matching image formats - each format is an arrayref with
696two values, $channel_order and $channel_type, in it. 885two values, $channel_order and $channel_type, in it.
… …
747for completion, unless the method is called in void context, in which case 936for completion, unless the method is called in void context, in which case
748no event object is created. 937no event object is created.
749 938
750They also allow you to specify any number of other event objects that this 939They also allow you to specify any number of other event objects that this
751request has to wait for before it starts executing, by simply passing the 940request has to wait for before it starts executing, by simply passing the
752event objects as extra parameters to the enqueue methods. 941event objects as extra parameters to the enqueue methods. To simplify
942program design, this module ignores any C<undef> values in the list of
943events. This makes it possible to code operations such as this, without
944having to put a valid event object into C<$event> first:
945
946 $event = $queue->enqueue_xxx (..., $event);
753 947
754Queues execute in-order by default, without any parallelism, so in most 948Queues execute in-order by default, without any parallelism, so in most
755cases (i.e. you use only one queue) it's not necessary to wait for or 949cases (i.e. you use only one queue) it's not necessary to wait for or
756create event objects. 950create event objects, althoguh an our of order queue is often a bit
951faster.
757 952
758=over 4 953=over 4
759 954
760=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 955=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
761 956
… …
781 976
782http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html 977http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
783 978
784=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 979=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
785 980
981L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
982
983=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...)
984
786L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 985L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
787 986
788=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 987=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
789 988
790L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 989L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
791 990
991=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...)
992
993L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
994
995=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...)
996
997L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
998
792=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...) 999=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...)
793 1000
794Yeah. 1001Yeah.
795 1002
796L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
797
798=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...)
799
800L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1003L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
801
802=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...)
803
804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
805
806=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...)
807
808L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
809 1004
810=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1005=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
811 1006
812L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1007L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
813 1008
… …
827reference to an array of local work sizes, with the same number of 1022reference to an array of local work sizes, with the same number of
828elements as @$global_work_size. 1023elements as @$global_work_size.
829 1024
830L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1025L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
831 1026
832=item $ev = $queue->enqueue_marker 1027=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
833 1028
1029Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
1030for subsequent OpenCL usage.
1031
834L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 1032L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
1033
1034=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1035
1036Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1037for subsequent OpenGL usage.
1038
1039L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
835 1040
836=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1041=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
837 1042
838L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1043L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
839 1044
840=item $queue->enqueue_barrier 1045=item $ev = $queue->enqueue_marker ($wait_events...)
841 1046
1047L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1048
1049=item $ev = $queue->enqueue_barrier ($wait_events...)
1050
842L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1051L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
843 1052
844=item $queue->flush 1053=item $queue->flush
845 1054
846L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1055L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
847 1056
… …
928 1137
929Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1138Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
930 1139
931=for gengetinfo end mem 1140=for gengetinfo end mem
932 1141
1142=item ($type, $name) = $mem->gl_object_info
1143
1144Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1145object "name" (e.g. the texture name) used to create this memory object.
1146
1147L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1148
933=back 1149=back
934 1150
1151=head2 THE OpenCL::Buffer CLASS
1152
1153This is a subclass of OpenCL::Memory, and the superclass of
1154OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1155and sub-buffers.
1156
1157=head2 THE OpenCL::BufferObj CLASS
1158
1159This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1160because one cna create sub buffers of OpenLC::BufferObj objects, but not
1161sub buffers from these sub buffers.
1162
1163=over 4
1164
1165=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1166
1167Creates an OpenCL::Buffer objects from this buffer and returns it. The
1168C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1169
1170L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1171
1172=back
1173
935=head2 THE OpenCL::Image CLASS 1174=head2 THE OpenCL::Image CLASS
936 1175
937This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1176This is the superclass of all image objects - OpenCL::Image1D,
1177OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1178OpenCL::Image2DArray and OpenCL::Image3D.
938 1179
939=over 4 1180=over 4
940 1181
941=item $packed_value = $ev->image_info ($name) 1182=item $packed_value = $ev->image_info ($name)
942 1183
… …
973 1214
974Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1215Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
975 1216
976=for gengetinfo end image 1217=for gengetinfo end image
977 1218
1219=for gengetinfo begin gl_texture
1220
1221=item $GLenum = $gl_texture->target
1222
1223Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1224
1225=item $GLint = $gl_texture->gl_mipmap_level
1226
1227Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1228
1229=for gengetinfo end gl_texture
1230
978=back 1231=back
979 1232
980=head2 THE OpenCL::Sampler CLASS 1233=head2 THE OpenCL::Sampler CLASS
981 1234
982=over 4 1235=over 4
… …
1017 1270
1018=over 4 1271=over 4
1019 1272
1020=item $program->build ($device, $options = "") 1273=item $program->build ($device, $options = "")
1021 1274
1022Tries to build the program with the givne options. 1275Tries to build the program with the given options. See also the
1276C<$ctx->build> convenience function.
1023 1277
1024L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1278L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1025 1279
1026=item $packed_value = $program->build_info ($device, $name) 1280=item $packed_value = $program->build_info ($device, $name)
1027 1281
… …
1034 1288
1035Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1289Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1036the program. 1290the program.
1037 1291
1038L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1292L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1293
1294=item @kernels = $program->kernels_in_program
1295
1296Returns all kernels successfully compiled for all devices in program.
1297
1298http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1039 1299
1040=for gengetinfo begin program_build 1300=for gengetinfo begin program_build
1041 1301
1042=item $build_status = $program->build_status ($device) 1302=item $build_status = $program->build_status ($device)
1043 1303
… …
1171 1431
1172This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1432This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1173 1433
1174TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1434TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1175C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1435C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1176C<image2d>, C<image3d>, C<sampler> or C<event>. 1436C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1177 1437
1178Chars and integers (including the half type) are specified as integers, 1438Chars and integers (including the half type) are specified as integers,
1179float and double as floating point values, memory/buffer/image2d/image3d 1439float and double as floating point values, memory/buffer/image2d/image3d
1180must be an object of that type or C<undef>, and sampler and event must be 1440must be an object of that type or C<undef>, local-memory arguments are
1181objects of that type. 1441set by specifying the size, and sampler and event must be objects of that
1442type.
1443
1444Setting an argument for a kernel does NOT keep a reference to the object -
1445for example, if you set an argument to some image object, free the image,
1446and call the kernel, you will run into undefined behaviour.
1182 1447
1183L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1448L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1184 1449
1185=back 1450=back
1186 1451
… …
1275package OpenCL; 1540package OpenCL;
1276 1541
1277use common::sense; 1542use common::sense;
1278 1543
1279BEGIN { 1544BEGIN {
1280 our $VERSION = '0.55'; 1545 our $VERSION = '0.96';
1281 1546
1282 require XSLoader; 1547 require XSLoader;
1283 XSLoader::load (__PACKAGE__, $VERSION); 1548 XSLoader::load (__PACKAGE__, $VERSION);
1284 1549
1285 @OpenCL::Buffer::ISA = 1550 @OpenCL::Buffer::ISA =
1286 @OpenCL::Image::ISA = OpenCL::Memory::; 1551 @OpenCL::Image::ISA = OpenCL::Memory::;
1287 1552
1553 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1554
1288 @OpenCL::Image2D::ISA = 1555 @OpenCL::Image2D::ISA =
1556 @OpenCL::Image3D::ISA =
1557 @OpenCL::Image2DArray::ISA =
1558 @OpenCL::Image1D::ISA =
1559 @OpenCL::Image1DArray::ISA =
1289 @OpenCL::Image3D::ISA = OpenCL::Image::; 1560 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
1290 1561
1291 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1562 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1292} 1563}
1293 1564
12941; 15651;
1295 1566
1296=head1 AUTHOR 1567=head1 AUTHOR

Diff Legend

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