HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
| 3 | <!-- saved from url=(0013)about:internet --> | |
| 4 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glBufferData - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glBufferData"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBufferData — creates and initializes a buffer object's data store</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glBufferData</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLsizeiptr </td><td><var class="pdparam">size</var>, </td></tr><tr><td> </td><td>const GLvoid * </td><td><var class="pdparam">data</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">usage</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p> | |
| 5 | Specifies the target buffer object. | |
| 6 | The symbolic constant must be | |
| 7 | <code class="constant">GL_ARRAY_BUFFER</code>, | |
| 8 | <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>, | |
| 9 | <code class="constant">GL_COPY_READ_BUFFER</code>, | |
| 10 | <code class="constant">GL_COPY_WRITE_BUFFER</code>, | |
| 11 | <code class="constant">GL_DRAW_INDIRECT_BUFFER</code>, | |
| 12 | <code class="constant">GL_DISPATCH_INDIRECT_BUFFER</code>, | |
| 13 | <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>, | |
| 14 | <code class="constant">GL_PIXEL_PACK_BUFFER</code>, | |
| 15 | <code class="constant">GL_PIXEL_UNPACK_BUFFER</code>, | |
| 16 | <code class="constant">GL_SHADER_STORAGE_BUFFER</code>, | |
| 17 | <code class="constant">GL_TEXTURE_BUFFER</code>, | |
| 18 | <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>, or | |
| 19 | <code class="constant">GL_UNIFORM_BUFFER</code>. | |
| 20 | </p></dd><dt><span class="term"><em class="parameter"><code>size</code></em></span></dt><dd><p> | |
| 21 | Specifies the size in bytes of the buffer object's new data store. | |
| 22 | </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p> | |
| 23 | Specifies a pointer to data that will be copied into the data store for initialization, | |
| 24 | or <code class="constant">NULL</code> if no data is to be copied. | |
| 25 | </p></dd><dt><span class="term"><em class="parameter"><code>usage</code></em></span></dt><dd><p> | |
| 26 | Specifies the expected usage pattern of the data store. The symbolic constant must be | |
| 27 | <code class="constant">GL_STREAM_DRAW</code>, <code class="constant">GL_STREAM_READ</code>, <code class="constant">GL_STREAM_COPY</code>, | |
| 28 | <code class="constant">GL_STATIC_DRAW</code>, <code class="constant">GL_STATIC_READ</code>, <code class="constant">GL_STATIC_COPY</code>, | |
| 29 | <code class="constant">GL_DYNAMIC_DRAW</code>, <code class="constant">GL_DYNAMIC_READ</code>, or <code class="constant">GL_DYNAMIC_COPY</code>. | |
| 30 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
| 31 | <code class="function">glBufferData</code> creates a new data store for the buffer object currently bound to | |
| 32 | <em class="parameter"><code>target</code></em>. Any pre-existing data store is deleted. The new data store is created with the | |
| 33 | specified <em class="parameter"><code>size</code></em> in bytes and <em class="parameter"><code>usage</code></em>. If <em class="parameter"><code>data</code></em> | |
| 34 | is not <code class="constant">NULL</code>, the data store is initialized with data from this pointer. In its initial | |
| 35 | state, the new data store is not mapped, it has a <code class="constant">NULL</code> mapped pointer, and its mapped access | |
| 36 | is <code class="constant">GL_READ_WRITE</code>. | |
| 37 | </p><p> | |
| 38 | <em class="parameter"><code>usage</code></em> is a hint to the GL implementation as to how a buffer object's data store will be | |
| 39 | accessed. This enables the GL implementation to make more intelligent decisions that may significantly | |
| 40 | impact buffer object performance. It does not, however, constrain the actual usage of the data store. | |
| 41 | <em class="parameter"><code>usage</code></em> can be broken down into two parts: first, the frequency of access (modification | |
| 42 | and usage), and second, the nature of that access. The frequency of access may be one of these: | |
| 43 | </p><div class="variablelist"><dl><dt><span class="term">STREAM</span></dt><dd><p> | |
| 44 | The data store contents will be modified once and used at most a few times. | |
| 45 | </p></dd><dt><span class="term">STATIC</span></dt><dd><p> | |
| 46 | The data store contents will be modified once and used many times. | |
| 47 | </p></dd><dt><span class="term">DYNAMIC</span></dt><dd><p> | |
| 48 | The data store contents will be modified repeatedly and used many times. | |
| 49 | </p></dd></dl></div><p> | |
| 50 | The nature of access may be one of these: | |
| 51 | </p><div class="variablelist"><dl><dt><span class="term">DRAW</span></dt><dd><p> | |
| 52 | The data store contents are modified by the application, and used as the source for GL drawing and | |
| 53 | image specification commands. | |
| 54 | </p></dd><dt><span class="term">READ</span></dt><dd><p> | |
| 55 | The data store contents are modified by reading data from the GL, and used to return that data | |
| 56 | when queried by the application. | |
| 57 | </p></dd><dt><span class="term">COPY</span></dt><dd><p> | |
| 58 | The data store contents are modified by reading data from the GL, and used as the source for GL | |
| 59 | drawing and image specification commands. | |
| 60 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
| 61 | If <em class="parameter"><code>data</code></em> is <code class="constant">NULL</code>, a data store of the specified size is still created, | |
| 62 | but its contents remain uninitialized and thus undefined. | |
| 63 | </p><p> | |
| 64 | Clients must align data elements consistent with the requirements of the client | |
| 65 | platform, with an additional base-level requirement that an offset within a buffer to | |
| 66 | a datum comprising <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">N</mml:mi> bytes be a | |
| 67 | multiple of <mml:mi mathvariant="italic">N</mml:mi></mml:math>. | |
| 68 | </p><p> | |
| 69 | The <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code> target is available only if the GL version | |
| 70 | is 4.2 or greater. | |
| 71 | </p><p> | |
| 72 | The <code class="constant">GL_DISPATCH_INDIRECT_BUFFER</code> and <code class="constant">GL_SHADER_STORAGE_BUFFER</code> targets are available only if the GL version | |
| 73 | is 4.3 or greater. | |
| 74 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
| 75 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not | |
| 76 | one of the accepted buffer targets. | |
| 77 | </p><p> | |
| 78 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>usage</code></em> is not | |
| 79 | <code class="constant">GL_STREAM_DRAW</code>, <code class="constant">GL_STREAM_READ</code>, <code class="constant">GL_STREAM_COPY</code>, | |
| 80 | <code class="constant">GL_STATIC_DRAW</code>, <code class="constant">GL_STATIC_READ</code>, <code class="constant">GL_STATIC_COPY</code>, | |
| 81 | <code class="constant">GL_DYNAMIC_DRAW</code>, <code class="constant">GL_DYNAMIC_READ</code>, or <code class="constant">GL_DYNAMIC_COPY</code>. | |
| 82 | </p><p> | |
| 83 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>size</code></em> is negative. | |
| 84 | </p><p> | |
| 85 | <code class="constant">GL_INVALID_OPERATION</code> is generated if the reserved buffer object name 0 is bound to <em class="parameter"><code>target</code></em>. | |
| 86 | </p><p> | |
| 87 | <code class="constant">GL_OUT_OF_MEMORY</code> is generated if the GL is unable to create a data store with the specified <em class="parameter"><code>size</code></em>. | |
| 88 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
| 89 | <a href="glGetBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glGetBufferSubData</span></span></a> | |
| 90 | </p><p> | |
| 91 | <a href="glGetBufferParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetBufferParameter</span></span></a> with argument <code class="constant">GL_BUFFER_SIZE</code> or <code class="constant">GL_BUFFER_USAGE</code> | |
| 92 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
| 93 | <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>, | |
| 94 | <a href="glBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glBufferSubData</span></span></a>, | |
| 95 | <a href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>, | |
| 96 | <a href="glUnmapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a> | |
| 97 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 98 | Copyright <span class="trademark"></span>© 2005 Addison-Wesley. | |
| 99 | Copyright <span class="trademark"></span>© 2011-2012 Khronos Group. | |
| 100 | This material may be distributed subject to the terms and conditions set forth in | |
| 101 | the Open Publication License, v 1.0, 8 June 1999. | |
| 102 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 103 | </p></div></div></body></html> |