import "golang.org/x/mobile/gl"
Package gl implements Go bindings for OpenGL ES 2.
The bindings are deliberately minimal, staying as close the C API as possible. The semantics of each function maps onto functions described in the Khronos documentation:
https://www.khronos.org/opengles/sdk/docs/man/
One notable departure from the C API is the introduction of types to represent common uses of GLint: Texture, Surface, Buffer, etc.
A tracing version of the OpenGL bindings is behind the `gldebug` build tag. It acts as a simplified version of apitrace. Build your Go binary with
-tags gldebug
and each call to a GL function will log its input, output, and any error messages. For example,
I/GoLog (27668): gl.GenBuffers(1) [Buffer(70001)] I/GoLog (27668): gl.BindBuffer(ARRAY_BUFFER, Buffer(70001)) I/GoLog (27668): gl.BufferData(ARRAY_BUFFER, 36, len(36), STATIC_DRAW) I/GoLog (27668): gl.BindBuffer(ARRAY_BUFFER, Buffer(70001)) I/GoLog (27668): gl.VertexAttribPointer(Attrib(0), 6, FLOAT, false, 0, 0) error: [INVALID_VALUE]
The gldebug tracing has very high overhead, so make sure to remove the build tag before deploying any binaries.
consts.go doc.go fn.go gl.go interface.go types_prod.go work.go
const ( POINTS = 0x0000 LINES = 0x0001 LINE_LOOP = 0x0002 LINE_STRIP = 0x0003 TRIANGLES = 0x0004 TRIANGLE_STRIP = 0x0005 TRIANGLE_FAN = 0x0006 SRC_COLOR = 0x0300 ONE_MINUS_SRC_COLOR = 0x0301 SRC_ALPHA = 0x0302 ONE_MINUS_SRC_ALPHA = 0x0303 DST_ALPHA = 0x0304 ONE_MINUS_DST_ALPHA = 0x0305 DST_COLOR = 0x0306 ONE_MINUS_DST_COLOR = 0x0307 SRC_ALPHA_SATURATE = 0x0308 FUNC_ADD = 0x8006 BLEND_EQUATION = 0x8009 BLEND_EQUATION_RGB = 0x8009 BLEND_EQUATION_ALPHA = 0x883D FUNC_SUBTRACT = 0x800A FUNC_REVERSE_SUBTRACT = 0x800B BLEND_DST_RGB = 0x80C8 BLEND_SRC_RGB = 0x80C9 BLEND_DST_ALPHA = 0x80CA BLEND_SRC_ALPHA = 0x80CB CONSTANT_COLOR = 0x8001 ONE_MINUS_CONSTANT_COLOR = 0x8002 CONSTANT_ALPHA = 0x8003 ONE_MINUS_CONSTANT_ALPHA = 0x8004 BLEND_COLOR = 0x8005 ARRAY_BUFFER = 0x8892 ELEMENT_ARRAY_BUFFER = 0x8893 ARRAY_BUFFER_BINDING = 0x8894 ELEMENT_ARRAY_BUFFER_BINDING = 0x8895 STREAM_DRAW = 0x88E0 STATIC_DRAW = 0x88E4 DYNAMIC_DRAW = 0x88E8 BUFFER_SIZE = 0x8764 BUFFER_USAGE = 0x8765 CURRENT_VERTEX_ATTRIB = 0x8626 FRONT = 0x0404 BACK = 0x0405 FRONT_AND_BACK = 0x0408 TEXTURE_2D = 0x0DE1 CULL_FACE = 0x0B44 BLEND = 0x0BE2 DITHER = 0x0BD0 STENCIL_TEST = 0x0B90 DEPTH_TEST = 0x0B71 SCISSOR_TEST = 0x0C11 POLYGON_OFFSET_FILL = 0x8037 SAMPLE_ALPHA_TO_COVERAGE = 0x809E SAMPLE_COVERAGE = 0x80A0 INVALID_ENUM = 0x0500 INVALID_VALUE = 0x0501 INVALID_OPERATION = 0x0502 OUT_OF_MEMORY = 0x0505 CW = 0x0900 CCW = 0x0901 LINE_WIDTH = 0x0B21 ALIASED_POINT_SIZE_RANGE = 0x846D ALIASED_LINE_WIDTH_RANGE = 0x846E CULL_FACE_MODE = 0x0B45 FRONT_FACE = 0x0B46 DEPTH_RANGE = 0x0B70 DEPTH_WRITEMASK = 0x0B72 DEPTH_CLEAR_VALUE = 0x0B73 DEPTH_FUNC = 0x0B74 STENCIL_CLEAR_VALUE = 0x0B91 STENCIL_FUNC = 0x0B92 STENCIL_FAIL = 0x0B94 STENCIL_PASS_DEPTH_FAIL = 0x0B95 STENCIL_PASS_DEPTH_PASS = 0x0B96 STENCIL_REF = 0x0B97 STENCIL_VALUE_MASK = 0x0B93 STENCIL_WRITEMASK = 0x0B98 STENCIL_BACK_FUNC = 0x8800 STENCIL_BACK_FAIL = 0x8801 STENCIL_BACK_PASS_DEPTH_FAIL = 0x8802 STENCIL_BACK_PASS_DEPTH_PASS = 0x8803 STENCIL_BACK_REF = 0x8CA3 STENCIL_BACK_VALUE_MASK = 0x8CA4 STENCIL_BACK_WRITEMASK = 0x8CA5 VIEWPORT = 0x0BA2 SCISSOR_BOX = 0x0C10 COLOR_CLEAR_VALUE = 0x0C22 COLOR_WRITEMASK = 0x0C23 UNPACK_ALIGNMENT = 0x0CF5 PACK_ALIGNMENT = 0x0D05 MAX_TEXTURE_SIZE = 0x0D33 MAX_VIEWPORT_DIMS = 0x0D3A SUBPIXEL_BITS = 0x0D50 RED_BITS = 0x0D52 GREEN_BITS = 0x0D53 BLUE_BITS = 0x0D54 ALPHA_BITS = 0x0D55 DEPTH_BITS = 0x0D56 STENCIL_BITS = 0x0D57 POLYGON_OFFSET_UNITS = 0x2A00 POLYGON_OFFSET_FACTOR = 0x8038 TEXTURE_BINDING_2D = 0x8069 SAMPLE_BUFFERS = 0x80A8 SAMPLES = 0x80A9 SAMPLE_COVERAGE_VALUE = 0x80AA SAMPLE_COVERAGE_INVERT = 0x80AB NUM_COMPRESSED_TEXTURE_FORMATS = 0x86A2 COMPRESSED_TEXTURE_FORMATS = 0x86A3 DONT_CARE = 0x1100 FASTEST = 0x1101 NICEST = 0x1102 GENERATE_MIPMAP_HINT = 0x8192 BYTE = 0x1400 UNSIGNED_BYTE = 0x1401 SHORT = 0x1402 UNSIGNED_SHORT = 0x1403 INT = 0x1404 UNSIGNED_INT = 0x1405 FLOAT = 0x1406 FIXED = 0x140C DEPTH_COMPONENT = 0x1902 ALPHA = 0x1906 RGB = 0x1907 RGBA = 0x1908 LUMINANCE = 0x1909 LUMINANCE_ALPHA = 0x190A UNSIGNED_SHORT_4_4_4_4 = 0x8033 UNSIGNED_SHORT_5_5_5_1 = 0x8034 UNSIGNED_SHORT_5_6_5 = 0x8363 MAX_VERTEX_ATTRIBS = 0x8869 MAX_VERTEX_UNIFORM_VECTORS = 0x8DFB MAX_VARYING_VECTORS = 0x8DFC MAX_COMBINED_TEXTURE_IMAGE_UNITS = 0x8B4D MAX_VERTEX_TEXTURE_IMAGE_UNITS = 0x8B4C MAX_TEXTURE_IMAGE_UNITS = 0x8872 MAX_FRAGMENT_UNIFORM_VECTORS = 0x8DFD SHADER_TYPE = 0x8B4F DELETE_STATUS = 0x8B80 LINK_STATUS = 0x8B82 VALIDATE_STATUS = 0x8B83 ATTACHED_SHADERS = 0x8B85 ACTIVE_UNIFORMS = 0x8B86 ACTIVE_UNIFORM_MAX_LENGTH = 0x8B87 ACTIVE_ATTRIBUTES = 0x8B89 ACTIVE_ATTRIBUTE_MAX_LENGTH = 0x8B8A SHADING_LANGUAGE_VERSION = 0x8B8C CURRENT_PROGRAM = 0x8B8D NEVER = 0x0200 LESS = 0x0201 EQUAL = 0x0202 LEQUAL = 0x0203 GREATER = 0x0204 NOTEQUAL = 0x0205 GEQUAL = 0x0206 ALWAYS = 0x0207 KEEP = 0x1E00 REPLACE = 0x1E01 INCR = 0x1E02 DECR = 0x1E03 INVERT = 0x150A INCR_WRAP = 0x8507 DECR_WRAP = 0x8508 VENDOR = 0x1F00 RENDERER = 0x1F01 VERSION = 0x1F02 EXTENSIONS = 0x1F03 NEAREST = 0x2600 LINEAR = 0x2601 NEAREST_MIPMAP_NEAREST = 0x2700 LINEAR_MIPMAP_NEAREST = 0x2701 NEAREST_MIPMAP_LINEAR = 0x2702 LINEAR_MIPMAP_LINEAR = 0x2703 TEXTURE_MAG_FILTER = 0x2800 TEXTURE_MIN_FILTER = 0x2801 TEXTURE_WRAP_S = 0x2802 TEXTURE_WRAP_T = 0x2803 TEXTURE = 0x1702 TEXTURE_CUBE_MAP = 0x8513 TEXTURE_BINDING_CUBE_MAP = 0x8514 TEXTURE_CUBE_MAP_POSITIVE_X = 0x8515 TEXTURE_CUBE_MAP_NEGATIVE_X = 0x8516 TEXTURE_CUBE_MAP_POSITIVE_Y = 0x8517 TEXTURE_CUBE_MAP_NEGATIVE_Y = 0x8518 TEXTURE_CUBE_MAP_POSITIVE_Z = 0x8519 TEXTURE_CUBE_MAP_NEGATIVE_Z = 0x851A MAX_CUBE_MAP_TEXTURE_SIZE = 0x851C TEXTURE0 = 0x84C0 TEXTURE1 = 0x84C1 TEXTURE2 = 0x84C2 TEXTURE3 = 0x84C3 TEXTURE4 = 0x84C4 TEXTURE5 = 0x84C5 TEXTURE6 = 0x84C6 TEXTURE7 = 0x84C7 TEXTURE8 = 0x84C8 TEXTURE9 = 0x84C9 TEXTURE10 = 0x84CA TEXTURE11 = 0x84CB TEXTURE12 = 0x84CC TEXTURE13 = 0x84CD TEXTURE14 = 0x84CE TEXTURE15 = 0x84CF TEXTURE16 = 0x84D0 TEXTURE17 = 0x84D1 TEXTURE18 = 0x84D2 TEXTURE19 = 0x84D3 TEXTURE20 = 0x84D4 TEXTURE21 = 0x84D5 TEXTURE22 = 0x84D6 TEXTURE23 = 0x84D7 TEXTURE24 = 0x84D8 TEXTURE25 = 0x84D9 TEXTURE26 = 0x84DA TEXTURE27 = 0x84DB TEXTURE28 = 0x84DC TEXTURE29 = 0x84DD TEXTURE30 = 0x84DE TEXTURE31 = 0x84DF ACTIVE_TEXTURE = 0x84E0 REPEAT = 0x2901 CLAMP_TO_EDGE = 0x812F MIRRORED_REPEAT = 0x8370 VERTEX_ATTRIB_ARRAY_ENABLED = 0x8622 VERTEX_ATTRIB_ARRAY_SIZE = 0x8623 VERTEX_ATTRIB_ARRAY_STRIDE = 0x8624 VERTEX_ATTRIB_ARRAY_TYPE = 0x8625 VERTEX_ATTRIB_ARRAY_NORMALIZED = 0x886A VERTEX_ATTRIB_ARRAY_POINTER = 0x8645 VERTEX_ATTRIB_ARRAY_BUFFER_BINDING = 0x889F IMPLEMENTATION_COLOR_READ_TYPE = 0x8B9A IMPLEMENTATION_COLOR_READ_FORMAT = 0x8B9B COMPILE_STATUS = 0x8B81 INFO_LOG_LENGTH = 0x8B84 SHADER_SOURCE_LENGTH = 0x8B88 SHADER_COMPILER = 0x8DFA SHADER_BINARY_FORMATS = 0x8DF8 NUM_SHADER_BINARY_FORMATS = 0x8DF9 LOW_FLOAT = 0x8DF0 MEDIUM_FLOAT = 0x8DF1 HIGH_FLOAT = 0x8DF2 LOW_INT = 0x8DF3 MEDIUM_INT = 0x8DF4 HIGH_INT = 0x8DF5 FRAMEBUFFER = 0x8D40 RENDERBUFFER = 0x8D41 RGBA4 = 0x8056 RGB5_A1 = 0x8057 RGB565 = 0x8D62 DEPTH_COMPONENT16 = 0x81A5 STENCIL_INDEX8 = 0x8D48 RENDERBUFFER_WIDTH = 0x8D42 RENDERBUFFER_HEIGHT = 0x8D43 RENDERBUFFER_INTERNAL_FORMAT = 0x8D44 RENDERBUFFER_RED_SIZE = 0x8D50 RENDERBUFFER_GREEN_SIZE = 0x8D51 RENDERBUFFER_BLUE_SIZE = 0x8D52 RENDERBUFFER_ALPHA_SIZE = 0x8D53 RENDERBUFFER_DEPTH_SIZE = 0x8D54 RENDERBUFFER_STENCIL_SIZE = 0x8D55 FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE = 0x8CD0 FRAMEBUFFER_ATTACHMENT_OBJECT_NAME = 0x8CD1 FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL = 0x8CD2 FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE = 0x8CD3 COLOR_ATTACHMENT0 = 0x8CE0 DEPTH_ATTACHMENT = 0x8D00 STENCIL_ATTACHMENT = 0x8D20 FRAMEBUFFER_COMPLETE = 0x8CD5 FRAMEBUFFER_INCOMPLETE_ATTACHMENT = 0x8CD6 FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT = 0x8CD7 FRAMEBUFFER_INCOMPLETE_DIMENSIONS = 0x8CD9 FRAMEBUFFER_UNSUPPORTED = 0x8CDD FRAMEBUFFER_BINDING = 0x8CA6 RENDERBUFFER_BINDING = 0x8CA7 MAX_RENDERBUFFER_SIZE = 0x84E8 INVALID_FRAMEBUFFER_OPERATION = 0x0506 )
const ( DEPTH_BUFFER_BIT = 0x00000100 STENCIL_BUFFER_BIT = 0x00000400 COLOR_BUFFER_BIT = 0x00004000 )
const ( FLOAT_VEC2 = 0x8B50 FLOAT_VEC3 = 0x8B51 FLOAT_VEC4 = 0x8B52 INT_VEC2 = 0x8B53 INT_VEC3 = 0x8B54 INT_VEC4 = 0x8B55 BOOL = 0x8B56 BOOL_VEC2 = 0x8B57 BOOL_VEC3 = 0x8B58 BOOL_VEC4 = 0x8B59 FLOAT_MAT2 = 0x8B5A FLOAT_MAT3 = 0x8B5B FLOAT_MAT4 = 0x8B5C SAMPLER_2D = 0x8B5E SAMPLER_CUBE = 0x8B60 )
const ( FRAGMENT_SHADER = 0x8B30 VERTEX_SHADER = 0x8B31 )
const ( FALSE = 0 TRUE = 1 ZERO = 0 ONE = 1 NO_ERROR = 0 NONE = 0 )
Attrib identifies the location of a specific attribute variable.
Buffer identifies a GL buffer object.
type Context interface { // ActiveTexture sets the active texture unit. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glActiveTexture.xhtml ActiveTexture(texture Enum) // AttachShader attaches a shader to a program. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glAttachShader.xhtml AttachShader(p Program, s Shader) // BindAttribLocation binds a vertex attribute index with a named // variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBindAttribLocation.xhtml BindAttribLocation(p Program, a Attrib, name string) // BindBuffer binds a buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBindBuffer.xhtml BindBuffer(target Enum, b Buffer) // BindFramebuffer binds a framebuffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBindFramebuffer.xhtml BindFramebuffer(target Enum, fb Framebuffer) // BindRenderbuffer binds a render buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBindRenderbuffer.xhtml BindRenderbuffer(target Enum, rb Renderbuffer) // BindTexture binds a texture. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBindTexture.xhtml BindTexture(target Enum, t Texture) // BlendColor sets the blend color. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBlendColor.xhtml BlendColor(red, green, blue, alpha float32) // BlendEquation sets both RGB and alpha blend equations. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBlendEquation.xhtml BlendEquation(mode Enum) // BlendEquationSeparate sets RGB and alpha blend equations separately. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBlendEquationSeparate.xhtml BlendEquationSeparate(modeRGB, modeAlpha Enum) // BlendFunc sets the pixel blending factors. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBlendFunc.xhtml BlendFunc(sfactor, dfactor Enum) // BlendFunc sets the pixel RGB and alpha blending factors separately. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBlendFuncSeparate.xhtml BlendFuncSeparate(sfactorRGB, dfactorRGB, sfactorAlpha, dfactorAlpha Enum) // BufferData creates a new data store for the bound buffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBufferData.xhtml BufferData(target Enum, src []byte, usage Enum) // BufferInit creates a new uninitialized data store for the bound buffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBufferData.xhtml BufferInit(target Enum, size int, usage Enum) // BufferSubData sets some of data in the bound buffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glBufferSubData.xhtml BufferSubData(target Enum, offset int, data []byte) // CheckFramebufferStatus reports the completeness status of the // active framebuffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCheckFramebufferStatus.xhtml CheckFramebufferStatus(target Enum) Enum // Clear clears the window. // // The behavior of Clear is influenced by the pixel ownership test, // the scissor test, dithering, and the buffer writemasks. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glClear.xhtml Clear(mask Enum) // ClearColor specifies the RGBA values used to clear color buffers. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glClearColor.xhtml ClearColor(red, green, blue, alpha float32) // ClearDepthf sets the depth value used to clear the depth buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glClearDepthf.xhtml ClearDepthf(d float32) // ClearStencil sets the index used to clear the stencil buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glClearStencil.xhtml ClearStencil(s int) // ColorMask specifies whether color components in the framebuffer // can be written. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glColorMask.xhtml ColorMask(red, green, blue, alpha bool) // CompileShader compiles the source code of s. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCompileShader.xhtml CompileShader(s Shader) // CompressedTexImage2D writes a compressed 2D texture. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCompressedTexImage2D.xhtml CompressedTexImage2D(target Enum, level int, internalformat Enum, width, height, border int, data []byte) // CompressedTexSubImage2D writes a subregion of a compressed 2D texture. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCompressedTexSubImage2D.xhtml CompressedTexSubImage2D(target Enum, level, xoffset, yoffset, width, height int, format Enum, data []byte) // CopyTexImage2D writes a 2D texture from the current framebuffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCopyTexImage2D.xhtml CopyTexImage2D(target Enum, level int, internalformat Enum, x, y, width, height, border int) // CopyTexSubImage2D writes a 2D texture subregion from the // current framebuffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCopyTexSubImage2D.xhtml CopyTexSubImage2D(target Enum, level, xoffset, yoffset, x, y, width, height int) // CreateBuffer creates a buffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGenBuffers.xhtml CreateBuffer() Buffer // CreateFramebuffer creates a framebuffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGenFramebuffers.xhtml CreateFramebuffer() Framebuffer // CreateProgram creates a new empty program object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCreateProgram.xhtml CreateProgram() Program // CreateRenderbuffer create a renderbuffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGenRenderbuffers.xhtml CreateRenderbuffer() Renderbuffer // CreateShader creates a new empty shader object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCreateShader.xhtml CreateShader(ty Enum) Shader // CreateTexture creates a texture object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGenTextures.xhtml CreateTexture() Texture // CullFace specifies which polygons are candidates for culling. // // Valid modes: FRONT, BACK, FRONT_AND_BACK. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glCullFace.xhtml CullFace(mode Enum) // DeleteBuffer deletes the given buffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDeleteBuffers.xhtml DeleteBuffer(v Buffer) // DeleteFramebuffer deletes the given framebuffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDeleteFramebuffers.xhtml DeleteFramebuffer(v Framebuffer) // DeleteProgram deletes the given program object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDeleteProgram.xhtml DeleteProgram(p Program) // DeleteRenderbuffer deletes the given render buffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDeleteRenderbuffers.xhtml DeleteRenderbuffer(v Renderbuffer) // DeleteShader deletes shader s. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDeleteShader.xhtml DeleteShader(s Shader) // DeleteTexture deletes the given texture object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDeleteTextures.xhtml DeleteTexture(v Texture) // DepthFunc sets the function used for depth buffer comparisons. // // Valid fn values: // NEVER // LESS // EQUAL // LEQUAL // GREATER // NOTEQUAL // GEQUAL // ALWAYS // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDepthFunc.xhtml DepthFunc(fn Enum) // DepthMask sets the depth buffer enabled for writing. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDepthMask.xhtml DepthMask(flag bool) // DepthRangef sets the mapping from normalized device coordinates to // window coordinates. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDepthRangef.xhtml DepthRangef(n, f float32) // DetachShader detaches the shader s from the program p. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDetachShader.xhtml DetachShader(p Program, s Shader) // Disable disables various GL capabilities. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDisable.xhtml Disable(cap Enum) // DisableVertexAttribArray disables a vertex attribute array. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDisableVertexAttribArray.xhtml DisableVertexAttribArray(a Attrib) // DrawArrays renders geometric primitives from the bound data. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDrawArrays.xhtml DrawArrays(mode Enum, first, count int) // DrawElements renders primitives from a bound buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glDrawElements.xhtml DrawElements(mode Enum, count int, ty Enum, offset int) // Enable enables various GL capabilities. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glEnable.xhtml Enable(cap Enum) // EnableVertexAttribArray enables a vertex attribute array. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glEnableVertexAttribArray.xhtml EnableVertexAttribArray(a Attrib) // Finish blocks until the effects of all previously called GL // commands are complete. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glFinish.xhtml Finish() // Flush empties all buffers. It does not block. // // An OpenGL implementation may buffer network communication, // the command stream, or data inside the graphics accelerator. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glFlush.xhtml Flush() // FramebufferRenderbuffer attaches rb to the current frame buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glFramebufferRenderbuffer.xhtml FramebufferRenderbuffer(target, attachment, rbTarget Enum, rb Renderbuffer) // FramebufferTexture2D attaches the t to the current frame buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glFramebufferTexture2D.xhtml FramebufferTexture2D(target, attachment, texTarget Enum, t Texture, level int) // FrontFace defines which polygons are front-facing. // // Valid modes: CW, CCW. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glFrontFace.xhtml FrontFace(mode Enum) // GenerateMipmap generates mipmaps for the current texture. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGenerateMipmap.xhtml GenerateMipmap(target Enum) // GetActiveAttrib returns details about an active attribute variable. // A value of 0 for index selects the first active attribute variable. // Permissible values for index range from 0 to the number of active // attribute variables minus 1. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetActiveAttrib.xhtml GetActiveAttrib(p Program, index uint32) (name string, size int, ty Enum) // GetActiveUniform returns details about an active uniform variable. // A value of 0 for index selects the first active uniform variable. // Permissible values for index range from 0 to the number of active // uniform variables minus 1. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetActiveUniform.xhtml GetActiveUniform(p Program, index uint32) (name string, size int, ty Enum) // GetAttachedShaders returns the shader objects attached to program p. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetAttachedShaders.xhtml GetAttachedShaders(p Program) []Shader // GetAttribLocation returns the location of an attribute variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetAttribLocation.xhtml GetAttribLocation(p Program, name string) Attrib // GetBooleanv returns the boolean values of parameter pname. // // Many boolean parameters can be queried more easily using IsEnabled. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGet.xhtml GetBooleanv(dst []bool, pname Enum) // GetFloatv returns the float values of parameter pname. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGet.xhtml GetFloatv(dst []float32, pname Enum) // GetIntegerv returns the int values of parameter pname. // // Single values may be queried more easily using GetInteger. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGet.xhtml GetIntegerv(dst []int32, pname Enum) // GetInteger returns the int value of parameter pname. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGet.xhtml GetInteger(pname Enum) int // GetBufferParameteri returns a parameter for the active buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetBufferParameter.xhtml GetBufferParameteri(target, value Enum) int // GetError returns the next error. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetError.xhtml GetError() Enum // GetFramebufferAttachmentParameteri returns attachment parameters // for the active framebuffer object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetFramebufferAttachmentParameteriv.xhtml GetFramebufferAttachmentParameteri(target, attachment, pname Enum) int // GetProgrami returns a parameter value for a program. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetProgramiv.xhtml GetProgrami(p Program, pname Enum) int // GetProgramInfoLog returns the information log for a program. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetProgramInfoLog.xhtml GetProgramInfoLog(p Program) string // GetRenderbufferParameteri returns a parameter value for a render buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetRenderbufferParameteriv.xhtml GetRenderbufferParameteri(target, pname Enum) int // GetShaderi returns a parameter value for a shader. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetShaderiv.xhtml GetShaderi(s Shader, pname Enum) int // GetShaderInfoLog returns the information log for a shader. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetShaderInfoLog.xhtml GetShaderInfoLog(s Shader) string // GetShaderPrecisionFormat returns range and precision limits for // shader types. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetShaderPrecisionFormat.xhtml GetShaderPrecisionFormat(shadertype, precisiontype Enum) (rangeLow, rangeHigh, precision int) // GetShaderSource returns source code of shader s. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetShaderSource.xhtml GetShaderSource(s Shader) string // GetString reports current GL state. // // Valid name values: // EXTENSIONS // RENDERER // SHADING_LANGUAGE_VERSION // VENDOR // VERSION // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetString.xhtml GetString(pname Enum) string // GetTexParameterfv returns the float values of a texture parameter. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetTexParameter.xhtml GetTexParameterfv(dst []float32, target, pname Enum) // GetTexParameteriv returns the int values of a texture parameter. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetTexParameter.xhtml GetTexParameteriv(dst []int32, target, pname Enum) // GetUniformfv returns the float values of a uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetUniform.xhtml GetUniformfv(dst []float32, src Uniform, p Program) // GetUniformiv returns the float values of a uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetUniform.xhtml GetUniformiv(dst []int32, src Uniform, p Program) // GetUniformLocation returns the location of a uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetUniformLocation.xhtml GetUniformLocation(p Program, name string) Uniform // GetVertexAttribf reads the float value of a vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetVertexAttrib.xhtml GetVertexAttribf(src Attrib, pname Enum) float32 // GetVertexAttribfv reads float values of a vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetVertexAttrib.xhtml GetVertexAttribfv(dst []float32, src Attrib, pname Enum) // GetVertexAttribi reads the int value of a vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetVertexAttrib.xhtml GetVertexAttribi(src Attrib, pname Enum) int32 // GetVertexAttribiv reads int values of a vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glGetVertexAttrib.xhtml GetVertexAttribiv(dst []int32, src Attrib, pname Enum) // Hint sets implementation-specific modes. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glHint.xhtml Hint(target, mode Enum) // IsBuffer reports if b is a valid buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glIsBuffer.xhtml IsBuffer(b Buffer) bool // IsEnabled reports if cap is an enabled capability. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glIsEnabled.xhtml IsEnabled(cap Enum) bool // IsFramebuffer reports if fb is a valid frame buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glIsFramebuffer.xhtml IsFramebuffer(fb Framebuffer) bool // IsProgram reports if p is a valid program object. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glIsProgram.xhtml IsProgram(p Program) bool // IsRenderbuffer reports if rb is a valid render buffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glIsRenderbuffer.xhtml IsRenderbuffer(rb Renderbuffer) bool // IsShader reports if s is valid shader. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glIsShader.xhtml IsShader(s Shader) bool // IsTexture reports if t is a valid texture. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glIsTexture.xhtml IsTexture(t Texture) bool // LineWidth specifies the width of lines. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glLineWidth.xhtml LineWidth(width float32) // LinkProgram links the specified program. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glLinkProgram.xhtml LinkProgram(p Program) // PixelStorei sets pixel storage parameters. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glPixelStorei.xhtml PixelStorei(pname Enum, param int32) // PolygonOffset sets the scaling factors for depth offsets. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glPolygonOffset.xhtml PolygonOffset(factor, units float32) // ReadPixels returns pixel data from a buffer. // // In GLES 3, the source buffer is controlled with ReadBuffer. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glReadPixels.xhtml ReadPixels(dst []byte, x, y, width, height int, format, ty Enum) // ReleaseShaderCompiler frees resources allocated by the shader compiler. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glReleaseShaderCompiler.xhtml ReleaseShaderCompiler() // RenderbufferStorage establishes the data storage, format, and // dimensions of a renderbuffer object's image. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glRenderbufferStorage.xhtml RenderbufferStorage(target, internalFormat Enum, width, height int) // SampleCoverage sets multisample coverage parameters. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glSampleCoverage.xhtml SampleCoverage(value float32, invert bool) // Scissor defines the scissor box rectangle, in window coordinates. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glScissor.xhtml Scissor(x, y, width, height int32) // ShaderSource sets the source code of s to the given source code. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glShaderSource.xhtml ShaderSource(s Shader, src string) // StencilFunc sets the front and back stencil test reference value. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glStencilFunc.xhtml StencilFunc(fn Enum, ref int, mask uint32) // StencilFunc sets the front or back stencil test reference value. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glStencilFuncSeparate.xhtml StencilFuncSeparate(face, fn Enum, ref int, mask uint32) // StencilMask controls the writing of bits in the stencil planes. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glStencilMask.xhtml StencilMask(mask uint32) // StencilMaskSeparate controls the writing of bits in the stencil planes. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glStencilMaskSeparate.xhtml StencilMaskSeparate(face Enum, mask uint32) // StencilOp sets front and back stencil test actions. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glStencilOp.xhtml StencilOp(fail, zfail, zpass Enum) // StencilOpSeparate sets front or back stencil tests. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glStencilOpSeparate.xhtml StencilOpSeparate(face, sfail, dpfail, dppass Enum) // TexImage2D writes a 2D texture image. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glTexImage2D.xhtml TexImage2D(target Enum, level int, width, height int, format Enum, ty Enum, data []byte) // TexSubImage2D writes a subregion of a 2D texture image. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glTexSubImage2D.xhtml TexSubImage2D(target Enum, level int, x, y, width, height int, format, ty Enum, data []byte) // TexParameterf sets a float texture parameter. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glTexParameter.xhtml TexParameterf(target, pname Enum, param float32) // TexParameterfv sets a float texture parameter array. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glTexParameter.xhtml TexParameterfv(target, pname Enum, params []float32) // TexParameteri sets an integer texture parameter. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glTexParameter.xhtml TexParameteri(target, pname Enum, param int) // TexParameteriv sets an integer texture parameter array. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glTexParameter.xhtml TexParameteriv(target, pname Enum, params []int32) // Uniform1f writes a float uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform1f(dst Uniform, v float32) // Uniform1fv writes a [len(src)]float uniform array. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform1fv(dst Uniform, src []float32) // Uniform1i writes an int uniform variable. // // Uniform1i and Uniform1iv are the only two functions that may be used // to load uniform variables defined as sampler types. Loading samplers // with any other function will result in a INVALID_OPERATION error. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform1i(dst Uniform, v int) // Uniform1iv writes a int uniform array of len(src) elements. // // Uniform1i and Uniform1iv are the only two functions that may be used // to load uniform variables defined as sampler types. Loading samplers // with any other function will result in a INVALID_OPERATION error. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform1iv(dst Uniform, src []int32) // Uniform2f writes a vec2 uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform2f(dst Uniform, v0, v1 float32) // Uniform2fv writes a vec2 uniform array of len(src)/2 elements. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform2fv(dst Uniform, src []float32) // Uniform2i writes an ivec2 uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform2i(dst Uniform, v0, v1 int) // Uniform2iv writes an ivec2 uniform array of len(src)/2 elements. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform2iv(dst Uniform, src []int32) // Uniform3f writes a vec3 uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform3f(dst Uniform, v0, v1, v2 float32) // Uniform3fv writes a vec3 uniform array of len(src)/3 elements. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform3fv(dst Uniform, src []float32) // Uniform3i writes an ivec3 uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform3i(dst Uniform, v0, v1, v2 int32) // Uniform3iv writes an ivec3 uniform array of len(src)/3 elements. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform3iv(dst Uniform, src []int32) // Uniform4f writes a vec4 uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform4f(dst Uniform, v0, v1, v2, v3 float32) // Uniform4fv writes a vec4 uniform array of len(src)/4 elements. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform4fv(dst Uniform, src []float32) // Uniform4i writes an ivec4 uniform variable. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform4i(dst Uniform, v0, v1, v2, v3 int32) // Uniform4i writes an ivec4 uniform array of len(src)/4 elements. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml Uniform4iv(dst Uniform, src []int32) // UniformMatrix2fv writes 2x2 matrices. Each matrix uses four // float32 values, so the number of matrices written is len(src)/4. // // Each matrix must be supplied in column major order. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml UniformMatrix2fv(dst Uniform, src []float32) // UniformMatrix3fv writes 3x3 matrices. Each matrix uses nine // float32 values, so the number of matrices written is len(src)/9. // // Each matrix must be supplied in column major order. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml UniformMatrix3fv(dst Uniform, src []float32) // UniformMatrix4fv writes 4x4 matrices. Each matrix uses 16 // float32 values, so the number of matrices written is len(src)/16. // // Each matrix must be supplied in column major order. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUniform.xhtml UniformMatrix4fv(dst Uniform, src []float32) // UseProgram sets the active program. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glUseProgram.xhtml UseProgram(p Program) // ValidateProgram checks to see whether the executables contained in // program can execute given the current OpenGL state. // // Typically only used for debugging. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glValidateProgram.xhtml ValidateProgram(p Program) // VertexAttrib1f writes a float vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttrib.xhtml VertexAttrib1f(dst Attrib, x float32) // VertexAttrib1fv writes a float vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttrib.xhtml VertexAttrib1fv(dst Attrib, src []float32) // VertexAttrib2f writes a vec2 vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttrib.xhtml VertexAttrib2f(dst Attrib, x, y float32) // VertexAttrib2fv writes a vec2 vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttrib.xhtml VertexAttrib2fv(dst Attrib, src []float32) // VertexAttrib3f writes a vec3 vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttrib.xhtml VertexAttrib3f(dst Attrib, x, y, z float32) // VertexAttrib3fv writes a vec3 vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttrib.xhtml VertexAttrib3fv(dst Attrib, src []float32) // VertexAttrib4f writes a vec4 vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttrib.xhtml VertexAttrib4f(dst Attrib, x, y, z, w float32) // VertexAttrib4fv writes a vec4 vertex attribute. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttrib.xhtml VertexAttrib4fv(dst Attrib, src []float32) // VertexAttribPointer uses a bound buffer to define vertex attribute data. // // Direct use of VertexAttribPointer to load data into OpenGL is not // supported via the Go bindings. Instead, use BindBuffer with an // ARRAY_BUFFER and then fill it using BufferData. // // The size argument specifies the number of components per attribute, // between 1-4. The stride argument specifies the byte offset between // consecutive vertex attributes. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glVertexAttribPointer.xhtml VertexAttribPointer(dst Attrib, size int, ty Enum, normalized bool, stride, offset int) // Viewport sets the viewport, an affine transformation that // normalizes device coordinates to window coordinates. // // http://www.khronos.org/opengles/sdk/docs/man3/html/glViewport.xhtml Viewport(x, y, width, height int) }
Context is an OpenGL context.
Calls are not safe for concurrent use. However calls can be made from any goroutine, the gl package removes the notion of thread-local context.
Contexts are independent. Two contexts can be used concurrently.
NewContext creates a cgo OpenGL context.
See the Worker interface for more details on how it is used.
Enum is equivalent to GLenum, and is normally used with one of the constants defined in this package.
Framebuffer identifies a GL framebuffer.
func (v Framebuffer) String() string
type Program struct { // Init is set by CreateProgram, as some GL drivers (in particular, // ANGLE) return true for glIsProgram(0). Init bool Value uint32 }
Program identifies a compiled shader program.
A Renderbuffer is a GL object that holds an image in an internal format.
func (v Renderbuffer) String() string
Shader identifies a GLSL shader.
A Texture identifies a GL texture unit.
Uniform identifies the location of a specific uniform variable.
type Worker interface { // WorkAvailable returns a channel that communicates when DoWork should be // called. WorkAvailable() <-chan struct{} // DoWork performs any pending OpenGL calls. DoWork() }
Worker is used by display driver code to execute OpenGL calls.
Typically display driver code creates a gl.Context for an application, and along with it establishes a locked OS thread to execute the cgo calls:
go func() { runtime.LockOSThread() // ... platform-specific cgo call to bind a C OpenGL context // into thread-local storage. glctx, worker := gl.NewContext() workAvailable := worker.WorkAvailable() go userAppCode(glctx) for { select { case <-workAvailable: worker.DoWork() case <-drawEvent: // ... platform-specific cgo call to draw screen } } }()
This interface is an internal implementation detail and should only be used by the package responsible for managing the screen, such as golang.org/x/mobile/app.
Package gl imports 4 packages (graph) and is imported by 34 packages. Updated 7 days ago. Refresh now. Tools for package owners.