glDispatchCompute - launch one or more compute work groups

Associated Gets

glGet() with argument GL_MAX_COMPUTE_WORK_GROUP_COUNT

C Specification

voidglDispatchCompute(GLuintnum_groups_x,GLuintnum_groups_y,GLuintnum_groups_z);

Copyright

       Copyright © 2013-2014 Khronos Group

[FIXME: source]                                    11/18/2024                              GLDISPATCHCOMPUTE(3G)

Description

glDispatchCompute launches one or more compute work groups. Each work group is processed by the active
       program object for the compute shader stage. While the individual shader invocations within a work group
       are executed as a unit, work groups are executed completely independently and in unspecified order.
       num_groups_x, num_groups_y and num_groups_z specify the number of local work groups that will be
       dispatched in the X, Y and Z dimensions, respectively.

Errors

GL_INVALID_OPERATION is generated if there is no active program for the compute shader stage.

       GL_INVALID_VALUE is generated if any of num_groups_x, num_groups_y, or num_groups_z is greater than or
       equal to the maximum work-group count for the corresponding dimension.

Name

       glDispatchCompute - launch one or more compute work groups

Parameters

num_groups_x
           The number of work groups to be launched in the X dimension.

       num_groups_y
           The number of work groups to be launched in the Y dimension.

       num_groups_z
           The number of work groups to be launched in the Z dimension.

Version Support

       ┌───────────────────┬───────────────────────────────────────────────────────────────────────┐
       │                   │                OpenGLVersion                                         │
       ├───────────────────┼─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┤
       │ Function          │ 2.0 │ 2.1 │ 3.0 │ 3.1 │ 3.2 │ 3.3 │ 4.0 │ 4.1 │ 4.2 │ 4.3 │ 4.4 │ 4.5 │
       │ /                 │     │     │     │     │     │     │     │     │     │     │     │     │
       │ Feature           │     │     │     │     │     │     │     │     │     │     │     │     │
       │ Name              │     │     │     │     │     │     │     │     │     │     │     │     │
       ├───────────────────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
       │ glDispatchCompute │  -  │  -  │  -  │  -  │  -  │  -  │  -  │  -  │  -  │  ✔  │  ✔  │  ✔  │
       └───────────────────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘