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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.10 by root, Thu Nov 17 02:10:39 2011 UTC vs.
Revision 1.43 by root, Fri Apr 20 20:24:20 2012 UTC

18vendors) - usually there is only one. 18vendors) - usually there is only one.
19 19
20Each platform gives you access to a number of OpenCL::Device objects, e.g. 20Each platform gives you access to a number of OpenCL::Device objects, e.g.
21your graphics card. 21your graphics card.
22 22
23From a platform and some devices, you create an OpenCL::Context, which is 23From a platform and some device(s), you create an OpenCL::Context, which is
24a very central object in OpenCL: Once you have a context you can create 24a very central object in OpenCL: Once you have a context you can create
25most other objects: 25most other objects:
26 26
27OpenCL::Program objects, which store source code and, after building 27OpenCL::Program objects, which store source code and, after building for a
28("compiling and linking"), also binary programs. For each kernel function 28specific device ("compiling and linking"), also binary programs. For each
29in a program you can then create an OpenCL::Kernel object which represents 29kernel function in a program you can then create an OpenCL::Kernel object
30basically a function call with argument values. 30which represents basically a function call with argument values.
31 31
32OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat 32OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat
33memory areas, think array) and OpenCL::Image objects (think 2d or 3d 33memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34array) for bulk data and input and output for kernels. 34or 3d array) for bulk data and input and output for kernels.
35 35
36OpenCL::Sampler objects, which are kind of like texture filter modes in 36OpenCL::Sampler objects, which are kind of like texture filter modes in
37OpenGL. 37OpenGL.
38 38
39OpenCL::Queue objects - command queues, which allow you to submit memory 39OpenCL::Queue objects - command queues, which allow you to submit memory
52 52
53OpenCL manpages: 53OpenCL manpages:
54 54
55 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ 55 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
56 56
57If you are into UML class diagrams, the following diagram might help - if
58not, it will be mildly cobfusing:
59
60 http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html
61
62Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
63is, but at least it's free of charge:
64
65 http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
66
67And here's NVIDIA's OpenCL Best Practises Guide:
68
69 http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
70
57=head1 BASIC WORKFLOW 71=head1 BASIC WORKFLOW
58 72
59To get something done, you basically have to do this once: 73To get something done, you basically have to do this once (refer to the
74examples below for actual code, this is just a high-level description):
60 75
61Find some platform (e.g. the first one) and some device (e.g. the first 76Find some platform (e.g. the first one) and some device(s) (e.g. the first
62device you can find), and create a context from those. 77device of the platform), and create a context from those.
63 78
64Create a command queue from your context, and program objects from your 79Create program objects from your OpenCL source code, then build (compile)
65OpenCL source code, build the programs. 80the programs for each device you want to run them on.
66 81
67Create kernel objects for all kernels you want to use. 82Create kernel objects for all kernels you want to use (surprisingly, these
83are not device-specific).
68 84
69Then, to execute stuff, you repeat this: 85Then, to execute stuff, you repeat these steps, possibly resuing or
86sharing some buffers:
70 87
71Create some input and output buffers from your context. Initialise the 88Create some input and output buffers from your context. Set these as
72input buffers with data. Set these as arguments to your kernel. 89arguments to your kernel.
90
91Enqueue buffer writes to initialise your input buffers (when not
92initialised at creation time).
73 93
74Enqueue the kernel execution. 94Enqueue the kernel execution.
75 95
76Enqueue buffer reads for your output buffer to read results. 96Enqueue buffer reads for your output buffer to read results.
77 97
78The next section shows how this can be done.
79
80=head1 EXAMPLES 98=head1 EXAMPLES
81 99
82=head2 Enumerate all devices and get contexts for them. 100=head2 Enumerate all devices and get contexts for them.
83 101
102Best run this once to get a feel for the platforms and devices in your
103system.
104
84 for my $platform (OpenCL::platforms) { 105 for my $platform (OpenCL::platforms) {
85 printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); 106 printf "platform: %s\n", $platform->name;
86 printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); 107 printf "extensions: %s\n", $platform->extensions;
87 for my $device ($platform->devices) { 108 for my $device ($platform->devices) {
88 printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); 109 printf "+ device: %s\n", $device->name;
89 my $ctx = $device->context; 110 my $ctx = $platform->context (undef, [$device]);
90 # do stuff 111 # do stuff
91 } 112 }
92 } 113 }
93 114
94=head2 Get a useful context and a command queue. 115=head2 Get a useful context and a command queue.
95 116
96 my $dev = ((OpenCL::platforms)[0]->devices)[0]; 117This is a useful boilerplate for any OpenCL program that only wants to use
97 my $ctx = $dev->context; 118one device,
98 my $queue = $ctx->queue ($dev); 119
120 my ($platform) = OpenCL::platforms; # find first platform
121 my ($dev) = $platform->devices; # find first device of platform
122 my $ctx = $platform->context (undef, [$dev]); # create context out of those
123 my $queue = $ctx->queue ($dev); # create a command queue for the device
99 124
100=head2 Print all supported image formats of a context. 125=head2 Print all supported image formats of a context.
126
127Best run this once for your context, to see whats available and how to
128gather information.
101 129
102 for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) { 130 for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
103 print "supported image formats for ", OpenCL::enum2str $type, "\n"; 131 print "supported image formats for ", OpenCL::enum2str $type, "\n";
104 132
105 for my $f ($ctx->supported_image_formats (0, $type)) { 133 for my $f ($ctx->supported_image_formats (0, $type)) {
121 149
122=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
123functions. 151functions.
124 152
125 my $src = ' 153 my $src = '
126 __kernel void 154 kernel void
127 squareit (__global float *input, __global float *output) 155 squareit (global float *input, global float *output)
128 { 156 {
129 size_t id = get_global_id (0); 157 $id = get_global_id (0);
130 output [id] = input [id] * input [id]; 158 output [id] = input [id] * input [id];
131 } 159 }
132 '; 160 ';
133 161
134 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->program_with_source ($src);
135 163
136 eval { $prog->build ($dev); 1 } 164 # build croaks on compile errors, so catch it and print the compile errors
137 or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG); 165 eval { $prog->build ($dev, "-cl-fast-relaxed-math"); 1 }
166 or die $prog->build_log;
138 167
139 my $kernel = $prog->kernel ("squareit"); 168 my $kernel = $prog->kernel ("squareit");
140 169
141=head2 Create some input and output float buffers, then call squareit on them. 170=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them.
142 172
143 my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5); 173 my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);
144 my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5); 174 my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
145 175
146 # set buffer 176 # set buffer
181 $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);
182 212
183 # wait for the last event to complete 213 # wait for the last event to complete
184 $ev->wait; 214 $ev->wait;
185 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 }
310
186=head1 DOCUMENTATION 311=head1 DOCUMENTATION
187 312
188=head2 BASIC CONVENTIONS 313=head2 BASIC CONVENTIONS
189 314
190This is not a 1:1 C-style translation of OpenCL to Perl - instead I 315This is not a one-to-one C-style translation of OpenCL to Perl - instead
191attempted to make the interface as type-safe as possible and introducing 316I attempted to make the interface as type-safe as possible by introducing
192object syntax where it makes sense. There are a number of important 317object syntax where it makes sense. There are a number of important
193differences between the OpenCL C API and this module: 318differences between the OpenCL C API and this module:
194 319
195=over 4 320=over 4
196 321
197=item * Object lifetime managament is automatic - there is no need 322=item * Object lifetime managament is automatic - there is no need
198to free objects explicitly (C<clReleaseXXX>), the release function 323to free objects explicitly (C<clReleaseXXX>), the release function
199is called automatically once all Perl references to it go away. 324is called automatically once all Perl references to it go away.
200 325
201=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), 326=item * OpenCL uses CamelCase for function names
327(e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module
202while this module uses underscores as word separator and often leaves out 328uses underscores as word separator and often leaves out prefixes
203prefixes (C<< $platform->info >>). 329(C<OpenCL::platforms>, C<< $platform->info >>).
204 330
205=item * OpenCL often specifies fixed vector function arguments as short 331=item * OpenCL often specifies fixed vector function arguments as short
206arrays (C<size_t origin[3]>), while this module explicitly expects the 332arrays (C<size_t origin[3]>), while this module explicitly expects the
207components as separate arguments- 333components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
334function calls.
208 335
209=item * Where possible, one of the pitch values is calculated from the 336=item * Structures are often specified by flattening out their components
210perl scalar length and need not be specified. 337as with short vectors, and returned as arrayrefs.
211 338
212=item * When enqueuing commands, the wait list is specified by adding 339=item * When enqueuing commands, the wait list is specified by adding
213extra arguments to the function - anywhere a C<$wait_events...> argument 340extra arguments to the function - anywhere a C<$wait_events...> argument
214is documented this can be any number of event objects. 341is documented this can be any number of event objects.
215 342
239 ulong IV - Q 366 ulong IV - Q
240 float NV float f 367 float NV float f
241 half IV ushort S 368 half IV ushort S
242 double NV double d 369 double NV double d
243 370
371=head2 GLX SUPPORT
372
373Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL
374module, which has little to no documentation and has little to no support
375for glX), this module, as a special extension, treats context creation
376properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR>
377specially: If either or both of these are C<undef>, then the OpenCL
378module tries to dynamically resolve C<glXGetCurrentDisplay> and
379C<glXGetCurrentContext>, call these functions and use their return values
380instead.
381
382For this to work, the OpenGL library must be loaded, a GLX context must
383have been created and be made current, and C<dlsym> must be available and
384capable of finding the function via C<RTLD_DEFAULT>.
385
244=head2 THE OpenCL PACKAGE 386=head2 THE OpenCL PACKAGE
245 387
246=over 4 388=over 4
247 389
248=item $int = OpenCL::errno 390=item $int = OpenCL::errno
249 391
250The last error returned by a function - it's only changed on errors. 392The last error returned by a function - it's only valid after an error occured
393and before calling another OpenCL function.
251 394
252=item $str = OpenCL::err2str $errval 395=item $str = OpenCL::err2str $errval
253 396
254Comverts an error value into a human readable string. 397Comverts an error value into a human readable string.
255 398
256=item $str = OpenCL::enum2str $enum 399=item $str = OpenCL::enum2str $enum
257 400
258Converts most enum values (inof parameter names, image format constants, 401Converts most enum values (of parameter names, image format constants,
259object types, addressing and filter modes, command types etc.) into a 402object types, addressing and filter modes, command types etc.) into a
260human readbale string. When confronted with some random integer it can be 403human readable string. When confronted with some random integer it can be
261very helpful to pass it through this function to maybe get some readable 404very helpful to pass it through this function to maybe get some readable
262string out of it. 405string out of it.
263 406
264=item @platforms = OpenCL::platforms 407=item @platforms = OpenCL::platforms
265 408
283 426
284=head2 THE OpenCL::Platform CLASS 427=head2 THE OpenCL::Platform CLASS
285 428
286=over 4 429=over 4
287 430
431=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
432
433Returns a list of matching OpenCL::Device objects.
434
435=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
436
437Tries to create a context. Never worked for me, and you need devices explicitly anyway.
438
439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
440
441=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)
442
443Create a new OpenCL::Context object using the given device object(s)- a
444CL_CONTEXT_PLATFORM property is supplied automatically.
445
446L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
447
288=item $packed_value = $platform->info ($name) 448=item $packed_value = $platform->info ($name)
289 449
290Calls C<clGetPlatformInfo> and returns the packed, raw value - for 450Calls C<clGetPlatformInfo> and returns the packed, raw value - for
291strings, this will be the string, for other values you probably need to 451strings, this will be the string (possibly including terminating \0), for
292use the correct C<unpack>. This might get improved in the future. Hopefully. 452other values you probably need to use the correct C<unpack>.
453
454It's best to avoid this method and use one of the following convenience
455wrappers.
293 456
294L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 457L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
295 458
296=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 459=for gengetinfo begin platform
297 460
298Returns a list of matching OpenCL::Device objects. 461=item $string = $platform->profile
299 462
300=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) 463Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
301 464
302Tries to create a context. Never worked for me. 465=item $string = $platform->version
303 466
304L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> 467Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result.
468
469=item $string = $platform->name
470
471Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result.
472
473=item $string = $platform->vendor
474
475Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result.
476
477=item $string = $platform->extensions
478
479Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result.
480
481=for gengetinfo end platform
305 482
306=back 483=back
307 484
308=head2 THE OpenCL::Device CLASS 485=head2 THE OpenCL::Device CLASS
309 486
313 490
314See C<< $platform->info >> for details. 491See C<< $platform->info >> for details.
315 492
316L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> 493L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
317 494
318=item $ctx = $device->context ($properties = undef, $notify = undef) 495=for gengetinfo begin device
319 496
320Create a new OpenCL::Context object. 497=item $device_type = $device->type
321 498
322L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> 499Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result.
500
501=item $uint = $device->vendor_id
502
503Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result.
504
505=item $uint = $device->max_compute_units
506
507Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result.
508
509=item $uint = $device->max_work_item_dimensions
510
511Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result.
512
513=item $int = $device->max_work_group_size
514
515Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result.
516
517=item @ints = $device->max_work_item_sizes
518
519Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result.
520
521=item $uint = $device->preferred_vector_width_char
522
523Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result.
524
525=item $uint = $device->preferred_vector_width_short
526
527Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result.
528
529=item $uint = $device->preferred_vector_width_int
530
531Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result.
532
533=item $uint = $device->preferred_vector_width_long
534
535Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result.
536
537=item $uint = $device->preferred_vector_width_float
538
539Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result.
540
541=item $uint = $device->preferred_vector_width_double
542
543Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result.
544
545=item $uint = $device->max_clock_frequency
546
547Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result.
548
549=item $bitfield = $device->address_bits
550
551Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result.
552
553=item $uint = $device->max_read_image_args
554
555Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result.
556
557=item $uint = $device->max_write_image_args
558
559Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result.
560
561=item $ulong = $device->max_mem_alloc_size
562
563Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result.
564
565=item $int = $device->image2d_max_width
566
567Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result.
568
569=item $int = $device->image2d_max_height
570
571Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result.
572
573=item $int = $device->image3d_max_width
574
575Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result.
576
577=item $int = $device->image3d_max_height
578
579Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result.
580
581=item $int = $device->image3d_max_depth
582
583Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result.
584
585=item $uint = $device->image_support
586
587Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result.
588
589=item $int = $device->max_parameter_size
590
591Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result.
592
593=item $uint = $device->max_samplers
594
595Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result.
596
597=item $uint = $device->mem_base_addr_align
598
599Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result.
600
601=item $uint = $device->min_data_type_align_size
602
603Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result.
604
605=item $device_fp_config = $device->single_fp_config
606
607Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result.
608
609=item $device_mem_cache_type = $device->global_mem_cache_type
610
611Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result.
612
613=item $uint = $device->global_mem_cacheline_size
614
615Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result.
616
617=item $ulong = $device->global_mem_cache_size
618
619Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result.
620
621=item $ulong = $device->global_mem_size
622
623Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result.
624
625=item $ulong = $device->max_constant_buffer_size
626
627Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result.
628
629=item $uint = $device->max_constant_args
630
631Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result.
632
633=item $device_local_mem_type = $device->local_mem_type
634
635Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result.
636
637=item $ulong = $device->local_mem_size
638
639Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result.
640
641=item $boolean = $device->error_correction_support
642
643Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result.
644
645=item $int = $device->profiling_timer_resolution
646
647Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result.
648
649=item $boolean = $device->endian_little
650
651Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result.
652
653=item $boolean = $device->available
654
655Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result.
656
657=item $boolean = $device->compiler_available
658
659Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result.
660
661=item $device_exec_capabilities = $device->execution_capabilities
662
663Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result.
664
665=item $command_queue_properties = $device->properties
666
667Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result.
668
669=item $ = $device->platform
670
671Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result.
672
673=item $string = $device->name
674
675Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result.
676
677=item $string = $device->vendor
678
679Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result.
680
681=item $string = $device->driver_version
682
683Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result.
684
685=item $string = $device->profile
686
687Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result.
688
689=item $string = $device->version
690
691Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result.
692
693=item $string = $device->extensions
694
695Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result.
696
697=item $uint = $device->preferred_vector_width_half
698
699Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result.
700
701=item $uint = $device->native_vector_width_char
702
703Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result.
704
705=item $uint = $device->native_vector_width_short
706
707Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result.
708
709=item $uint = $device->native_vector_width_int
710
711Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result.
712
713=item $uint = $device->native_vector_width_long
714
715Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result.
716
717=item $uint = $device->native_vector_width_float
718
719Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result.
720
721=item $uint = $device->native_vector_width_double
722
723Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result.
724
725=item $uint = $device->native_vector_width_half
726
727Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result.
728
729=item $device_fp_config = $device->double_fp_config
730
731Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result.
732
733=item $device_fp_config = $device->half_fp_config
734
735Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result.
736
737=item $boolean = $device->host_unified_memory
738
739Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result.
740
741=item $device = $device->parent_device_ext
742
743Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result.
744
745=item @device_partition_property_exts = $device->partition_types_ext
746
747Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result.
748
749=item @device_partition_property_exts = $device->affinity_domains_ext
750
751Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
752
753=item $uint = $device->reference_count_ext
754
755Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result.
756
757=item @device_partition_property_exts = $device->partition_style_ext
758
759Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
760
761=for gengetinfo end device
323 762
324=back 763=back
325 764
326=head2 THE OpenCL::Context CLASS 765=head2 THE OpenCL::Context CLASS
327 766
328=over 4 767=over 4
329 768
330=item $packed_value = $ctx->info ($name)
331
332See C<< $platform->info >> for details.
333
334L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
335
336=item $queue = $ctx->queue ($device, $properties) 769=item $queue = $ctx->queue ($device, $properties)
337 770
338Create a new OpenCL::Queue object from the context and the given device. 771Create a new OpenCL::Queue object from the context and the given device.
339 772
340L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 773L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
345 778
346L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> 779L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html>
347 780
348=item $buf = $ctx->buffer ($flags, $len) 781=item $buf = $ctx->buffer ($flags, $len)
349 782
350Creates a new OpenCL::Buffer object with the given flags and octet-size. 783Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the
784given flags and octet-size.
351 785
352L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> 786L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html>
353 787
354=item $buf = $ctx->buffer_sv ($flags, $data) 788=item $buf = $ctx->buffer_sv ($flags, $data)
355 789
356Creates a new OpenCL::Buffer object and initialise it with the given data values. 790Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
791initialise it with the given data values.
357 792
358=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) 793=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
359 794
360Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. 795Creates a new OpenCL::Image2D object and optionally initialises it with
796the given data values.
361 797
362L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> 798L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
363 799
364=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) 800=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
365 801
366Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. 802Creates a new OpenCL::Image3D object and optionally initialises it with
803the given data values.
367 804
368L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> 805L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
806
807=item $buffer = $ctx->gl_buffer ($flags, $bufobj)
808
809Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
810OpenGL buffer object.
811
812http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
813
814=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
815
816Creates a new OpenCL::Image2D object that refers to the given OpenGL
8172D texture object.
818
819http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
820
821=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
822
823Creates a new OpenCL::Image3D object that refers to the given OpenGL
8243D texture object.
825
826http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
827
828=item $ctx->gl_renderbuffer ($flags, $renderbuffer)
829
830Creates a new OpenCL::Image2D object that refers to the given OpenGL
831render buffer.
832
833http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html
369 834
370=item @formats = $ctx->supported_image_formats ($flags, $image_type) 835=item @formats = $ctx->supported_image_formats ($flags, $image_type)
371 836
372Returns a list of matching image formats - each format is an arrayref with 837Returns a list of matching image formats - each format is an arrayref with
373two values, $channel_order and $channel_type, in it. 838two values, $channel_order and $channel_type, in it.
383=item $program = $ctx->program_with_source ($string) 848=item $program = $ctx->program_with_source ($string)
384 849
385Creates a new OpenCL::Program object from the given source code. 850Creates a new OpenCL::Program object from the given source code.
386 851
387L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> 852L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html>
853
854=item $packed_value = $ctx->info ($name)
855
856See C<< $platform->info >> for details.
857
858L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html>
859
860=for gengetinfo begin context
861
862=item $uint = $context->reference_count
863
864Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result.
865
866=item @devices = $context->devices
867
868Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result.
869
870=item @property_ints = $context->properties
871
872Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result.
873
874=item $uint = $context->num_devices
875
876Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result.
877
878=for gengetinfo end context
388 879
389=back 880=back
390 881
391=head2 THE OpenCL::Queue CLASS 882=head2 THE OpenCL::Queue CLASS
392 883
406cases (i.e. you use only one queue) it's not necessary to wait for or 897cases (i.e. you use only one queue) it's not necessary to wait for or
407create event objects. 898create event objects.
408 899
409=over 4 900=over 4
410 901
411=item $packed_value = $ctx->info ($name)
412
413See C<< $platform->info >> for details.
414
415L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
416
417=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 902=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
418 903
419Reads data from buffer into the given string. 904Reads data from buffer into the given string.
420 905
421L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> 906L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html>
428 913
429=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) 914=item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...)
430 915
431L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> 916L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html>
432 917
918=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...)
919
920http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html
921
922=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...)
923
924http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html
925
433=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) 926=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
434 927
928L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
929
930=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...)
931
435L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> 932L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
436 933
437=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) 934=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
438 935
439L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> 936L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
440 937
938=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...)
939
940L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
941
942=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...)
943
944L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
945
441=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, 4dst_row_pitch, $dst_slice_pitch, $ait_event...) 946=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...)
442 947
443Yeah. 948Yeah.
444 949
445L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
446
447=item $ev = $queue->enqueue_copy_buffer_to_image (OpenCL::Buffer src, OpenCL::Image dst, size_t src_offset, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
448
449L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 950L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
450
451=item $ev = $queue->enqueue_copy_image (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)
452
453L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
454
455=item $ev = $queue->enqueue_copy_image_to_buffer (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t width, size_t height, size_t depth, size_t dst_offset, ...)
456
457L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
458 951
459=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 952=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
460 953
461L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 954L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
462 955
476reference to an array of local work sizes, with the same number of 969reference to an array of local work sizes, with the same number of
477elements as @$global_work_size. 970elements as @$global_work_size.
478 971
479L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 972L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
480 973
481=item $ev = $queue->enqueue_marker 974=item $ev = $queue->enqueue_marker ($wait_events...)
482 975
483L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> 976L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
484 977
978=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
979
980Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
981for subsequent OpenCL usage.
982
983L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html>
984
985=item $ev = $queue->enqueue_release_gl_objects ([object, ...], $wait_events...)
986
987Enqueues a list (an array-ref of OpenCL::Memory objects) to be released
988for subsequent OpenGL usage.
989
990L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html>
991
485=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 992=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
486 993
487L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 994L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
488 995
489=item $queue->enqueue_barrier 996=item $queue->enqueue_barrier
496 1003
497=item $queue->finish 1004=item $queue->finish
498 1005
499L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> 1006L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html>
500 1007
1008=item $packed_value = $queue->info ($name)
1009
1010See C<< $platform->info >> for details.
1011
1012L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html>
1013
1014=for gengetinfo begin command_queue
1015
1016=item $ctx = $command_queue->context
1017
1018Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result.
1019
1020=item $device = $command_queue->device
1021
1022Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result.
1023
1024=item $uint = $command_queue->reference_count
1025
1026Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result.
1027
1028=item $command_queue_properties = $command_queue->properties
1029
1030Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result.
1031
1032=for gengetinfo end command_queue
1033
501=back 1034=back
502 1035
503=head2 THE OpenCL::Memory CLASS 1036=head2 THE OpenCL::Memory CLASS
504 1037
505This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, 1038This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image,
506OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class 1039OpenCL::Image2D and OpenCL::Image3D.
507currently only exist to allow type-checking.
508 1040
509=over 4 1041=over 4
510 1042
511=item $packed_value = $memory->info ($name) 1043=item $packed_value = $memory->info ($name)
512 1044
513See C<< $platform->info >> for details. 1045See C<< $platform->info >> for details.
514 1046
515L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> 1047L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html>
516 1048
1049=for gengetinfo begin mem
1050
1051=item $mem_object_type = $mem->type
1052
1053Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result.
1054
1055=item $mem_flags = $mem->flags
1056
1057Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result.
1058
1059=item $int = $mem->size
1060
1061Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result.
1062
1063=item $ptr_value = $mem->host_ptr
1064
1065Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result.
1066
1067=item $uint = $mem->map_count
1068
1069Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result.
1070
1071=item $uint = $mem->reference_count
1072
1073Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result.
1074
1075=item $ctx = $mem->context
1076
1077Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result.
1078
1079=item $mem = $mem->associated_memobject
1080
1081Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result.
1082
1083=item $int = $mem->offset
1084
1085Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result.
1086
1087=for gengetinfo end mem
1088
1089=item ($type, $name) = $mem->gl_object_info
1090
1091Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the
1092object "name" (e.g. the texture name) used to create this memory object.
1093
1094L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html>
1095
517=back 1096=back
518 1097
1098=head2 THE OpenCL::Buffer CLASS
1099
1100This is a subclass of OpenCL::Memory, and the superclass of
1101OpenCL::BufferObj. Its purpose is simply to distinguish between buffers
1102and sub-buffers.
1103
1104=head2 THE OpenCL::BufferObj CLASS
1105
1106This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists
1107because one cna create sub buffers of OpenLC::BufferObj objects, but not
1108sub buffers from these sub buffers.
1109
1110=over 4
1111
1112=item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size)
1113
1114Creates an OpenCL::Buffer objects from this buffer and returns it. The
1115C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>.
1116
1117L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html>
1118
1119=back
1120
1121=head2 THE OpenCL::Image CLASS
1122
1123This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D.
1124
1125=over 4
1126
1127=item $packed_value = $ev->image_info ($name)
1128
1129See C<< $platform->info >> for details.
1130
1131The reason this method is not called C<info> is that there already is an
1132C<< ->info >> method inherited from C<OpenCL::Memory>.
1133
1134L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1135
1136=for gengetinfo begin image
1137
1138=item $int = $image->element_size
1139
1140Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
1141
1142=item $int = $image->row_pitch
1143
1144Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result.
1145
1146=item $int = $image->slice_pitch
1147
1148Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result.
1149
1150=item $int = $image->width
1151
1152Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result.
1153
1154=item $int = $image->height
1155
1156Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result.
1157
1158=item $int = $image->depth
1159
1160Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result.
1161
1162=for gengetinfo end image
1163
1164=for gengetinfo begin gl_texture
1165
1166=item $GLenum = $gl_texture->target
1167
1168Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result.
1169
1170=item $GLint = $gl_texture->gl_mipmap_level
1171
1172Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result.
1173
1174=for gengetinfo end gl_texture
1175
1176=back
1177
519=head2 THE OpenCL::Sampler CLASS 1178=head2 THE OpenCL::Sampler CLASS
520 1179
521=over 4 1180=over 4
522 1181
523=item $packed_value = $sampler->info ($name) 1182=item $packed_value = $sampler->info ($name)
524 1183
525See C<< $platform->info >> for details. 1184See C<< $platform->info >> for details.
526 1185
527L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> 1186L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html>
528 1187
1188=for gengetinfo begin sampler
1189
1190=item $uint = $sampler->reference_count
1191
1192Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result.
1193
1194=item $ctx = $sampler->context
1195
1196Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result.
1197
1198=item $addressing_mode = $sampler->normalized_coords
1199
1200Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result.
1201
1202=item $filter_mode = $sampler->addressing_mode
1203
1204Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result.
1205
1206=item $boolean = $sampler->filter_mode
1207
1208Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result.
1209
1210=for gengetinfo end sampler
1211
529=back 1212=back
530 1213
531=head2 THE OpenCL::Program CLASS 1214=head2 THE OpenCL::Program CLASS
532 1215
533=over 4 1216=over 4
534
535=item $packed_value = $program->info ($name)
536
537See C<< $platform->info >> for details.
538
539L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
540 1217
541=item $program->build ($device, $options = "") 1218=item $program->build ($device, $options = "")
542 1219
543Tries to build the program with the givne options. 1220Tries to build the program with the givne options.
544 1221
556Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1233Creates an OpenCL::Kernel object out of the named C<__kernel> function in
557the program. 1234the program.
558 1235
559L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1236L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
560 1237
1238=for gengetinfo begin program_build
1239
1240=item $build_status = $program->build_status ($device)
1241
1242Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result.
1243
1244=item $string = $program->build_options ($device)
1245
1246Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result.
1247
1248=item $string = $program->build_log ($device)
1249
1250Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result.
1251
1252=for gengetinfo end program_build
1253
1254=item $packed_value = $program->info ($name)
1255
1256See C<< $platform->info >> for details.
1257
1258L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1259
1260=for gengetinfo begin program
1261
1262=item $uint = $program->reference_count
1263
1264Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result.
1265
1266=item $ctx = $program->context
1267
1268Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result.
1269
1270=item $uint = $program->num_devices
1271
1272Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result.
1273
1274=item @devices = $program->devices
1275
1276Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result.
1277
1278=item $string = $program->source
1279
1280Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result.
1281
1282=item @ints = $program->binary_sizes
1283
1284Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result.
1285
1286=for gengetinfo end program
1287
1288=item @blobs = $program->binaries
1289
1290Returns a string for the compiled binary for every device associated with
1291the program, empty strings indicate missing programs, and an empty result
1292means no program binaries are available.
1293
1294These "binaries" are often, in fact, informative low-level assembly
1295sources.
1296
1297L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html>
1298
561=back 1299=back
562 1300
563=head2 THE OpenCL::Kernel CLASS 1301=head2 THE OpenCL::Kernel CLASS
564 1302
565=over 4 1303=over 4
567=item $packed_value = $kernel->info ($name) 1305=item $packed_value = $kernel->info ($name)
568 1306
569See C<< $platform->info >> for details. 1307See C<< $platform->info >> for details.
570 1308
571L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> 1309L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html>
1310
1311=for gengetinfo begin kernel
1312
1313=item $string = $kernel->function_name
1314
1315Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result.
1316
1317=item $uint = $kernel->num_args
1318
1319Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result.
1320
1321=item $uint = $kernel->reference_count
1322
1323Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result.
1324
1325=item $ctx = $kernel->context
1326
1327Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result.
1328
1329=item $program = $kernel->program
1330
1331Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result.
1332
1333=for gengetinfo end kernel
1334
1335=item $packed_value = $kernel->work_group_info ($device, $name)
1336
1337See C<< $platform->info >> for details.
1338
1339The reason this method is not called C<info> is that there already is an
1340C<< ->info >> method.
1341
1342L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html>
1343
1344=for gengetinfo begin kernel_work_group
1345
1346=item $int = $kernel->work_group_size ($device)
1347
1348Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result.
1349
1350=item @ints = $kernel->compile_work_group_size ($device)
1351
1352Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result.
1353
1354=item $ulong = $kernel->local_mem_size ($device)
1355
1356Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result.
1357
1358=item $int = $kernel->preferred_work_group_size_multiple ($device)
1359
1360Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result.
1361
1362=item $ulong = $kernel->private_mem_size ($device)
1363
1364Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result.
1365
1366=for gengetinfo end kernel_work_group
572 1367
573=item $kernel->set_TYPE ($index, $value) 1368=item $kernel->set_TYPE ($index, $value)
574 1369
575This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. 1370This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>.
576 1371
577TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, 1372TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>,
578C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, 1373C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>,
579C<image2d>, C<image3d>, C<sampler> or C<event>. 1374C<image2d>, C<image3d>, C<sampler>, C<local> or C<event>.
580 1375
581Chars and integers (including the half type) are specified as integers, 1376Chars and integers (including the half type) are specified as integers,
582float and double as floating point values, memory/buffer/image2d/image3d 1377float and double as floating point values, memory/buffer/image2d/image3d
583must be an object of that type or C<undef>, and sampler and event must be 1378must be an object of that type or C<undef>, local-memory arguments are
584objects of that type. 1379set by specifying the size, and sampler and event must be objects of that
1380type.
585 1381
586L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1382L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
587 1383
588=back 1384=back
589 1385
592This is the superclass for all event objects (including OpenCL::UserEvent 1388This is the superclass for all event objects (including OpenCL::UserEvent
593objects). 1389objects).
594 1390
595=over 4 1391=over 4
596 1392
1393=item $ev->wait
1394
1395Waits for the event to complete.
1396
1397L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1398
597=item $packed_value = $ev->info ($name) 1399=item $packed_value = $ev->info ($name)
598 1400
599See C<< $platform->info >> for details. 1401See C<< $platform->info >> for details.
600 1402
601L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> 1403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
602 1404
603=item $ev->wait 1405=for gengetinfo begin event
604 1406
605Waits for the event to complete. 1407=item $queue = $event->command_queue
606 1408
1409Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result.
1410
1411=item $command_type = $event->command_type
1412
1413Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result.
1414
1415=item $uint = $event->reference_count
1416
1417Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result.
1418
1419=item $uint = $event->command_execution_status
1420
1421Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result.
1422
1423=item $ctx = $event->context
1424
1425Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result.
1426
1427=for gengetinfo end event
1428
1429=item $packed_value = $ev->profiling_info ($name)
1430
1431See C<< $platform->info >> for details.
1432
1433The reason this method is not called C<info> is that there already is an
1434C<< ->info >> method.
1435
607L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 1436L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html>
1437
1438=for gengetinfo begin profiling
1439
1440=item $ulong = $event->profiling_command_queued
1441
1442Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result.
1443
1444=item $ulong = $event->profiling_command_submit
1445
1446Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result.
1447
1448=item $ulong = $event->profiling_command_start
1449
1450Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result.
1451
1452=item $ulong = $event->profiling_command_end
1453
1454Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result.
1455
1456=for gengetinfo end profiling
608 1457
609=back 1458=back
610 1459
611=head2 THE OpenCL::UserEvent CLASS 1460=head2 THE OpenCL::UserEvent CLASS
612 1461
625package OpenCL; 1474package OpenCL;
626 1475
627use common::sense; 1476use common::sense;
628 1477
629BEGIN { 1478BEGIN {
630 our $VERSION = '0.03'; 1479 our $VERSION = '0.96';
631 1480
632 require XSLoader; 1481 require XSLoader;
633 XSLoader::load (__PACKAGE__, $VERSION); 1482 XSLoader::load (__PACKAGE__, $VERSION);
634 1483
635 @OpenCL::Buffer::ISA = 1484 @OpenCL::Buffer::ISA =
636 @OpenCL::Image::ISA = OpenCL::Memory::; 1485 @OpenCL::Image::ISA = OpenCL::Memory::;
637 1486
1487 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1488
638 @OpenCL::Image2D::ISA = 1489 @OpenCL::Image2D::ISA =
639 @OpenCL::Image3D::ISA = OpenCL::Image::; 1490 @OpenCL::Image3D::ISA = OpenCL::Image::;
640 1491
641 @OpenCL::UserEvent::ISA = OpenCL::Event::; 1492 @OpenCL::UserEvent::ISA = OpenCL::Event::;
642} 1493}
643 1494
6441; 14951;
645 1496
646=head1 AUTHOR 1497=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines