… | |
… | |
27 | OpenCL::Program objects, which store source code and, after building for a |
27 | OpenCL::Program objects, which store source code and, after building for a |
28 | specific device ("compiling and linking"), also binary programs. For each |
28 | specific device ("compiling and linking"), also binary programs. For each |
29 | kernel function in a program you can then create an OpenCL::Kernel object |
29 | kernel function in a program you can then create an OpenCL::Kernel object |
30 | which represents basically a function call with argument values. |
30 | which represents basically a function call with argument values. |
31 | |
31 | |
32 | OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat |
32 | OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat |
33 | memory areas, think arrays or structs) and OpenCL::Image objects (think 2d |
33 | memory areas, think arrays or structs) and OpenCL::Image objects (think 2d |
34 | or 3d array) for bulk data and input and output for kernels. |
34 | or 3d array) for bulk data and input and output for kernels. |
35 | |
35 | |
36 | OpenCL::Sampler objects, which are kind of like texture filter modes in |
36 | OpenCL::Sampler objects, which are kind of like texture filter modes in |
37 | OpenGL. |
37 | OpenGL. |
… | |
… | |
52 | |
52 | |
53 | OpenCL manpages: |
53 | OpenCL 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 | |
|
|
57 | If you are into UML class diagrams, the following diagram might help - if |
|
|
58 | not, it will be mildly cobfusing: |
|
|
59 | |
|
|
60 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html |
|
|
61 | |
57 | Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it |
62 | Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it |
58 | is, but at least it's free of charge: |
63 | is, but at least it's free of charge: |
59 | |
64 | |
60 | http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf |
65 | http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf |
61 | |
66 | |
62 | If you are into UML class diagrams, the following diagram might help - if |
67 | And here's NVIDIA's OpenCL Best Practises Guide: |
63 | not, it will be mildly cofusing: |
|
|
64 | |
68 | |
65 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html |
69 | http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf |
66 | |
70 | |
67 | =head1 BASIC WORKFLOW |
71 | =head1 BASIC WORKFLOW |
68 | |
72 | |
69 | To get something done, you basically have to do this once (refer to the |
73 | To get something done, you basically have to do this once (refer to the |
70 | examples below for actual code, this is just a high-level description): |
74 | examples below for actual code, this is just a high-level description): |
… | |
… | |
97 | |
101 | |
98 | Best run this once to get a feel for the platforms and devices in your |
102 | Best run this once to get a feel for the platforms and devices in your |
99 | system. |
103 | system. |
100 | |
104 | |
101 | for my $platform (OpenCL::platforms) { |
105 | for my $platform (OpenCL::platforms) { |
102 | printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); |
106 | printf "platform: %s\n", $platform->name; |
103 | printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); |
107 | printf "extensions: %s\n", $platform->extensions; |
104 | for my $device ($platform->devices) { |
108 | for my $device ($platform->devices) { |
105 | printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); |
109 | printf "+ device: %s\n", $device->name; |
106 | my $ctx = $device->context; |
110 | my $ctx = $platform->context (undef, [$device]); |
107 | # do stuff |
111 | # do stuff |
108 | } |
112 | } |
109 | } |
113 | } |
110 | |
114 | |
111 | =head2 Get a useful context and a command queue. |
115 | =head2 Get a useful context and a command queue. |
… | |
… | |
145 | |
149 | |
146 | =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 |
147 | functions. |
151 | functions. |
148 | |
152 | |
149 | my $src = ' |
153 | my $src = ' |
150 | __kernel void |
154 | kernel void |
151 | squareit (__global float *input, __global float *output) |
155 | squareit (global float *input, global float *output) |
152 | { |
156 | { |
153 | $id = get_global_id (0); |
157 | $id = get_global_id (0); |
154 | output [id] = input [id] * input [id]; |
158 | output [id] = input [id] * input [id]; |
155 | } |
159 | } |
156 | '; |
160 | '; |
157 | |
161 | |
158 | my $prog = $ctx->program_with_source ($src); |
162 | my $prog = $ctx->program_with_source ($src); |
159 | |
163 | |
160 | # 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 |
161 | eval { $prog->build ($dev); 1 } |
165 | eval { $prog->build ($dev); 1 } |
162 | or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG); |
166 | or die $prog->build_log; |
163 | |
167 | |
164 | my $kernel = $prog->kernel ("squareit"); |
168 | my $kernel = $prog->kernel ("squareit"); |
165 | |
169 | |
166 | =head2 Create some input and output float buffers, then call the |
170 | =head2 Create some input and output float buffers, then call the |
167 | 'squareit' kernel on them. |
171 | 'squareit' kernel on them. |
… | |
… | |
222 | |
226 | |
223 | =item * Object lifetime managament is automatic - there is no need |
227 | =item * Object lifetime managament is automatic - there is no need |
224 | to free objects explicitly (C<clReleaseXXX>), the release function |
228 | to free objects explicitly (C<clReleaseXXX>), the release function |
225 | is called automatically once all Perl references to it go away. |
229 | is called automatically once all Perl references to it go away. |
226 | |
230 | |
227 | =item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), |
231 | =item * OpenCL uses CamelCase for function names |
|
|
232 | (e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module |
228 | while this module uses underscores as word separator and often leaves out |
233 | uses underscores as word separator and often leaves out prefixes |
229 | prefixes (C<< $platform->info >>). |
234 | (C<OpenCL::platforms>, C<< $platform->info >>). |
230 | |
235 | |
231 | =item * OpenCL often specifies fixed vector function arguments as short |
236 | =item * OpenCL often specifies fixed vector function arguments as short |
232 | arrays (C<$origin[3]>), while this module explicitly expects the |
237 | arrays (C<size_t origin[3]>), while this module explicitly expects the |
233 | components as separate arguments- |
238 | components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in |
|
|
239 | function calls. |
234 | |
240 | |
235 | =item * Structures are often specified with their components, and returned |
241 | =item * Structures are often specified by flattening out their components |
236 | as arrayrefs. |
242 | as with short vectors, and returned as arrayrefs. |
237 | |
|
|
238 | =item * Where possible, one of the pitch values is calculated from the |
|
|
239 | perl scalar length and need not be specified. |
|
|
240 | |
243 | |
241 | =item * When enqueuing commands, the wait list is specified by adding |
244 | =item * When enqueuing commands, the wait list is specified by adding |
242 | extra arguments to the function - anywhere a C<$wait_events...> argument |
245 | extra arguments to the function - anywhere a C<$wait_events...> argument |
243 | is documented this can be any number of event objects. |
246 | is documented this can be any number of event objects. |
244 | |
247 | |
… | |
… | |
268 | ulong IV - Q |
271 | ulong IV - Q |
269 | float NV float f |
272 | float NV float f |
270 | half IV ushort S |
273 | half IV ushort S |
271 | double NV double d |
274 | double NV double d |
272 | |
275 | |
|
|
276 | =head2 OpenGL sharing |
|
|
277 | |
|
|
278 | This module can be optionally compiled with support for |
|
|
279 | OpenGL sharing. The sharing functions are only available when |
|
|
280 | C<OpenCL::HAVE_OPENGL> returns true, otherwise they are absent and cannot |
|
|
281 | be called. |
|
|
282 | |
273 | =head2 THE OpenCL PACKAGE |
283 | =head2 THE OpenCL PACKAGE |
274 | |
284 | |
275 | =over 4 |
285 | =over 4 |
276 | |
286 | |
277 | =item $int = OpenCL::errno |
287 | =item $int = OpenCL::errno |
… | |
… | |
283 | |
293 | |
284 | Comverts an error value into a human readable string. |
294 | Comverts an error value into a human readable string. |
285 | |
295 | |
286 | =item $str = OpenCL::enum2str $enum |
296 | =item $str = OpenCL::enum2str $enum |
287 | |
297 | |
288 | Converts most enum values (inof parameter names, image format constants, |
298 | Converts most enum values (of parameter names, image format constants, |
289 | object types, addressing and filter modes, command types etc.) into a |
299 | object types, addressing and filter modes, command types etc.) into a |
290 | human readbale string. When confronted with some random integer it can be |
300 | human readable string. When confronted with some random integer it can be |
291 | very helpful to pass it through this function to maybe get some readable |
301 | very helpful to pass it through this function to maybe get some readable |
292 | string out of it. |
302 | string out of it. |
293 | |
303 | |
294 | =item @platforms = OpenCL::platforms |
304 | =item @platforms = OpenCL::platforms |
295 | |
305 | |
… | |
… | |
313 | |
323 | |
314 | =head2 THE OpenCL::Platform CLASS |
324 | =head2 THE OpenCL::Platform CLASS |
315 | |
325 | |
316 | =over 4 |
326 | =over 4 |
317 | |
327 | |
318 | =item $packed_value = $platform->info ($name) |
|
|
319 | |
|
|
320 | Calls C<clGetPlatformInfo> and returns the packed, raw value - for |
|
|
321 | strings, this will be the string, for other values you probably need to |
|
|
322 | use the correct C<unpack>. This might get improved in the future. Hopefully. |
|
|
323 | |
|
|
324 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> |
|
|
325 | |
|
|
326 | =item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) |
328 | =item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) |
327 | |
329 | |
328 | Returns a list of matching OpenCL::Device objects. |
330 | Returns a list of matching OpenCL::Device objects. |
329 | |
331 | |
330 | =item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) |
332 | =item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) |
331 | |
333 | |
332 | Tries to create a context. Never worked for me, and you need devices explitly anyway. |
334 | Tries to create a context. Never worked for me, and you need devices explicitly anyway. |
333 | |
335 | |
334 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
336 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
335 | |
337 | |
336 | =item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) |
338 | =item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef) |
337 | |
339 | |
338 | Create a new OpenCL::Context object using the given device object(s)- a |
340 | Create a new OpenCL::Context object using the given device object(s)- a |
339 | CL_CONTEXT_PLATFORM property is supplied automatically. |
341 | CL_CONTEXT_PLATFORM property is supplied automatically. |
340 | |
342 | |
341 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
343 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
342 | |
344 | |
|
|
345 | =item $packed_value = $platform->info ($name) |
|
|
346 | |
|
|
347 | Calls C<clGetPlatformInfo> and returns the packed, raw value - for |
|
|
348 | strings, this will be the string (possibly including terminating \0), for |
|
|
349 | other values you probably need to use the correct C<unpack>. |
|
|
350 | |
|
|
351 | It's best to avoid this method and use one of the following convenience |
|
|
352 | wrappers. |
|
|
353 | |
|
|
354 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> |
|
|
355 | |
|
|
356 | =for gengetinfo begin platform |
|
|
357 | |
|
|
358 | =item $string = $platform->profile |
|
|
359 | |
|
|
360 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. |
|
|
361 | |
|
|
362 | =item $string = $platform->version |
|
|
363 | |
|
|
364 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. |
|
|
365 | |
|
|
366 | =item $string = $platform->name |
|
|
367 | |
|
|
368 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. |
|
|
369 | |
|
|
370 | =item $string = $platform->vendor |
|
|
371 | |
|
|
372 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. |
|
|
373 | |
|
|
374 | =item $string = $platform->extensions |
|
|
375 | |
|
|
376 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. |
|
|
377 | |
|
|
378 | =for gengetinfo end platform |
|
|
379 | |
343 | =back |
380 | =back |
344 | |
381 | |
345 | =head2 THE OpenCL::Device CLASS |
382 | =head2 THE OpenCL::Device CLASS |
346 | |
383 | |
347 | =over 4 |
384 | =over 4 |
… | |
… | |
350 | |
387 | |
351 | See C<< $platform->info >> for details. |
388 | See C<< $platform->info >> for details. |
352 | |
389 | |
353 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> |
390 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> |
354 | |
391 | |
|
|
392 | =for gengetinfo begin device |
|
|
393 | |
|
|
394 | =item $device_type = $device->type |
|
|
395 | |
|
|
396 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. |
|
|
397 | |
|
|
398 | =item $uint = $device->vendor_id |
|
|
399 | |
|
|
400 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. |
|
|
401 | |
|
|
402 | =item $uint = $device->max_compute_units |
|
|
403 | |
|
|
404 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. |
|
|
405 | |
|
|
406 | =item $uint = $device->max_work_item_dimensions |
|
|
407 | |
|
|
408 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. |
|
|
409 | |
|
|
410 | =item $int = $device->max_work_group_size |
|
|
411 | |
|
|
412 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. |
|
|
413 | |
|
|
414 | =item @ints = $device->max_work_item_sizes |
|
|
415 | |
|
|
416 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. |
|
|
417 | |
|
|
418 | =item $uint = $device->preferred_vector_width_char |
|
|
419 | |
|
|
420 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. |
|
|
421 | |
|
|
422 | =item $uint = $device->preferred_vector_width_short |
|
|
423 | |
|
|
424 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. |
|
|
425 | |
|
|
426 | =item $uint = $device->preferred_vector_width_int |
|
|
427 | |
|
|
428 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. |
|
|
429 | |
|
|
430 | =item $uint = $device->preferred_vector_width_long |
|
|
431 | |
|
|
432 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. |
|
|
433 | |
|
|
434 | =item $uint = $device->preferred_vector_width_float |
|
|
435 | |
|
|
436 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. |
|
|
437 | |
|
|
438 | =item $uint = $device->preferred_vector_width_double |
|
|
439 | |
|
|
440 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. |
|
|
441 | |
|
|
442 | =item $uint = $device->max_clock_frequency |
|
|
443 | |
|
|
444 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. |
|
|
445 | |
|
|
446 | =item $bitfield = $device->address_bits |
|
|
447 | |
|
|
448 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. |
|
|
449 | |
|
|
450 | =item $uint = $device->max_read_image_args |
|
|
451 | |
|
|
452 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. |
|
|
453 | |
|
|
454 | =item $uint = $device->max_write_image_args |
|
|
455 | |
|
|
456 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. |
|
|
457 | |
|
|
458 | =item $ulong = $device->max_mem_alloc_size |
|
|
459 | |
|
|
460 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. |
|
|
461 | |
|
|
462 | =item $int = $device->image2d_max_width |
|
|
463 | |
|
|
464 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. |
|
|
465 | |
|
|
466 | =item $int = $device->image2d_max_height |
|
|
467 | |
|
|
468 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. |
|
|
469 | |
|
|
470 | =item $int = $device->image3d_max_width |
|
|
471 | |
|
|
472 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. |
|
|
473 | |
|
|
474 | =item $int = $device->image3d_max_height |
|
|
475 | |
|
|
476 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. |
|
|
477 | |
|
|
478 | =item $int = $device->image3d_max_depth |
|
|
479 | |
|
|
480 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. |
|
|
481 | |
|
|
482 | =item $uint = $device->image_support |
|
|
483 | |
|
|
484 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. |
|
|
485 | |
|
|
486 | =item $int = $device->max_parameter_size |
|
|
487 | |
|
|
488 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. |
|
|
489 | |
|
|
490 | =item $uint = $device->max_samplers |
|
|
491 | |
|
|
492 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. |
|
|
493 | |
|
|
494 | =item $uint = $device->mem_base_addr_align |
|
|
495 | |
|
|
496 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. |
|
|
497 | |
|
|
498 | =item $uint = $device->min_data_type_align_size |
|
|
499 | |
|
|
500 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. |
|
|
501 | |
|
|
502 | =item $device_fp_config = $device->single_fp_config |
|
|
503 | |
|
|
504 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. |
|
|
505 | |
|
|
506 | =item $device_mem_cache_type = $device->global_mem_cache_type |
|
|
507 | |
|
|
508 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. |
|
|
509 | |
|
|
510 | =item $uint = $device->global_mem_cacheline_size |
|
|
511 | |
|
|
512 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. |
|
|
513 | |
|
|
514 | =item $ulong = $device->global_mem_cache_size |
|
|
515 | |
|
|
516 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. |
|
|
517 | |
|
|
518 | =item $ulong = $device->global_mem_size |
|
|
519 | |
|
|
520 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. |
|
|
521 | |
|
|
522 | =item $ulong = $device->max_constant_buffer_size |
|
|
523 | |
|
|
524 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. |
|
|
525 | |
|
|
526 | =item $uint = $device->max_constant_args |
|
|
527 | |
|
|
528 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. |
|
|
529 | |
|
|
530 | =item $device_local_mem_type = $device->local_mem_type |
|
|
531 | |
|
|
532 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. |
|
|
533 | |
|
|
534 | =item $ulong = $device->local_mem_size |
|
|
535 | |
|
|
536 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. |
|
|
537 | |
|
|
538 | =item $boolean = $device->error_correction_support |
|
|
539 | |
|
|
540 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. |
|
|
541 | |
|
|
542 | =item $int = $device->profiling_timer_resolution |
|
|
543 | |
|
|
544 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. |
|
|
545 | |
|
|
546 | =item $boolean = $device->endian_little |
|
|
547 | |
|
|
548 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. |
|
|
549 | |
|
|
550 | =item $boolean = $device->available |
|
|
551 | |
|
|
552 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. |
|
|
553 | |
|
|
554 | =item $boolean = $device->compiler_available |
|
|
555 | |
|
|
556 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. |
|
|
557 | |
|
|
558 | =item $device_exec_capabilities = $device->execution_capabilities |
|
|
559 | |
|
|
560 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. |
|
|
561 | |
|
|
562 | =item $command_queue_properties = $device->properties |
|
|
563 | |
|
|
564 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. |
|
|
565 | |
|
|
566 | =item $ = $device->platform |
|
|
567 | |
|
|
568 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. |
|
|
569 | |
|
|
570 | =item $string = $device->name |
|
|
571 | |
|
|
572 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. |
|
|
573 | |
|
|
574 | =item $string = $device->vendor |
|
|
575 | |
|
|
576 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. |
|
|
577 | |
|
|
578 | =item $string = $device->driver_version |
|
|
579 | |
|
|
580 | Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. |
|
|
581 | |
|
|
582 | =item $string = $device->profile |
|
|
583 | |
|
|
584 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. |
|
|
585 | |
|
|
586 | =item $string = $device->version |
|
|
587 | |
|
|
588 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. |
|
|
589 | |
|
|
590 | =item $string = $device->extensions |
|
|
591 | |
|
|
592 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. |
|
|
593 | |
|
|
594 | =item $uint = $device->preferred_vector_width_half |
|
|
595 | |
|
|
596 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. |
|
|
597 | |
|
|
598 | =item $uint = $device->native_vector_width_char |
|
|
599 | |
|
|
600 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. |
|
|
601 | |
|
|
602 | =item $uint = $device->native_vector_width_short |
|
|
603 | |
|
|
604 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. |
|
|
605 | |
|
|
606 | =item $uint = $device->native_vector_width_int |
|
|
607 | |
|
|
608 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. |
|
|
609 | |
|
|
610 | =item $uint = $device->native_vector_width_long |
|
|
611 | |
|
|
612 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. |
|
|
613 | |
|
|
614 | =item $uint = $device->native_vector_width_float |
|
|
615 | |
|
|
616 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. |
|
|
617 | |
|
|
618 | =item $uint = $device->native_vector_width_double |
|
|
619 | |
|
|
620 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. |
|
|
621 | |
|
|
622 | =item $uint = $device->native_vector_width_half |
|
|
623 | |
|
|
624 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. |
|
|
625 | |
|
|
626 | =item $device_fp_config = $device->double_fp_config |
|
|
627 | |
|
|
628 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. |
|
|
629 | |
|
|
630 | =item $device_fp_config = $device->half_fp_config |
|
|
631 | |
|
|
632 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. |
|
|
633 | |
|
|
634 | =item $boolean = $device->host_unified_memory |
|
|
635 | |
|
|
636 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. |
|
|
637 | |
|
|
638 | =item $device = $device->parent_device_ext |
|
|
639 | |
|
|
640 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. |
|
|
641 | |
|
|
642 | =item @device_partition_property_exts = $device->partition_types_ext |
|
|
643 | |
|
|
644 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. |
|
|
645 | |
|
|
646 | =item @device_partition_property_exts = $device->affinity_domains_ext |
|
|
647 | |
|
|
648 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. |
|
|
649 | |
|
|
650 | =item $uint = $device->reference_count_ext |
|
|
651 | |
|
|
652 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result. |
|
|
653 | |
|
|
654 | =item @device_partition_property_exts = $device->partition_style_ext |
|
|
655 | |
|
|
656 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. |
|
|
657 | |
|
|
658 | =for gengetinfo end device |
|
|
659 | |
355 | =back |
660 | =back |
356 | |
661 | |
357 | =head2 THE OpenCL::Context CLASS |
662 | =head2 THE OpenCL::Context CLASS |
358 | |
663 | |
359 | =over 4 |
664 | =over 4 |
360 | |
665 | |
361 | =item $packed_value = $ctx->info ($name) |
|
|
362 | |
|
|
363 | See C<< $platform->info >> for details. |
|
|
364 | |
|
|
365 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> |
|
|
366 | |
|
|
367 | =item $queue = $ctx->queue ($device, $properties) |
666 | =item $queue = $ctx->queue ($device, $properties) |
368 | |
667 | |
369 | Create a new OpenCL::Queue object from the context and the given device. |
668 | Create a new OpenCL::Queue object from the context and the given device. |
370 | |
669 | |
371 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> |
670 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> |
… | |
… | |
376 | |
675 | |
377 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> |
676 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> |
378 | |
677 | |
379 | =item $buf = $ctx->buffer ($flags, $len) |
678 | =item $buf = $ctx->buffer ($flags, $len) |
380 | |
679 | |
381 | Creates a new OpenCL::Buffer object with the given flags and octet-size. |
680 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the |
|
|
681 | given flags and octet-size. |
382 | |
682 | |
383 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> |
683 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> |
384 | |
684 | |
385 | =item $buf = $ctx->buffer_sv ($flags, $data) |
685 | =item $buf = $ctx->buffer_sv ($flags, $data) |
386 | |
686 | |
387 | Creates a new OpenCL::Buffer object and initialise it with the given data values. |
687 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and |
|
|
688 | initialise it with the given data values. |
388 | |
689 | |
389 | =item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) |
690 | =item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) |
390 | |
691 | |
391 | Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. |
692 | Creates a new OpenCL::Image2D object and optionally initialises it with |
|
|
693 | the given data values. |
392 | |
694 | |
393 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> |
695 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> |
394 | |
696 | |
395 | =item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) |
697 | =item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) |
396 | |
698 | |
397 | Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. |
699 | Creates a new OpenCL::Image3D object and optionally initialises it with |
|
|
700 | the given data values. |
398 | |
701 | |
399 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> |
702 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> |
400 | |
703 | |
401 | =item @formats = $ctx->supported_image_formats ($flags, $image_type) |
704 | =item @formats = $ctx->supported_image_formats ($flags, $image_type) |
402 | |
705 | |
… | |
… | |
414 | =item $program = $ctx->program_with_source ($string) |
717 | =item $program = $ctx->program_with_source ($string) |
415 | |
718 | |
416 | Creates a new OpenCL::Program object from the given source code. |
719 | Creates a new OpenCL::Program object from the given source code. |
417 | |
720 | |
418 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> |
721 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> |
|
|
722 | |
|
|
723 | =item $packed_value = $ctx->info ($name) |
|
|
724 | |
|
|
725 | See C<< $platform->info >> for details. |
|
|
726 | |
|
|
727 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> |
|
|
728 | |
|
|
729 | =for gengetinfo begin context |
|
|
730 | |
|
|
731 | =item $uint = $context->reference_count |
|
|
732 | |
|
|
733 | Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. |
|
|
734 | |
|
|
735 | =item @devices = $context->devices |
|
|
736 | |
|
|
737 | Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. |
|
|
738 | |
|
|
739 | =item @property_ints = $context->properties |
|
|
740 | |
|
|
741 | Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. |
|
|
742 | |
|
|
743 | =item $uint = $context->num_devices |
|
|
744 | |
|
|
745 | Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. |
|
|
746 | |
|
|
747 | =for gengetinfo end context |
419 | |
748 | |
420 | =back |
749 | =back |
421 | |
750 | |
422 | =head2 THE OpenCL::Queue CLASS |
751 | =head2 THE OpenCL::Queue CLASS |
423 | |
752 | |
… | |
… | |
437 | cases (i.e. you use only one queue) it's not necessary to wait for or |
766 | cases (i.e. you use only one queue) it's not necessary to wait for or |
438 | create event objects. |
767 | create event objects. |
439 | |
768 | |
440 | =over 4 |
769 | =over 4 |
441 | |
770 | |
442 | =item $packed_value = $ctx->info ($name) |
|
|
443 | |
|
|
444 | See C<< $platform->info >> for details. |
|
|
445 | |
|
|
446 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html> |
|
|
447 | |
|
|
448 | =item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) |
771 | =item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) |
449 | |
772 | |
450 | Reads data from buffer into the given string. |
773 | Reads data from buffer into the given string. |
451 | |
774 | |
452 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> |
775 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> |
… | |
… | |
459 | |
782 | |
460 | =item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) |
783 | =item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) |
461 | |
784 | |
462 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> |
785 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> |
463 | |
786 | |
|
|
787 | =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...) |
|
|
788 | |
|
|
789 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html |
|
|
790 | |
|
|
791 | =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...) |
|
|
792 | |
|
|
793 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html |
|
|
794 | |
464 | =item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
795 | =item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
465 | |
796 | |
|
|
797 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> |
|
|
798 | |
|
|
799 | =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...) |
|
|
800 | |
466 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> |
801 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> |
467 | |
802 | |
468 | =item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) |
803 | =item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
469 | |
804 | |
470 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> |
805 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> |
471 | |
806 | |
|
|
807 | =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...) |
|
|
808 | |
|
|
809 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> |
|
|
810 | |
|
|
811 | =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...) |
|
|
812 | |
|
|
813 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html> |
|
|
814 | |
472 | =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, $wait_event...) |
815 | =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...) |
473 | |
816 | |
474 | Yeah. |
817 | Yeah. |
475 | |
818 | |
476 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> |
|
|
477 | |
|
|
478 | =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...) |
|
|
479 | |
|
|
480 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. |
819 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. |
481 | |
|
|
482 | =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...) |
|
|
483 | |
|
|
484 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> |
|
|
485 | |
|
|
486 | =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...) |
|
|
487 | |
|
|
488 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html> |
|
|
489 | |
820 | |
490 | =item $ev = $queue->enqueue_task ($kernel, $wait_events...) |
821 | =item $ev = $queue->enqueue_task ($kernel, $wait_events...) |
491 | |
822 | |
492 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> |
823 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> |
493 | |
824 | |
… | |
… | |
527 | |
858 | |
528 | =item $queue->finish |
859 | =item $queue->finish |
529 | |
860 | |
530 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> |
861 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> |
531 | |
862 | |
|
|
863 | =item $packed_value = $queue->info ($name) |
|
|
864 | |
|
|
865 | See C<< $platform->info >> for details. |
|
|
866 | |
|
|
867 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html> |
|
|
868 | |
|
|
869 | =for gengetinfo begin command_queue |
|
|
870 | |
|
|
871 | =item $ctx = $command_queue->context |
|
|
872 | |
|
|
873 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. |
|
|
874 | |
|
|
875 | =item $device = $command_queue->device |
|
|
876 | |
|
|
877 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. |
|
|
878 | |
|
|
879 | =item $uint = $command_queue->reference_count |
|
|
880 | |
|
|
881 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. |
|
|
882 | |
|
|
883 | =item $command_queue_properties = $command_queue->properties |
|
|
884 | |
|
|
885 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. |
|
|
886 | |
|
|
887 | =for gengetinfo end command_queue |
|
|
888 | |
532 | =back |
889 | =back |
533 | |
890 | |
534 | =head2 THE OpenCL::Memory CLASS |
891 | =head2 THE OpenCL::Memory CLASS |
535 | |
892 | |
536 | This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, |
893 | This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, |
537 | OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class |
894 | OpenCL::Image2D and OpenCL::Image3D. |
538 | currently only exist to allow type-checking. |
|
|
539 | |
895 | |
540 | =over 4 |
896 | =over 4 |
541 | |
897 | |
542 | =item $packed_value = $memory->info ($name) |
898 | =item $packed_value = $memory->info ($name) |
543 | |
899 | |
544 | See C<< $platform->info >> for details. |
900 | See C<< $platform->info >> for details. |
545 | |
901 | |
546 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> |
902 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> |
547 | |
903 | |
|
|
904 | =for gengetinfo begin mem |
|
|
905 | |
|
|
906 | =item $mem_object_type = $mem->type |
|
|
907 | |
|
|
908 | Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. |
|
|
909 | |
|
|
910 | =item $mem_flags = $mem->flags |
|
|
911 | |
|
|
912 | Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. |
|
|
913 | |
|
|
914 | =item $int = $mem->size |
|
|
915 | |
|
|
916 | Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. |
|
|
917 | |
|
|
918 | =item $ptr_value = $mem->host_ptr |
|
|
919 | |
|
|
920 | Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. |
|
|
921 | |
|
|
922 | =item $uint = $mem->map_count |
|
|
923 | |
|
|
924 | Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. |
|
|
925 | |
|
|
926 | =item $uint = $mem->reference_count |
|
|
927 | |
|
|
928 | Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. |
|
|
929 | |
|
|
930 | =item $ctx = $mem->context |
|
|
931 | |
|
|
932 | Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. |
|
|
933 | |
|
|
934 | =item $mem = $mem->associated_memobject |
|
|
935 | |
|
|
936 | Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. |
|
|
937 | |
|
|
938 | =item $int = $mem->offset |
|
|
939 | |
|
|
940 | Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. |
|
|
941 | |
|
|
942 | =for gengetinfo end mem |
|
|
943 | |
548 | =back |
944 | =back |
549 | |
945 | |
|
|
946 | =head2 THE OpenCL::Buffer CLASS |
|
|
947 | |
|
|
948 | This is a subclass of OpenCL::Memory, and the superclass of |
|
|
949 | OpenCL::BufferObj. Its purpose is simply to distinguish between buffers |
|
|
950 | and sub-buffers. |
|
|
951 | |
|
|
952 | =head2 THE OpenCL::BufferObj CLASS |
|
|
953 | |
|
|
954 | This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists |
|
|
955 | because one cna create sub buffers of OpenLC::BufferObj objects, but not |
|
|
956 | sub buffers from these sub buffers. |
|
|
957 | |
|
|
958 | =over 4 |
|
|
959 | |
|
|
960 | =item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size) |
|
|
961 | |
|
|
962 | Creates an OpenCL::Buffer objects from this buffer and returns it. The |
|
|
963 | C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>. |
|
|
964 | |
|
|
965 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html> |
|
|
966 | |
|
|
967 | =back |
|
|
968 | |
|
|
969 | =head2 THE OpenCL::Image CLASS |
|
|
970 | |
|
|
971 | This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. |
|
|
972 | |
|
|
973 | =over 4 |
|
|
974 | |
|
|
975 | =item $packed_value = $ev->image_info ($name) |
|
|
976 | |
|
|
977 | See C<< $platform->info >> for details. |
|
|
978 | |
|
|
979 | The reason this method is not called C<info> is that there already is an |
|
|
980 | C<< ->info >> method inherited from C<OpenCL::Memory>. |
|
|
981 | |
|
|
982 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> |
|
|
983 | |
|
|
984 | =for gengetinfo begin image |
|
|
985 | |
|
|
986 | =item $int = $image->element_size |
|
|
987 | |
|
|
988 | Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. |
|
|
989 | |
|
|
990 | =item $int = $image->row_pitch |
|
|
991 | |
|
|
992 | Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. |
|
|
993 | |
|
|
994 | =item $int = $image->slice_pitch |
|
|
995 | |
|
|
996 | Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. |
|
|
997 | |
|
|
998 | =item $int = $image->width |
|
|
999 | |
|
|
1000 | Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. |
|
|
1001 | |
|
|
1002 | =item $int = $image->height |
|
|
1003 | |
|
|
1004 | Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. |
|
|
1005 | |
|
|
1006 | =item $int = $image->depth |
|
|
1007 | |
|
|
1008 | Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. |
|
|
1009 | |
|
|
1010 | =for gengetinfo end image |
|
|
1011 | |
|
|
1012 | =back |
|
|
1013 | |
550 | =head2 THE OpenCL::Sampler CLASS |
1014 | =head2 THE OpenCL::Sampler CLASS |
551 | |
1015 | |
552 | =over 4 |
1016 | =over 4 |
553 | |
1017 | |
554 | =item $packed_value = $sampler->info ($name) |
1018 | =item $packed_value = $sampler->info ($name) |
555 | |
1019 | |
556 | See C<< $platform->info >> for details. |
1020 | See C<< $platform->info >> for details. |
557 | |
1021 | |
558 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> |
1022 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> |
559 | |
1023 | |
|
|
1024 | =for gengetinfo begin sampler |
|
|
1025 | |
|
|
1026 | =item $uint = $sampler->reference_count |
|
|
1027 | |
|
|
1028 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. |
|
|
1029 | |
|
|
1030 | =item $ctx = $sampler->context |
|
|
1031 | |
|
|
1032 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. |
|
|
1033 | |
|
|
1034 | =item $addressing_mode = $sampler->normalized_coords |
|
|
1035 | |
|
|
1036 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. |
|
|
1037 | |
|
|
1038 | =item $filter_mode = $sampler->addressing_mode |
|
|
1039 | |
|
|
1040 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. |
|
|
1041 | |
|
|
1042 | =item $boolean = $sampler->filter_mode |
|
|
1043 | |
|
|
1044 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. |
|
|
1045 | |
|
|
1046 | =for gengetinfo end sampler |
|
|
1047 | |
560 | =back |
1048 | =back |
561 | |
1049 | |
562 | =head2 THE OpenCL::Program CLASS |
1050 | =head2 THE OpenCL::Program CLASS |
563 | |
1051 | |
564 | =over 4 |
1052 | =over 4 |
565 | |
|
|
566 | =item $packed_value = $program->info ($name) |
|
|
567 | |
|
|
568 | See C<< $platform->info >> for details. |
|
|
569 | |
|
|
570 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> |
|
|
571 | |
1053 | |
572 | =item $program->build ($device, $options = "") |
1054 | =item $program->build ($device, $options = "") |
573 | |
1055 | |
574 | Tries to build the program with the givne options. |
1056 | Tries to build the program with the givne options. |
575 | |
1057 | |
… | |
… | |
587 | Creates an OpenCL::Kernel object out of the named C<__kernel> function in |
1069 | Creates an OpenCL::Kernel object out of the named C<__kernel> function in |
588 | the program. |
1070 | the program. |
589 | |
1071 | |
590 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> |
1072 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> |
591 | |
1073 | |
|
|
1074 | =for gengetinfo begin program_build |
|
|
1075 | |
|
|
1076 | =item $build_status = $program->build_status ($device) |
|
|
1077 | |
|
|
1078 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. |
|
|
1079 | |
|
|
1080 | =item $string = $program->build_options ($device) |
|
|
1081 | |
|
|
1082 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. |
|
|
1083 | |
|
|
1084 | =item $string = $program->build_log ($device) |
|
|
1085 | |
|
|
1086 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. |
|
|
1087 | |
|
|
1088 | =for gengetinfo end program_build |
|
|
1089 | |
|
|
1090 | =item $packed_value = $program->info ($name) |
|
|
1091 | |
|
|
1092 | See C<< $platform->info >> for details. |
|
|
1093 | |
|
|
1094 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> |
|
|
1095 | |
|
|
1096 | =for gengetinfo begin program |
|
|
1097 | |
|
|
1098 | =item $uint = $program->reference_count |
|
|
1099 | |
|
|
1100 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. |
|
|
1101 | |
|
|
1102 | =item $ctx = $program->context |
|
|
1103 | |
|
|
1104 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. |
|
|
1105 | |
|
|
1106 | =item $uint = $program->num_devices |
|
|
1107 | |
|
|
1108 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. |
|
|
1109 | |
|
|
1110 | =item @devices = $program->devices |
|
|
1111 | |
|
|
1112 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. |
|
|
1113 | |
|
|
1114 | =item $string = $program->source |
|
|
1115 | |
|
|
1116 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. |
|
|
1117 | |
|
|
1118 | =item @ints = $program->binary_sizes |
|
|
1119 | |
|
|
1120 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. |
|
|
1121 | |
|
|
1122 | =for gengetinfo end program |
|
|
1123 | |
|
|
1124 | =item @blobs = $program->binaries |
|
|
1125 | |
|
|
1126 | Returns a string for the compiled binary for every device associated with |
|
|
1127 | the program, empty strings indicate missing programs, and an empty result |
|
|
1128 | means no program binaries are available. |
|
|
1129 | |
|
|
1130 | These "binaries" are often, in fact, informative low-level assembly |
|
|
1131 | sources. |
|
|
1132 | |
|
|
1133 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> |
|
|
1134 | |
592 | =back |
1135 | =back |
593 | |
1136 | |
594 | =head2 THE OpenCL::Kernel CLASS |
1137 | =head2 THE OpenCL::Kernel CLASS |
595 | |
1138 | |
596 | =over 4 |
1139 | =over 4 |
… | |
… | |
598 | =item $packed_value = $kernel->info ($name) |
1141 | =item $packed_value = $kernel->info ($name) |
599 | |
1142 | |
600 | See C<< $platform->info >> for details. |
1143 | See C<< $platform->info >> for details. |
601 | |
1144 | |
602 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> |
1145 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> |
|
|
1146 | |
|
|
1147 | =for gengetinfo begin kernel |
|
|
1148 | |
|
|
1149 | =item $string = $kernel->function_name |
|
|
1150 | |
|
|
1151 | Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. |
|
|
1152 | |
|
|
1153 | =item $uint = $kernel->num_args |
|
|
1154 | |
|
|
1155 | Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. |
|
|
1156 | |
|
|
1157 | =item $uint = $kernel->reference_count |
|
|
1158 | |
|
|
1159 | Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. |
|
|
1160 | |
|
|
1161 | =item $ctx = $kernel->context |
|
|
1162 | |
|
|
1163 | Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. |
|
|
1164 | |
|
|
1165 | =item $program = $kernel->program |
|
|
1166 | |
|
|
1167 | Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. |
|
|
1168 | |
|
|
1169 | =for gengetinfo end kernel |
|
|
1170 | |
|
|
1171 | =item $packed_value = $kernel->work_group_info ($device, $name) |
|
|
1172 | |
|
|
1173 | See C<< $platform->info >> for details. |
|
|
1174 | |
|
|
1175 | The reason this method is not called C<info> is that there already is an |
|
|
1176 | C<< ->info >> method. |
|
|
1177 | |
|
|
1178 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> |
|
|
1179 | |
|
|
1180 | =for gengetinfo begin kernel_work_group |
|
|
1181 | |
|
|
1182 | =item $int = $kernel->work_group_size ($device) |
|
|
1183 | |
|
|
1184 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. |
|
|
1185 | |
|
|
1186 | =item @ints = $kernel->compile_work_group_size ($device) |
|
|
1187 | |
|
|
1188 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. |
|
|
1189 | |
|
|
1190 | =item $ulong = $kernel->local_mem_size ($device) |
|
|
1191 | |
|
|
1192 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. |
|
|
1193 | |
|
|
1194 | =item $int = $kernel->preferred_work_group_size_multiple ($device) |
|
|
1195 | |
|
|
1196 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. |
|
|
1197 | |
|
|
1198 | =item $ulong = $kernel->private_mem_size ($device) |
|
|
1199 | |
|
|
1200 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. |
|
|
1201 | |
|
|
1202 | =for gengetinfo end kernel_work_group |
603 | |
1203 | |
604 | =item $kernel->set_TYPE ($index, $value) |
1204 | =item $kernel->set_TYPE ($index, $value) |
605 | |
1205 | |
606 | This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. |
1206 | This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. |
607 | |
1207 | |
… | |
… | |
623 | This is the superclass for all event objects (including OpenCL::UserEvent |
1223 | This is the superclass for all event objects (including OpenCL::UserEvent |
624 | objects). |
1224 | objects). |
625 | |
1225 | |
626 | =over 4 |
1226 | =over 4 |
627 | |
1227 | |
|
|
1228 | =item $ev->wait |
|
|
1229 | |
|
|
1230 | Waits for the event to complete. |
|
|
1231 | |
|
|
1232 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> |
|
|
1233 | |
628 | =item $packed_value = $ev->info ($name) |
1234 | =item $packed_value = $ev->info ($name) |
629 | |
1235 | |
630 | See C<< $platform->info >> for details. |
1236 | See C<< $platform->info >> for details. |
631 | |
1237 | |
632 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> |
1238 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> |
633 | |
1239 | |
634 | =item $ev->wait |
1240 | =for gengetinfo begin event |
635 | |
1241 | |
636 | Waits for the event to complete. |
1242 | =item $queue = $event->command_queue |
637 | |
1243 | |
|
|
1244 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. |
|
|
1245 | |
|
|
1246 | =item $command_type = $event->command_type |
|
|
1247 | |
|
|
1248 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. |
|
|
1249 | |
|
|
1250 | =item $uint = $event->reference_count |
|
|
1251 | |
|
|
1252 | Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. |
|
|
1253 | |
|
|
1254 | =item $uint = $event->command_execution_status |
|
|
1255 | |
|
|
1256 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. |
|
|
1257 | |
|
|
1258 | =item $ctx = $event->context |
|
|
1259 | |
|
|
1260 | Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. |
|
|
1261 | |
|
|
1262 | =for gengetinfo end event |
|
|
1263 | |
|
|
1264 | =item $packed_value = $ev->profiling_info ($name) |
|
|
1265 | |
|
|
1266 | See C<< $platform->info >> for details. |
|
|
1267 | |
|
|
1268 | The reason this method is not called C<info> is that there already is an |
|
|
1269 | C<< ->info >> method. |
|
|
1270 | |
638 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> |
1271 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html> |
|
|
1272 | |
|
|
1273 | =for gengetinfo begin profiling |
|
|
1274 | |
|
|
1275 | =item $ulong = $event->profiling_command_queued |
|
|
1276 | |
|
|
1277 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. |
|
|
1278 | |
|
|
1279 | =item $ulong = $event->profiling_command_submit |
|
|
1280 | |
|
|
1281 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. |
|
|
1282 | |
|
|
1283 | =item $ulong = $event->profiling_command_start |
|
|
1284 | |
|
|
1285 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. |
|
|
1286 | |
|
|
1287 | =item $ulong = $event->profiling_command_end |
|
|
1288 | |
|
|
1289 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. |
|
|
1290 | |
|
|
1291 | =for gengetinfo end profiling |
639 | |
1292 | |
640 | =back |
1293 | =back |
641 | |
1294 | |
642 | =head2 THE OpenCL::UserEvent CLASS |
1295 | =head2 THE OpenCL::UserEvent CLASS |
643 | |
1296 | |
… | |
… | |
656 | package OpenCL; |
1309 | package OpenCL; |
657 | |
1310 | |
658 | use common::sense; |
1311 | use common::sense; |
659 | |
1312 | |
660 | BEGIN { |
1313 | BEGIN { |
661 | our $VERSION = '0.14'; |
1314 | our $VERSION = '0.92'; |
662 | |
1315 | |
663 | require XSLoader; |
1316 | require XSLoader; |
664 | XSLoader::load (__PACKAGE__, $VERSION); |
1317 | XSLoader::load (__PACKAGE__, $VERSION); |
665 | |
1318 | |
666 | @OpenCL::Buffer::ISA = |
1319 | @OpenCL::Buffer::ISA = |
667 | @OpenCL::Image::ISA = OpenCL::Memory::; |
1320 | @OpenCL::Image::ISA = OpenCL::Memory::; |
668 | |
1321 | |
|
|
1322 | @OpenCL::BufferObj::ISA = OpenCL::Buffer::; |
|
|
1323 | |
669 | @OpenCL::Image2D::ISA = |
1324 | @OpenCL::Image2D::ISA = |
670 | @OpenCL::Image3D::ISA = OpenCL::Image::; |
1325 | @OpenCL::Image3D::ISA = OpenCL::Image::; |
671 | |
1326 | |
672 | @OpenCL::UserEvent::ISA = OpenCL::Event::; |
1327 | @OpenCL::UserEvent::ISA = OpenCL::Event::; |
673 | } |
1328 | } |
674 | |
1329 | |
675 | 1; |
1330 | 1; |
676 | |
1331 | |
677 | =head1 AUTHOR |
1332 | =head1 AUTHOR |