oracular (3) workItemFunctions.3clc.gz

Provided by: opencl-1.2-man-doc_1.0~svn33624-5_all bug

NAME
       Work-Item_Built-In_Functions - Click an item in the table below for details about that function.

       ┌────────────────────────┬─────────────────────────────┐
       │get_work_dim(3clc)      │ Number of dimensions in use │
       ├────────────────────────┼─────────────────────────────┤
       │get_global_size(3clc)   │ Number of global work items │
       ├────────────────────────┼─────────────────────────────┤
       │get_global_id(3clc)     │ Global work item ID value   │
       ├────────────────────────┼─────────────────────────────┤
       │get_local_size(3clc)    │ Number of local work items  │
       ├────────────────────────┼─────────────────────────────┤
       │get_local_id(3clc)      │ Local work item ID          │
       ├────────────────────────┼─────────────────────────────┤
       │get_num_groups(3clc)    │ Number of work groups       │
       ├────────────────────────┼─────────────────────────────┤
       │get_group_id(3clc)      │ Work group ID               │
       ├────────────────────────┼─────────────────────────────┤
       │get_global_offset(3clc) │ Work offset                 │
       └────────────────────────┴─────────────────────────────┘


DESCRIPTION
       Built-in work-item functions can be used to query the number of dimensions, the global and local work
       size specified to clEnqueueNDRangeKernel(3clc), and the global and local identifier of each work-item
       when this kernel is being executed on a device. The number of dimensions, the global and local work size
       when executing a kernel using the function clEnqueueTask(3clc) is one.


SPECIFICATION
       OpenCL Specification[1]


SEE ALSO
       clEnqueueNDRangeKernel(3clc), clEnqueueTask(3clc)


AUTHORS
       The Khronos Group


       Copyright © 2007-2011 The Khronos Group Inc.
       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or
       associated documentation files (the "Materials"), to deal in the Materials without restriction, including
       without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to
       the condition that this copyright notice and permission notice shall be included in all copies or
       substantial portions of the Materials.


NOTES
        1. OpenCL Specification
           page 242, section 6.12.1 - Work-Item Functions