GLAPI/glDrawArraysIndirect: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Bot: Adjusting API page category.
Better indices specification.
 
(7 intermediate revisions by 2 users not shown)
Line 9: Line 9:
== Function Definition ==
== Function Definition ==


   void '''glDrawArraysIndirect'''(GLenum ''mode'', const void *''indirect'');
   void '''glDrawArraysIndirect'''(GLenum {{param|mode}}, const void *{{param|indirect}});


; mode
; mode
: Specifies what kind of primitives to render. Symbolic constants {{code|GL_POINTS}}, {{code|GL_LINE_STRIP}}, {{code|GL_LINE_LOOP}}, {{code|GL_LINES}}, {{code|GL_LINE_STRIP_ADJACENCY}}, {{code|GL_LINES_ADJACENCY}}, {{code|GL_TRIANGLE_STRIP}}, {{code|GL_TRIANGLE_FAN}}, {{code|GL_TRIANGLES}}, {{code|GL_TRIANGLE_STRIP_ADJACENCY}}, {{code|GL_TRIANGLES_ADJACENCY}}, and {{code|GL_PATCHES}} are accepted.
: Specifies what kind of primitives to render. Symbolic constants {{enum|GL_POINTS}}, {{enum|GL_LINE_STRIP}}, {{enum|GL_LINE_LOOP}}, {{enum|GL_LINES}}, {{enum|GL_LINE_STRIP_ADJACENCY}}, {{enum|GL_LINES_ADJACENCY}}, {{enum|GL_TRIANGLE_STRIP}}, {{enum|GL_TRIANGLE_FAN}}, {{enum|GL_TRIANGLES}}, {{enum|GL_TRIANGLE_STRIP_ADJACENCY}}, {{enum|GL_TRIANGLES_ADJACENCY}}, and {{enum|GL_PATCHES}} are accepted.
; indirect
; indirect
: Specifies the address of a structure containing the draw parameters.
: Specifies a byte offset (cast to a pointer type) into the buffer bound to {{enum|GL_DRAW_INDIRECT_BUFFER}}, which designates the starting point of the structure containing the draw parameters.


== Description ==
== Description ==


'''glDrawArraysIndirect''' specifies multiple geometric primitives with very few subroutine calls. '''glDrawArraysIndirect''' behaves similarly to [[GLAPI/glDrawArraysInstancedBaseInstance|glDrawArraysInstancedBaseInstance]], execept that the parameters to [[GLAPI/glDrawArraysInstancedBaseInstance|glDrawArraysInstancedBaseInstance]] are stored in memory at the address given by ''indirect''.
'''glDrawArraysIndirect''' specifies multiple geometric primitives with very few subroutine calls. '''glDrawArraysIndirect''' behaves similarly to {{apifunc|glDrawArraysInstancedBaseInstance}}, except that the parameters to {{apifunc|glDrawArraysInstancedBaseInstance}} are stored in the buffer bound to {{enum|GL_DRAW_INDIRECT_BUFFER}}, offset by {{param|indirect}} bytes.


The parameters addressed by ''indirect'' are packed into a structure that takes the form (in C):  
The parameters referenced by {{param|indirect}} are packed into a structure that takes the form (in C):  


<source lang="cpp">
<source lang="cpp">
     typedef  struct {
     typedef  struct {
         uint  count;
         uint  count;
         uint  primCount;
         uint  instanceCount;
         uint  first;
         uint  first;
         uint  baseInstance;
         uint  baseInstance;
Line 31: Line 31:


     const DrawArraysIndirectCommand  *cmd  = (const DrawArraysIndirectCommand  *)indirect;
     const DrawArraysIndirectCommand  *cmd  = (const DrawArraysIndirectCommand  *)indirect;
     glDrawArraysInstancedBaseInstance(mode,  cmd->first,  cmd->count,  cmd->primCount, cmd->baseInstance);
     glDrawArraysInstancedBaseInstance(mode,  cmd->first,  cmd->count,  cmd->instanceCount, cmd->baseInstance);
</source>
</source>


If a buffer is bound to the {{code|GL_DRAW_INDIRECT_BUFFER}} binding at the time of a call to '''glDrawArraysIndirect''', ''indirect'' is interpreted as an offset, in basic machine units, into that buffer and the parameter data is read from the buffer rather than from client memory.
{{param|indirect}} is interpreted as an offset, in basic machine units, into the buffer bound to {{enum|GL_DRAW_INDIRECT_BUFFER}} at the time of the call. The parameter data stored there is read from the buffer and executed.


In contrast to [[GLAPI/glDrawArraysInstancedBaseInstance|glDrawArraysInstancedBaseInstance]], the {{code|first}} member of the parameter structure is unsigned, and out-of-range indices do not generate an error.
In contrast to {{apifunc|glDrawArraysInstancedBaseInstance}}, the {{code|first}} member of the parameter structure is unsigned, and out-of-range indices do not generate an error.


Vertex attributes that are modified by '''glDrawArraysIndirect''' have an unspecified value after '''glDrawArraysIndirect''' returns. Attributes that aren't modified remain well defined.
Vertex attributes that are modified by '''glDrawArraysIndirect''' have an unspecified value after '''glDrawArraysIndirect''' returns. Attributes that aren't modified remain well defined.
Line 42: Line 42:
== Notes ==
== Notes ==


The ''baseInstance'' member of the ''DrawArraysIndirectCommand'' structure is defined only if the GL version is 4.2 or greater. For versions of the GL less than 4.2, this parameter is present but is reserved and should be set to zero. On earlier versions of the GL, behavior is undefined if it is non-zero.
The {{param|baseInstance}} member of the {{param|DrawArraysIndirectCommand}} structure is defined only if the GL version is 4.2 or greater. For versions of the GL less than 4.2, this parameter is present but is reserved and should be set to zero. On earlier versions of the GL, behavior is undefined if it is non-zero.


== Errors ==
== Errors ==


{{code|GL_INVALID_ENUM}} is generated if ''mode'' is not an accepted value.
{{enum|GL_INVALID_ENUM}} is generated if {{param|mode}} is not an accepted value.


{{code|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to an enabled array or to the {{code|GL_DRAW_INDIRECT_BUFFER}} binding and the buffer object's data store is currently mapped.
{{enum|GL_INVALID_OPERATION}} is generated if buffer object name zero is bound to the {{enum|GL_DRAW_INDIRECT_BUFFER}} binding.


{{code|GL_INVALID_OPERATION}} is generated if a geometry shader is active and ''mode'' is incompatible with the input primitive type of the geometry shader in the currently installed program object.
{{enum|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to an enabled array or to the {{enum|GL_DRAW_INDIRECT_BUFFER}} binding and the buffer object's data store is currently mapped.


{{code|GL_INVALID_OPERATION}} is generated if ''mode'' is {{code|GL_PATCHES}} and no tessellation control shader is active.
{{enum|GL_INVALID_OPERATION}} is generated if a geometry shader is active and {{param|mode}} is incompatible with the input primitive type of the geometry shader in the currently installed program object.
 
{{enum|GL_INVALID_OPERATION}} is generated if {{param|mode}} is {{enum|GL_PATCHES}} and no tessellation control shader is active.


== See Also ==
== See Also ==


[[GLAPI/glDrawArrays|glDrawArrays]], [[GLAPI/glDrawArraysInstanced|glDrawArraysInstanced]], [[GLAPI/glDrawElements|glDrawElements]], [[GLAPI/glDrawRangeElements|glDrawRangeElements]],
{{apifunc|glBindVertexArray}}, {{apifunc|glDrawArrays}}, {{apifunc|glDrawArraysInstanced}}, {{apifunc|glDrawArraysInstancedBaseInstance}}, {{apifunc|glDrawElementsIndirect}}, {{apifunc|glMultiDrawArrays}}, {{apifunc|glMultiDrawArraysIndirect}}


== Copyright ==
== Copyright ==
Line 62: Line 64:
Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].
Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].


[[Category:API Reference 4|DrawArraysIndirect]]
[[Category:Core API Ref Vertex Rendering|DrawArraysIndirect]]
[[Category:GL 4 API Vertex Rendering|DrawArraysIndirect]]
[[Category:Core API Reference|DrawArraysIndirect]]

Latest revision as of 04:30, 31 July 2013

glDrawArraysIndirect
Core in version 4.6
Core since version 4.0
Core ARB extension ARB_draw_indirect

glDrawArraysIndirect: render primitives from array data, taking parameters from memory

Function Definition

 void glDrawArraysIndirect(GLenum mode​, const void *indirect​);
mode
Specifies what kind of primitives to render. Symbolic constants GL_POINTS, GL_LINE_STRIP, GL_LINE_LOOP, GL_LINES, GL_LINE_STRIP_ADJACENCY, GL_LINES_ADJACENCY, GL_TRIANGLE_STRIP, GL_TRIANGLE_FAN, GL_TRIANGLES, GL_TRIANGLE_STRIP_ADJACENCY, GL_TRIANGLES_ADJACENCY, and GL_PATCHES are accepted.
indirect
Specifies a byte offset (cast to a pointer type) into the buffer bound to GL_DRAW_INDIRECT_BUFFER, which designates the starting point of the structure containing the draw parameters.

Description

glDrawArraysIndirect specifies multiple geometric primitives with very few subroutine calls. glDrawArraysIndirect behaves similarly to glDrawArraysInstancedBaseInstance, except that the parameters to glDrawArraysInstancedBaseInstance are stored in the buffer bound to GL_DRAW_INDIRECT_BUFFER, offset by indirect​ bytes.

The parameters referenced by indirect​ are packed into a structure that takes the form (in C): 

    typedef  struct {
        uint  count;
        uint  instanceCount;
        uint  first;
        uint  baseInstance;
    } DrawArraysIndirectCommand;

    const DrawArraysIndirectCommand  *cmd  = (const DrawArraysIndirectCommand  *)indirect;
    glDrawArraysInstancedBaseInstance(mode,  cmd->first,  cmd->count,  cmd->instanceCount, cmd->baseInstance);

indirect​ is interpreted as an offset, in basic machine units, into the buffer bound to GL_DRAW_INDIRECT_BUFFER at the time of the call. The parameter data stored there is read from the buffer and executed.

In contrast to glDrawArraysInstancedBaseInstance, the first member of the parameter structure is unsigned, and out-of-range indices do not generate an error.

Vertex attributes that are modified by glDrawArraysIndirect have an unspecified value after glDrawArraysIndirect returns. Attributes that aren't modified remain well defined.

Notes

The baseInstance​ member of the DrawArraysIndirectCommand​ structure is defined only if the GL version is 4.2 or greater. For versions of the GL less than 4.2, this parameter is present but is reserved and should be set to zero. On earlier versions of the GL, behavior is undefined if it is non-zero.

Errors

GL_INVALID_ENUM is generated if mode​ is not an accepted value.

GL_INVALID_OPERATION is generated if buffer object name zero is bound to the GL_DRAW_INDIRECT_BUFFER binding.

GL_INVALID_OPERATION is generated if a non-zero buffer object name is bound to an enabled array or to the GL_DRAW_INDIRECT_BUFFER binding and the buffer object's data store is currently mapped.

GL_INVALID_OPERATION is generated if a geometry shader is active and mode​ is incompatible with the input primitive type of the geometry shader in the currently installed program object.

GL_INVALID_OPERATION is generated if mode​ is GL_PATCHES and no tessellation control shader is active.

See Also

glBindVertexArray, glDrawArrays, glDrawArraysInstanced, glDrawArraysInstancedBaseInstance, glDrawElementsIndirect, glMultiDrawArrays, glMultiDrawArraysIndirect

Copyright

Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glDrawArraysIndirect&oldid=10804"