Browse code

Add readme example

Robert Cranston authored on 12/02/2023 18:51:14
Showing 1 changed files

... ...
@@ -158,6 +158,48 @@ Environment variables:
158 158
     Defaults to `ms=01;31:fn=35:ln=32:se=36:ve=01;34:ex=34:un=01;33`.
159 159
 ```
160 160
 
161
+## Examples
162
+
163
+The following example demonstrates exploring the OpenGL API starting from code
164
+in a repository.
165
+
166
+```
167
+$ glregistry audit-tree example-repo
168
+4.6,GL_ARB_texture_filter_anisotropic,GL_EXT_texture_filter_anisotropic
169
+  GL_TEXTURE_MAX_ANISOTROPY
170
+    src/gltexture.cpp:3:17
171
+
172
+$ glregistry exts-all GL_TEXTURE_MAX_ANISOTROPY
173
+GL_ARB_sampler_objects
174
+GL_ARB_texture_filter_anisotropic
175
+GL_EXT_texture_filter_anisotropic
176
+
177
+$ glregistry groups GL_TEXTURE_MAX_ANISOTROPY
178
+SamplerParameterF
179
+TextureParameterName
180
+
181
+$ glregistry enums-tree SamplerParameterF
182
+1.0
183
+  GL_TEXTURE_BORDER_COLOR
184
+1.2
185
+  GL_TEXTURE_MAX_LOD
186
+  GL_TEXTURE_MIN_LOD
187
+1.4,GL_EXT_texture_lod_bias
188
+  GL_TEXTURE_LOD_BIAS
189
+4.6,GL_ARB_texture_filter_anisotropic,GL_EXT_texture_filter_anisotropic
190
+  GL_TEXTURE_MAX_ANISOTROPY
191
+
192
+$ glregistry params-tree SamplerParameterF
193
+pname:3
194
+  3.3,GL_ARB_sampler_objects
195
+    glGetSamplerParameterfv
196
+    glSamplerParameterf
197
+    glSamplerParameterfv
198
+
199
+$ glregistry refs glSamplerParameter
200
+https://registry.khronos.org/OpenGL-Refpages/gl4/html/glSamplerParameter.xhtml
201
+```
202
+
161 203
 ## References
162 204
 
163 205
 Note that some of these might be out of date.