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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.24 by root, Sun Nov 20 22:31:48 2011 UTC vs.
Revision 1.47 by root, Sat Apr 21 19:48: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->program_with_source ($src);
163 163
164 # build croaks on compile errors, so catch it and print the compile errors 164 # build croaks on compile errors, so catch it and print the compile errors
165 eval { $prog->build ($dev); 1 } 165 eval { $prog->build ($dev, "-cl-fast-relaxed-math"); 1 }
166 or die $prog->build_log; 166 or die $prog->build_log;
167 167
168 my $kernel = $prog->kernel ("squareit"); 168 my $kernel = $prog->kernel ("squareit");
169 169
170=head2 Create some input and output float buffers, then call the 170=head2 Create some input and output float buffers, then call the
… …
210 # enqueue an async read 210 # enqueue an async read
211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); 211 $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev);
212 212
213 # wait for the last event to complete 213 # wait for the last event to complete
214 $ev->wait; 214 $ev->wait;
215
216=head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia
217set tunnel effect.
218
219This is quite a long example to get you going.
220
221 use OpenGL ":all";
222 use OpenCL;
223
224 # open a window and create a gl texture
225 OpenGL::glpOpenWindow width => 256, height => 256;
226 my $texid = glGenTextures_p 1;
227 glBindTexture GL_TEXTURE_2D, $texid;
228 glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0;
229
230 # find and use the first opencl device that let's us get a shared opengl context
231 my $platform;
232 my $dev;
233 my $ctx;
234
235 for (OpenCL::platforms) {
236 $platform = $_;
237 for ($platform->devices) {
238 $dev = $_;
239 $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev])
240 and last;
241 }
242 }
243
244 $ctx
245 or die "cannot find suitable OpenCL device\n";
246
247 my $queue = $ctx->queue ($dev);
248
249 # now attach an opencl image2d object to the opengl texture
250 my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid);
251
252 # now the boring opencl code
253 my $src = <<EOF;
254 kernel void
255 juliatunnel (write_only image2d_t img, float time)
256 {
257 float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f;
258
259 float2 m = (float2)(1.f, p.y) / fabs (p.x);
260 m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f;
261
262 float2 z = m;
263 float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001));
264
265 for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i)
266 z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c;
267
268 float3 colour = (float3)(z.x, z.y, z.x * z.y);
269 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
270 }
271 EOF
272 my $prog = $ctx->program_with_source ($src);
273 eval { $prog->build ($dev); 1 }
274 or die $prog->build_log ($dev);
275
276 my $kernel = $prog->kernel ("juliatunnel");
277
278 # program compiled, kernel ready, now draw and loop
279
280 for (my $time; ; ++$time) {
281 # acquire objects from opengl
282 $queue->enqueue_acquire_gl_objects ([$tex]);
283
284 # configure and run our kernel
285 $kernel->set_image2d (0, $tex);
286 $kernel->set_float (1, $time);
287 $queue->enqueue_nd_range_kernel ($kernel, undef, [256, 256], undef);
288
289 # release objects to opengl again
290 $queue->enqueue_release_gl_objects ([$tex]);
291
292 # wait
293 $queue->finish;
294
295 # now draw the texture, the defaults should be all right
296 glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
297
298 glEnable GL_TEXTURE_2D;
299 glBegin GL_QUADS;
300 glTexCoord2f 0, 1; glVertex3i -1, -1, -1;
301 glTexCoord2f 0, 0; glVertex3i 1, -1, -1;
302 glTexCoord2f 1, 0; glVertex3i 1, 1, -1;
303 glTexCoord2f 1, 1; glVertex3i -1, 1, -1;
304 glEnd;
305
306 glXSwapBuffers;
307
308 select undef, undef, undef, 1/60;
309 }
215 310
216=head1 DOCUMENTATION 311=head1 DOCUMENTATION
217 312
218=head2 BASIC CONVENTIONS 313=head2 BASIC CONVENTIONS
219 314
… …
241=item * Structures are often specified by flattening out their components 336=item * Structures are often specified by flattening out their components
242as with short vectors, and returned as arrayrefs. 337as with short vectors, and returned as arrayrefs.
243 338
244=item * When enqueuing commands, the wait list is specified by adding 339=item * When enqueuing commands, the wait list is specified by adding
245extra arguments to the function - anywhere a C<$wait_events...> argument 340extra arguments to the function - anywhere a C<$wait_events...> argument
246is documented this can be any number of event objects. 341is documented this can be any number of event objects. As an extsnion
342implemented by this module, C<undef> values will be ignored in the event
343list.
247 344
248=item * When enqueuing commands, if the enqueue method is called in void 345=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 346context, no event is created. In all other contexts an event is returned
250by the method. 347by the method.
251 348
… …
271 ulong IV - Q 368 ulong IV - Q
272 float NV float f 369 float NV float f
273 half IV ushort S 370 half IV ushort S
274 double NV double d 371 double NV double d
275 372
373=head2 GLX SUPPORT
374
375Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
376module, which has little to no documentation and has little to no support
377for glX), this module, as a special extension, treats context creation
378properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
379specially: If either or both of these are C<undef>, then the OpenCL
380module tries to dynamically resolve C<glXGetCurrentDisplay> and
381C<glXGetCurrentContext>, call these functions and use their return values
382instead.
383
384For this to work, the OpenGL library must be loaded, a GLX context must
385have been created and be made current, and C<dlsym> must be available and
386capable of finding the function via C<RTLD_DEFAULT>.
387
276=head2 THE OpenCL PACKAGE 388=head2 THE OpenCL PACKAGE
277 389
278=over 4 390=over 4
279 391
280=item $int = OpenCL::errno 392=item $int = OpenCL::errno
… …
286 398
287Comverts an error value into a human readable string. 399Comverts an error value into a human readable string.
288 400
289=item $str = OpenCL::enum2str $enum 401=item $str = OpenCL::enum2str $enum
290 402
291Converts most enum values (inof parameter names, image format constants, 403Converts most enum values (of parameter names, image format constants,
292object types, addressing and filter modes, command types etc.) into a 404object types, addressing and filter modes, command types etc.) into a
293human readbale string. When confronted with some random integer it can be 405human readable string. When confronted with some random integer it can be
294very helpful to pass it through this function to maybe get some readable 406very helpful to pass it through this function to maybe get some readable
295string out of it. 407string out of it.
296 408
297=item @platforms = OpenCL::platforms 409=item @platforms = OpenCL::platforms
298 410
… …
326 438
327Tries to create a context. Never worked for me, and you need devices explicitly anyway. 439Tries to create a context. Never worked for me, and you need devices explicitly anyway.
328 440
329L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 441L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
330 442
331=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) 443=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
332 444
333Create a new OpenCL::Context object using the given device object(s)- a 445Create a new OpenCL::Context object using the given device object(s)- a
334CL_CONTEXT_PLATFORM property is supplied automatically. 446CL_CONTEXT_PLATFORM property is supplied automatically.
335 447
336L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 448L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
… …
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
… …
660 772
661Create a new OpenCL::Queue object from the context and the given device. 773Create a new OpenCL::Queue object from the context and the given device.
662 774
663L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 775L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
664 776
777Example: create an out-of-order queue.
778
779 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
780
665=item $ev = $ctx->user_event 781=item $ev = $ctx->user_event
666 782
667Creates a new OpenCL::UserEvent object. 783Creates a new OpenCL::UserEvent object.
668 784
669L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 785L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
670 786
671=item $buf = $ctx->buffer ($flags, $len) 787=item $buf = $ctx->buffer ($flags, $len)
672 788
673Creates a new OpenCL::Buffer object with the given flags and octet-size. 789Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
790given flags and octet-size.
674 791
675L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 792L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
676 793
677=item $buf = $ctx->buffer_sv ($flags, $data) 794=item $buf = $ctx->buffer_sv ($flags, $data)
678 795
679Creates a new OpenCL::Buffer object and initialise it with the given data values. 796Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
797initialise it with the given data values.
680 798
681=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 799=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
682 800
683Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 801Creates a new OpenCL::Image2D object and optionally initialises it with
802the given data values.
684 803
685L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
686 805
687=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) 806=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
688 807
689Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 808Creates a new OpenCL::Image3D object and optionally initialises it with
809the given data values.
690 810
691L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 811L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
812
813=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
814
815Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
816OpenGL buffer object.
817
818http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
819
820=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
821
822Creates a new OpenCL::Image object that refers to the given OpenGL
823texture object or buffer.
824
825http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
826
827=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
828
829Creates a new OpenCL::Image2D object that refers to the given OpenGL
8302D texture object.
831
832http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
833
834=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
835
836Creates a new OpenCL::Image3D object that refers to the given OpenGL
8373D texture object.
838
839http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
840
841=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
842
843Creates a new OpenCL::Image2D object that refers to the given OpenGL
844render buffer.
845
846http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
692 847
693=item @formats = $ctx->supported_image_formats ($flags, $image_type) 848=item @formats = $ctx->supported_image_formats ($flags, $image_type)
694 849
695Returns a list of matching image formats - each format is an arrayref with 850Returns a list of matching image formats - each format is an arrayref with
696two values, $channel_order and $channel_type, in it. 851two values, $channel_order and $channel_type, in it.
… …
747for completion, unless the method is called in void context, in which case 902for completion, unless the method is called in void context, in which case
748no event object is created. 903no event object is created.
749 904
750They also allow you to specify any number of other event objects that this 905They 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 906request has to wait for before it starts executing, by simply passing the
752event objects as extra parameters to the enqueue methods. 907event objects as extra parameters to the enqueue methods. To simplify
908program design, this module ignores any C<undef> values in the list of
909events. This makes it possible to code operations such as this, without
910having to put a valid event object into C<$event> first:
911
912 $event = $queue->enqueue_xxx (..., $event);
753 913
754Queues execute in-order by default, without any parallelism, so in most 914Queues 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 915cases (i.e. you use only one queue) it's not necessary to wait for or
756create event objects. 916create event objects, althoguh an our of order queue is often a bit
917faster.
757 918
758=over 4 919=over 4
759 920
760=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 921=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
761 922
… …
771 932
772=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 933=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
773 934
774L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 935L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
775 936
937=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...)
938
939http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
940
941=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...)
942
943http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
944
776=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 945=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
777 946
947L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
948
949=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...)
950
778L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 951L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
779 952
780=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 953=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
781 954
782L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 955L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
783 956
957=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...)
958
959L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
960
961=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...)
962
963L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
964
784=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...) 965=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...)
785 966
786Yeah. 967Yeah.
787 968
788L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
789
790=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...)
791
792L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 969L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
793
794=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...)
795
796L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
797
798=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...)
799
800L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
801 970
802=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 971=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
803 972
804L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 973L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
805 974
… …
819reference to an array of local work sizes, with the same number of 988reference to an array of local work sizes, with the same number of
820elements as @$global_work_size. 989elements as @$global_work_size.
821 990
822L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 991L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
823 992
824=item $ev = $queue->enqueue_marker 993=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
825 994
995Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
996for subsequent OpenCL usage.
997
826L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 998L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
999
1000=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
1001
1002Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
1003for subsequent OpenGL usage.
1004
1005L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
827 1006
828=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1007=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
829 1008
830L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1009L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
831 1010
832=item $queue->enqueue_barrier 1011=item $ev = $queue->enqueue_marker ($wait_events...)
833 1012
1013L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1014
1015=item $ev = $queue->enqueue_barrier ($wait_events...)
1016
834L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1017L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
835 1018
836=item $queue->flush 1019=item $queue->flush
837 1020
838L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1021L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
839 1022
… …
920 1103
921Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. 1104Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
922 1105
923=for gengetinfo end mem 1106=for gengetinfo end mem
924 1107
1108=item ($type, $name) = $mem->gl_object_info
1109
1110Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1111object "name" (e.g. the texture name) used to create this memory object.
1112
1113L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1114
925=back 1115=back
926 1116
1117=head2 THE OpenCL::Buffer CLASS
1118
1119This is a subclass of OpenCL::Memory, and the superclass of
1120OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1121and sub-buffers.
1122
1123=head2 THE OpenCL::BufferObj CLASS
1124
1125This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1126because one cna create sub buffers of OpenLC::BufferObj objects, but not
1127sub buffers from these sub buffers.
1128
1129=over 4
1130
1131=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1132
1133Creates an OpenCL::Buffer objects from this buffer and returns it. The
1134C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1135
1136L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1137
1138=back
1139
927=head2 THE OpenCL::Image CLASS 1140=head2 THE OpenCL::Image CLASS
928 1141
929This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1142This is the superclass of all image objects - OpenCL::Image1D,
1143OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1144OpenCL::Image2DArray and OpenCL::Image3D.
930 1145
931=over 4 1146=over 4
932 1147
933=item $packed_value = $ev->image_info ($name) 1148=item $packed_value = $ev->image_info ($name)
934 1149
… …
964=item $int = $image->depth 1179=item $int = $image->depth
965 1180
966Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. 1181Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
967 1182
968=for gengetinfo end image 1183=for gengetinfo end image
1184
1185=for gengetinfo begin gl_texture
1186
1187=item $GLenum = $gl_texture->target
1188
1189Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1190
1191=item $GLint = $gl_texture->gl_mipmap_level
1192
1193Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1194
1195=for gengetinfo end gl_texture
969 1196
970=back 1197=back
971 1198
972=head2 THE OpenCL::Sampler CLASS 1199=head2 THE OpenCL::Sampler CLASS
973 1200
… …
1163 1390
1164This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1391This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
1165 1392
1166TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1393TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
1167C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1394C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
1168C<image2d>, C<image3d>, C<sampler> or C<event>. 1395C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
1169 1396
1170Chars and integers (including the half type) are specified as integers, 1397Chars and integers (including the half type) are specified as integers,
1171float and double as floating point values, memory/buffer/image2d/image3d 1398float and double as floating point values, memory/buffer/image2d/image3d
1172must be an object of that type or C<undef>, and sampler and event must be 1399must be an object of that type or C<undef>, local-memory arguments are
1173objects of that type. 1400set by specifying the size, and sampler and event must be objects of that
1401type.
1174 1402
1175L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1176 1404
1177=back 1405=back
1178 1406
… …
1267package OpenCL; 1495package OpenCL;
1268 1496
1269use common::sense; 1497use common::sense;
1270 1498
1271BEGIN { 1499BEGIN {
1272 our $VERSION = '0.55'; 1500 our $VERSION = '0.96';
1273 1501
1274 require XSLoader; 1502 require XSLoader;
1275 XSLoader::load (__PACKAGE__, $VERSION); 1503 XSLoader::load (__PACKAGE__, $VERSION);
1276 1504
1277 @OpenCL::Buffer::ISA = 1505 @OpenCL::Buffer::ISA =
1278 @OpenCL::Image::ISA = OpenCL::Memory::; 1506 @OpenCL::Image::ISA = OpenCL::Memory::;
1279 1507
1508 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1509
1280 @OpenCL::Image2D::ISA = 1510 @OpenCL::Image2D::ISA =
1511 @OpenCL::Image3D::ISA =
1512 @OpenCL::Image2DArray::ISA =
1513 @OpenCL::Image1D::ISA =
1514 @OpenCL::Image1DArray::ISA =
1281 @OpenCL::Image3D::ISA = OpenCL::Image::; 1515 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
1282 1516
1283 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1517 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1284} 1518}
1285 1519
12861; 15201;
1287 1521
1288=head1 AUTHOR 1522=head1 AUTHOR

Diff Legend

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